Skip to main content

Data Model

The map component presents a data model that can be explored using the Live Data Viewer. It consists of services and telemetry streams.

Dynamic Maps​

Telemetry​

  • dynamicMaps: This telemetry stream contains information about the dynamic maps that are currently being used by the map component. It includes the name of each running dynamic map and number of nodes and edges in it.
  • dynamicMaps/<dynamicMapName>: This telemetry stream contains the live updates for each dynamic map running, showing updates such as nodes and edges added, removed, or updated.

Services​

  • clear: Clears the dynamic map.
  • get: Gets the dynamic map. Takes an optional mode parameter which can be either monolithic or progressive. The default is monolithic. The monolithic mode returns the entire map in one message, while the progressive mode returns the map in chunks.
  • edgeTypes: Returns an array of the string edge types present in the dynamic map.
  • edgesByID: Takes an array of edge IDs and returns the corresponding edges. The edgeData boolean specifies whether the edge data should be included in the response.
  • edgesByType: Takes an array of edge types and returns all edges of those types. The edgeData boolean specifies whether the edge data should be included in the response.
  • nodeTypes: Returns an array of the string node types present in the dynamic map.
  • nodesByID: Takes an array of node IDs and returns the corresponding nodes. The nodeData boolean specifies whether the node data should be included in the response.
  • nodesByType: Takes an array of node types and returns all nodes of those types. The nodeData boolean specifies whether the node data should be included in the response.
  • traversal: Dynamic map traversal services are outlined here.

Static Maps​

Telemetry​

  • staticMaps: This telemetry stream contains information about the static maps that are currently stored on the agent disk.

Services​

  • export: Exports the static map with specified hash to a .tgz file at the spcified file path.
  • import: Imports a static map from a .tgz file at the specified file path.
  • get: Returns the content of the static map specified by hash.
  • load: Loads the static map specified by hash into the specified dynamic map.
  • merge: Merges the static map specified by hash into the specified dynamic map. This differs from the load service in that it does not clear the dynamic map before loading the static map. So the content of the static map will be merged with the existing dynamic map.
  • remove: Removes the static map specified by hash.
  • save: Saves the content currently in the specified dynamic map to a static map. The hash of the static map is returned.