Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IMappedinNode

A IMappedinNode represents a position, anchored to a specific IMappedinMap.

A Node can have more properties but usually the default is sufficient. The IMappedin 'things' object is where you would specify what properties you want to download for Nodes. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.

Hierarchy

  • MappedinNavigatable
    • IMappedinNode

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private #private

#private: any

Private #private

#private: any

Optional externalId

externalId: string

id

id: string

Node ID.

property

id {string}

map

map: string

ID of Map that the Node is located on.

property

map {string}

x

x: number

X coordinate of Node's position.

property

x {number}

y

y: number

Y coordinate of Node's position.

property

y {number}

Accessors

locations

paths

polygon

Methods

directionsTo

directionsToCallback

distanceTo

  • Calculate distance between 2 nodes, polygons or locations

    Parameters

    • destination: IMappedinPolygon | IMappedinLocation | IMappedinNode
    • options: TDirectionToOptions
    • Optional cb: (error: any, distance: number) => void
        • (error: any, distance: number): void

        • Parameters

          • error: any
          • distance: number

          Returns void

    Returns number

toJSON

  • toJSON(): any

  • Returns any

Static fetch

  • Parameters

    Returns Promise<any>

Static hydrate

  • hydrate(nodes: any, mappedin: IMappedin): any

  • Parameters

    Returns any