Using Query Parameters to Configure Pointr Web SDK¶

Query parameters allow you to easily customize the Pointr Web SDK for different tasks and use cases by adding specific parameters to your URL. This is useful for tailoring the SDK to various scenarios, such as showing locations, setting wayfinding, and adjusting the map view.

This guide will show you how to use query parameters for scenarios like:

• Show Specific Locations (site, building, level, POI, or custom point)
• Set Wayfinding Points (start/destination POI or custom point)
• Auto-Start Navigation between two points (POI or custom point)
• Enable Accessible Mode for wayfinding automatically
• Predefine Map Language
• Adjust Map View (location, orientation, initial zoom level)

Example: You can configure the Web SDK to automatically start wayfinding from Point A to Point B when the map is loaded using a simple query parameter.

Displaying a Specific Site¶

Add ptrSiteInternalIdentifier query parameter to the URL to show a specific site.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>

Displaying a Specific Building¶

Add ptrSiteInternalIdentifier and ptrBuildingInternalIdentifier query parameters to the URL to show a specific building.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrBuildingInternalIdentifier=<BID>

Displaying a Specific Floor¶

Add ptrSiteInternalIdentifier, ptrBuildingInternalIdentifier, and ptrLevelIndex query parameters to the URL to show a specific floor.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrBuildingInternalIdentifier=<BID>&ptrLevelIndex=<LEVEL_INDEX>

Highlighting a Specific POI¶

Add ptrSiteInternalIdentifier, ptrHighlightPoiIdentifier query parameters to the URL to show a specific poi.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrHighlightPoiIdentifier=<POI_FID>

Setting a Starting POI for Wayfinding¶

Add ptrSiteInternalIdentifier and ptrNavigationStartPoi query parameters to the URL to set the starting point of the navigation.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrNavigationStartPoi=<POI_FID>

Setting a Destination POI for Wayfinding¶

Add ptrSiteInternalIdentifier and ptrNavigationDestinationPoi query parameters to the URL to set the destination point of the navigation.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrNavigationDestinationPoi=<POI_FID>

Starting Wayfinding Automatically Between Two POIs¶

Add ptrSiteInternalIdentifier, ptrNavigationStartPoi and ptrNavigationDestinationPoi query parameters to the URL to start a navigation automatically.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrNavigationStartPoi=<POI_FID>&ptrNavigationDestinationPoi=<POI_FID>

Starting Wayfinding Automatically Between Two Points¶

Add ptrSiteInternalIdentifier, ptrBuildingInternalIdentifier, ptrStartLevelIndex, ptrStartPointLat, ptrStartPointLng, ptrDestinationLevelIndex, ptrDestinationPointLat, ptrDestinationPointLng query parameters to the URL to start a navigation automatically.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrBuildingInternalIdentifier=<BID>&ptrStartLevelIndex=<LEVEL_INDEX>&ptrStartPointLat=<LATITUDE>&ptrStartPointLng=<LONGITUDE>&ptrDestinationLevelIndex=<LEVEL_INDEX>&ptrDestinationPointLat=<LATITUDE>&ptrDestinationPointLng=<LONGITUDE>

Highlighting a Specific Custom Point¶

Add ptrSiteInternalIdentifier, ptrBuildingInternalIdentifier, ptrLevelIndex, ptrHighlightPointLat, ptrHighlightPointLng query parameters to the URL to show a specific point with a pin.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrBuildingInternalIdentifier=<BID>&ptrLevelIndex=<LEVEL_INDEX>&ptrHighlightPointLat=<LATITUDE>&ptrHighlightPointLng=<LONGITUDE>

Setting a Starting Custom Point for Wayfinding¶

Add ptrSiteInternalIdentifier, ptrBuildingInternalIdentifier, ptrStartLevelIndex, ptrStartPointLat, ptrStartPointLng query parameters to the URL to set the starting point of the navigation.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrBuildingInternalIdentifier=<BID>&ptrStartLevelIndex=<LEVEL_INDEX>&ptrStartPointLat=<LATITUDE>&ptrStartPointLng=<LONGITUDE>

Setting a Destination Custom Point for Wayfinding¶

Add ptrSiteInternalIdentifier, ptrBuildingInternalIdentifier, ptrDestinationLevelIndex, ptrDestinationPointLat, ptrDestinationPointLng query parameters to the URL to set the destination point of the navigation.

https://yourWebSDKLink.com?ptrSiteInternalIdentifier=<SID>&ptrBuildingInternalIdentifier=<BID>&ptrDestinationLevelIndex=<LEVEL_INDEX>&ptrDestinationPointLat=<LATITUDE>&ptrDestinationPointLng=<LONGITUDE>

Set Default Language¶

Add ptrLanguageCode query parameter to the URL to set the default language.

https://yourWebSDKLink.com?ptrLanguageCode=<LANGUAGE_CODE>

To view all the supported languages and their codes, click here to learn more.

Set Map Location and Orientaion¶

Available options:

• ptrInitialZoomLevel
• ptrLatitude
• ptrLongitude
• ptrBearing (0-360)
• ptrPitch (0-60)

https://yourWebSDKLink.com?ptrInitialZoomLevel=<ZOOM_LEVEL>&ptrLatitude=<LATITUDE>&ptrLongitude=<LONGITUDE>&ptrBearing=<BEARING>&ptrPitch=<PITCH>

All Available Query Parameters¶

Below is a complete list of all available parameters for customizing your Web SDK views. Please note that some parameters may override others when used together.

• ptrShouldStartAccessibilityEnabled: Set true to enable accessible wayfinding mode
• ptrSiteInternalIdentifier: Internal identifier for the site.
• ptrBuildingInternalIdentifier: Internal identifier for the building.
• ptrLevelIndex: Level index within the building.
• ptrSiteExternalIdentifier: External identifier for the site.
• ptrBuildingExternalIdentifier: External identifier for the building.
• ptrInitialZoomLevel: Initial zoom level.
• ptrLatitude: Latitude of the location.
• ptrLongitude: Longitude of the location.
• ptrBearing: Map bearing (rotation: 0-90).
• ptrPitch: Map pitch (angle: 0- 60).
• ptrMapMinZoom: Minimum zoom level (0-24).
• ptrMapMaxZoom: Maximum zoom level (0-24).
• ptrLanguageCode: Language code, see here for more details.
• ptrNavigationStartPoi: Navigate from a POI
• ptrNavigationDestinationPoi: Navigate to a POI
• ptrHighlightPoiIdentifier: Highlight a POI using a POI Identifier.
• ptrHighlightPointLat: The latitude of the custom point is to be highlighted.
• ptrHighlightPointLng: The length of the custom point is to be highlighted.
• ptrStartLevelIndex: Starting level index.
• ptrStartPointLat: Starting point latitude.
• ptrStartPointLng: Starting point longitude.
• ptrDestinationLevelIndex: Destination level index.
• ptrDestinationPointLat: Destination point latitude.
• ptrDestinationPointLng: Destination point longitude.