Class MapControl

Internal - Documentation will follow.

Export

Hierarchy

MapControl

Index

Constructors

Properties

eventEmitter? floorSelector? onCameraEventSubs onCurrentBuildingChangedSub? onCurrentVenueChangedSub? onFloorUpdateSubs onLiveUpdateSubs onLocationSelectedSub? onMapClickSub? onMarkerClickSub? onMarkerInfoWindowClickSub?

Methods

addLiveDataListener addOnCameraEventListener addOnFloorUpdateListener animateCamera clearFilter deSelectLocation disableLiveData enableLiveData getCurrentBuilding getCurrentBuildingFloor getCurrentCameraPosition getCurrentFloorIndex getCurrentMapsIndoorsZoom getCurrentVenue getMapStyle getMapViewPaddingBottom getMapViewPaddingEnd getMapViewPaddingStart getMapViewPaddingTop goTo hideFloorSelector isFloorSelectorHidden isUserPositionShown moveCamera onFloorSelectionChanged removeLiveDataListener removeOnCameraEventListener removeOnFloorUpdateListener selectBuilding selectFloor selectLocation selectVenue setFilter setFloorSelector setMapPadding setMapStyle setOnCurrentBuildingChangedListener setOnCurrentVenueChangedListener setOnLocationSelectedListener setOnMapClickListener setOnMarkerClickListener setOnMarkerInfoWindowClickListener setupFloorSelector showInfoWindowOnClickedLocation showUserPosition teardownFloorSelector create

Constructors

`Private` constructor

new MapControl(): MapControl
Private
Creates an instance of MapControl

Returns MapControl
- Defined in src/core/MapControl.ts:30

Properties

`Private` `Optional` eventEmitter

eventEmitter?: NativeEventEmitter

Internal - Documentation will follow.

`Private` `Optional` floorSelector

floorSelector?: EmitterSubscription

Internal - Documentation will follow.

`Private` onCameraEventSubs

onCameraEventSubs: Map<MPCameraEventListener, EmitterSubscription> = ...

Internal - Documentation will follow.

`Private` `Optional` onCurrentBuildingChangedSub

onCurrentBuildingChangedSub?: EmitterSubscription

Internal - Documentation will follow.

`Private` `Optional` onCurrentVenueChangedSub

onCurrentVenueChangedSub?: EmitterSubscription

Internal - Documentation will follow.

`Private` onFloorUpdateSubs

onFloorUpdateSubs: Map<OnFloorUpdateListener, EmitterSubscription> = ...

Internal - Documentation will follow.

`Private` onLiveUpdateSubs

onLiveUpdateSubs: Map<string, EmitterSubscription> = ...

Internal - Documentation will follow.

`Private` `Optional` onLocationSelectedSub

onLocationSelectedSub?: EmitterSubscription

Internal - Documentation will follow.

`Private` `Optional` onMapClickSub

onMapClickSub?: EmitterSubscription

Internal - Documentation will follow.

`Private` `Optional` onMarkerClickSub

onMarkerClickSub?: EmitterSubscription

Internal - Documentation will follow.

`Private` `Optional` onMarkerInfoWindowClickSub

onMarkerInfoWindowClickSub?: EmitterSubscription

Internal - Documentation will follow.

Methods

`Private` addLiveDataListener

addLiveDataListener(domainType, listener): void
Private
Set up livedata listener to receive events from the native SDK.
Parameters
- domainType: string
- listener: OnLiveLocationUpdateListener
Returns void
- Defined in src/core/MapControl.ts:610

addOnCameraEventListener

addOnCameraEventListener(listener): 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 src/core/MapControl.ts:806

addOnFloorUpdateListener

addOnFloorUpdateListener(listener): 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 src/core/MapControl.ts:837

animateCamera

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

Async
- Defined in src/core/MapControl.ts:652

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 src/core/MapControl.ts:239

deSelectLocation

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

Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:403

disableLiveData

disableLiveData(domainType): Promise<void>
Disables live data for a specific domainType.
Parameters
- domainType: string
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:627

enableLiveData

enableLiveData(domainType, listener?): 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
- Optional listener: OnLiveLocationUpdateListener
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:596

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 src/core/MapControl.ts:177

getCurrentBuildingFloor

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

Returns Promise<MPFloor>

Async
- Defined in src/core/MapControl.ts:414

getCurrentCameraPosition

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

Returns Promise<MPCameraPosition>

Async
- Defined in src/core/MapControl.ts:675

getCurrentFloorIndex

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

Returns Promise<number>

Async
- Defined in src/core/MapControl.ts:426

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 src/core/MapControl.ts:437

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 src/core/MapControl.ts:165

getMapStyle

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

Returns Promise<MPMapStyle>

Async
- Defined in src/core/MapControl.ts:377

getMapViewPaddingBottom

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

Returns Promise<number>

Async
- Defined in src/core/MapControl.ts:354

getMapViewPaddingEnd

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

Returns Promise<number>

Async
- Defined in src/core/MapControl.ts:343

getMapViewPaddingStart

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

Returns Promise<number>

Async
- Defined in src/core/MapControl.ts:321

getMapViewPaddingTop

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

Returns Promise<number>

Async
- Defined in src/core/MapControl.ts:332

goTo

goTo(entity): 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.
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:295

hideFloorSelector

hideFloorSelector(hide): 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 src/core/MapControl.ts:478

isFloorSelectorHidden

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

Returns Promise<boolean>

Async
- Defined in src/core/MapControl.ts:462

isUserPositionShown

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

Returns Promise<boolean>

Async
- Defined in src/core/MapControl.ts:581

moveCamera

moveCamera(update): 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 src/core/MapControl.ts:664

`Private` onFloorSelectionChanged

onFloorSelectionChanged(newFloor): void
Private
Internal - Documentation will follow.
Parameters
- newFloor: MPFloor
Returns void
- Defined in src/core/MapControl.ts:141

`Private` removeLiveDataListener

removeLiveDataListener(domainType): void
Private
Destroy up livedata listener to receive events from the native SDK.
Parameters
- domainType: string
Returns void
- Defined in src/core/MapControl.ts:638

removeOnCameraEventListener

removeOnCameraEventListener(listener): void
Remove a camera event listener.
Parameters
- listener: MPCameraEventListener
Returns void
- Defined in src/core/MapControl.ts:823

removeOnFloorUpdateListener

removeOnFloorUpdateListener(listener): void
Remove a floor update listener.
Parameters
- listener: OnFloorUpdateListener
Returns void
- Defined in src/core/MapControl.ts:854

selectBuilding

selectBuilding(building, moveCamera): 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 src/core/MapControl.ts:191

selectFloor

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

For floor names/z-index pairs check the value returned by floors
Parameters
- floorIndex: number
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:451

selectLocation

selectLocation(location, behavior): 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 src/core/MapControl.ts:204
selectLocation(id, behavior): 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 src/core/MapControl.ts:214

selectVenue

selectVenue(venue, moveCamera): 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 src/core/MapControl.ts:154

setFilter

setFilter(locations, filterBehavior): 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 src/core/MapControl.ts:252
setFilter(filter, filterBehavior): 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 src/core/MapControl.ts:262

setFloorSelector

setFloorSelector(floorSelector?): Promise<void>
Replaces the default FloorSelector with a custom one.
Parameters
- Optional floorSelector: MPFloorSelectorInterface
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:490

setMapPadding

setMapPadding(start, top, end, bottom): Promise<void>
Sets padding on the map.
Parameters
- start: number
- top: number
- end: number
- bottom: number
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:310

setMapStyle

setMapStyle(style): 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 src/core/MapControl.ts:366

setOnCurrentBuildingChangedListener

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

setOnCurrentVenueChangedListener

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

setOnLocationSelectedListener

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

setOnMapClickListener

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

setOnMarkerClickListener

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

setOnMarkerInfoWindowClickListener

setOnMarkerInfoWindowClickListener(listener?): void
Set a info window click listener, invoked when an info window is clicked.
Parameters
- Optional listener: OnMarkerInfoWindowClickListener
Returns void
- Defined in src/core/MapControl.ts:789

`Private` setupFloorSelector

setupFloorSelector(floorSelector): Promise<void>
Private
Sets up the floor selector to be able to receive events from the native SDK.
Parameters
- floorSelector: MPFloorSelectorInterface
Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:507

showInfoWindowOnClickedLocation

showInfoWindowOnClickedLocation(show): 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 src/core/MapControl.ts:392

showUserPosition

showUserPosition(show): 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 src/core/MapControl.ts:570

`Private` teardownFloorSelector

teardownFloorSelector(): Promise<void>
Private
Removes a custom floor selector.

Returns Promise<void>

Async
- Defined in src/core/MapControl.ts:553

`Static` create

create(config, nativeEventEmitter): 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: typeof NativeEventEmitter
  
  An event emitter needed to communicate with the native SDKs.
Returns Promise<MapControl>
A ready to use MapControl instace.

Static

Async
- Defined in src/core/MapControl.ts:124

Class MapControl

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Returns MapControl

Properties

Private Optional eventEmitter

Private Optional floorSelector

Private onCameraEventSubs

Private Optional onCurrentBuildingChangedSub

Private Optional onCurrentVenueChangedSub

Private onFloorUpdateSubs

Private onLiveUpdateSubs

Private Optional onLocationSelectedSub

Private Optional onMapClickSub

Private Optional onMarkerClickSub

Private Optional onMarkerInfoWindowClickSub

Methods

Private addLiveDataListener

Parameters

domainType: string

listener: OnLiveLocationUpdateListener

Returns void

addOnCameraEventListener

Parameters

listener: MPCameraEventListener

Returns void

addOnFloorUpdateListener

Parameters

listener: OnFloorUpdateListener

Returns void

animateCamera

Parameters

update: MPCameraUpdate

Optional duration: number

Returns Promise<void>

Async

clearFilter

Returns Promise<void>

Async

deSelectLocation

Returns Promise<void>

Async

disableLiveData

Parameters

domainType: string

Returns Promise<void>

Async

enableLiveData

Parameters

domainType: string

Optional listener: OnLiveLocationUpdateListener

Returns Promise<void>

Async

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

getMapStyle

Returns Promise<MPMapStyle>

Async

`Private` constructor

`Private` `Optional` eventEmitter

`Private` `Optional` floorSelector

`Private` onCameraEventSubs

`Private` `Optional` onCurrentBuildingChangedSub

`Private` `Optional` onCurrentVenueChangedSub

`Private` onFloorUpdateSubs

`Private` onLiveUpdateSubs

`Private` `Optional` onLocationSelectedSub

`Private` `Optional` onMapClickSub

`Private` `Optional` onMarkerClickSub

`Private` `Optional` onMarkerInfoWindowClickSub

`Private` addLiveDataListener

`Optional` duration: number

`Optional` listener: OnLiveLocationUpdateListener

`Private` onFloorSelectionChanged

`Private` removeLiveDataListener