Class Space

A Space represents an area enclosed by walls, such as a hall or room. Spaces can be Interactive and have Labels and Markers added to them. Spaces can also be customized with a color, texture and hover color.

Refer to the Spaces Guide for more information and interactive examples.

Hierarchy

  • default
    • Space

Properties

id images links

Accessors

center description doors externalId floor name type

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map data.

images

images: ImageData[]

Gets the array of images associated with this data type.

Returns

An array of Image objects, or an empty array if no images exist.

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

  • Gets the description of the space.

    Returns string

    The description of the space, or an empty string if no description exists.

doors

  • get doors(): Door[]

  • Gets the array of Doors associated with the space.

    Returns Door[]

    The doors array.

externalId

  • get externalId(): string

  • Gets the external identifier of the space.

    Returns string

    The external ID of the space, or an empty string if no external ID exists.

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.

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.

Staticis

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

Properties
Accessors
Methods