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

    Interface MapOptions

    Constructor options for the Map entity.

    interface MapOptions {
        backgroundColor?: ColorRepresentation;
        backgroundOpacity?: number;
        castShadow?: boolean;
        colorimetry?: ColorimetryOptions;
        contourLines?: boolean | Partial<ContourLineOptions>;
        depthTest?: boolean;
        discardNoData?: boolean;
        elevationRange?: ElevationRange;
        extent: Extent;
        forceTextureAtlases?: boolean;
        graticule?: boolean | Partial<GraticuleOptions>;
        lighting?: boolean | MapLightingOptions;
        maxSubdivisionLevel?: number;
        name?: string;
        object3d?: Object3D<Object3DEventMap>;
        outlineColor?: ColorRepresentation;
        receiveShadow?: boolean;
        showOutline?: boolean;
        side?: Side;
        subdivisionStrategy?: MapSubdivisionStrategy;
        subdivisionThreshold?: number;
        terrain?: boolean | Partial<TerrainOptions>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    backgroundColor? backgroundOpacity? castShadow? colorimetry? contourLines? depthTest? discardNoData? elevationRange? extent forceTextureAtlases? graticule? lighting? maxSubdivisionLevel? name? object3d? outlineColor? receiveShadow? showOutline? side? subdivisionStrategy? subdivisionThreshold? terrain?

    Properties

    backgroundColor?: ColorRepresentation

    The color of the map when no color layers are present.

    DEFAULT_MAP_BACKGROUND_COLOR

    backgroundOpacity?: number

    The opacity of the map background.

    1 (opaque)
    castShadow?: boolean

    If true, the map will cast shadow.

    true
    colorimetry?: ColorimetryOptions

    The colorimetry for the whole map. Those are distinct from the individual layers' own colorimetry.

    undefined
    contourLines?: boolean | Partial<ContourLineOptions>

    Enables contour lines. If undefined or false, contour lines are not displayed.

    Note: this option has no effect if the map does not contain an elevation layer.

    undefined (contour lines are disabled)

    depthTest?: boolean

    Enable or disable depth testing on materials.

    true
    discardNoData?: boolean

    If true, parts of the map that relate to no-data elevation values are not displayed. Note: you should only set this value to true if an elevation layer is present, otherwise the map will never be displayed.

    false
    elevationRange?: ElevationRange

    The optional elevation range of the map. The map will not be rendered for elevations outside of this range. Note: this feature is only useful if an elevation layer is added to this map.

    undefined (elevation range is disabled)
    extent: Extent

    The geographic extent of the map.

    Note: It must have the same CRS as the instance this map will be added to.

    forceTextureAtlases?: boolean

    Force using texture atlases even when not required.

    false
    graticule?: boolean | Partial<GraticuleOptions>

    The graticule options.

    undefined (graticule is disabled).
    lighting?: boolean | MapLightingOptions

    Lighting and shading parameters.

    undefined (lighting is disabled)

    maxSubdivisionLevel?: number

    Maximum tile depth of the map. If undefined, there is no limit to the subdivision of the map.

    undefined
    name?: string

    The optional display name of this entity. Mostly used for debugging.

    object3d?: Object3D<Object3DEventMap>

    The root object of this entity. If none is provided, a new Group is created.

    outlineColor?: ColorRepresentation

    The color of the tile borders.

    red
    receiveShadow?: boolean

    If true, the map will receive shadow. Note: only available if lighting.mode is MapLightingMode.LightBased

    true
    showOutline?: boolean

    Show the map tiles' borders.

    false
    side?: Side

    The sidedness of the map surface:

    • FrontSide will only display the "above ground" side of the map (in cartesian maps), or the outer shell of the map (in globe settings).
    • BackSide will only display the "underground" side of the map (in cartesian maps), or the inner shell of the map (in globe settings).
    • DoubleSide will display both sides of the map.

    FrontSide

    subdivisionStrategy?: MapSubdivisionStrategy

    The subdivision strategy used to subdivide map tiles.

    defaultMapSubdivisionStrategy

    subdivisionThreshold?: number

    The threshold before which a map tile is subdivided.

    DEFAULT_SUBDIVISION_THRESHOLD

    terrain?: boolean | Partial<TerrainOptions>

    Options for geometric terrain rendering.

    Settings

    Member Visibility

    On This Page

    Properties