Class Door

A class representing door data within the map.

This class provides details and operations related to a door.

Hierarchy

default
- Door

Index

Properties

Accessors

center description externalId floor images isExterior name

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
Calculates and gets the center Coordinate of the door.

Returns Coordinate
The center coordinate.

description

get description(): string
Returns string

externalId

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

Returns string
The external ID of the door.

floor

get floor(): Floor
Gets the Floor object associated with the door.

Returns Floor
The floor object.

Throws
Will throw an error if the floor is not found.

images

get images(): Image[]
Returns Image[]

isExterior

get isExterior(): boolean
Gets whether this door is an exterior door.

Returns boolean

name

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

Returns string
The name of the door.

Methods

toJSON

toJSON(): {
    center: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    };
    floor: string;
    id: string;
    name: string;
}
Converts the door information to a JSON object.

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

`Static`is

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