02- Map Viewer specification

Introduction #

In this page we explain more about Situm Map Viewer for you to have a better knowledge of how this tool can satisfy your demands and checkout about the features we have.

First of all if you want a quick start and know the basic guidelines for a minimal integration you can check our quickstart guidelines with Situm Map Viewer.

To be aware of recently added features and fixes you can check our Situm Map Viewer’s changelog.

We make our best effort to keep this software updated and we release features and new query params as frequently as we can. The intention of this page is also to be a guide for developers and integrators and ease their work.

Features #

These are some of the most relevant features that Map Viewer have:

Clustering: we implement an algorithm that cluster POIs nearby to avoid the overpopulation of the map.

Some clusters done by zooming out

Filter by categories: as the POIs are categorized we offer a display to filter by them.

Example of a ‘Coffee’ category filter

Trace routes: one of our main features is to select a few POIs and calculate the fastest route between them, allowing to make steps and follow user all along the way.

Example of route

Support for geojson maps and colours: we can handle this type of maps to be able to render maps in 2.5D and allowing to customize their color.

Lock Buildings: a simple way to prevent users to scroll away from the current building.

Dark mode: support to view a map with a dark theme.

Example of dark mode theme active

Custom organization’s color theme as Map Viewer’s color scheme: if the organization has a color scheme related to his mark, or just want a custom color to display in the layout elements, we support this type of customization.

Custom POIs iconography and colors: we offer common icons and categories for your POIs but they can be fully customized with any icon you want to upload as well as its category or background color.

Query parameters #

We offer a wide set of query parameters that can be used to maximize the adaptation of our Map Viewer to our customers’ needs to provide a very customizable integration.

This request parameters are:

emailIndicates the user’s email
apikeyIndicates the api key explained before (related to email). Use this endpoint to get your api keys.
buildingidIndicates the selected building identifier. Use this endpoint to get your buildings ids.
flooridIndicates the selected floor identifier. Use this endpoint to get your floors ids.
poiidIndicates the selected POI identifier. Use this endpoint to get your POIs ids.
navigation_toIndicates the destiny POI identifier in a route.
navigation_fromIndicates the origin POI identifier in a route.
lngSets the language of the UI. Supported values: en, es and ar. English, Spanish and Arabian.
hideReceives a set of strings separated by commas, each one hides a specific layout element:
pcl: hides pois clusters
pn: hides poi names
ec: hides explorer control
mc: hides map control
-lc: hides location control
wlReceives a boolean that when it’s true indicates that no logo is shown. If not specified, it is false by default.
rtlReceives a boolean that when it’s true make texts and layout elements adapt to right to left languages. If not specified, it is false by default.

To know more about these params usage you can scroll down to the examples section and check it out.

All identifiers will match with the ones used on Situm Dashboard App.

Example of a multiple Query Params url:

https://map-viewer.situm.com/?lng=es&navigation_from=100593&navigation_to=92993&buildingid=7033&floorid=14468

During the usage of the Map Viewer the url will be dynamically updated with the query params depending on the action done by the user. This is a way to keep the state and share it with others or open it at the same point on the user’s phone.

Examples #

To understand better all these query parameters now here we have some visual examples of its usage. We difference 2 types of query params, static and dynamic ones. The static must be set by the user or the integrator and they do not change with the usage of the app, some examples are the email, apikey, language, hiding options, etc. The ones that change dynamically will mutate the url as we use the user interface by: changing between buildings, floors and POIs, tracing routes, … the url will be modified according to the action done.

email & apikey #

These two parameters are used together, they allow you to use your account and access to your organization’s available buildings.

https://map-viewer.situm.com/?email=<your_email_here>&apikey=<your_api_key_here>

buildingid & floorid #

These two parameters are used together, they trigger the display of the map in the specified floor that belongs to the specified building.

https://map-viewer.situm.com/?buildingid=7033&floorid=14467

Building and floor visualization

poiid #

This parameter centers the view on the specified POI and shows the available information at the superior left corner. It usually goes with buildingid and floorid, but if you have permission to view a certain POI and you pass this param without building and floor identifiers these two missing params will autocomplete.

https://map-viewer.situm.com/?poiid=47204

POI visualization

navigation_to #

Once a POI is selected you can ask directions to get to it from a certain position, to do this first it is needed to pick a destination. The destination is specified on the navigation_to query param.

https://map-viewer.situm.com/?buildingid=7033&floorid=14467&navigation_to=47204

Route destination selected

navigation_from #

When the destination is selected, only the origin is missing to finish the route calculation. To do this we have navigation_from, which specifies the POI where you are expected to be and you are starting to walk towards the destination.

In the User Interface, once both origin and destination are selected, you need to click ‘Calculate Route’ button to start the journey.

https://map-viewer.situm.com/?buildingid=7033&floorid=14467&navigation_to=47204&poiid=47196&navigation_from=47196

Route origin selected

lng #

Use lng query param to force User Interface to be on a specific locale.

https://map-viewer.situm.com/?lng=es&poiid=47196&navigation_from=47196&navigation_to=47204&buildingid=7033&floorid=14467

UI translated to Spanish

hide #

This query param can receive a comma separated list of element that can will indicate the element that can hide.

In the following image we mark the elements that can be hidden and the name of the input you can submit in the hide list.

Elements from layout that can be hidden

https://map-viewer.situm.com/?hide=lc,mc,pn&buildingid=7033&floorid=14467

wl #

This param (which comes from White Label) receives a boolean, by default we asume it is false when not specified, but when it is true it will hide organization’s logo.

https://map-viewer.situm.com/?wl=true&buildingid=7033&floorid=14467

Exploration control without logo

rtl #

Same way as wl parameter this param (that means right to left) receives a boolean, by default false, that when it is true mirrors the elements of the interface to adapt the UI to right to left languages. It is commonly used with lng=ar.

https://map-viewer.situm.com/?rtl=true&buildingid=7033&floorid=14467

Right to left layout

Subscribe to our newsletter

BASIC INFORMATION ON DATA PROTECTION

Data controller: SITUM TECHNOLOGIES, S.L.
Contact: Data controller: situm@situm.es
Responsible for protection: dpo@situm.es
Purpose and legal basis: To manage the sending of SITUM newsletters only with consent.
Legitimation: Express consent of the interested party.
Recipients: The data will not be passed on to third parties with the exception of legal obligations.
Retention period: As long as the interested party remains subscribed to the newsletter (a link to unsubscribe will be available in each newsletter sent by Situm).
Rights: The interested party may at any time revoke their consent, as well as exercise their rights of opposition, access, conservation, rectification, limitation, deletion of data and not be subject to a decision based only on automated data processing, by writing to SITUM at the addresses indicated.
Additional Information: You can consult additional and detailed information on Data Protection in our privacy policy.

Please, download your copy here

Thank you for downloading our whitepaper. Please do not hesitate to contact us if you would like to know more about how our solutions can help your business. Download whitepaper


Close window