Class Node

A class representing Path node data within the map.

Nodes are used to define points in the map's pathfinding graph.

Hierarchy

  • default
    • Node

Properties

id links

Accessors

coordinate externalId floor locations neighbors

Methods

toJSON is

Properties

Readonlyid

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

coordinate

externalId

  • get externalId(): string

  • Gets the external ID of the node.

    Returns string

    The external ID of the node.

floor

  • get floor(): Floor

  • Gets the Floor associated with the node.

    Returns Floor

    The floor object.

    Throws

    Will throw an error if the floor is not found.

locations

neighbors

  • get neighbors(): Node[]

  • Gets the neighboring nodes of this node.

    Returns Node[]

    An array of neighboring Node objects.

Methods

toJSON

  • toJSON(): {
        coordinate: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
        };
        floor: string;
        id: string;
        neighbors: string[];
    }

  • Serializes the node data to JSON.

    Returns {
        coordinate: {
            floor: undefined | string;
            latitude: number;
            longitude: number;
        };
        floor: string;
        id: string;
        neighbors: string[];
    }

    An object representing the node.

    • coordinate: {
          floor: undefined | string;
          latitude: number;
          longitude: number;
      }
      • floor: undefined | string
      • latitude: number
      • longitude: number
    • floor: string
    • id: string
    • neighbors: string[]

Staticis

  • is(instance): instance is Node

  • Checks if the provided instance is of type Node.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is Node

    True if the instance is a Node, false otherwise.

Settings

Member Visibility

On This Page

idlinkscoordinateexternalIdfloorlocationsneighborstoJSONis