Map Tile Provider Customization

When creating a Map Plot visualization, the map images are retrieved from a map tile provider on web URL. Panopticon provides a default map tile provider preconfigured within the software. In addition, custom map tile providers can be added to the server configuration by editing the following file:

/etc/panopticon/appdata/default-settings/tileproviders.json

The default map tile provider that is shipped with the product can be overridden by specifying a different one and use the providerId Default.

In case the tileproviders.json file is deleted or moved and hence not found on server startup, then a new default tileproviders.json file will be created in the default-settings folder.

NOTE:

You will not be able to keep the original default map tile provider with a different name. The original default will become unavailable for as long as the new map tile provider service with the name Default exists in the configuration.

 

Each provider is a name-value pair object with the following parameters:

Parameter Description

providerId

The name label that will be visible in the selection dropdown in the settings of the Map Plot visualization. This value must be unique across all map tile providers saved in the file.

minZoom

The default value is 0. This is the minimum zoom level that should be available in the Panopticon Map Plot when using this map tile provider. However, the minimum zoom level available from the tile service may be a higher value (e.g., 5). Refer to the documentation of the map tile service provider.

maxZoom

The default value is 18. This is the maximum zoom level that should be available in the Panopticon Map Plot when using this map tile provider. However, the maximum zoom level available from the tile service may be a higher value (e.g., 20) or a lower value (e.g., 15). Refer to the documentation of the map tile service provider.

tileSize

The default value is 256. This is the size of each tile image coming from the map tile service. It describes a raster size, 256 by 256. Some services also use 512 by 512.

NOTE: It is required to have the correct tileSize setting for the service you are using. Otherwise, the tiles received will not be positioned correctly in the Map Plot and you will not see a correct map. Refer to the documentation of the map tile service provider. If the tile size is not specified by the map tile provider, assume 256.

urlFormat

This is the URL of the map tile provider, and it will be different for each map tile provider.

For map tile providers that use the OSM tile coordinates encoding, the URL will end with /{z}/{x}/{y}.png or /{z}/{x}/{y}.jpg, which for Panopticon must be changed into /{0}/{1}/{2}.png or /{0}/{1}/{2}.jpg. Some tile providers will require an API key, which is appended as a URL request parameter, on this form: ?apikey=abc123.

For map tile providers that use the QUAD_KEY tile coordinates encoding, the URL will contain a {quadkey} reference which for Panopticon must be changed into {0}.

tileCoordEncoding

The default value is OSM. This value means that the map tile service uses the same URL principle as OpenStreetMap, where each tile URL request contains /zoomlevel/x-coord/y-coord/, which corresponds to /{0}/{1}/{2}/ in the urlFormat.

Value QUAD_KEY means that the map tile service uses the QuadKey principle, for example, like what Bing maps do. QuadKey is short for Quadtree Key, which is a one-dimensional string of digits, created from the two-dimensional X-Y coordinates. A Quadkey uniquely identifies a map tile at a specific zoomlevel.

 

 

 

 

(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support