Type alias TMapViewOptionsLegacy

TMapViewOptionsLegacy: {
    alpha?: boolean;
    antialias?: boolean;
    backgroundAlpha?: number;
    backgroundColor?: string;
    disableHover?: boolean;
    disableZoomOnMapSizeChange?: boolean;
    firstMap?: MappedinMap | string;
    loadOptions?: {
        mode?: "json" | "obj";
        zoomOverrides?: {
            focusZoomFactorPolygon: unknown;
            zoomMultiplier: unknown;
        };
    };
    markerWorldIslandSplit?: boolean;
    multiBufferRendering?: boolean;
    onDataLoaded?: ((venue?) => void);
    onFirstMapLoaded?: ((venue?) => void);
    onWebGLContextCreationError?: (() => void);
    onWebGLContextLost?: (() => void);
    onWebGLContextRestored?: (() => void);
    onWebGLRendererError?: (() => void);
}

Type declaration

  • Optional alpha?: boolean

    True if the opacity argument to setBackgroundColor should be considered.

    Default

    true
  • Optional antialias?: boolean

    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 backgroundAlpha?: number

    The opacity of the initial background color.

  • Optional backgroundColor?: string

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

  • Optional disableHover?: boolean

    If you would like to completely disable the hover effect (if you are on a touch screen for example), set this to true.

    Default

    false;
  • Optional disableZoomOnMapSizeChange?: boolean
  • Optional firstMap?: MappedinMap | string

    First map to be rendered

  • Optional loadOptions?: {
        mode?: "json" | "obj";
        zoomOverrides?: {
            focusZoomFactorPolygon: unknown;
            zoomMultiplier: unknown;
        };
    }
    • Optional mode?: "json" | "obj"
    • Optional zoomOverrides?: {
          focusZoomFactorPolygon: unknown;
          zoomMultiplier: unknown;
      }
      • focusZoomFactorPolygon: unknown
      • zoomMultiplier: unknown
  • Optional markerWorldIslandSplit?: boolean
  • Optional Beta multiBufferRendering?: boolean
  • Optional onDataLoaded?: ((venue?) => void)
      • (venue?): void

      • A callback executed with the 3D files have been downloaded for the first Map, and are starting to load into memory. The MapView is fully functional at this point, but some things will still be popping in.

        Parameters

        Returns void

  • Optional onFirstMapLoaded?: ((venue?) => void)
      • (venue?): void

      • A callback executed when the first map is fully loaded. This means onDataLoaded has already been fired (if specified) and then all the textures and other resources have finished popping in.

        Parameters

        Returns void

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

      • Returns void

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

      • Returns void

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

      • Returns void

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

      • Returns void

Settings

Member Visibility

Theme