Table of Contents
An important feature of our Map Viewer is the ability to configure the way buildings & POIs are shown. This is achieved by using special custom-fields for each of them.
Building custom fields #
You may configure building custom fields as explained here. The following table summarizes the most important you may use.
| Key | Value | Example | Description |
|---|---|---|---|
| geojson_map_url | URL where the GeoJSON map is hosted. Value is empty by default (no GeoJSON shown). | geojson_map_url = https://dashboard.situm.com/floorplan.geojson | The Map Viewer downloads and displays the GeoJSON map from the URL |
| has_tiles | true, false | has_tiles=true | Indicates whether the venue floorplans are available as high-resolution tiles. This is needed so that the MapViewer shows them. If not present, the value is assumed to be false and tiles are not shown. |
POI custom fields #
You may configure POI custom fields as explained here. The following table summarizes the most important you may use.
| Key | Value | Example | Description |
|---|---|---|---|
| priority | Priority level from 1 (max priority) to 10 (min priority). Value is 10 by default (lowest priority) | priority = 3 | If the POI is too close to other POIs, the Map Viewer shows only some of them to avoid cluttering the view. Those with the highest priority will have a higher chance to be shown. |
| top_level | true or false. Value is false by default (any value other than true will be false) | top_level = true | If the POI is too close to other POIs, the Map Viewer shows only some of them to avoid cluttering the view. Those with this custom-field set to true will never be hidden. |
| surname | String | “Gentleman” might be a surname to show for a POI on the Gentleman side of a fashion store | Allows to show a specific subtitle or surname for each POI. This is the default language fallback. |
| surname_lng | String | Caballero (spanish translation of “Gentleman”) | Allows to shown a specific subtitle for each POI, on a specific language (lng), following this convention. E.g. surname_es will be the subtitle for spanish. |
POI categories custom fields #
You may also configure POI categories custom fields. The following table summarizes the most important you may use.
| Key | Value | Example | Description |
|---|---|---|---|
| show_on_map | text, icon | show_on_map=text | If this custom-field is not present, both name & icon of the POIs of this category will be shown. If the value is “text”, only the text will be shown. If the value is “icon”, only the icon will be shown. |
