Type alias TShowVenueOptions

Type declaration

• 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

  'full'
  Copy

• Optional backgroundAlpha?: number

  The opacity of the initial background color.

• Optional backgroundColor?: string

  Sets the initial background color of the map, including while loading.

• Optional firstMapId?: string

  The id of the first map to show on map load

• Optional labelAllLocationsOnInit?: boolean

  Whether or not to display default styled Floating Labels initially

• Optional loadOptions?: {
      mapRenderStrategy?: MAP_RENDER_MODE;
      useLivePolygons?: boolean;
  }

  • Optional Beta mapRenderStrategy?: MAP_RENDER_MODE

    Set the map render strategy in order to optimize FPS

  • 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 Experimental multiBufferRendering?: boolean

  Enable multi-buffer rendering

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

  Default

  false
  Copy

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

  Enable outdoor view. Requires multi-buffer rendering 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