Class MapObject

A class representing generic map object data within the map.

It could represent various objects on the map, such as desks, walls, etc.

Hierarchy

default
- MapObject

Index

Properties

Accessors

center description 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 MapObject.

Returns Coordinate
The object's center coordinate.

description

get description(): string
Gets the description of the MapObject.

Returns string
The description of the object.

externalId

get externalId(): string
Gets the external ID of the MapObject.

Returns string
The external ID of the object.

floor

get floor(): Floor
Gets the Floor associated with the MapObject.

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

Returns string
The name of the object.

type

get type(): string
Gets the type of the MapObject.

Returns string
The kind of the object.

Methods

toJSON

toJSON(): {
    center: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    };
    floor: string;
    id: string;
    name: string;
    type: string;
}
Serializes the MapObject data to JSON.

Returns {
    center: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    };
    floor: string;
    id: string;
    name: string;
    type: string;
}
An object representing the MapObject.
- center: {
      floor: undefined | string;
      latitude: number;
      longitude: number;
  }
  - floor: undefined | string
  - latitude: number
  - longitude: number
- floor: string
- id: string
- name: string
- type: string

`Static`is

is(instance): instance is MapObject
Checks if the provided instance is of type MapObject.
Parameters
- instance: object
  The instance to check.
Returns instance is MapObject
True if the instance is a MapObject, false otherwise.