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

Properties

id: string

identity of the map object

links: Hyperlink[] = []

Gets the links associated with this data type.

The links associated with this data type

Accessors

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

    Returns Annotation[]

    An array of Annotation objects linked to this floor.

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

    Returns Connection[]

    An array of Connection objects linked to this floor.

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

    Returns Door[]

    An array of Door objects on this floor.

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

    Returns number

    The elevation of the floor.

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

    Returns FloorStack

    The FloorStack that this floor belongs to.

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

    Returns string

    The name of the floor.

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

    Returns MapObject[]

    An array of MapObject objects on this floor.

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

    Returns Space[]

    An array of Space objects on this floor.

Methods

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

    • annotations: string[]
    • connections: string[]
    • doors: string[]
    • elevation: number
    • id: string
    • name: string
    • objects: string[]
    • pois: string[]
    • spaces: string[]
  • 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.