Class MapControl

Internal - Documentation will follow.

Export

Constructors

constructor

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 setLabelOptions 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

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

    Returns void

addOnCameraEventListener

  • addOnCameraEventListener(listener): void

  • Add a camera event listener, invoked when a camera event occurs (e.g. moved, idle) (see MPCameraEvent).

    Parameters

    Returns void

addOnFloorUpdateListener

  • addOnFloorUpdateListener(listener): void

  • Add a listener object to catch floor changes made by either the user or the positioning service.

    Parameters

    Returns void

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

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

deSelectLocation

  • deSelectLocation(): Promise<void>

  • Call this to deselect a location previously selected with (MPLocation, MPSelectionBehavior).

    Returns Promise<void>

    Async

disableLiveData

  • disableLiveData(domainType): Promise<void>

  • Disables live data for a specific domainType.

    Parameters

    • domainType: string

    Returns Promise<void>

    Async

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

    Returns Promise<void>

    Async

getCurrentBuilding

  • getCurrentBuilding(): Promise<MPBuilding>

  • Get the currently selected building, if there is any.

    Returns Promise<MPBuilding>

    The current building, if any is selected.

    Async

getCurrentBuildingFloor

  • getCurrentBuildingFloor(): Promise<MPFloor>

  • Returns the current MPFloor of the current MPBuilding in focus.

    Returns Promise<MPFloor>

    Async

getCurrentCameraPosition

getCurrentFloorIndex

getCurrentMapsIndoorsZoom

  • getCurrentMapsIndoorsZoom(): Promise<number>

  • Get the zoom level that MapsIndoors is currently using for displaying icons on the map.

    Returns Promise<number>

    Async

getCurrentVenue

  • getCurrentVenue(): Promise<MPVenue>

  • Get the currently selected venue, if there is any.

    Returns Promise<MPVenue>

    The current venue, if any is selected.

    Async

getMapStyle

  • getMapStyle(): Promise<MPMapStyle>

  • Gets the current map style of MapsIndoors tiles.

    Returns Promise<MPMapStyle>

    Async

getMapViewPaddingBottom

  • getMapViewPaddingBottom(): Promise<number>

  • Gets the Map View bottom padding.

    Returns Promise<number>

    Async

getMapViewPaddingEnd

  • getMapViewPaddingEnd(): Promise<number>

  • Gets the Map View bottom padding.

    Returns Promise<number>

    Async

getMapViewPaddingStart

  • getMapViewPaddingStart(): Promise<number>

  • Gets the Map View bottom padding.

    Returns Promise<number>

    Async

getMapViewPaddingTop

  • getMapViewPaddingTop(): Promise<number>

  • Gets the Map View bottom padding.

    Returns Promise<number>

    Async

goTo

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

isFloorSelectorHidden

  • isFloorSelectorHidden(): Promise<boolean>

  • Returns the visibility state of the currently used MPFloorSelectorInterface.

    Returns Promise<boolean>

    Async

isUserPositionShown

  • isUserPositionShown(): Promise<boolean>

  • Returns the current visibility state of the user location icon (blue dot).

    Returns Promise<boolean>

    Async

moveCamera

  • moveCamera(update): Promise<void>

  • Uses a camera update to move the camera instantly.

    Parameters

    Returns Promise<void>

    Async

Private onFloorSelectionChanged

  • onFloorSelectionChanged(newFloor): void
  • Private

    Internal - Documentation will follow.

    Parameters

    Returns void

Private removeLiveDataListener

  • removeLiveDataListener(domainType): void
  • Private

    Destroy up livedata listener to receive events from the native SDK.

    Parameters

    • domainType: string

    Returns void

removeOnCameraEventListener

  • removeOnCameraEventListener(listener): void

  • Remove a camera event listener.

    Parameters

    Returns void

removeOnFloorUpdateListener

  • removeOnFloorUpdateListener(listener): void

  • Remove a floor update listener.

    Parameters

    Returns void

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

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 MPBuilding.floors

    Parameters

    • floorIndex: number

    Returns Promise<void>

    Async

selectLocation

  • selectLocation(location, behavior): Promise<void>

  • Selects a location based on a MPLocation object.

    Parameters

    Returns Promise<void>

    Async

  • selectLocation(id, behavior): Promise<void>

  • Selects a location based on a id string object.

    Parameters

    Returns Promise<void>

    Async

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

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

  • setFilter(filter, filterBehavior): Promise<boolean>

  • Use this method to display temporary locations, not points of interests location. Use [clearFilter()] to exit this state.

    Parameters

    Returns Promise<boolean>

    True if any locations are available.

    Async

setFloorSelector

  • setFloorSelector(floorSelector?): Promise<void>

  • Replaces the default FloorSelector with a custom one.

    Parameters

    Returns Promise<void>

    Async

setLabelOptions

  • setLabelOptions(textSize?, color?, showHalo?): Promise<void>

  • Set options for location labels

    Parameters

    • Optional textSize: number

      if undefined keeps the current textsize

    • Optional color: String

      if undefined keeps the current color

    • Optional showHalo: boolean

      default false

    Returns Promise<void>

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

setMapStyle

  • setMapStyle(style): Promise<void>

  • Sets the map style for MapsIndoors tiles.

    Parameters

    Returns Promise<void>

    Async

setOnCurrentBuildingChangedListener

  • setOnCurrentBuildingChangedListener(listener?): void

  • Set a current building changed event listener, which is invoked when the currently selected building changes.

    Parameters

    Returns void

setOnCurrentVenueChangedListener

  • setOnCurrentVenueChangedListener(listener?): void

  • Set a current venue changed event listener, which is invoked when the currently selected venue changes.

    Parameters

    Returns void

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

    Returns void

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

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

setOnMarkerInfoWindowClickListener

  • setOnMarkerInfoWindowClickListener(listener?): void

  • Set a info window click listener, invoked when an info window is clicked.

    Parameters

    Returns void

Private setupFloorSelector

  • setupFloorSelector(floorSelector): Promise<void>
  • Private

    Sets up the floor selector to be able to receive events from the native SDK.

    Parameters

    Returns Promise<void>

    Async

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

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

Private teardownFloorSelector

  • teardownFloorSelector(): Promise<void>
  • Private

    Removes a custom floor selector.

    Returns Promise<void>

    Async

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc