Class FloorStack

A class representing floor stack data within the map.

FloorStacks are used to represent a group of floors that are part of a single entity.

Hierarchy

default
- FloorStack

Index

Properties

Accessors

defaultFloor externalId facade floors geoJSON geoJSONBoundingBox name shortName type

Methods

Properties

`Readonly`id

id: string

The identity of the map data.

Accessors

defaultFloor

get defaultFloor(): Floor
Get the default floor for this floor stack

Returns Floor

externalId

get externalId(): string
Gets the externalId of FloorStack

Returns string

facade

get facade(): undefined | Facade
Gets the facade (Facade) representing this floor stack, if it exists.

Returns undefined | Facade

floors

get floors(): [Floor, ...Floor[]]
Gets the floors (Floor) included in this FloorStack.

Returns [Floor, ...Floor[]]
An array of Floor objects in this FloorStack.

geoJSON

get geoJSON(): { geometry: {}; properties: null; type: string }
Returns { geometry: {}; properties: null; type: string }
Inherited from BaseMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): {}
Gets the bounding box of the geoJSON geometry.

Returns {}
The bounding box of the geoJSON geometry

Inherited from BaseMapData.geoJSONBoundingBox

name

get name(): string
Gets the name of the FloorStack.

Returns string
The name of the FloorStack.

shortName

get shortName(): string
Gets the short name of the FloorStack.

Returns string
The short name of the FloorStack.

type

get type(): undefined | "Outdoor" | "Building"
Gets the type of FloorStack.

Returns undefined | "Outdoor" | "Building"

Methods

toJSON

toJSON(): {
    floors: string[];
    id: string;
    name: string;
    type: undefined
    | "Outdoor"
    | "Building";
}
Serializes the FloorStack data to JSON.

Returns {
    floors: string[];
    id: string;
    name: string;
    type: undefined | "Outdoor" | "Building";
}
An object representing the FloorStack.

`Static`is

is(instance: object): instance is FloorStack
Checks if the provided instance is of type FloorStack.
Parameters
- instance: object
  The instance to check.
Returns instance is FloorStack
True if the instance is a FloorStack, false otherwise.