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

Implements

Properties

id

Accessors

coordinate externalId floor geoJSON neighbors space

Methods

toJSON is

Properties

Readonlyid

id: string

The identity of the map metadata.

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.

geoJSON

  • get geoJSON(): { geometry: Point; properties: null; type: "Feature" }

    Gets the underlying GeoJSON Feature representation of this Node.

    Returns { geometry: Point; properties: null; type: "Feature" }

neighbors

  • get neighbors(): Node[]

    Gets the neighboring nodes of this node.

    Returns Node[]

    An array of neighboring Node objects.

space

  • get space(): undefined | Space

    Gets the Space object associated with the node.

    Returns undefined | Space

Methods

toJSON

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

    Serializes the node data to JSON.

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

    An object representing the node.

Staticis

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

Properties
Accessors
Methods