Interface FloorChangerServiceInterface

The floor changer service reports available and current floors and provides methods to change the current floor.

Hierarchy

  • FloorChangerServiceInterface

Properties

currentFloors onFloorChange onFloorUpdate

Methods

changeFloorByEntity changeFloorByName

Properties

Readonly currentFloors

currentFloors: SiteModelEntityInterface[]

Currently active floor entitites

Readonly onFloorChange

onFloorChange: Signal<FloorChangeHandler>

Signal that is emitted when the current floor is changed

Readonly onFloorUpdate

onFloorUpdate: Signal<FloorUpdateHandler>

Signal that is emitted when the list of available floors is changed

Methods

changeFloorByEntity

  • Change the floor to the specified site model entity or one of its parent entities

    All floors with the same name are added to the list of current floors. The call may result in an onFloorChange event.

    Returns

    Promise which resolves if a floorChanged event was triggered, otherwise rejects.

    Parameters

    • entity: SiteModelEntityInterface

      A site model entity that is a floor or has a floor in its ancestor chain

    • Optional mayChangeLocation: boolean

      Indicates if floor change should cause a location change (defaults to true for the panorama view being the main one, false for the main map view)

    Returns Promise<void>

changeFloorByName

  • Change the current floor by a provided floor name

    All floors with the same name are added to the list of current floors. The call may result in an onFloorChange event.

    Returns

    Promise which resolves if a floorChanged event was triggered, otherwise rejects.

    Parameters

    • floorName: string

      Name of floor to change to

    • Optional mayChangeLocation: boolean

      Indicates if floor change should cause a location change (defaults to true for the panorama view being the main one, false for the main map view)

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc