Map Layer

This component displays and dynamically updates geo-fences, devices, and node table expressions.

The map layer can show markers that indicate the current location of devices providing GPS data, along with their track paths. It can also display links between devices (device topology).

Sources for map layer data include:

  • Context Mask - used for displaying devices. All content and topology expressions are enabled. Expressions will be applied for every device.
  • Geo-Fence Mask - used for displaying geo-fences. Latitude, Longitude and topology expressions are disabled. Expressions will be applied for every row in geo-fence.
  • Custom Nodes - used for displaying custom data generated by Node Table Expression. All content expressions are enabled, topology expressions are disabled. Expressions will be applied for every row in the Node Table Expression result table.
  • Track - used for displaying tracks, e.g. history of device/vehicle movements. Nodes will be added to the track in the order in that they appear in the table returned by Node Table Expression. All content expressions are enabled, topology expressions are disabled.

Basic Properties

Common

Map Layer has the following basic properties that are common for all widgets:

Visible, Border, Font, Pin Points.

Topology Visualisation

Map Layer inherits the following basic properties from Topology Visualization:

Vertex Popup Menu, Edge Popup Menu.

Depth

Depth of the layer, that is also called z-order. Layers with a lower depth are rendered over the layers with a higher depth.

Property name: depth

Property type: Integer

Content Properties

Type

Selects the data provider type. The list of available types includes:

  • Context Mask (Mask of device contexts)
  • Geo-Fence Mask (Mask of Geo-Fence contexts)
  • Node Table Expression (Expression which should return a data table)

Property name: type

Property type: String

Context Mask

This source type allows to select a devices context mask as a layer data provider.

A default mask users.*.devices.* matches all devices in the system.

Property name: contextMask

Property type: String

Fields format: Device

Geo-Fence Mask

This source type allows to select a geo-fence context mask as a layer data provider.

A default mask geofences.* matches all devices in the system.

Property name: geofenceMask

Property type: String

Fields format: Geo-fences

Node Table Expression

This source type allows to use an expression (should return DataTable) as a layer data provider.

Default Context

None.

Default Data Table

None.

Default Row

None.

Environment Variables

Standard variables only.

Property name: nodeTableExpression

Property type: String

For example the expression "table("<<latitude><E>><<longitude><E>><<description><S>><<type><S>>,<<color><C>>", 55.2595, 34.814, "A","server",color(0,255,0), 50.2595, 27.814, "A","printer",color(0,0,255))" creates a data table with two records.

Displayable Track Length (Waypoints)

A number of Device track waypoints to show on the map.

Device setting history storage must be enabled for Location (location) setting of a Device in order to keep historical track information and display it on the map.

Property name: trackLength

Property type: Integer

Expressions Properties

Topology Visualization

Map Layer inherits the following expressions properties from Topology Visualization:

Preferred Action Name Expression, Color Expression, Image Expression, Azimuth Expression, Marker Ratio Expression.

Color Type

Type of color for painting layer objects.

Property name: contentColorType

Property type: String

Selection values:

  • Static (Mask of devices contexts)
  • Dynamic (Mask of Geo-Fence contexts)

Color

Color for painting layer objects.

Property name: contentColor

Property type: Color

Tooltip Expression

Expression which returns tooltips of the layer objects.

Default Context

Layer context (for Geo-Fence Type), device context (for Context type), none (for Node Table Expression type).

Default Data Table

Node Table Expression result table (for Node Table Expression type), none for other.

Default Row

Points to currently processed row of the default data table, none (for Context type).

Environment Variables

Standard variables only.

Property name: tooltipExpression

Property type: String

Latitude Expression

Expression which returns latitude of the layer objects (not available for Geo-Fence Type).

Default Context

Layer context (for Geo-Fence Type), device context (for Context type), none (for Node Table Expression type).

Default Data Table

Node Table Expression result table (for Node Table Expression type), none for other.

Default Row

Points to currently processed row of the default data table, none (for Context type).

Environment Variables

Standard variables only.

Property name: latitudeExpression

Property type: String

Longitude Expression

Expression which returns longitude of the layer objects (not available for Geo-Fence Type).

Default Context

Layer context (for Geo-Fence Type), device context (for Context type), none (for Node Table Expression type).

Default Data Table

Node Table Expression result table (for Node Table Expression type), none for other.

Default Row

Points to currently processed row of the default data table, none (for Context type).

Environment Variables

Standard variables only.

Property name: longitudeExpression

Property type: String

Bindings Properties

Map Layer uses Bindings property that is common for all widgets.

Topology Properties

Topology Visualization

Map Layer inherits the following properties from Topology Visualization:

Provider, Source and Target Nodes are Contexts, Display Unlinked Nodes, Topology Expression, Node Expression, Link Expression, Link Id Expression, Node Id Expression, Source Expression, Target Expression, Interface Expression, Directed Expression, Width Expression, Link Description Expression, Show Link Description, Link Color Expression, Show Neighbouring Nodes, Node Tooltip Expression, Link Tooltip Expression.

Common Events

Hidden, Shown, Moved, Resized, Mouse Clicked, Mouse Pressed, Mouse Released, Mouse Entered, Mouse Exited, Mouse Moved, Mouse Wheel Moved, Key Typed, Key Pressed, Key Released, Focus Gained, Focus Lost

Custom Events

Node Click

This event is fired when a map node is clicked.

Event name: nodeClick

If a clicked node is a Device/Context:

Field

Name

Type

Description

Node

node

String

Path of a clicked node/context.

Latitude

latitude

Float

Latitude of a hovered server context.

Longitude

longitude

Float

Longitude of a hovered server context.

Type

type

String

Type of a clicked node/context (printer,server, etc.).

Color

color

Color

Color of a clicked node/context.

Labels

labels

Data Table

See Node Description Expression.

Image

image

Data

Image of a clicked node/context.

Tooltip

tooltip

String

Tooltip of a clicked node/context.

Device Name

deviceName

String

Name of a clicked node/context.

Device Description

deviceDescription

String

Description of a clicked node/context.

Azimuth

azimuth

Double

An angular measurement in a spherical coordinate system of a clicked node/context.

Ratio

ratio

Double

Ratio of image size of a clicked node/context.

If a clicked node is a Geo-Fence point:

Field

Name

Type

Description

Description

description

String

Description of a clicked point.

Latitude

latitude

Float

Latitude of a hovered point.

Longitude

longitude

Float

Longitude of a hovered point.

Type

type

String

Type of a clicked point.

Color

color

Color

Color of a clicked point.

If a clicked node is a Node Table Expression point, event fields contain records from the Node Table Expression result table. See the example.

Node Double Click

This event is fired when a map node is double-clicked.

Event name: nodeDoubleClick

When a clicked node is a Device/Context:

Field

Name

Type

Description

Node

node

String

Path of a clicked node/context.

Latitude

latitude

Float

Latitude of a hovered server context.

Longitude

longitude

Float

Longitude of a hovered server context.

Type

type

String

Type of a clicked node/context (printer,server, etc.).

Color

color

Color

Color of a clicked node/context.

Labels

labels

Data Table

See Node Description Expression.

Image

image

Data

Image of a clicked node/context.

Tooltip

tooltip

String

Tooltip of a clicked node/context.

Device Name

deviceName

String

Name of a clicked node/context.

Device Description

deviceDescription

String

Description of a clicked node/context.

Azimuth

azimuth

Double

An angular measurement in a spherical coordinate system of a clicked node/context.

Ratio

ratio

Double

Ratio of image size of a clicked node/context.

In case of clicked node is a Geo-Fence point:

Field

Name

Type

Description

Description

description

String

Description of a clicked point.

Latitude

latitude

Float

Latitude of a hovered point.

Longitude

longitude

Float

Longitude of a hovered point.

Type

type

String

Type of a clicked point.

Color

color

Color

Color of a clicked point.

In case of clicked node is Node Table Expression point, event field contains record from Node Table Expression result table see the example.

Node Enter

This event is fired when mouse is hovered over a node displayed on a map.

Event name: nodeEnter

In case of clicked node is Device/Context

Field

Name

Type

Description

Node

node

String

Path of a clicked node/context.

Latitude

latitude

Float

Latitude of a hovered server context.

Longitude

longitude

Float

Longitude of a hovered server context.

Type

type

String

Type of a clicked node/context (printer,server, etc.).

Color

color

Color

Color of a clicked node/context.

Labels

labels

Data Table

See Node Description Expression.

Image

image

Data

Image of a clicked node/context.

Tooltip

tooltip

String

Tooltip of a clicked node/context.

Device Name

deviceName

String

Name of a clicked node/context.

Device Description

deviceDescription

String

Description of a clicked node/context.

Azimuth

azimuth

Double

An angular measurement in a spherical coordinate system of a clicked node/context.

Ratio

ratio

Double

Ratio of image size of a clicked node/context.

   

In case of clicked node is Geo-Fence point, event fields:

Field

Name

Type

Description

Description

description

String

Description of a clicked point.

Latitude

latitude

Float

Latitude of a hovered point.

Longitude

longitude

Float

Longitude of a hovered point.

Type

type

String

Type of a clicked point.

Color

color

Color

Color of a clicked point.

In case of clicked node is Node Table Expression point, event field contains record from Node Table Expression result table see the example.

Node Leave

This event is fired when mouse is unhovered from a node displayed on a map.

Event name: nodeLeave

In case of clicked node is Device/Context

Field

Name

Type

Description

Node

node

String

Path of a clicked node/context.

Latitude

latitude

Float

Latitude of a hovered server context.

Longitude

longitude

Float

Longitude of a hovered server context.

Type

type

String

Type of a clicked node/context (printer,server, etc.).

Color

color

Color

Color of a clicked node/context.

Labels

labels

Data Table

See Node Description Expression.

Image

image

Data

Image of a clicked node/context.

Tooltip

tooltip

String

Tooltip of a clicked node/context.

Device Name

deviceName

String

Name of a clicked node/context.

Device Description

deviceDescription

String

Description of a clicked node/context.

Azimuth

azimuth

Double

An angular measurement in a spherical coordinate system of a clicked node/context.

Ratio

ratio

Double

Ratio of image size of a clicked node/context.

   

In case of clicked node is Geo-Fence point, event fields:

Field

Name

Type

Description

Description

description

String

Description of a clicked point.

Latitude

latitude

Float

Latitude of a hovered point.

Longitude

longitude

Float

Longitude of a hovered point.

Type

type

String

Type of a clicked point.

Color

color

Color

Color of a clicked point.

In case of clicked node is Node Table Expression point, event field contains record from Node Table Expression result table see the example.

Polygon Click

This event is fired when a polygon is clicked.

Event name: polygonClick

Field

Name

Type

Description

Context

context

String

Path of a clicked polygon.

Name

name

String

Name of a clicked polygon.

Type

type

String

Type of a clicked polygon.

Polygon Double Click

This event is fired when a polygon is double-clicked.

Event name: polygonDoubleClick

Field

Name

Type

Description

Context

context

String

Path of a clicked polygon.

Name

name

String

Name of a clicked polygon.

Type

type

String

Type of a clicked polygon.

Polygon Enter

This event is fired when mouse is hovered polygon displayed on a map.

Event name: polygonEnter

Field

Name

Type

Description

Context

context

String

Path of a clicked polygon.

Name

name

String

Name of a clicked polygon.

Type

type

String

Type of a clicked polygon.

Polygon Leave

This event is fired when mouse is unhovered from a polygon displayed on a map.  

Event name: polygonLeave

Field

Name

Type

Description

Context

context

String

Path of a clicked polygon.

Name

name

String

Name of a clicked polygon.

Type

type

String

Type of a clicked polygon.

Edge Enter

This event is fired when mouse is hovered over a link between two nodes displayed on a map.

Event name: edgeEnter

Field

Name

Type

Description

Source

source

String

Link source context name.

Destination

destination

String

Link destination context name.

Source Interface

sourceInterface

String

Link source interface name.

Destination Interface

destinationInterface

String

Link destination interface name.

Edge Leave

This event is fired when mouse is unhovered from a link between two nodes displayed on a map.  

Event name: edgeLeave

Field

Name

Type

Description

Source

source

String

Link source context name.

Destination

destination

String

Link destination context name.

Source Interface

sourceInterface

String

Link source interface name.

Destination Interface

destinationInterface

String

Link destination interface name.

Edge Click

This event is fired when a link between two nodes is clicked.

Event name: edgeClick

Field

Name

Type

Description

Source

source

String

Link source context name.

Destination

destination

String

Link destination context name.

Source Interface

sourceInterface

String

Link source interface name.

Destination Interface

destinationInterface

String

Link destination interface name.

nodeShowPopup

This event is fired when you right-click a node and a popup menu is displayed.

Event name: nodeShowPopup

Event fields:

Field

Name

Type

Description

Node

node

String

Path of a node/context. The popup menu is displayed for this node.

edgeShowPopup

This event is fired when you right-click a link between two nodes and a popup menu is displayed.

Event name: edgeShowPopup

Event fields:

Field

Name

Type

Description

Source

source

String

Edge source node/context.

Destination

destination

String

Edge destination node/context.

Source Interface

sourceInterfaceId

String

Edge source interface. Important when there are multiple edges between two nodes.

Destination Interface

destinationInterfaceId

String

Edge destination interface. Important when there are multiple edges between two nodes.

graphShowPopup

This event is fired when you right-click the canvas and a popup menu is displayed.

Event name: graphShowPopup

This event has no fields.

Was this page helpful?