API (v2.0.0) - Giro3D
    Preparing search index...

    Interface InstanceOptions

    Options for creating Instance

    interface InstanceOptions {
        backgroundColor?: ColorRepresentation | null;
        camera?: PerspectiveCamera | OrthographicCamera;
        crs: CoordinateSystem;
        renderer?: WebGLRenderer | WebGLRendererParameters;
        scene3D?: Scene;
        target: string | HTMLDivElement;
    }
    Index

    Properties

    backgroundColor? camera? crs renderer? scene3D? target

    Properties

    backgroundColor?: ColorRepresentation | null

    The background color of the canvas. If null, the canvas is transparent. If undefined, the default color is used.

    '#030508'

    camera?: PerspectiveCamera | OrthographicCamera

    The THREE camera to use

    crs: CoordinateSystem

    The coordinate reference system of the scene. Must be a cartesian system. Must first be registered via CoordinateSystem.register

    renderer?: WebGLRenderer | WebGLRendererParameters

    The renderer to use. Might be either an instance of an existing WebGLRenderer, or options to create one. If undefined, a new one will be created with default parameters.

    scene3D?: Scene

    The Three.js Scene instance to use, otherwise a default one will be constructed

    target: string | HTMLDivElement

    The container for the instance. May be either the id of an existing <div> element, or the element itself.

    Settings

    Member Visibility

    On This Page

    Properties