The Open Street Maps widget uses the Maptalks API and displays a street map of the world and you can add markers via a simple JSON config. Choose between different base maps tyles. At different zoom levels, when markers are too close together, they automatically cluster together and show the number of markers in that area. Unlike our other open maps widget, this widget allows you to set up to 5 ord values. The values are shown on a tooltip via single click, which is great for mobile users as well. Markers can have different colours OR bind each marker to a boolean/enum. 3 colours of your choice make up the change in value. Tooltip icons can also be changed to a image of your choice, or removed entirely. Values and markers also update in real-time. A search box will also help find markers and automatically pan to them when clicked. *You need an internet connection to view the maps, however if you are on a restricted network, its recommended you set up an outbound firewall rule to the mapping server: http://d.basemaps.cartocdn.com **Map tiles are automatically stored as you browse the map. If you go offline, the maps in the cache will be loaded first. The widget has a number of configurable properties that can be used to modify look, feel, and functionality.
Are you looking for a cost effective way to manage and visualize data for all your customers? Why not have a look at View Builder ?
Before you start. Download the modules from our portal (see your order confirmation, which also explains licensing). Copy the modules file to your modules directory. Restart BOTH station and Workbench.
1. Copy the openStreetMapsWithValues-ux.jar file to your modules directory. 2. Open the module from your palette file. 3. Drag and drop the widget from the palette onto your px view. Note: in >4.10 you will need to modify the Web Service settings in the station to allow maps to show up See Here frame-src * img-src 'self' workbench data: https://a.basemaps.cartocdn.com/ https://b.basemaps.cartocdn.com/ https://c.basemaps.cartocdn.com/ https://d.basemaps.cartocdn.com/ https://www.wse-ltd.com https://cdn.jsdelivr.net style-src 'self' workbench 'unsafe-inline' https://fonts.googleapis.com https://cdn.jsdelivr.net https://api.mapbox.com https://cdnjs.cloudflare.com script-src 'self' workbench 'unsafe-inline' 'unsafe-eval' https://s.ytimg.com/ https://unpkg.com/ https://fonts.googleapis.com https://cdn.jsdelivr.net https://api.mapbox.com blob://* https://cdnjs.cloudflare.com
The widget has a number of configurable properties that can be used to modify look, feel, and functionality. Change the properties as required:
A JSON config for map markers. See below for setup. You can point the menu to a file that exists on the station. Valid values are ords e.g.: file:^openMapsFolder/config.txt If you do not specify a file reference, an message will show up. Verify all point exist in your config. Heres a sample config to help you get started. Download
The map will display at this location when initialised.
The viewing angle of the map.
Overview Control, Scale Control, Zoom Control
Shows/hides the controls on the map. Set to true or false.
The default zoom level. Default is 15.5.
Set these values to manually set the height/width of the map frame.
Recently the open maps have added a free api key which you can sign up for at https://carto.com/basemaps/apikey/
On the widget property sheet add the API key parameter to the baseMapsUrl property: http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png?key=YOURKEY
Can put in shared folder or use the remote link.
https://cdn.jsdelivr.net/npm/ [email protected] /dist/maptalks.min.js /ord/file:^openMaps/maptalks.css|view:web:FileDownloadView
https://cdn.jsdelivr.net/npm/ [email protected] /dist/maptalks.css /ord/file:^openMaps/maptalks.min.js|view:web:FileDownloadView
Base Maps Url - Style
There are a few different styles you can display. Default: https://{s}.basemaps.cartocdn.com/rastertiles/voyager_labels_under/{z}/{x}/{y}.png No Labels: https://{s}.basemaps.cartocdn.com/rastertiles/voyager_nolabels/{z}/{x}/{y}.png Positron w/ Labels: https://{s}.basemaps.cartocdn.com/rastertiles/light_all/{z}/{x}/{y}.png Positron without labels: https://{s}.basemaps.cartocdn.com/rastertiles/light_nolabels/{z}/{x}/{y}.png Dark with Labels: https://{s}.basemaps.cartocdn.com/rastertiles/dark_all/{z}/{x}/{y}.png Dark without labels: https://{s}.basemaps.cartocdn.com/rastertiles/dark_nolabels/{z}/{x}/{y}.png
The current version when writing this document is 0.49.5. Do not use anything beyond this version. Although rc-1 has been released, it has some breaking changes which will not work with the widget. As we do not maintain the mapping images, change this value as new versions are released. The latest version value can be found here. https://github.com/maptalks/maptalks.js/releases
Marker Cluster API Url Default is /module/openStreetMapWithValues/rc/maptalks.markercluster.min.js or you can use the url https://unpkg.com/maptalks.markercluster/dist/maptalks.markercluster.min.js (Required for firefox)
The marker config is in JSON format. You can customise as needed. Special characters should be avoided. Advanced users can enter html content in the label and tooltipText properties. Heres a sample config to help you get started. Download
If no link is specified, the marker, label, and tooltip will be shown. For links to navigate correctly in Workbench, and if you're running 4.3 or above, there should be a "toggle preview" button at the end of the toolbar when looking at a Px graphic. This will show you your Px page rendered in a browser and the links will work correctly
JSON Values Explained: lat- geo coordinate. long- geo coordinate. link- link to when clicked on tooltip label. linkTarget- link to target window. Default is parent. Possible values: blank, self, parent, or top. label- label to show on map and tooltip. defaultMarkerColor- default color for marker when spectrum binding is false. markerChangeValueOrd- ord binding to marker change value when spectrum binding is used. Absolute ord e.g. station:|slot:/Drivers/Sites/Overview/COMeasurement. Its best to use a boolean or enum. Boolean will be 0 or 1. The enum index will determine the value e.g. 0, 1, 2. ord- ord value for tooltip data. Absolute ord e.g. station:|slot:/Drivers/Sites/Overview/COMeasurement ordDisplayName- ord value display name on tooltip. ord1- ord value 1 for tooltip data. ord1DisplayName- ord value 1 display name on tooltip. ord1Icon- icon to show on tooltip. File can be in the stations shared directory e.g. /ord/file:%5EopenMaps/brt-medium.png or come from a module e.g. /module/openStreetMapWithValues/rc/humidity-sm.png ord2- ord 2 value. ord2DisplayName- ord 2 display name. ord2Icon- ord 2 icon. ord3- ord 3 value. ord3DisplayName- Ord 3 display name. ord3Icon- ord 3 icon. ord4- ord 4 ord4DisplayName- ord 4 display name. ord4Icon- ord 4 icons.
JSON Editing To help build your menu configuration use an online JSON editor like: https://jsoneditoronline.org/
back to more widgets...
Build Your Own dashboards and win Projects by showing data that increase value and reduces expenditure.
Home About Us Current Projects Affiliations Privacy Policy ECommerce Policy
View Builder IOT ™© Mobile Solutions N4 View Builder ™© Niagara PX Graphics
Software Development Consultancy Project Management Graphic Design Knowledge
T: +44 (0)800 511 8446 (UK) +1 888 207 4061 (US)
Copyright © 2026 Works Software & Engineering Ltd. All rights reserved.