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<SpaceCollection["features"][number]>
    • Space

Implements

Properties

id

Accessors

center description doors externalId floor geoJSON geoJSONBoundingBox images links locationProfiles name type

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map data.

Accessors

center

description

  • get description(): string

    Gets the description of the map feature.

    Returns string

    The description of the map feature, 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 map feature.

    Returns string

    The external ID of the map feature, 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.

geoJSON

  • get geoJSON(): {
        geometry: Polygon
        | LineString
        | Point;
        properties: null;
        type: "Feature";
    }

    Gets the underlying GeoJSON Feature representation of this Space.

    Returns { geometry: Polygon | LineString | Point; properties: null; type: "Feature" }

geoJSONBoundingBox

  • get geoJSONBoundingBox(): undefined | BBox

    Gets the bounding box of the geoJSON geometry.

    Returns undefined | BBox

    The bounding box of the geoJSON geometry

images

  • get images(): ImageMetaData[]

    Gets the array of ImageMetaDatas associated with this map feature.

    Returns ImageMetaData[]

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

links

  • Gets the array of Hyperlinks associated with this map feature.

    Returns Hyperlink[]

    An array of Hyperlink objects, or an empty array if no links exist.

locationProfiles

name

  • get name(): string

    Gets the name of the map feature.

    Returns string

    The name of the map feature.

type

Methods

toJSON

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

    Serializes the space data to JSON.

    Returns {
        __type: string;
        center: {
            __type: string;
            floor: undefined | string;
            latitude: number;
            longitude: number;
            verticalOffset: 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