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

Index

Properties

Accessors

center description doors externalId floor images name type

Methods

Properties

`Readonly`id

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

get center(): Coordinate
Gets the center Coordinate of the space.

Returns Coordinate
The space's center coordinate.

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.

images

get images(): Image[]
Gets the array of images associated with the space.

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

name

get name(): string
Gets the name of the space.

Returns string
The name of the space.

type

get type(): TSpaceType
Gets the type/kind of the space.

Returns TSpaceType
The type of the space.

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

`Static`is

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.