Class Connection

A class representing connection data within the map.

Connections are used to represent pathways between different map nodes.

Hierarchy

default
- Connection

Implements

IFocusable

Index

Properties

id images links

Accessors

accessible coordinates description externalId floors geoJSON geoJSONBoundingBox locationProfiles name nodes type

Methods

Properties

`Readonly`id

id: string

The identity of the map data.

images

images: ImageData[]

Gets the array of images associated with this data type.

Returns

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

links

links: Hyperlink[]

Gets the links associated with this data type.

Returns

The links associated with this data type

Accessors

accessible

get accessible(): boolean
Whether the connection is accessible. For example elevators are accessible while stairs are not.

Returns boolean
Whether the connection is accessible.

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.

geoJSON

get geoJSON(): { geometry: {}; properties: null; type: string }
Returns { geometry: {}; properties: null; type: string }
Inherited from BaseMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): {}
Gets the bounding box of the geoJSON geometry.

Returns {}
The bounding box of the geoJSON geometry

Inherited from BaseMapData.geoJSONBoundingBox

locationProfiles

get locationProfiles(): LocationProfile[]
Gets the LocationProfile objects attached to this connection.

Returns LocationProfile[]
An array of location profile objects.

name

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

Returns string
The name of the connection.

nodes

get nodes(): Node[]
Gets the nodes (Node) associated with the connection.

Returns Node[]

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;
        verticalOffset: 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;
        verticalOffset: number;
    }[];
    externalId: string;
    floors: string[];
    id: string;
    name: string;
    type: string;
}
An object representing the connection.

`Static`is

is(instance: object): 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.