Class Floor

A class representing floor data within the map.

Floors are used to represent different levels within a map, each containing various map elements.

Hierarchy

default
- Floor

Implements

Index

Properties

Accessors

annotations center connections doors elevation externalId floorStack geoJSON geoJSONBoundingBox maxHeight name objects pois shortName spaces subtitle

Methods

Properties

`Readonly`id

id: string

The identity of the map data.

Accessors

annotations

get annotations(): Annotation[]
Gets the annotations (Annotation) associated with this floor.

Returns Annotation[]
An array of Annotation objects linked to this floor.

center

get center(): Coordinate
Returns Coordinate

connections

get connections(): Connection[]
Gets the connections (Connection) associated with this floor.

Returns Connection[]
An array of Connection objects linked to this floor.

doors

get doors(): Door[]
Gets the doors (Door) located on this floor.

Returns Door[]
An array of Door objects on this floor.

elevation

get elevation(): number
Gets the elevation of the floor.

Returns number
The elevation of the floor.

externalId

get externalId(): string
Gets the external ID of the floor.

Returns string
The external ID of the floor.

floorStack

get floorStack(): FloorStack
Gets the FloorStack (FloorStack) that this floor belongs to.

Returns FloorStack
The FloorStack that this floor belongs to.

geoJSON

get geoJSON(): Feature<Polygon | MultiPolygon, null>
Gets the underlying GeoJSON Feature representation of this Space.

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

maxHeight

get maxHeight(): number | undefined
Gets the max height of the floor if there is one.

Returns number | undefined
The max height of the floor.

name

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

Returns string
The name of the floor.

objects

get objects(): MapObject[]
Gets the objects (MapObject) located on this floor.

Returns MapObject[]
An array of MapObject objects on this floor.

pois

get pois(): PointOfInterest[]
Gets the points of interest (PointOfInterest) located on this floor.

Returns PointOfInterest[]
An array of PointOfInterest objects on this floor.

shortName

get shortName(): string
Gets the short name of the floor (i.e. "F1", "L, "2", etc.). Used in space constrained lists and Often aligns with what is displayed on an elevator.

Returns string
The short name of the floor.

spaces

get spaces(): Space[]
Gets the spaces (Space) located on this floor.

Returns Space[]
An array of Space objects on this floor.

subtitle

get subtitle(): string
Gets the subtitle of the floor.

Returns string
The subtitle of the floor.

Methods

toJSON

toJSON(): {
    __type: string;
    annotations: string[];
    connections: string[];
    doors: string[];
    elevation: number;
    id: string;
    maxHeight: number
    | undefined;
    name: string;
    objects: string[];
    pois: string[];
    shortName: string;
    spaces: string[];
    subtitle: string;
}
Serializes the floor data to JSON.

Returns {
    __type: string;
    annotations: string[];
    connections: string[];
    doors: string[];
    elevation: number;
    id: string;
    maxHeight: number | undefined;
    name: string;
    objects: string[];
    pois: string[];
    shortName: string;
    spaces: string[];
    subtitle: string;
}
An object representing the floor.

`Static`is

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