Type alias TShowVenueOptions

TShowVenueOptions: {
    backgroundAlpha?: number;
    backgroundColor?: string;
    firstMapId?: string;
    labelAllLocationsOnInit?: boolean;
    loadOptions?: {
        mapRenderStrategy?: MAP_RENDER_MODE;
    };
    multiBufferRendering?: boolean;
    outdoorContext?: {
        authURL?: string;
        enabled?: boolean;
        url?: string;
    };
    xRayPath?: boolean;
}

Type declaration

  • 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 outdoorContext?: {
        authURL?: string;
        enabled?: boolean;
        url?: string;
    }

    Enable outdoor context. Requires multi-buffer rendering to be enabled

    • Optional authURL?: string
    • Optional enabled?: boolean
    • Optional url?: string
  • 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