Class Connection

A class representing connection data within the map.

Connections are used to represent pathways between different map nodes.

Hierarchy

default
- Connection

Index

Properties

Accessors

accessible coordinates description externalId floors 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

accessible

get accessible(): boolean
Returns boolean

coordinates

get coordinates(): Coordinate[]
Gets the coordinates (Coordinate) of the connection.

Returns Coordinate[]
An array of coordinates for the connection.

description

get description(): string
Returns string

externalId

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

Returns string
The external ID of the connection.

floors

get floors(): Floor[]
Gets the floors (Floor) associated with the connection.

Returns Floor[]
An array of floors for the connection.

images

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

name

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

Returns string
The name of the connection.

type

get type(): string
/**
- Gets the type of the connection.
Returns string
The type of the connection.

Methods

toJSON

toJSON(): {
    coordinates: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    }[];
    externalId: string;
    floors: string[];
    id: string;
    name: string;
    type: string;
}
Serializes the connection data to JSON.

Returns {
    coordinates: {
        floor: undefined | string;
        latitude: number;
        longitude: number;
    }[];
    externalId: string;
    floors: string[];
    id: string;
    name: string;
    type: string;
}
An object representing the connection.
- coordinates: {
      floor: undefined | string;
      latitude: number;
      longitude: number;
  }[]
- externalId: string
- floors: string[]
- id: string
- name: string
- type: string

`Static`is

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