Type Alias MapConstructorOptions

MapConstructorOptions: {
    backgroundColor?: ColorRepresentation;
    backgroundOpacity?: number;
    colorimetry?: ColorimetryOptions;
    contourLines?: boolean | ContourLineOptions;
    depthTest?: boolean;
    discardNoData?: boolean;
    elevationRange?: ElevationRange;
    extent: Extent;
    forceTextureAtlases?: boolean;
    graticule?: boolean | GraticuleOptions;
    hillshading?: boolean | HillshadingOptions;
    maxSubdivisionLevel?: number;
    object3d?: Object3D;
    outlineColor?: ColorRepresentation;
    segments?: number;
    showOutline?: boolean;
    side?: Side;
    subdivisionThreshold?: number;
    terrain?: boolean | TerrainOptions;
}

Type declaration

  • OptionalbackgroundColor?: ColorRepresentation

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

    Default Value

    DEFAULT_MAP_BACKGROUND_COLOR

  • OptionalbackgroundOpacity?: number

    The opacity of the map background.

    Default Value

    1 (opaque)
  • Optionalcolorimetry?: ColorimetryOptions

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

    Default Value

    undefined
  • OptionalcontourLines?: boolean | 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.

    Default Value

    undefined (contour lines are disabled)

  • OptionaldepthTest?: boolean

    Enable or disable depth testing on materials.

    Default Value

    true
  • OptionaldiscardNoData?: 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.

    Default Value

    false
  • OptionalelevationRange?: 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.

    Default Value

    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.

  • OptionalforceTextureAtlases?: boolean

    Force using texture atlases even when not required.

    Default Value

    false
  • Optionalgraticule?: boolean | GraticuleOptions

    The graticule options.

    Default Value

    undefined (graticule is disabled).
  • Optionalhillshading?: boolean | HillshadingOptions

    Enables hillshading. If undefined or false, hillshading is disabled.

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

    Default Value

    undefined (hillshading is disabled)

  • OptionalmaxSubdivisionLevel?: number

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

    Default Value

    undefined
  • Optionalobject3d?: Object3D

    The optional Object3D to use as the root object of this map. If none provided, a new one will be created.

  • OptionaloutlineColor?: ColorRepresentation

    The color of the tile borders.

    Default Value

    red
  • Optionalsegments?: number

    The number of geometry segments in each map tile. The higher the better. It must be power of two between 1 included and 256 included. Note: the number of vertices per tile side is segments + 1.

    Default Value

    DEFAULT_MAP_SEGMENTS

  • OptionalshowOutline?: boolean

    Show the map tiles' borders.

    Default Value

    false
  • Optionalside?: 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.

    Default Value

    FrontSide

  • OptionalsubdivisionThreshold?: number

    The threshold before which a map tile is subdivided.

    Default Value

    DEFAULT_SUBDIVISION_THRESHOLD

  • Optionalterrain?: boolean | TerrainOptions

    Options for geometric terrain rendering.

Settings

Member Visibility