Class GaugeNodeMap

api/gauges/:id?format=map&begin=...

Hierarchy (view full)

Constructors

constructor

Properties

TYPE name description latitude longitude team id version

Accessors

links

Methods

setConfiguration getConfiguration toJSON setMapData getMapData getLinks getLink getLinkIds getLinksCount addLinks getVersion

Constructors

constructor

  • new GaugeNodeMap(json): GaugeNodeMap

  • Parameters

    • json: {
          id: string;
          latitude: number;
          longitude: number;
          name: string;
          description: string;
          team: string | TeamNode;
          configurationAsJSON?: string;
          map?: string;
          links?: Link[] | RaainNode[];
          version?: string;
      }
      • id: string
      • latitude: number
      • longitude: number
      • name: string
      • description: string
      • team: string | TeamNode
      • Optional configurationAsJSON?: string
      • Optional map?: string
      • Optional links?: Link[] | RaainNode[]
      • Optional version?: string

    Returns GaugeNodeMap

Properties

Static TYPE

TYPE: string = 'gauge'

Type identifier for gauge nodes

name

name: string

Name of the gauge station

description

description: string

Description of the gauge station

latitude

latitude: number

Latitude of the gauge station

longitude

longitude: number

Longitude of the gauge station

team

team: TeamNode

Associated team

id

id: string

Unique identifier for the node

version

version: string

Version string of the node

Accessors

links

Methods

setConfiguration

getConfiguration

toJSON

  • toJSON(): {
        name: string;
        description: string;
        latitude: number;
        longitude: number;
        team: string | TeamNode;
        configurationAsJSON: string;
        map: string;
        id: string;
        links: Link[];
        version?: string;
    }

  • Converts the gauge node to a JSON object.

    Returns {
        name: string;
        description: string;
        latitude: number;
        longitude: number;
        team: string | TeamNode;
        configurationAsJSON: string;
        map: string;
        id: string;
        links: Link[];
        version?: string;
    }

    A JSON object containing the gauge node's data

    • name: string
    • description: string
    • latitude: number
    • longitude: number
    • team: string | TeamNode
    • configurationAsJSON: string
    • map: string
    • id: string
    • links: Link[]
    • Optional version?: string

setMapData

getMapData

getLinks

getLink

getLinkIds

getLinksCount

  • getLinksCount(linkType?): number

  • Gets the count of links, optionally filtered by type.

    Parameters

    • Optional linkType: string

      Optional type of links to count

    Returns number

    The number of links

addLinks

getVersion

Settings

Member Visibility

Theme

On This Page

constructorTYPEnamedescriptionlatitudelongitudeteamidversionlinkssetConfigurationgetConfigurationtoJSONsetMapDatagetMapDatagetLinksgetLinkgetLinkIdsgetLinksCountaddLinksgetVersion