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

Properties

id

Accessors

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

Methods

toJSON is

Properties

Readonlyid

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.

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(): { geometry: {}; properties: null; type: string }

  • Returns { geometry: {}; properties: null; type: string }

geoJSONBoundingBox

  • get geoJSONBoundingBox(): {}

  • Gets the bounding box of the geoJSON geometry.

    Returns {}

    The bounding box of the geoJSON geometry

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

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.

Methods

toJSON

  • toJSON(): {
        annotations: string[];
        connections: string[];
        doors: string[];
        elevation: number;
        id: string;
        name: string;
        objects: string[];
        pois: string[];
        spaces: string[];
    }

  • Serializes the floor data to JSON.

    Returns {
        annotations: string[];
        connections: string[];
        doors: string[];
        elevation: number;
        id: string;
        name: string;
        objects: string[];
        pois: string[];
        spaces: string[];
    }

    An object representing the floor.

Staticis

  • 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.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR