Class AegirMap

isFullyLoaded

• get isFullyLoaded(): boolean

• Returns boolean

constructor

• new AegirMap(logger?): AegirMap

• Parameters

  • logger: Logger = globalLogger

  Returns AegirMap

addAnnotation

• addAnnotation(annotation): Marker

• Parameters

  • annotation: PointAnnotation

  Returns Marker

addListener

• addListener(type, handler): void

• Adds a listener for events of a specified type.

  Parameters

  • type: AegirMapEvents

    Any of the supported map events

  • handler: ((e) => void)

    A callback function to norify the event.

    • • (e): void

      • Parameters

        • e: any

        Returns void

  Returns void

  Since

  2.0.0

addMarker

• addMarker(longitude, latitude, desc?): Marker

• Parameters

  • longitude: number

  • latitude: number

  • Optional desc: any

  Returns Marker

centerMap

• centerMap(lng, lat, params): void

• Parameters

  • lng: number

  • lat: number

  • params: any

  Returns void

changeFloors

• changeFloors(indoorFloors, outdoorFloors?): void

• Handles automatically hiding and showing floors.

  Parameters

  • indoorFloors: string[]

    the list of ids for floors indoor floors to change

  • outdoorFloors: string[] = undefined

    the list of ids for floors outdoor floors to change

  Returns void

clearMarkers

• clearMarkers(): void

• Returns void

dispose

• dispose(): void

• Clean up and release all internal resources associated with this map. This includes DOM elements, event bindings, web workers, and WebGL resources. Use this method when you are done using the map and wish to ensure that it no longer consumes browser resources. Afterwards, you must not call any other methods on the map.

  Returns void

  Since

  2.0.0

enableWayfinding

• enableWayfinding(): Wayfinding

• Returns Wayfinding

findFloorWithId

• findFloorWithId(floorId): any

• Search for indoor floors in any building

  Parameters

  • floorId: string

    the unique id for the floor you are searching for

  Returns any

  the matched floor, or null if not found

  Since

  1.2

findOutdoorFloorWithId

• findOutdoorFloorWithId(floorId): any

• Search for outdoor floors in any building

  Parameters

  • floorId: string

    the unique id for the floor you are searching for

  Returns any

  the matched floor, or null if not found

  Since

  1.2

getBuildings

• getBuildings(): any[]

• List of buildings for the venue

  Returns any[]

  all building objects

  Since

  1.2

getConfig

• getConfig(): AegirMapConfig

• Get current configuration

  Returns AegirMapConfig

  active configuration settings

  Deprecated

getCurrentFloor

• getCurrentFloor(): any

• Returns any

getCurrentFloors

• getCurrentFloors(): any[]

• Get the list of currently active indoor floors

  Returns any[]

  list of floors

getCurrentOutdoorFloors

• getCurrentOutdoorFloors(): any[]

• Get the list of currently active outdoor floors

  Returns any[]

  list of floors

getDebug

• getDebug(): any

• Get debug settings

  Returns any

  debug settings

getFloors

• getFloors(): VmFloor[]

• Returns VmFloor[]

getFloorsMap

• getFloorsMap(): any

• A Dictionary of all the floors in the venue where each key is a floor Id.

  Returns any

  a Key-Value dictionary of floor Id and floor

getLayers

• getLayers(): {
      commonBuildingLayers: (string | string[])[][];
      commonLayers: (string | string[])[][];
      customStyleLayers: any[];
      globalLayers: (string | string[])[][];
      rasterLayers: (string | string[])[][];
      vectorLayers: (string | string[])[][];
  }

• Get map layers

  Returns {
      commonBuildingLayers: (string | string[])[][];
      commonLayers: (string | string[])[][];
      customStyleLayers: any[];
      globalLayers: (string | string[])[][];
      rasterLayers: (string | string[])[][];
      vectorLayers: (string | string[])[][];
  }

  map layers

  • commonBuildingLayers: (string | string[])[][]

  • commonLayers: (string | string[])[][]

  • customStyleLayers: any[]

  • globalLayers: (string | string[])[][]

  • rasterLayers: (string | string[])[][]

  • vectorLayers: (string | string[])[][]

  Deprecated

getMapBounds

• getMapBounds(): AegirMapBoundConfig

• Gets the coordinates of the map bounds

  Returns AegirMapBoundConfig

  MapBounds instance

getOutdoorBuildings

• getOutdoorBuildings(): any[]

• List of outdoor buildings for the venue

  Returns any[]

  the list of outdoor floors in the venue

  Since

  1.2

getVmd

• getVmd(): VenueMapData

• Returns VenueMapData

getWayfinding

• getWayfinding(): Wayfinding

• Returns Wayfinding

loadMapView

• loadMapView(loadOptions, cameraConfig?): Promise<void>

• Loads the map view, initialized at the given lat/lng

  Parameters

  • loadOptions: MapViewLoadConfig

    mapview configuration

  • cameraConfig: MapViewCameraConfig = {}

    mapview camera initial configuration

  Returns Promise<void>

loadVenueMapData

• loadVenueMapData(vmd, __namedParameters): Promise<VmMapBuilding>

• Parameters

  • vmd: VenueMapData

  • __namedParameters: MapDataLoadConfig

  Returns Promise<VmMapBuilding>

removeAnnotation

• removeAnnotation(annotation): void

• Parameters

  • annotation: PointAnnotation

  Returns void

removeStyleForBuilding

• removeStyleForBuilding(building): void

• Parameters

  • building: VmMapBuilding

  Returns void

  Since

  1.2.1

removeStyleForUnit

• removeStyleForUnit(unit): void

• Parameters

  • unit: VmMapUnit

    the unit to remove the style from. Style will revert back to default style defined in json config.

  Returns void

  Since

  1.2.1

setBackgroundAlpha

• setBackgroundAlpha(alpha): void

• set's the alpha on the map's background layer

  Parameters

  • alpha: string

  Returns void

  Since

  1.2

setImageForKey

• setImageForKey(imagePath, key): void

• Parameters

  • imagePath: string

    path of image

  • key: string

    key

  Returns void

  Since

  1.3

setStyleForBuilding

• setStyleForBuilding(style, building): void

• Parameters

  • style: VmVenueLayerStyle

    the new style for the building

  • building: VmMapBuilding

    the building to apply the style to

  Returns void

  Since

  2.0.0

setStyleForUnit

• setStyleForUnit(style, unit): void

• Parameters

  • style: VmVenueLayerStyle

    the new style for the unit

  • unit: VmMapUnit

    the unit to apply the style to

  Returns void

  Since

  1.2.1

setVenueMapModel

• setVenueMapModel(dataModel): void

• Sets the object model for the map. The object model represents the the Venue's buildings, floors and units

  Parameters

  • dataModel: VenueMapModel

    The parsed GeoJSON object model

  Returns void

  Since

  2.0

showFloor

• showFloor(floorId): void

• Load map layers for a particular floor

  Parameters

  • floorId: string

    the id of the floor to show

  Returns void

zoomIn

• zoomIn(): void

• Increases the map's zoom level by 1.

  Returns void

  Since

  2.0.0

zoomOut

• zoomOut(): void

• Decreases the map's zoom level by 1.

  Returns void

  Since

  2.0.0

zoomTo

• zoomTo(zoom): void

• Zooms the map to the specified zoom level, with an animated transition.

  Parameters

  • zoom: number

    The zoom level to transition to.

  Returns void

  Example

  // Zoom to the zoom level 5 without an animated transition
  map.zoomTo(5);
  Copy

  Since

  2.0.0

Readonly EVENTS

featureMap

Readonly mapEngine

vmd