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. |
| poiCategoryOrder | text | poiCategoryOrder=code1, code2, code3 | If this custom-field is not present, the order of the POI categories in the POI category filter menu will be alphabetical. Otherwise, it will be ordered based on the specific order of the POI category codes inputed. |
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 | The POI priority is used for two different purposes: 1. Clustering view : 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. 2. Semantic indications: If in navigation mode the route crosses the coverage area of a POI, the corresponding instruction will include information about that POI. (only for priority = 1) link |
| 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. |
| max_zoom | Decimal number between 1 (lowest zoom) and 23 (highest zoom) | 18.2 | Experimental feature POI will disappear after a certain zoom level. E.g. in the example if you zoom higher than 18.2 the POI will dissapear |
| min_zoom | Decimal number between 1 (lowest zoom) and 23 (highest zoom) | 18.2 | Experimental feature POI will never appear before a certain zoom level. After that zoom level, POI will appear as long as clustering algorithm allows it. E.g. in the example if you zoom higher than 18.2 the POI will appear at some point, provided that there are no higher priority POIs too close. |
| hide | Combination of the following values in a list: on_map, on_search, on_map_icon, on_map_text | hide = on_map, on_search | This configuration allows precise control over a Point of Interest (POI)’s visibility on a map and in search results. Key settings include: – on_map: Hides the POI on the map. – on_search: Hides the POI in search results. – on_map_icon: Hides the POI’s map icon. – on_map_text: Hides the POI’s label (name) on the map. You can also combine values, e.g., “hide=on_map, on_search” hides POIs on the map and in search results. Exception: If set to “on_map” or a combo of “on_map_icon” and “on_map_text,” the POI will still appear on the map when selected, serving as a route endpoint, or as a fixed point of interest. |
| indication_type | String (floor) | indication_type = floor | Specify how the user should make transitions between floors. To add extra information in the floor transition indications, it’s necessary to include the following custom field in the POIs that indicate a transition between floors, such as an elevator or escalator. link (Example of Indication: if we have a POI scalator the indication can be as following: “Change floor 1 using scalator“). |
| indication_radius | Decimal value (distance in meters) | indication_raidius = 5.5 | Distance from the POI to the route to add the POI information in indications. The added information in the indications varies depending on the proximity of the POI to the route using the value previously defined. link (Example of Indication: if we have a POI information the indication can be as following: “Turn left and go ahead for 17 m to Information“). NOTE: There is the possibility of configuring a global distance for all POIs. |
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 |
|---|---|---|---|
| hide | Combination of the following values in a list: on_map, on_search, on_map_icon, on_map_text | hide = on_map, on_search | Controls specific POI category visibility on the map and in search results. Visibility settings are independent for each category, such that they don’t propagate from parent to subcategories. Key settings include: – on_map: Hides all POIs within the specified category on the map. – on_search: Hides all POIs within the specified category in search results. – on_map_icon: Hides icons associated with all POIs within the specified category on the map. – on_map_text: Hides labels (names) of all POIs within the specified category on the map. You can also combine values, e.g., “hide=on_map, on_search” hides POIs on the map and in search results. Exception: If set to “on_map” or a combination of “on_map_icon” and “on_map_text,” POIs in the designated category will still appear on the map when selected, serving as a route endpoint, or as a fixed point of interest. |
