Class MapControl

Internal - Documentation will follow.

Export

MapControl

Index

Methods

addOnCameraEventListener addOnFloorUpdateListener animateCamera clearFilter clearHighlight deSelectLocation disableLiveData enableLiveData getBuildingSelectionMode getCurrentBuilding getCurrentBuildingFloor getCurrentCameraPosition getCurrentFloorIndex getCurrentMapsIndoorsZoom getCurrentVenue getFloorSelectionMode getHiddenFeatures getMapStyle getMapViewPaddingBottom getMapViewPaddingEnd getMapViewPaddingStart getMapViewPaddingTop goTo hideFloorSelector isFloorSelectorHidden isUserPositionShown moveCamera removeOnCameraEventListener removeOnFloorUpdateListener selectBuilding selectFloor selectLocation selectVenue setBuildingSelectionMode setFilter setFloorSelectionMode setFloorSelector setHiddenFeatures setHighlight setLabelOptions setMapPadding setMapStyle setOnCurrentBuildingChangedListener setOnCurrentVenueChangedListener setOnLocationSelectedListener setOnMapClickListener setOnMarkerClickListener setOnMarkerInfoWindowClickListener showInfoWindowOnClickedLocation showUserPosition create

Methods

addOnCameraEventListener

addOnCameraEventListener(listener: MPCameraEventListener): void
Add a camera event listener, invoked when a camera event occurs (e.g. moved, idle) (see MPCameraEvent).
Parameters
- listener: MPCameraEventListener
Returns void
- Defined in MapControl.ts:836

addOnFloorUpdateListener

addOnFloorUpdateListener(listener: OnFloorUpdateListener): void
Add a listener object to catch floor changes made by either the user or the positioning service.
Parameters
- listener: OnFloorUpdateListener
Returns void
- Defined in MapControl.ts:867

animateCamera

animateCamera(update: MPCameraUpdate, duration?: number): Promise<void>
Uses a camera update to animate the camera.
Parameters
- update: MPCameraUpdate
  How to update the camera.
- Optionalduration: number
  how long the animation should take in ms.
Returns Promise<void>
Async
- Defined in MapControl.ts:679

clearFilter

clearFilter(): Promise<void>
Invoke this method to restore the map to its default state (POIs shown based on their display rules, etc.).

Returns Promise<void>
Async
- Defined in MapControl.ts:242

clearHighlight

clearHighlight(): Promise<void>
Returns Promise<void>
- Defined in MapControl.ts:304

deSelectLocation

deSelectLocation(): Promise<void>
Call this to deselect a location previously selected with (MPLocation, MPSelectionBehavior).

Returns Promise<void>
Async
- Defined in MapControl.ts:430

disableLiveData

disableLiveData(domainType: string): Promise<void>
Disables live data for a specific domainType.
Parameters
- domainType: string
Returns Promise<void>
Async
- Defined in MapControl.ts:654

enableLiveData

enableLiveData(
domainType: string,
listener?: OnLiveLocationUpdateListener,
): Promise<void>
Enables live data on a specific domain and uses MapsIndoors standard graphic implementation.

Uses a domainType string, use LiveDataDomainTypes to get supported strings.
Parameters
- domainType: string
- Optionallistener: OnLiveLocationUpdateListener
Returns Promise<void>
Async
- Defined in MapControl.ts:623

getBuildingSelectionMode

getBuildingSelectionMode(): Promise<MPSelectionMode>
Get the selection mode for buildings.

Returns Promise<MPSelectionMode>
- Defined in MapControl.ts:925

getCurrentBuilding

getCurrentBuilding(): Promise<MPBuilding>
Get the currently selected building, if there is any.

Returns Promise<MPBuilding>
The current building, if any is selected.

Async
- Defined in MapControl.ts:180

getCurrentBuildingFloor

getCurrentBuildingFloor(): Promise<MPFloor>
Returns the current MPFloor of the current MPBuilding in focus.

Returns Promise<MPFloor>
Async
- Defined in MapControl.ts:441

getCurrentCameraPosition

getCurrentCameraPosition(): Promise<MPCameraPosition>
Saves the current position of the camera into a MPCameraPosition.

Returns Promise<MPCameraPosition>
Async
- Defined in MapControl.ts:705

getCurrentFloorIndex

getCurrentFloorIndex(): Promise<number>
Returns the current floor index or MPFloor.defaultGroundFloorIndex if no MPBuilding is in focus.

Returns Promise<number>
Async
- Defined in MapControl.ts:453

getCurrentMapsIndoorsZoom

getCurrentMapsIndoorsZoom(): Promise<number>
Get the zoom level that MapsIndoors is currently using for displaying icons on the map.

Returns Promise<number>
Async
- Defined in MapControl.ts:464

getCurrentVenue

getCurrentVenue(): Promise<MPVenue>
Get the currently selected venue, if there is any.

Returns Promise<MPVenue>
The current venue, if any is selected.

Async
- Defined in MapControl.ts:168

getFloorSelectionMode

getFloorSelectionMode(): Promise<MPSelectionMode>
Get the selection mode for floors.

Returns Promise<MPSelectionMode>
- Defined in MapControl.ts:944

getHiddenFeatures

getHiddenFeatures(): Promise<MPFeatureType[]>
Get features that are hidden on the map.

Returns Promise<MPFeatureType[]>
- Defined in MapControl.ts:958

getMapStyle

getMapStyle(): Promise<MPMapStyle>
Gets the current map style of MapsIndoors tiles.

Returns Promise<MPMapStyle>
Async
- Defined in MapControl.ts:404

getMapViewPaddingBottom

getMapViewPaddingBottom(): Promise<number>
Gets the Map View bottom padding.

Returns Promise<number>
Async
- Defined in MapControl.ts:381

getMapViewPaddingEnd

getMapViewPaddingEnd(): Promise<number>
Gets the Map View bottom padding.

Returns Promise<number>
Async
- Defined in MapControl.ts:370

getMapViewPaddingStart

getMapViewPaddingStart(): Promise<number>
Gets the Map View bottom padding.

Returns Promise<number>
Async
- Defined in MapControl.ts:348

getMapViewPaddingTop

getMapViewPaddingTop(): Promise<number>
Gets the Map View bottom padding.

Returns Promise<number>
Async
- Defined in MapControl.ts:359

goTo

goTo(entity: MPEntity, maxZoom?: number): Promise<void>
Focus the map on the given MPEntity.

Examples of classes of type MPEntity are: MPVenue, MPBuilding, MPBuilding, MPLocation.
Parameters
- entity: MPEntity
  The entity to move to.
- OptionalmaxZoom: number
Returns Promise<void>
Async
- Defined in MapControl.ts:319

hideFloorSelector

hideFloorSelector(hide: boolean): Promise<void>
Shows or hides the MPFloorSelectorInterface, i.e. hiding the View from MapControl.

MapControl will still receive relevant events on floor updates, building change etc.

The Interface will also receive the events, making it possible to show/hide in real time, without refreshing the map.
Parameters
- hide: boolean
Returns Promise<void>
Async
- Defined in MapControl.ts:505

isFloorSelectorHidden

isFloorSelectorHidden(): Promise<boolean>
Returns the visibility state of the currently used MPFloorSelectorInterface.

Returns Promise<boolean>
Async
- Defined in MapControl.ts:489

isUserPositionShown

isUserPositionShown(): Promise<boolean>
Returns the current visibility state of the user location icon (blue dot).

Returns Promise<boolean>
Async
- Defined in MapControl.ts:608

moveCamera

moveCamera(update: MPCameraUpdate): Promise<void>
Uses a camera update to move the camera instantly.
Parameters
- update: MPCameraUpdate
  How to update the camera.
Returns Promise<void>
Async
- Defined in MapControl.ts:694

removeOnCameraEventListener

removeOnCameraEventListener(listener: MPCameraEventListener): void
Remove a camera event listener.
Parameters
- listener: MPCameraEventListener
Returns void
- Defined in MapControl.ts:853

removeOnFloorUpdateListener

removeOnFloorUpdateListener(listener: OnFloorUpdateListener): void
Remove a floor update listener.
Parameters
- listener: OnFloorUpdateListener
Returns void
- Defined in MapControl.ts:884

selectBuilding

selectBuilding(building: MPBuilding, moveCamera: boolean): Promise<void>
Select a building, optionally move the camera to the given building.
Parameters
- building: MPBuilding
- moveCamera: boolean
  Whether to move the camera such that it shows the selected building
Returns Promise<void>
When the selection (and possible camera animation) has completed

Async
- Defined in MapControl.ts:194

selectFloor

selectFloor(floorIndex: number): Promise<void>
Sets the current visible floor to the given floorIndex one.

For floor names/z-index pairs check the value returned by MPBuilding.floors
Parameters
- floorIndex: number
Returns Promise<void>
Async
- Defined in MapControl.ts:478

selectLocation

selectLocation(
location: MPLocation,
behavior: MPSelectionBehavior,
): Promise<void>
Selects a location based on a MPLocation object.
Parameters
- location: MPLocation
- behavior: MPSelectionBehavior
  Optionally apply a MPSelectionBehavior.
Returns Promise<void>
Async
- Defined in MapControl.ts:207
selectLocation(id: string, behavior: MPSelectionBehavior): Promise<void>
Selects a location based on a id string object.
Parameters
- id: string
- behavior: MPSelectionBehavior
  Optionally apply a MPSelectionBehavior.
Returns Promise<void>
Async
- Defined in MapControl.ts:217

selectVenue

selectVenue(venue: MPVenue, moveCamera: boolean): Promise<void>
Select a venue, optionally move the camera to the given venue.
Parameters
- venue: MPVenue
- moveCamera: boolean
  Whether to move the camera such that it shows the selected venue
Returns Promise<void>
When the selection (and possible camera animation) has completed

Async
- Defined in MapControl.ts:157

setBuildingSelectionMode

setBuildingSelectionMode(selectionMode: MPSelectionMode): Promise<void>
Set the selection mode for buildings.
Parameters
- selectionMode: MPSelectionMode
Returns Promise<void>
- Defined in MapControl.ts:916

setFilter

setFilter(
locations: MPLocation[],
filterBehavior: MPFilterBehavior,
): Promise<boolean>
Use this method to display temporary locations, not points of interests location. Use [clearFilter()] to exit this state.
Parameters
- locations: MPLocation[]
  A list of locations to display.
- filterBehavior: MPFilterBehavior
  How the map should show the applied filter.
Returns Promise<boolean>
True if any locations are available.

Async
- Defined in MapControl.ts:255
setFilter(filter: MPFilter, filterBehavior: MPFilterBehavior): Promise<boolean>
Use this method to display temporary locations, not points of interests location. Use [clearFilter()] to exit this state.
Parameters
- filter: MPFilter
  The applied filter.
- filterBehavior: MPFilterBehavior
  How the map should show the applied filter.
Returns Promise<boolean>
True if any locations are available.

Async
- Defined in MapControl.ts:265

setFloorSelectionMode

setFloorSelectionMode(selectionMode: MPSelectionMode): Promise<void>
Set the selection mode for floors.
Parameters
- selectionMode: MPSelectionMode
Returns Promise<void>
- Defined in MapControl.ts:935

setFloorSelector

setFloorSelector(floorSelector?: MPFloorSelectorInterface): Promise<void>
Replaces the default FloorSelector with a custom one.
Parameters
- OptionalfloorSelector: MPFloorSelectorInterface
Returns Promise<void>
Async
- Defined in MapControl.ts:517

setHiddenFeatures

setHiddenFeatures(features: MPFeatureType[]): Promise<void>
Set features to hide on the map.
Parameters
- features: MPFeatureType[]
Returns Promise<void>
- Defined in MapControl.ts:951

setHighlight

setHighlight(
locations: MPLocation[],
highlightBehavior: MPHighlightBehavior,
): Promise<void>
Use this method to highlight a list of locations. Use [clearHighlight()] to exit this state.
Parameters
- locations: MPLocation[]
  the locations to highlight
- highlightBehavior: MPHighlightBehavior
  How the map should show the applied highlight
Returns Promise<void>
- Defined in MapControl.ts:296

setLabelOptions

setLabelOptions(
    textSize?: number,
    color?: String,
    showHalo?: boolean,
): Promise<void>
Set options for location labels
Parameters
- OptionaltextSize: number
  if undefined keeps the current textsize
- Optionalcolor: String
  if undefined keeps the current color
- OptionalshowHalo: boolean
  default false
Returns Promise<void>
- Defined in MapControl.ts:900

setMapPadding

setMapPadding(
    start: number,
    top: number,
    end: number,
    bottom: number,
): Promise<void>
Sets padding on the map.
Parameters
- start: number
- top: number
- end: number
- bottom: number
Returns Promise<void>
Async
- Defined in MapControl.ts:337

setMapStyle

setMapStyle(style: MPMapStyle): Promise<void>
Sets the map style for MapsIndoors tiles.
Parameters
- style: MPMapStyle
  Is a MPMapStyle object, a list of available MPMapStyles can be fetched via MapsIndoors.getMapStyles.
Returns Promise<void>
Async
- Defined in MapControl.ts:393

setOnCurrentBuildingChangedListener

setOnCurrentBuildingChangedListener(
listener?: OnBuildingFoundAtCameraTargetListener,
): void
Set a current building changed event listener, which is invoked when the currently selected building changes.
Parameters
- Optionallistener: OnBuildingFoundAtCameraTargetListener
Returns void
- Defined in MapControl.ts:779

setOnCurrentVenueChangedListener

setOnCurrentVenueChangedListener(
listener?: OnVenueFoundAtCameraTargetListener,
): void
Set a current venue changed event listener, which is invoked when the currently selected venue changes.
Parameters
- Optionallistener: OnVenueFoundAtCameraTargetListener
Returns void
- Defined in MapControl.ts:758

setOnLocationSelectedListener

setOnLocationSelectedListener(
listener?: OnLocationSelectedListener,
consumeEvent?: boolean,
): void
Set a location selection listener, invoked when a location is selected, either by tapping on it, or programmatically with selectLocation.
Parameters
- Optionallistener: OnLocationSelectedListener
- OptionalconsumeEvent: boolean
  Whether the SDK should also react to this event.
Returns void
- Defined in MapControl.ts:741

setOnMapClickListener

setOnMapClickListener(
listener?: OnMapClickListener,
consumeEvent?: boolean,
): void
Set a listener for when the map has been tapped.
Parameters
- Optionallistener: OnMapClickListener
  Call with undefined to remove the listener.
- OptionalconsumeEvent: boolean
  Whether the SDK should also react to this event.
Returns void
- Defined in MapControl.ts:717

setOnMarkerClickListener

setOnMarkerClickListener(
listener?: OnMarkerClickListener,
consumeEvent?: boolean,
): void
Set a marker click event listener, invoked when a marker is clicked.
Parameters
- Optionallistener: OnMarkerClickListener
- OptionalconsumeEvent: boolean
  Whether the SDK should also react to this event.
Returns void
- Defined in MapControl.ts:802

setOnMarkerInfoWindowClickListener

setOnMarkerInfoWindowClickListener(
listener?: OnMarkerInfoWindowClickListener,
): void
Set a info window click listener, invoked when an info window is clicked.
Parameters
- Optionallistener: OnMarkerInfoWindowClickListener
Returns void
- Defined in MapControl.ts:819

showInfoWindowOnClickedLocation

showInfoWindowOnClickedLocation(show: boolean): Promise<void>
Enables/disables the info window on user-selected locations.

The info window is shown by default when the user selects a location (by tapping on it)
Parameters
- show: boolean
Returns Promise<void>
Async
- Defined in MapControl.ts:419

showUserPosition

showUserPosition(show: boolean): Promise<void>
Renders the positioning blue dot at the last known user position on the map.
Parameters
- show: boolean
Returns Promise<void>
Async
- Defined in MapControl.ts:597

`Static`create

create(config: MPMapConfig, nativeEventEmitter: any): Promise<MapControl>
Create a new MapControl instance.

Note that new MapControl instances will only be created when/if the MapsIndoors SDK has initialized successfully.

This method will wait until this condition has been met.
Parameters
- config: MPMapConfig
  A configuration object that handles setting multiple options for MapControl.
- nativeEventEmitter: any
  An event emitter needed to communicate with the native SDKs.
Returns Promise<MapControl>
A ready to use MapControl instace.

Static
Async
- Defined in MapControl.ts:127

Class MapControl

Export

Index

Methods

Methods

addOnCameraEventListener

Parameters

Returns void

addOnFloorUpdateListener

Parameters

Returns void

animateCamera

Parameters

Returns Promise<void>

Async

clearFilter

Returns Promise<void>

Async

clearHighlight

Returns Promise<void>

deSelectLocation

Returns Promise<void>

Async

disableLiveData

Parameters

Returns Promise<void>

Async

enableLiveData

Parameters

Returns Promise<void>

Async

getBuildingSelectionMode

Returns Promise<MPSelectionMode>

getCurrentBuilding

Returns Promise<MPBuilding>

Async

getCurrentBuildingFloor

Returns Promise<MPFloor>

Async

getCurrentCameraPosition

Returns Promise<MPCameraPosition>

Async

getCurrentFloorIndex

Returns Promise<number>

Async

getCurrentMapsIndoorsZoom

Returns Promise<number>

Async

getCurrentVenue

Returns Promise<MPVenue>

Async

getFloorSelectionMode

Returns Promise<MPSelectionMode>

getHiddenFeatures

Returns Promise<MPFeatureType[]>

getMapStyle

Returns Promise<MPMapStyle>

Async

getMapViewPaddingBottom

Returns Promise<number>

Async

getMapViewPaddingEnd

Returns Promise<number>

Async

getMapViewPaddingStart

Returns Promise<number>

Async

getMapViewPaddingTop

Returns Promise<number>

Async

goTo

Parameters

Returns Promise<void>

Async

hideFloorSelector

Parameters

Returns Promise<void>

Async

isFloorSelectorHidden

Returns Promise<boolean>