Class Connection

A class representing connection data within the map.

Connections are used to represent pathways between different map nodes.

Hierarchy

  • default<Feature<Point, SpaceProperties> | Feature<Point, MVFConnection>>
    • Connection

Implements

Properties

id

Accessors

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

Methods

toJSON is

Properties

Readonlyid

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

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.

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.

extra

  • get extra(): undefined | Record<string, unknown>

  • Extra properties of the connection.

    Returns undefined | Record<string, unknown>

    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(): { geometry: {}; properties: null; type: string }

  • Returns { geometry: {}; properties: null; type: string }

geoJSONBoundingBox

  • get geoJSONBoundingBox(): {}

  • Gets the bounding box of the geoJSON geometry.

    Returns {}

    The bounding box of the geoJSON geometry

images

  • get images(): ImageData[]

  • Gets the array of Images associated with this map feature.

    Returns ImageData[]

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

links

  • Gets the array of Hyperlinks associated with this map feature.

    Returns Hyperlink[]

    An array of Hyperlink objects, or an empty array if no links exist.

locationProfiles

name

  • get name(): string

  • Gets the name of the map feature.

    Returns string

    The name of the map feature.

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;
        extra: undefined
        | Record<string, unknown>;
        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;
        extra: undefined
        | Record<string, unknown>;
        floors: string[];
        id: string;
        name: string;
        type: string;
    }

    An object representing the connection.

Staticis

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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR