Map

The Map Portlet displays spatial data on an interactive geographical map, allowing users to view, navigate, and interact with markers and layers based on real-world coordinates.

General

General data is required for all portlets, see General.

Events

The Link portlet can receive events from other portlets but cannot send events to other portlets. See Events for more information.

Data

Marker

A marker is a visual symbol on the map representing a specific location or object, such as equipment, personnel, or a point of interest. Markers can be interactive, allowing users to trigger actions or workflows. End users can refresh the marker data at any time by clicking the refresh button on the portlet.

To set up a data source, see Data.

Data source columns

In the data source column, you can change column names and set their types. Click Manage to access a grid view of the configuration.

Click Execute in the data source section to fetch the columns. Each column can be configured with:

  • display name

  • column type

Marker mapping

  • Id: The unique identifier of the marker.

  • Latitude: The marker’s latitude position.

  • Longitude: The marker’s longitude position.

  • Label: The text to be displayed as the marker’s label.

  • Color: The marker’s color. The priority for determining the color is:

    1. Color rules in Style

    2. Color defined in marker mapping

    3. Default color in Style

Static layers

A static overlay is a non-interactive layer displayed on the map, such as a building or airport layout, providing spatial context. Since static layers do not change frequently, the cache level should be set accordingly, but end users can still refresh static overlays using the refresh button on the Static Layers control in the map. The allowed format for static layers is GeoJSON.

Click the Add button to add a new static layer. Multiple layers can be added, and a layer can be removed by clicking the delete icon.

GeoJSON layer

  • Layer group name: The name of the layer, which will be visible to the end user in the Static Layers control in the map portlet.

  • GeoJSON source: The component that outputs the static layer GeoJSON data.

  • Output variable: The variable containing the static layer GeoJSON data.

  • Mapping:

    • ID: The identifier of the GeoJSON layer.

    • Content: The GeoJSON code for the layer.

    • Label: The label of the GeoJSON layer.

Image overlay

  • Layer group name: The name of the layer, visible to the end user in the Static Layers control in the map portlet.

  • Image URL: The URL of the image.

  • Image position: Set the image position. Click Select position from Map to open an image editor in the map. Move and resize the box until you are satisfied with the position. Click Preview to see the image. The latitude and longitude coordinates of the image corners can also be entered manually. If the image position needs to be modified, adjust the corner coordinates manually. Clicking Select position from Map will reset the image position instead of moving an already saved image.

If you only want to show the image and not the map, make sure the image is zoomed in to cover the entire portlet and set Lock default position to True. This will fix the image position so the end user cannot move it. In these cases, you will most likely also want to disable the Scale, Zoom, and Home controls.

Presentation

Base layer

  • Default base layer: The default geographical map used in the portlet. The default map is set to Liberty.

  • Base layer control: Set to true if the end user should be able to change the base layer.

  • Base layer switcher available layers: Select the base layers that are available for the end user to choose from.

  • Static layer control: Set to true if the end user should be able to hide, unhide, and refresh static layers.

Default map position

  • Default map position: Click "Copy Current Map Position to copy the centre of the current map position; latitude and longitude values will be updated.

  • Latitude: Set the default latitude value manually or fetch it using "Copy Current Map Position."

  • Longitude: Set the default longitude value manually or fetch it using "Copy Current Map Position."

Zoom level

  • Zoom Level: Set the default zoom level.

  • Lock Default Position: Set to true if the map position should be static, preventing the end user from moving or zooming the map.

End user controls

  • Scale Control: Set to true if a scale control should be visible to the end user.

  • Zoom Control: Set to true if zoom functionality should be available to the end user.

  • Home Control: Set to true if the home control should be available to the end user. If available, the home position is the default map position.

Marker labels

  • Marker Labels: Set to true if marker labels should be shown.

  • Label Text: Enter the label text to be used; if left empty, the label from Marker Mapping will be shown.

  • Label Font Size: Set the font size for marker labels.

Clustering

  • Enable clustering: Set to true if marker clustering is to be enabled.

  • Max zoom level: Set the level where clustering starts/stops. It will be set to 10 as the default.

  • Radius: Distance, in pixels, within which markers will be combined into a cluster. It will be set to 30 as the default.

  • Default circle radius: The visual size of the cluster, in pixels. It will be set to 30 as the default.

  • Default minimum markers: Minimum number of markers to form a cluster. It will be set to 3 as the default.

  • Cluster color: The color of the cluster.

  • Cluster rules:

    • Click Add to add a cluster rule

    • Name: add the name for the rule

    • Circle radius: set the size of the cluster

    • Minimum markers: set the minimum number of markers to form a cluster

Tooltip

  • Show Tooltip: If unchecked, no tooltip will be displayed when hovering over a task. When checked, the data specified in the HTML will be shown in the tooltip.

  • Edit HTML: Configure the desired tooltip data using HTML to define the layout, and use curly brackets to specify the variables to be shown. Only plain HTML is allowed; style or script elements are forbidden.

Interactions

Create marker

Select the app or component to be run when a new marker is created. If set, an Add New Marker icon will appear in the map control panel. To create a marker, drag and drop the icon to the desired position on the map.

Drag&drop marker

Select the app or component to be run when a marker is moved. If set, users can drag and drop an existing marker to a new position on the map, and the configured app or component will be triggered with the updated location as input.

Double click marker

Select the app or component to be run when a marker is double-clicked. If set, double-clicking a marker on the map will trigger the configured app or component.

Style

Also see Style.

Markers

Marker Colors

  • Default Color: Set the default marker color.

  • Color Rules: Define conditional colors for markers.

    1. Click Add to create a new rule.

    2. Field: Select the data field on which the condition is based.

    3. Operator: Choose the operator for the condition.

    4. Value: Specify the value needed to meet the condition.

Color Priority:

  1. Color rules in Style

  2. Color defined in Marker mapping

  3. Default color in Style

Marker Icons

  • Default Icon: Set the default icon for the marker.

  • Icon Rules: Define conditional icons for markers.

    1. Click Add to create a new rule.

    2. Background: Select the icon to be used as the background.

    3. Field: Select the data field on which the condition is based.

    4. Operator: Choose the operator for the condition.

    5. Value: Specify the value needed to meet the condition.

Marker Shapes

Select the shape or the marker: Pin, Circle or Square.

Last updated

Was this helpful?