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

externalId floors name type

Methods

Properties

`Readonly`id

id: string

identity of the map object

links

links: Hyperlink[] = []

Gets the links associated with this data type.

Returns

The links associated with this data type

Accessors

externalId

get externalId(): string
Gets the externalId of FloorStack

Returns string

floors

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

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

name

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

Returns string
The name of the FloorStack.

type

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

Returns undefined | "Building" | "Outdoor"

Methods

toJSON

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

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

`Static`is

is(instance): 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.