Type alias TShowVenueOptions

TShowVenueOptions: {
    antialias?: TAntialiasConfiguration["antialias"];
    antialiasQuality?: TAntialiasConfiguration["antialiasQuality"];
    aoEnabled?: TAOConfiguration["aoEnabled"];
    aoQuality?: TAOConfiguration["aoQuality"];
    aoResolution?: TAOConfiguration["aoResolution"];
    backgroundAlpha?: number;
    backgroundColor?: string;
    firstMapId?: string;
    labelAllLocationsOnInit?: boolean;
    loadOptions?: {
        mapRenderStrategy?: MAP_RENDER_MODE;
    };
    multiBufferRendering?: boolean;
    outdoorView?: TOutdoorViewOptions & {
        enabled?: boolean;
    };
    shadingAndOutlines?: boolean;
    xRayPath?: boolean;
}

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
  • Optional Experimental antialiasQuality?: TAntialiasConfiguration["antialiasQuality"]

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

    Default

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

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

    Default

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

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

    Default

    'medium'
  • 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'
  • 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;
    }
    • Optional Beta mapRenderStrategy?: MAP_RENDER_MODE

      Set the map render strategy in order to optimize FPS

  • Optional Experimental multiBufferRendering?: boolean

    Enable multi-buffer rendering

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

    Default

    false
  • 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

Settings

Member Visibility

Theme