Class UserInterfaceConfiguration

    • Constructor Detail

    • Method Detail

      • getAccessibilityAnnouncePeriodInSec

         int getAccessibilityAnnouncePeriodInSec()

        Get accessibilityAnnouncePeriodInSec. Duration in seconds to repeat the same announcements, in accessibility mode. Default is 10

        Returns:

        accessibilityAnnouncePeriodInSec value

      • getAccuracyCircleStaticColor

        @NonNull() String getAccuracyCircleStaticColor()

        Get accuracyCircleStaticColor. The color used for the accuracy circle drawn around the user pin in HEX Default is "007AFF"

        Returns:

        accuracyCircleStaticColor value

      • getAccuracyCircleStaticColour

        @NonNull() String getAccuracyCircleStaticColour()

        Get accuracyCircleStaticColour. The color used for the accuracy circle drawn around the user pin in HEX Default is "007AFF"

        Returns:

        accuracyCircleStaticColour value

      • getDefaultLocationZoomLevel

         float getDefaultLocationZoomLevel()

        Get defaultLocationZoomLevel. Default zoom level to use while focusing to any location. Default is 18.0

        Returns:

        defaultLocationZoomLevel value

      • getDefaultOutdoorLocationZoomLevel

         float getDefaultOutdoorLocationZoomLevel()

        Get defaultOutdoorLocationZoomLevel. The default zoom level for outdoors Default is 18.0

        Returns:

        defaultOutdoorLocationZoomLevel value

      • getDisableScreenDimDuringWayfinding

         boolean getDisableScreenDimDuringWayfinding()

        Get disableScreenDimDuringWayfinding. If whether the screen should not be dimmed during wayfinding. Default is true

        Returns:

        disableScreenDimDuringWayfinding value

      • getDistanceUnit

         int getDistanceUnit()

        Get distanceUnit. What type of units should be used for distance in the UI Default is 0

        Returns:

        distanceUnit value

      • getEnableDynamicMinimumZoomLevel

         boolean getEnableDynamicMinimumZoomLevel()

        Get enableDynamicMinimumZoomLevel. If set true, minimumZoomLevel is dynamically calculated to a value enough to see the whole site Default is true

        Returns:

        enableDynamicMinimumZoomLevel value

      • getFlyOverAnimationDuration

         float getFlyOverAnimationDuration()

        Get flyOverAnimationDuration. Duration in seconds it takes to do the loading fly over animation. Default is 3.0

        Returns:

        flyOverAnimationDuration value

      • getFlyOverAnimationHeading

         float getFlyOverAnimationHeading()

        Get flyOverAnimationHeading. Heading of the map at the end of the fy over animation. Default is 0.0

        Returns:

        flyOverAnimationHeading value

      • getFlyOverTiltAngleInDegrees

         float getFlyOverTiltAngleInDegrees()

        Get flyOverTiltAngleInDegrees. Default is 45.0

        Returns:

        flyOverTiltAngleInDegrees value

      • getIsOfflineMapsEnabled

         boolean getIsOfflineMapsEnabled()

        Get isOfflineMapsEnabled. Enable/Disable offline maps feature Default is true

        Returns:

        isOfflineMapsEnabled value

      • getIsSearchCategoriesEnabled

         boolean getIsSearchCategoriesEnabled()

        Get isSearchCategoriesEnabled. If whether the categories search UI is enabled. Default is true

        Returns:

        isSearchCategoriesEnabled value

      • getMapWidgetLocationDataTimeoutInSeconds

         int getMapWidgetLocationDataTimeoutInSeconds()

        Get mapWidgetLocationDataTimeoutInSeconds. After how much time map widget will timeout waiting for location data (seconds). Default is 20

        Returns:

        mapWidgetLocationDataTimeoutInSeconds value

      • getMapWidgetMapTilesTimeoutInSeconds

         int getMapWidgetMapTilesTimeoutInSeconds()

        Get mapWidgetMapTilesTimeoutInSeconds. After how much time map widget will timeout waiting for map tiles (seconds). Default is 30

        Returns:

        mapWidgetMapTilesTimeoutInSeconds value

      • getMapWidgetMapUrlTimeoutInSeconds

         int getMapWidgetMapUrlTimeoutInSeconds()

        Get mapWidgetMapUrlTimeoutInSeconds. After how much time map widget will timeout waiting for map url (seconds). Default is 30

        Returns:

        mapWidgetMapUrlTimeoutInSeconds value

      • getMapWidgetPathDataTimeoutInSeconds

         int getMapWidgetPathDataTimeoutInSeconds()

        Get mapWidgetPathDataTimeoutInSeconds. After how much time map widget will timeout waiting for path data (seconds). Default is 30

        Returns:

        mapWidgetPathDataTimeoutInSeconds value

      • getMapWidgetPoiDataTimeoutInSeconds

         int getMapWidgetPoiDataTimeoutInSeconds()

        Get mapWidgetPoiDataTimeoutInSeconds. After how much time map widget will timeout waiting for poi data (seconds). Default is 30

        Returns:

        mapWidgetPoiDataTimeoutInSeconds value

      • getMapWidgetSiteDataTimeoutInSeconds

         int getMapWidgetSiteDataTimeoutInSeconds()

        Get mapWidgetSiteDataTimeoutInSeconds. After how much time map widget will timeout waiting for site data (seconds). Default is 60

        Returns:

        mapWidgetSiteDataTimeoutInSeconds value

      • getMaxZoomScale

         float getMaxZoomScale()

        Get maxZoomScale. Maximum zoom level allowed for the map Default is 18.5

        Returns:

        maxZoomScale value

      • getMaximumZoomLevel

         float getMaximumZoomLevel()

        Get maximumZoomLevel. Maximum zoom level allowed for the map Default is 18.5

        Returns:

        maximumZoomLevel value

      • getMinZoomScale

         float getMinZoomScale()

        Get minZoomScale. Minimum zoom level allowed for the map Default is 16.0

        Returns:

        minZoomScale value

      • getMinimumZoomLevel

         float getMinimumZoomLevel()

        Get minimumZoomLevel. Minimum zoom level allowed for the map Default is 16.0

        Returns:

        minimumZoomLevel value

      • getPathColor

        @NonNull() String getPathColor()

        Get pathColor. The color of the displayed path in HEX format Default is "0080FF"

        Returns:

        pathColor value

      • getPathDirectionThresholdInMeters

         float getPathDirectionThresholdInMeters()

        Get pathDirectionThresholdInMeters. Distance left to the next path direction, before we stop showing remaining Default is 5.0

        Returns:

        pathDirectionThresholdInMeters value

      • getPathTrackingTiltAngleInDegrees

         float getPathTrackingTiltAngleInDegrees()

        Get pathTrackingTiltAngleInDegrees. Default is 45.0

        Returns:

        pathTrackingTiltAngleInDegrees value

      • getPathWidth

         float getPathWidth()

        Get pathWidth. The width of the displayed path in points Default is 8.0

        Returns:

        pathWidth value

      • getQuickAccessTiltAngleInDegrees

         float getQuickAccessTiltAngleInDegrees()

        Get quickAccessTiltAngleInDegrees. Default is 45.0

        Returns:

        quickAccessTiltAngleInDegrees value

      • getRotationalTrackingCameraAngleThreshold

         float getRotationalTrackingCameraAngleThreshold()

        Get rotationalTrackingCameraAngleThreshold. How much the blue dot heading needs to change in order for the camera to rotate. Default is 10.0

        Returns:

        rotationalTrackingCameraAngleThreshold value

      • getShouldFocusOnFirstUserLocation

         boolean getShouldFocusOnFirstUserLocation()

        Get shouldFocusOnFirstUserLocation. If this parameter is true, then the map will focus on the user location when it first becomes available even if the user is browsing a different building Default is true

        Returns:

        shouldFocusOnFirstUserLocation value

      • getTurnBackAngleThresholdInDegrees

         float getTurnBackAngleThresholdInDegrees()

        Get turnBackAngleThresholdInDegrees. Default is 120.0

        Returns:

        turnBackAngleThresholdInDegrees value