Class GeometryApi

constructor

• new GeometryApi(mapViewer: MapViewer): GeometryApi

  Constructs a Geometry class and creates a geometry group in the process.

  Parameters

  • mapViewer: MapViewer

    A reference to the map viewer

  Returns GeometryApi

defaultGeometryGroupId

geometries

addCircle

• addCircle(
      coordinate: Coordinate,
      options?: {
          geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
          projection?: number;
          style?: TypeFeatureCircleStyle;
      },
      optionalFeatureId?: string,
      groupId?: string,
  ): Feature

  Creates a new circle.

  Parameters

  • coordinate: Coordinate

    The lon/lat coordinate of the circle

  • Optionaloptions: {
        geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
        projection?: number;
        style?: TypeFeatureCircleStyle;
    }

    Optional circle options including styling

  • OptionaloptionalFeatureId: string

    Optional id to be used to manage this geometry

  • OptionalgroupId: string

    Optional group id in which we want to add the geometry

  Returns Feature

  The created circle feature

addMarkerIcon

• addMarkerIcon(
      coordinate: Coordinate,
      options?: {
          geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
          projection?: number;
          style?: TypeIconStyle;
      },
      optionalFeatureId?: string,
      groupId?: string,
  ): Feature

  Creates a new marker icon.

  Parameters

  • coordinate: Coordinate

    The lon/lat position of the marker

  • Optionaloptions: {
        geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
        projection?: number;
        style?: TypeIconStyle;
    }

    Optional marker options including styling

  • OptionaloptionalFeatureId: string

    Optional id to be used to manage this geometry

  • OptionalgroupId: string

    Optional group id in which we want to add the geometry

  Returns Feature

  The created marker feature

addPolygon

• addPolygon(
      points: number[] | Coordinate[][],
      options?: {
          geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
          projection?: number;
          style?: TypeFeatureStyle;
      },
      optionalFeatureId?: string,
      groupId?: string,
  ): Feature

  Creates a new polygon.

  Parameters

  • points: number[] | Coordinate[][]

    The array of points to create the polygon

  • Optionaloptions: {
        geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
        projection?: number;
        style?: TypeFeatureStyle;
    }

    Optional polygon options including styling

  • OptionaloptionalFeatureId: string

    Optional id to be used to manage this geometry

  • OptionalgroupId: string

    Optional group id in which we want to add the geometry

  Returns Feature

  The created polygon feature

addPolyline

• addPolyline(
      points: Coordinate,
      options?: {
          geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
          projection?: number;
          style?: TypeFeatureStyle;
      },
      id?: string,
      groupId?: string,
  ): Feature

  Creates a polyline using an array of lon/lat points.

  Parameters

  • points: Coordinate

    The points of lon/lat to draw a polyline

  • Optionaloptions: {
        geometryLayout?: "XY" | "XYZ" | "XYM" | "XYZM";
        projection?: number;
        style?: TypeFeatureStyle;
    }

    Optional polyline options including styling

  • Optionalid: string

    Optional id to be used to manage this geometry

  • OptionalgroupId: string

    Optional group id in which we want to add the geometry

  Returns Feature

  The created polyline feature

addToGeometryGroup

• addToGeometryGroup(geometry: Feature, geometryGroupId?: string): void

  Adds a new geometry to the group whose identifier is equal to geometryGroupId.

  If geometryGroupId is not provided, uses the active geometry group. If the geometry group doesn't exist, creates it.

  Parameters

  • geometry: Feature

    The geometry to be added to the group

  • OptionalgeometryGroupId: string

    Optional id of the group to add the geometry to

  Returns void

createGeometryGroup

• createGeometryGroup(
      geometryGroupId: string,
      options?: {
          vectorLayerOptions?: Options<
              Feature<Geometry>,
              VectorSource<Feature<Geometry>>,
          >;
          vectorSourceOptions?: Options<Feature<Geometry>>;
      },
  ): FeatureCollection

  Creates a new geometry group to manage multiple geometries at once.

  The z-index is infinity by default, set the index to change the behaviour.

  Parameters

  • geometryGroupId: string

    The id of the group to use when managing this group

  • Optionaloptions: {
        vectorLayerOptions?: Options<
            Feature<Geometry>,
            VectorSource<Feature<Geometry>>,
        >;
        vectorSourceOptions?: Options<Feature<Geometry>>;
    }

    Optional vector layer and vector source options

  Returns FeatureCollection

  The created or existing geometry group

deleteGeometriesFromGroup

• deleteGeometriesFromGroup(geometryGroupid: string): FeatureCollection

  Deletes all geometries from the geometry group but keeps the group.

  Parameters

  • geometryGroupid: string

    The group id

  Returns FeatureCollection

  The group with empty layers

  Throws

  When the provided geometry group id does not exist

deleteGeometry

• deleteGeometry(featureId: string): void

  Deletes a feature using the id and removes it from the groups and the map.

  Parameters

  • featureId: string

    The id of the feature to delete

  Returns void

deleteGeometryFromGroup

• deleteGeometryFromGroup(featureId: string, geometryGroupid: string): void

  Deletes a specific feature from a group using the feature id.

  Parameters

  • featureId: string

    The feature id to be deleted

  • geometryGroupid: string

    The group id

  Returns void

  Throws

  When the provided geometry group id does not exist

deleteGeometryFromGroups

• deleteGeometryFromGroups(featureId: string): void

  Finds the groups that the feature exists in and deletes the feature from those groups.

  Parameters

  • featureId: string

    The geometry id

  Returns void

deleteGeometryGroup

• deleteGeometryGroup(geometryGroupid: string): void

  Deletes a geometry group and all the geometries from the map.

  The default geometry group can't be deleted.

  Parameters

  • geometryGroupid: string

    The id of the geometry group to delete

  Returns void

getActiveGeometryGroup

• getActiveGeometryGroup(): FeatureCollection

  Gets the active geometry group.

  Returns FeatureCollection

  The active geometry group

getFeatureCoords

• getFeatureCoords(
      featureId: string,
      projection?: number,
  ): Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][] | undefined

  Gets the coordinates of a specific feature.

  Parameters

  • featureId: string

    The id of the feature

  • Optionalprojection: number

    Optional projection code to transform the coordinates to. Otherwise, uses the map's projection by default

  Returns Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][] | undefined

  The coordinates of the feature, or undefined if not found or if the geometry type is not currently supported (e.g., GeometryCollection)

getGeometry

• getGeometry(featureId: string): Feature

  Finds a feature using its id.

  Parameters

  • featureId: string

    The id of the feature to return

  Returns Feature

  The feature having the specified id

getGeometryGroup

• getGeometryGroup(geometryGroupId: string): FeatureCollection

  Gets the geometry group by using the ID specified when the group was created.

  Parameters

  • geometryGroupId: string

    The id of the geometry group to return

  Returns FeatureCollection

  The geometry group

  Throws

  When the provided geometry group id does not exist

getGeometryGroups

• getGeometryGroups(): FeatureCollection[]

  Gets all geometry groups.

  Returns FeatureCollection[]

  Array of all geometry groups

getGeometryGroupsByFeatureId

• getGeometryGroupsByFeatureId(featureId: string): FeatureCollection[]

  Finds the groups that contain the geometry using its id.

  Parameters

  • featureId: string

    The id of the geometry

  Returns FeatureCollection[]

  Groups that contain the geometry

getGeometryGroupZIndex

• getGeometryGroupZIndex(geometryGroupId: string): number

  Gets the z-index of a geometry group's vector layer.

  Parameters

  • geometryGroupId: string

    The id of the group

  Returns number

  The z-index value of the vector layer

  Throws

  When the provided geometry group id does not exist

hasGeometryGroup

• hasGeometryGroup(geometryGroupId: string): boolean

  Checks if a geometry group exists.

  Parameters

  • geometryGroupId: string

    The id of the geometry group to check

  Returns boolean

  True if the group exists, false otherwise

offGeometryAdded

• offGeometryAdded(callback: GeometryAddedDelegate): void

  Unregisters a geometry added event handler.

  Parameters

  • callback: GeometryAddedDelegate

    The callback to stop being called whenever the event is emitted

  Returns void

onGeometryAdded

• onGeometryAdded(callback: GeometryAddedDelegate): void

  Registers a geometry added event handler.

  Parameters

  • callback: GeometryAddedDelegate

    The callback to be executed whenever the event is emitted

  Returns void

setActiveGeometryGroup

• setActiveGeometryGroup(id?: string): void

  Sets the active geometry group (the geometry group used when adding geometries).

  If id is not specified, uses the default geometry group.

  Parameters

  • Optionalid: string

    Optional id of the group to set as active

  Returns void

setFeatureCoords

• setFeatureCoords(
      featureId: string,
      coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][],
      projection?: number,
  ): void

  Allows for a feature's coordinates to be updated programmatically.

  Parameters

  • featureId: string

    The id of the feature to update

  • coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The new coordinates for the feature

  • Optionalprojection: number

    Optional projection code of the coordinates, assumes 4326 if not specified

  Returns void

setGeometryGroupAsInvisible

• setGeometryGroupAsInvisible(geometryGroupId: string): void

  Hides the identified geometry group from the map.

  Parameters

  • geometryGroupId: string

    The id of the group to hide from the map

  Returns void

  Throws

  When the provided geometry group id does not exist

setGeometryGroupAsVisible

• setGeometryGroupAsVisible(geometryGroupId: string): void

  Shows the identified geometry group on the map.

  Parameters

  • geometryGroupId: string

    The id of the group to show on the map

  Returns void

  Throws

  When the provided geometry group id does not exist

setGeometryGroupZIndex

• setGeometryGroupZIndex(geometryGroupId: string, zIndex: number): void

  Sets the z-index of a geometry group's vector layer.

  Parameters

  • geometryGroupId: string

    The id of the group

  • zIndex: number

    The z-index value to set

  Returns void

  Throws

  When the provided geometry group id does not exist

StaticcreateGeometryFromType

• createGeometryFromType(
      geometryType:
          | "Point"
          | "MultiPoint"
          | "LineString"
          | "MultiLineString"
          | "Polygon"
          | "MultiPolygon"
          | "GeometryCollection",
      coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][],
  ): Geometry

  Creates a Geometry given a geometry type and coordinates expected in any logical format.

  Parameters

  • geometryType:
        | "Point"
        | "MultiPoint"
        | "LineString"
        | "MultiLineString"
        | "Polygon"
        | "MultiPolygon"
        | "GeometryCollection"

    The geometry type to create

  • coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The coordinates to use to create the geometry

  Returns Geometry

  The OpenLayers Geometry

  Throws

  When the geometry type is not supported

StaticisArrayOfArrayOfArrayOfCoordinates

• isArrayOfArrayOfArrayOfCoordinates(
      coordinates:
          | Coordinate
          | Coordinate[]
          | Coordinate[][]
          | Coordinate[][][],
  ): coordinates is Coordinate[][][]

  Typeguards when a list of coordinates should actually be a single coordinate, such as a MultiPolygon.

  Parameters

  • coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The coordinates to check

  Returns coordinates is Coordinate[][][]

  True when the coordinates represent a MultiPolygon

StaticisArrayOfArrayOfCoordinates

• isArrayOfArrayOfCoordinates(
      coordinates:
          | Coordinate
          | Coordinate[]
          | Coordinate[][]
          | Coordinate[][][],
  ): coordinates is Coordinate[][]

  Typeguards when a list of coordinates should actually be a single coordinate, such as a MultiLineString or Polygon.

  Parameters

  • coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The coordinates to check

  Returns coordinates is Coordinate[][]

  True when the coordinates represent a MultiLineString or Polygon

StaticisArrayOfCoordinates

• isArrayOfCoordinates(
      coordinates:
          | Coordinate
          | Coordinate[]
          | Coordinate[][]
          | Coordinate[][][],
  ): coordinates is Coordinate[]

  Typeguards when a list of coordinates should actually be a single coordinate, such as a LineString.

  Parameters

  • coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The coordinates to check

  Returns coordinates is Coordinate[]

  True when the coordinates represent a LineString

StaticisCoordinates

• isCoordinates(
      coordinates:
          | Coordinate
          | Coordinate[]
          | Coordinate[][]
          | Coordinate[][][],
  ): coordinates is Coordinate

  Typeguards when a list of coordinates should actually be a single coordinate, such as a Point.

  Parameters

  • coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The coordinates to check

  Returns coordinates is Coordinate

  True when the coordinates represent a Point