Class Connection

A class representing connection data within the map.

Connections are used to represent pathways between different map nodes.

Hierarchy (View Summary)

DetailedMapData<Feature<Point, SpaceProperties> | Feature<Point, MVFConnection>>
- Connection

Implements

Index

Properties

Accessors

accessible coordinates description externalId extra floors geoJSON geoJSONBoundingBox icon images links locationProfiles name nodes type

Methods

toJSON is

Properties

`Readonly`id

id: string

The identity of the map data.

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
Gets the description of the map feature.

Returns string
The description of the map feature, or an empty string if no description exists.

Inherited from DetailedMapData.description

externalId

get externalId(): string
Gets the external identifier of the map feature.

Returns string
The external ID of the map feature, or an empty string if no external ID exists.

Inherited from DetailedMapData.externalId

extra

get extra(): Record<string, unknown> | undefined
Extra properties of the connection.

Returns Record<string, unknown> | undefined
Extra properties 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(): Feature<Polygon | MultiPolygon | Point | LineString, null>
Returns Feature<Polygon | MultiPolygon | Point | LineString, null>
Inherited from DetailedMapData.geoJSON

geoJSONBoundingBox

get geoJSONBoundingBox(): BBox | undefined
Gets the bounding box of the geoJSON geometry.

Returns BBox | undefined
The bounding box of the geoJSON geometry

Inherited from DetailedMapData.geoJSONBoundingBox

icon

get icon(): ImageMetaData | undefined
Gets the URL of the icon for the map feature.

Returns ImageMetaData | undefined
The icon of the map feature.

Inherited from DetailedMapData.icon

images

get images(): ImageMetaData[]
Gets the array of ImageMetaDatas associated with this map feature.

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

Inherited from DetailedMapData.images

locationProfiles

get locationProfiles(): LocationProfile[]
Gets the LocationProfiles attached to this feature.

Returns LocationProfile[]
An array of location profiles.

Remarks
Data Source: Maker - This property is only populated when using Maker credentials (API keys starting with mik_). Returns an empty array when using CMS/Enterprise credentials. For Enterprise data, use Space.enterpriseLocations or MapObject.enterpriseLocations instead.

Inherited from DetailedMapData.locationProfiles

name

get name(): string
Gets the name of the map feature.

Returns string
The name of the map feature.

Inherited from DetailedMapData.name

nodes

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

Returns Node[]

type

get type(): | "door"
| "stairs"
| "elevator"
| "escalator"
| "ramp"
| "slide"
| "portal"
| "security"
| "shuttle"
| "ladder"
Gets the type of the connection.

Returns
    | "door"
    | "stairs"
    | "elevator"
    | "escalator"
    | "ramp"
    | "slide"
    | "portal"
    | "security"
    | "shuttle"
    | "ladder"
The type of the connection.

Methods

toJSON

toJSON(): {
    __type: string;
    coordinates: {
        __type: string;
        floorId: string
        | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    }[];
    externalId: string;
    extra: Record<string, unknown>
    | undefined;
    floors: string[];
    id: string;
    name: string;
    type:
        | "door"
        | "stairs"
        | "elevator"
        | "escalator"
        | "ramp"
        | "slide"
        | "portal"
        | "security"
        | "shuttle"
        | "ladder";
}
Serializes the connection data to JSON.

Returns {
    __type: string;
    coordinates: {
        __type: string;
        floorId: string | undefined;
        latitude: number;
        longitude: number;
        verticalOffset: number;
    }[];
    externalId: string;
    extra: Record<string, unknown>
    | undefined;
    floors: string[];
    id: string;
    name: string;
    type:
        | "door"
        | "stairs"
        | "elevator"
        | "escalator"
        | "ramp"
        | "slide"
        | "portal"
        | "security"
        | "shuttle"
        | "ladder";
}
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.

Class Connection

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

Readonlyid

Accessors

accessible

Returns boolean

coordinates

Returns Coordinate[]

description

Returns string

externalId

Returns string

extra

Returns Record<string, unknown> | undefined

floors

Returns Floor[]

geoJSON

Returns Feature<Polygon | MultiPolygon | Point | LineString, null>

geoJSONBoundingBox

Returns BBox | undefined

icon

Returns ImageMetaData | undefined

images

Returns ImageMetaData[]

links

Returns Hyperlink[]

locationProfiles

Returns LocationProfile[]

Remarks

name

Returns string

nodes

Returns Node[]

type

Returns | "door" | "stairs" | "elevator" | "escalator" | "ramp" | "slide" | "portal" | "security" | "shuttle" | "ladder"

Methods

toJSON

Staticis

Parameters

Returns instance is Connection

Settings

On This Page

`Readonly`id

Returns
| "door"
| "stairs"
| "elevator"
| "escalator"
| "ramp"
| "slide"
| "portal"
| "security"
| "shuttle"
| "ladder"

`Static`is