Type alias TMapViewOptions

Type declaration

• Optional alpha?: boolean

  True if the opacity argument to setBackgroundColor should be considered.

  Default

  true
  Copy

• Optional antialias?: TAntialiasConfiguration["antialias"]

  Controls whether antialiasing is on. Defaults to true, as long as devicePixelRatio is 1. This is very expensive on high resolution screens.

  Default

  true
  Copy

• Optional Experimental antialiasQuality?: TAntialiasConfiguration["antialiasQuality"]

  Controls the antialiasing quality. Greater quality means less artifacts(less aliasing), but worse performance.

  Default

  'medium'
  Copy

• Optional Experimental aoEnabled?: TAOConfiguration["aoEnabled"]

  Enable ambient occlusion. Only works in single buffer mode and when device supports WebGL2.

  Default

  false
  Copy

• Optional Experimental aoQuality?: TAOConfiguration["aoQuality"]

  Change the quality of ambient occlusion in the scene. Greater quality means less noise, but worse performance.

  Default

  'medium'
  Copy

• Optional Experimental aoResolution?: TAOConfiguration["aoResolution"]

  Change the resolution of ambient occlusion. Lower resolution will see significant performance improvement at the cost of visual artifacting.

  Default

  'half'
  Copy

• Optional backgroundAlpha?: number

  The opacity of the initial background color.

• Optional backgroundColor?: string

  Background color of the map as a string e.g. #2e2e2e.

• Optional Experimental debug?: boolean

  Enable debug mode to check the visual representation of performance stats.

  Default

  false
  Copy

• Optional disableHover?: boolean

• Optional disableZoomOnMapSizeChange?: boolean

• Optional Experimental dynamicFocus?: {
      baseMap?: MappedinMap;
      buildingFullyVisibleZoomLevel?: number;
      indoorsFullyVisibleZoomLevel?: number;
      keepLayersActiveOnBaseMap?: string[];
      preloadDefaultMaps?: boolean;
      setMapAtZoomLevel?: number;
  }

  • Optional baseMap?: MappedinMap

    The Dynamic Focus Map to always be visible.

  • Optional buildingFullyVisibleZoomLevel?: number

    Mercator Zoom level when the outdoors geometry is fully visible.

  • Optional indoorsFullyVisibleZoomLevel?: number

    Mercator Zoom level where the indoors are fully visible.

  • Optional keepLayersActiveOnBaseMap?: string[]

    An array of base map layer names which should remain active when the focus has changed to a building map. This could include outdoor FloatingLabels or Markers that are attached to the base map.

  • Optional preloadDefaultMaps?: boolean

    Whether we should preload the default maps of each building. This will incur a cost up-front, but make transitions smoother.

    Default

    false
    Copy

  • Optional setMapAtZoomLevel?: number

    Level at which the map is "set", and colliders become visible.

• Optional Experimental dynamicPerformance?: boolean

  Adjust some quality settings automatically based on the current FPS. The algorithm will try to keep the FPS at 25 or higher by following the steps below:

  • If the FPS remains below 26 for the last 5 seconds, the ambient occlusion and antialiasing quality will be decreased.
  • If the FPS remains below 26 for the next 5 seconds, the ambient occlusion and antialiasing quality will be decreased again.
  • If the FPS remains below 26 for another 5 seconds, the ambient occlusion and antialiasing effects will be disabled, and path animation will be disabled, textures' anisotropy will be decreased. The same will happen if the FPS remains below 10 for the last 5 seconds.

  Default

  true
  Copy

• Optional firstMap?: MappedinMap | string

  First map to be rendered.

• Optional floatingLabels?: {
      iconSizeInterpolation?: {
          farScale: number;
          farZoomLevel: number;
          nearScale: number;
          nearZoomLevel: number;
      };
  }

  • Optional iconSizeInterpolation?: {
        farScale: number;
        farZoomLevel: number;
        nearScale: number;
        nearZoomLevel: number;
    }

    • farScale: number

    • farZoomLevel: number

    • nearScale: number

    • nearZoomLevel: number

• Optional Experimental layerGroups?: {
      layers: string[];
      opacityInterpolation?: {
          opacity: number;
          zoomLevel: number;
      }[] | {
          inputZoomLevel: number[];
          outputOpacity: number[];
      };
      visible?: boolean;
  }[]

  Defines which layers are visible or adds zoom based opacity interpolation

• Optional loadOptions?: {
      async?: boolean;
      mapRenderStrategy?: MAP_RENDER_MODE;
      outdoorGeometryLayers?: string[];
      useLivePolygons?: boolean;
      zoomOverrides?: {
          blueDotFollowingZoomFactor?: number;
          focusZoomFactorPolygon?: number;
          zoomMultiplier?: number;
      };
  }

  • Optional async?: boolean

  • Optional mapRenderStrategy?: MAP_RENDER_MODE

    By default, the SDK will merge all geometries by material to reduce the number of draw calls to the GPU To rever back to using a single geometry for every polygon, pass MAP_RENDER_MODE.MULTI_GEOMETRY

  • Optional Experimental outdoorGeometryLayers?: string[]

    Specify a list of layers that contain outdoor geometry

  • Optional useLivePolygons?: boolean

    Use the current polygon objects directly rather than what is stored when rendering the map in CMS.

    Important Considerations:

    • When this flag is set to true, the application will use live polygon data, which might not include certain enhancements such as 3D text annotations or automatically generated infill patterns. These features typically depend on the CMS's Render capabilities.
    • Opting for live polygons means the system will not utilize the pre-processed optimized polygon data that is available through the CMS's rendering pipeline.
    • This option is useful for applications requiring the most up-to-date representation of polygon data but may result in a less detailed visual representation due to the absence of certain rendered features.

    Use this option with caution, understanding the trade-offs between real-time update and visual detail.

  • Optional zoomOverrides?: {
        blueDotFollowingZoomFactor?: number;
        focusZoomFactorPolygon?: number;
        zoomMultiplier?: number;
    }

    • Optional blueDotFollowingZoomFactor?: number

    • Optional focusZoomFactorPolygon?: number

    • Optional zoomMultiplier?: number

• Optional Experimental multiBufferRendering?: boolean

  Multi-buffer rendering should improve performance but may cause issues on older GPUs/browsers

  Default

  false
  Copy

• Optional onWebGLContextCreationError?: (() => void)

  • • (): void

    • Returns void

• Optional onWebGLContextLost?: (() => void)

  • • (): void

    • Returns void

• Optional onWebGLContextRestored?: (() => void)

  • • (): void

    • Returns void

• Optional onWebGLRendererError?: (() => void)

  • • (): void

    • Returns void

• Optional Experimental outdoorView?: TOutdoorViewOptions & {
      enabled?: boolean;
  }

  Settings for experimental vector tile -based outdoor context Requires multiBufferRendering to be enabled.

• Optional shadingAndOutlines?: boolean

  Enable shading of bottoms of geometry along with outlines to make geometry stand out.

• Optional Experimental xRayPath?: boolean

  Journey path will be visible through other objects. Note: this is on by default, but requires the multiBufferRendering option (which is off by default) to be turned on.

  Default

  true
  Copy