Class Connection

A class representing connection data within the map.

Connections are used to represent pathways between different map nodes.


  • default
    • Connection


id: string

identity of the map object

links: Hyperlink[] = []

Gets the links associated with this data type.

The links associated with this data type


  • get description(): string
  • Returns string

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

    Returns Floor[]

    An array of floors for the connection.

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

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

    Returns string

    The name of the connection.

  • get type(): string
  • Gets the type of the connection.

    Returns string

    The type of the connection.


  • Serializes the connection data to JSON.

    Returns {
        coordinates: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
        floors: string[];
        id: string;
        name: string;
        type: string;

    An object representing the connection.

    • coordinates: {
          floor: undefined | string;
          latitude: number;
          longitude: number;
    • floors: string[]
    • id: string
    • name: string
    • type: string
  • Checks if the provided instance is of type Connection.


    • instance: object

      The instance to check.

    Returns instance is Connection

    True if the instance is a Connection, false otherwise.