Map

Displays a map with a marker for each geolocated thing or location.

Map

Note that in order to display at least one marker on the map, at least one among thing or location must specify the GPS position.

Tooltips

When you move over a marker in the map, a tooltip will display the main information of the related object (thing or location).

You can configure the content of the popup by adding property sub-elements to the widget.
Each property can be overwritten, defining the label, unit and filter for value transforming and format.

If you need to combine multiple properties in the same value, you can add composite-parts with a specific filter (e.g. connection status with last status update time).

Map Filters

Map markers can be highlighted according to different criteria (e.g. presence of problems).

The map offers these selectable map filters:

  • Connection Status: highlights markers based on the connection status of each thing.
    In the case of locations, it only needs one thing online for the entire location to be marked as online.

  • Status: highlights markers based on the presence of active failures (red) or anomalies (orange).

By default, the map displays markers by using the Connection Status filter, and other Map Filters must be manually added to the widget as sub-elements in the template editor.

By clicking on the badges on the map (e.g. Failure (1)), markers belonging to a specific group can be hidden or displayed.

In addition you can create your how map filters to display markers according to your user needs.

Multiple Selection

By selecting multiple markers (), the widget displays the bulk operations panel, which allows to:

  • Manage Tags: select/deselect and edit tags.

  • Execute Command: for each identified thing-definition, select a command with bulk support to execute.

  • Apply Recipe: select a recipe and apply it to the selected thing.

  • Update Firmware: select a firmware and apply it to the selected thing.

Map Tools

On the map you can find additional buttons providing helfull functionalities:

  • Zoom in/out: allows you zoom in an out the map.
    In addition, you can use the maous wheel to zoom on a specific point.

  • Fit Content: the visible area is adapted to allow all markers to be included.

  • Move Markers: if enabled (Move Tool Enabled option), the DPS user can drag markers and when done, the new GPS coordinates are saved on the referenced object (lcoation or thing).

Template Syntax

Below you can find some examples of how to use the component within a template.

<map-widget context="THINGS|LOCATION"
            [title]="'Thing Map'"
            [moveElementEnabled]="true"
            [bulkControlsEnabled]="true"
            [queryFieldRef]=""
            [query]="[{..},{..}]"
            maxClusterRadius="30"
            disableClusteringAtZoomLevel="19"
            maxZoomLevel="20"
            mapLayerUrl="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"
            tooltipDetailsFilter=""
            tooltipClass="my-tooltip"
            class="my-map-class">
    
    <property name="name"></property>
    <property name="serialNumber"></property>
  
    <composite-part label="Connection Status" filter="connectionStatus">
		<property name="connectionStatus"></property>
		<property name="connectionStatusLastUpdateTimestamp"></property>
	</composite-part>

    <map-filter name="connectionStatus"></map-filter>
    <map-filter name="status"></map-filter>
            
</map-widget>

Component Reference

Here is a comprehensive list of all the elements and properties that can be used to configure the component.

Map <map-widget>

Bulk Controls Enabled

The boolean flag indicating whether bulk selection and buttons (e.g. Tagging, Firmware Update) are enabled on the widget.

Name: bulkControlsEnabled

Type: BOOLEAN | Optional

Default Value: false

[bulkControlsEnabled]="true"

Cluster Max Radius

The maximum radius that a cluster will cover from the central marker (in pixels). Decreasing will make more, smaller clusters.

Name: maxClusterRadius

Type: INTEGER | Optional

Default Value: 40

maxClusterRadius="123"

Clustering Max Zoom Level

The zoom level after which clustering is disabled.

Name: disableClusteringAtZoomLevel

Type: INTEGER | Optional

Default Value: 19

disableClusteringAtZoomLevel="123"

Context

The type of objects to be loaded within the map.

Name: context

Type: ENUM | Optional

Values: THINGS, LOCATIONS

Default Value: THINGS

context="THINGS"

Map Layer URL

The URL used to load map layer tiles. You can refer to this page https://leaflet-extras.github.io/leaflet-providers/preview

Name: mapLayerUrl

Type: STRING | Optional

mapLayerUrl="https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"

Max Zoom Level

The maximum zoom level of the map.

Name: maxZoomLevel

Type: INTEGER | Optional

Default Value: 19

maxZoomLevel="10"

Move Tool Enabled

The boolean flag indicating whether the element move tool is enabled.

Name: moveElementEnabled

Type: BOOLEAN | Optional

Default Value: false

[moveElementEnabled]="true"

Query

The array of conditions filtering out items. For instance: [query]='[{'property': 'connectionStatus', 'predicate': 'eq', 'value': '1'}]'  Predicates: eq, beginsWith, like, notLike, isEmpty, isNotEmpty, gt, gte, lt, lte.

Name: query

Type: QUERY | Optional

Predicates: beginsWith, eq, neq, gt, gte, isEmpty, isNotEmpty, lt, lte, like, notLike

[query]="[{property:'prop1', predicate: 'eq', value: 'foo'}, {property:'prop2', predicate: 'in', value: ['bar', 'baz']}]"

Query Variable

The id of the page's <things-filter-field> used for searching.

Name: queryFieldRef

Type: STRING | Optional

queryFieldRef="query-1"

Refresh Interval

The map refresh interval in milliseconds.

Name: refreshInterval

Type: STRING | Optional

Default Value: 300000

refreshInterval="abc"

Show Hierarchy Enabled

The boolean flag indicating whether the show thing hierarchy is enabled.

Name: showHierarchyEnabled

Type: BOOLEAN | Optional

Default Value: false

[showHierarchyEnabled]="true"

Title

The title displayed on the top part of the widget box.

Name: title

Type: STRING | Optional

[title]="'Details'"

Tooltip CSS Class

The name(s) of the CSS class used to customize the marker tooltip.

Name: tooltipClass

Type: STRING | Optional

tooltipClass="abc"

Tooltip Details Filter

The name of the filter you can use to customize the marker tooltip.

Name: tooltipDetailsFilter

Type: FILTER | Optional

tooltipDetailsFilter="dateFormat"

Rendering

CSS Class

The name(s) of the CSS class used to customize the widget layout.

Name: class

Type: STRING | Optional

class="abc"

Sub Elements

Property

The property whose label and value must be displayed within the marker tooltip.

Composite Part

The composite part whose label and value must be displayed within the marker tooltip.

Map Filter

This element allows defining map markers filtering tools.

Property <property>

Description

The property description.

Name: description

Type: STRING | Optional

description="abc"

Filter

The name of the filter used to transform and display values.

Name: filter

Type: FILTER | Optional

filter="fooBarFilter"

Label

The property alternative label.

Name: label

Type: STRING | Optional

label="Temperature"

Name

The property whose value must be loaded by the widget.

Name: name

Type: PROPERTY | Required

name="serialNumber"

Advanced

Visibility Condition

The expression that allows you to reduce the visibility of the element.

Name: *ngIf

Type: STRING | Optional

*ngIf="getUser().organizationId != null"

Composite Part <composite-part>

Description

The composite-part description.

Name: description

Type: STRING | Optional

description="abc"

Filter

The filter applied on the composite-part to transform or display its value.

Name: filter

Type: FILTER | Optional

filter="fooBarFilter"

Label

The label displayed by the widget.

Name: label

Type: STRING | Optional

label="abc"

Name

The composite-part name.

Name: name

Type: STRING | Optional

name="abc"

Advanced

Visibility Condition

The expression that allows you to reduce the visibility of the element.

Name: *ngIf

Type: STRING | Optional

*ngIf="getUser().organizationId != null"

Sub Elements

Property

The property whose value must be loaded within the composite-part.

Property <property>

Name

The property whose value must be loaded by the widget.

Name: name

Type: PROPERTY | Required

name="serialNumber"

Map Filter <map-filter>

Filter

The filter used to highlight map markers according to a property value, connection status or health status.

Name: name

Type: FILTER | Optional

name="fooBarFilter"

Label

The optional map filter label; if missing, the default name is used.

Name: config.label

Type: STRING | Optional

[config]="{label: 'Online/Offline'}"