Class StackedMaps`Experimental`

Hierarchy (view full)

PubSub<TStackedMapsEvents>
- StackedMaps

Index

Properties

`Experimental`expandedFactor

expandedFactor: number = 0

The factor of the expanded floor stack. 0 is collapsed, 1 is fully expanded.

Accessors

expanded

get expanded(): boolean
Experimental
Whether the floor stack is expanded.

Returns boolean

floorVisibilityMode

get floorVisibilityMode(): "all-floors" | "only-current-floor"
Experimental
The visibility mode for the stacked maps. 'all-floors' will show all floors, 'only-current-floor' will only show the current floor in the stack.

Returns "all-floors" | "only-current-floor"
Default
```
'all-floors'
```

gapBelowFloors

get gapBelowFloors(): number
Experimental
The distance between floors in the stack in meters.

Returns number

includedFloors

get includedFloors(): Floor[]
Experimental
The floors included in the stack.

Returns Floor[]

state

get state(): TStackedMapsState
Experimental
Returns TStackedMapsState

Methods

changeFloorOnElevationChanges

changeFloorOnElevationChanges(value): void
Experimental
Set whether to listen to camera elevation changes to automatically change the floor.
Parameters
- value: boolean
Returns void

collapse

collapse(opts?): Promise<void>
Experimental
Collapse the floor stack.
Parameters
- Optionalopts: TCameraAnimationOptions
  Optional settings for the collapse.
Returns Promise<void>

expand

expand(opts?): Promise<void>
Experimental
Expand the floor stack.
Parameters
- Optionalopts: TExpandOptions
  Optional settings for the expansion.
Returns Promise<void>

off

off<EVENT_NAME>(eventName, fn): void
Experimental
Unsubscribe a function previously subscribed with on
Type Parameters
- EVENT_NAME extends "stacked-maps-state-change"
Parameters
- eventName: EVENT_NAME
  An event name to which the provided function was previously subscribed.
- fn: ((payload: TStackedMapsEvents[EVENT_NAME] extends {
          data: null;
      }
      ? any[any]["data"]
      : TStackedMapsEvents[EVENT_NAME]) => void)
  A function that was previously passed to on. The function must have the same reference as the function that was subscribed.
  - - (payload): void
    - Parameters
      payload: TStackedMapsEvents[EVENT_NAME] extends {
              data: null;
          }
          ? any[any]["data"]
          : TStackedMapsEvents[EVENT_NAME]
      Returns void
Returns void
Example
```
// Unsubscribe from the 'click' event
const handler = (event) => {
	console.log('Map was clicked', event);
};
map.off('click', handler);
```
Inherited from PubSub.off

on

on<EVENT_NAME>(eventName, fn): void
Experimental
Subscribe a function to an event.
Type Parameters
- EVENT_NAME extends "stacked-maps-state-change"
Parameters
- eventName: EVENT_NAME
  An event name which, when fired, will call the provided function.
- fn: ((payload: TStackedMapsEvents[EVENT_NAME] extends {
          data: null;
      }
      ? any[any]["data"]
      : TStackedMapsEvents[EVENT_NAME]) => void)
  A callback that gets called when the corresponding event is fired. The callback will get passed an argument with a type that's one of event payloads.
  - - (payload): void
    - Parameters
      payload: TStackedMapsEvents[EVENT_NAME] extends {
              data: null;
          }
          ? any[any]["data"]
          : TStackedMapsEvents[EVENT_NAME]
      Returns void
Returns void
Example
```
// Subscribe to the 'click' event
const handler = (event) => {
 const { coordinate } = event;
 const { latitude, longitude } = coordinate;
	console.log(`Map was clicked at ${latitude}, ${longitude}`);
};
map.on('click', handler);
```
Inherited from PubSub.on

setFloorVisiblityMode

setFloorVisiblityMode(mode): void
Experimental
Set the visibility mode for the stacked maps.
Parameters
- mode: "all-floors" | "only-current-floor"
  The visibility mode to set. Either all-floors or only-current-floor.
Returns void

Class StackedMapsExperimental

Hierarchy (view full)

Index

Properties

Accessors

Methods

Properties

ExperimentalexpandedFactor

Accessors

expanded

Returns boolean

floorVisibilityMode

Returns "all-floors" | "only-current-floor"

Default

gapBelowFloors

Returns number

includedFloors

Returns Floor[]

state

Returns TStackedMapsState

Methods

changeFloorOnElevationChanges

Parameters

Returns void

collapse

Parameters

Returns Promise<void>

expand

Parameters

Returns Promise<void>

off

Type Parameters

Parameters

Parameters

Returns void

Returns void

Example

on

Type Parameters

Parameters

Parameters

Returns void

Returns void

Example

setFloorVisiblityMode

Parameters

Returns void

Settings

On This Page

Class StackedMaps`Experimental`

`Experimental`expandedFactor