Class Space

A class representing space data within the map.

Spaces are used to represent different areas within a map, such as rooms, hallways, etc.

Hierarchy

  • default
    • Space

Properties

id links

Accessors

center description floor images name type

Methods

toJSON is

Properties

Readonlyid

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

center

description

  • get description(): string

  • Returns string

floor

  • get floor(): Floor

  • Gets the Floor object associated with the space.

    Returns Floor

    The floor object.

    Throws

    Will throw an error if the floor is not found.

images

  • get images(): Image[]

  • Returns Image[]

name

  • get name(): string

  • Gets the name of the space.

    Returns string

    The name of the space.

type

Methods

toJSON

  • toJSON(): {
        center: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
        };
        floor: string;
        id: string;
        name: string;
        type: TSpaceType;
    }

  • Serializes the space data to JSON.

    Returns {
        center: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
        };
        floor: string;
        id: string;
        name: string;
        type: TSpaceType;
    }

    An object representing the space.

    • center: {
          floor: undefined | string;
          latitude: number;
          longitude: number;
      }
      • floor: undefined | string
      • latitude: number
      • longitude: number
    • floor: string
    • id: string
    • name: string
    • type: TSpaceType

Staticis

  • is(instance): instance is Space

  • Checks if the provided instance is of type Space.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is Space

    True if the instance is a Space, false otherwise.

Settings

Member Visibility

On This Page

idlinkscenterdescriptionfloorimagesnametypetoJSONis