Class GaugeNodeMap

External

API: /gauges/:gaugeId

Hierarchy (view full)

GaugeNode
- GaugeNodeMap

Index

Constructors

Properties

TYPE name description latitude longitude team id version

Accessors

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
Overrides GaugeNode.constructor
- Defined in gauge/GaugeNodeMap.ts:12

Properties

`Static` TYPE

TYPE: RaainNodeType = RaainNodeType.GaugeNode

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

Associated team

id

id: string

Unique identifier for the node

version

version: string

Version string of the node

Accessors

links

get links(): Link[]
Gets all links associated with the node.

Returns Link[]
Array of HATEOAS links
Inherited from GaugeNode.links
- Defined in organization/RaainNode.ts:59
set links(links): void
Sets the links for the node.
Parameters
- links: Link[] | RaainNode[]
  Array of links to set
Returns void
Inherited from GaugeNode.links
- Defined in organization/RaainNode.ts:68

Methods

setConfiguration

setConfiguration(configuration): void
Sets the configuration for the gauge node.
Parameters
- configuration: any
  Configuration object or JSON string
Returns void
Inherited from GaugeNode.setConfiguration
- Defined in gauge/GaugeNode.ts:91

getConfiguration

getConfiguration(): any
Gets the configuration of the gauge node.

Returns any
The configuration object or null if not set
Inherited from GaugeNode.getConfiguration
- Defined in gauge/GaugeNode.ts:109

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
Overrides GaugeNode.toJSON
- Defined in gauge/GaugeNodeMap.ts:28

setMapData

setMapData(mapData): void
Parameters
- mapData: string | GaugeMeasure[]
Returns void
- Defined in gauge/GaugeNodeMap.ts:36

getMapData

getMapData(): GaugeMeasure[]
Returns GaugeMeasure[]
- Defined in gauge/GaugeNodeMap.ts:52

getLinks

getLinks(linkType?): Link[]
Parameters
- Optional linkType: RaainNodeType
Returns Link[]
Inherited from GaugeNode.getLinks
- Defined in organization/RaainNode.ts:149

getLink

getLink(linkType, index?): Link
Parameters
- linkType: RaainNodeType
- Optional index: number
Returns Link
Inherited from GaugeNode.getLink
- Defined in organization/RaainNode.ts:159

getLinkIds

getLinkIds(): string[]
Gets all link IDs associated with the node.

Returns string[]
Array of link IDs
Inherited from GaugeNode.getLinkIds
- Defined in organization/RaainNode.ts:173

getLinksCount

getLinksCount(linkType?): number
Gets the count of links, optionally filtered by type.
Parameters
- Optional linkType: RaainNodeType
  Optional type of links to count
Returns number
The number of links
Inherited from GaugeNode.getLinksCount
- Defined in organization/RaainNode.ts:183

addLinks

addLinks(links): void
Adds new links to the node.
Parameters
- links: Link[] | RaainNode[]
  Array of links to add
Returns void
Inherited from GaugeNode.addLinks
- Defined in organization/RaainNode.ts:198

getVersion

getVersion(): string
Gets the version string of the node.

Returns string
The version string
Inherited from GaugeNode.getVersion
- Defined in organization/RaainNode.ts:211