Class API

constructor

• new API(): API

  Initiates the event and projection objects.

  Returns API

config

layer

plugin

utilities

createMapFromConfig

• createMapFromConfig(
      divId: string,
      mapConfig: string,
      divHeight?: number,
      waitOnMapReady?: boolean,
  ): Promise<MapViewer>

  Creates a new map in a given div id.

  GV The div MUST NOT have a geoview-map class or a warning will be shown when initMapDivFromFunctionCall is called. If is present, the div will be created with a default config.

  Parameters

  • divId: string

    Id of the div to create map in (becomes the mapId)

  • mapConfig: string

    Config passed in from the function call (string or url of a config path)

  • OptionaldivHeight: number

    Optional height of the div to inject the map in (mandatory if the map reloads)

  • waitOnMapReady: boolean = true

    Optional flag to wait for the map to be ready before resolving the promise

  Returns Promise<MapViewer>

  A promise that resolves with the MapViewer (after the onMapReady is triggered) which will be created from the configuration

createMapFromConfigFast

• createMapFromConfigFast(
      divId: string,
      mapConfig: string,
      divHeight?: number,
  ): Promise<MapViewer>

  Creates a new map in a given div id.

  GV The div MUST NOT have a geoview-map class or a warning will be shown when initMapDivFromFunctionCall is called. If is present, the div will be created with a default config.

  Parameters

  • divId: string

    Id of the div to create map in (becomes the mapId)

  • mapConfig: string

    Config passed in from the function call (string or url of a config path)

  • OptionaldivHeight: number

    Optional height of the div to inject the map in (mandatory if the map reloads)

  Returns Promise<MapViewer>

  A promise that resolves with the MapViewer (after the onMapReady is triggered) which will be created from the configuration

deleteMapViewer

• deleteMapViewer(mapId: string, deleteContainer: boolean): Promise<void>

  Deletes a map viewer instance by its ID and unmounts it from the DOM - for React.

  Parameters

  • mapId: string

    The unique identifier of the map to delete

  • deleteContainer: boolean

    True if we want to delete div from the page

  Returns Promise<void>

  A promise that resolves when the map viewer is deleted

getMapViewer

• getMapViewer(mapId: string): MapViewer

  Gets a map viewer instance by its ID.

  Parameters

  • mapId: string

    The unique identifier of the map to retrieve

  Returns MapViewer

  The map viewer instance if found

  Throws

  When the map with the specified ID is not found

getMapViewerAsync

• getMapViewerAsync(mapId: string): Promise<MapViewer>

  Asynchronously gets a map viewer instance by its ID.

  Parameters

  • mapId: string

    The unique identifier of the map to retrieve

  Returns Promise<MapViewer>

  A promise that resolves with the map viewer instance when/if found

  Throws

  When the map with the specified ID is not found

getMapViewerIds

• getMapViewerIds(): string[]

  Gets the list of all map IDs currently in the collection.

  Returns string[]

  Array of map IDs

hasMapViewer

• hasMapViewer(mapId: string): boolean

  Returns true if a map id is already registered.

  Parameters

  • mapId: string

    The unique identifier of the map to retrieve

  Returns boolean

  True if map exist

reload

• reload(
      mapId: string,
      mapConfig?: TypeMapFeaturesConfig | TypeMapFeaturesInstance,
  ): Promise<MapViewer>

  Reload a map from a config object stored in store, or provided. It first removes then recreates the map.

  Parameters

  • mapId: string

    The unique identifier of the map to reload

  • OptionalmapConfig: TypeMapFeaturesConfig | TypeMapFeaturesInstance

    Optional map config to use for reload

  Returns Promise<MapViewer>

  A promise that resolves with the MapViewer which will be created once reloaded

reloadWithCurrentState

• reloadWithCurrentState(
      mapId: string,
      maintainGeocoreLayerNames?: boolean,
  ): Promise<MapViewer>

  Reload a map from a config object created using current map state. It first removes then recreates the map.

  Parameters

  • mapId: string

    The unique identifier of the map to reload

  • maintainGeocoreLayerNames: boolean = true

    Indicates if geocore layer names should be kept as is or returned to defaults. Set to false after a language change to update the layer names with the new language

  Returns Promise<MapViewer>

  A promise that resolves with the MapViewer which will be created once reloaded

setMapViewer

• setMapViewer(mapId: string, mapViewer: MapViewer): void

  Sets a map viewer in maps.

  Parameters

  • mapId: string

    ID of the map

  • mapViewer: MapViewer

    The viewer to be added

  Returns void