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

Implements

IGeoJSONData

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(): Facade | undefined
Gets the facade (Facade) representing this floor stack, if it exists.

Returns Facade | undefined

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(): Feature<Polygon | MultiPolygon, null>
Gets the underlying GeoJSON Feature representation of this FloorStack.

Returns a union of all floor geometries in this stack.

Returns Feature<Polygon | MultiPolygon, null>
Implementation of IGeoJSONData.geoJSON
Overrides BaseMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): BBox | undefined
Gets the bounding box of the geoJSON geometry.

Returns BBox | undefined
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(): "Building" | "Outdoor" | undefined
Gets the type of FloorStack.

Returns "Building" | "Outdoor" | undefined

Methods

toJSON

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

Returns {
    __type: string;
    floors: string[];
    id: string;
    name: string;
    shortName: string;
    type: "Building" | "Outdoor" | undefined;
}
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.