Interface MPFloorSelectorInterface

Interface used by MapsIndoors to communicate with floor selector UIs.

Export

MPFloorSelectorInterface

interface MPFloorSelectorInterface {
    isAutoFloorChangeEnabled(): boolean;
    setFloors(floors): void;
    setOnFloorSelectionChangedListener(listener): void;
    setSelectedFloor(floor): void;
    setSelectedFloorByFloorIndex(floorIndex): void;
    setUserPositionFloor(floorIndex): void;
    show(show, animated): void;
    zoomLevelChanged(newZoomLevel): void;
}

Index

Methods

isAutoFloorChangeEnabled setFloors setOnFloorSelectionChangedListener setSelectedFloor setSelectedFloorByFloorIndex setUserPositionFloor show zoomLevelChanged

Methods

isAutoFloorChangeEnabled

isAutoFloorChangeEnabled(): boolean
Whether to allow the floor to automatically change, eg. when panning to a new building that does not have the current floor.

Returns boolean
- Defined in src/core/MPFloorSelectorInterface.ts:56

setFloors

setFloors(floors): void
Update the floors shown in the selector.
Parameters
- floors: MPFloor[]
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:16

setOnFloorSelectionChangedListener

setOnFloorSelectionChangedListener(listener): void
NB: This is used internally in the SDK, overwriting the listener will result in functionality loss.

Set a listener that listens for when a floor is selected in the floor selector.
Parameters
- listener: OnFloorSelectionChangedListener
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:24

setSelectedFloor

setSelectedFloor(floor): void
Invoked when a floor has been selected programmatically.
Parameters
- floor: MPFloor
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:37

setSelectedFloorByFloorIndex

setSelectedFloorByFloorIndex(floorIndex): void
Invoked when a floor has been selected programmatically by index.
Parameters
- floorIndex: number
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:43

setUserPositionFloor

setUserPositionFloor(floorIndex): void
Invoked when user positioning changes floorIndex.
Parameters
- floorIndex: number
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:62

show

show(show, animated): void
Show/Hide the floor selector, this is called when a building comes into/out of view.
Parameters
- show: boolean
- animated: boolean
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:31

zoomLevelChanged

zoomLevelChanged(newZoomLevel): void
Invoked when the zoom level changes.
Parameters
- newZoomLevel: number
Returns void
- Defined in src/core/MPFloorSelectorInterface.ts:49

Generated using TypeDoc