Interface WebGLMapConstructorOptions

Defines the map options to be used when creating a new WebGLMap.

Hierarchy

Properties

adjustDepthRange? axes? border? globeColor? maxMemoryUsageHint? reference? wrapAroundWorld?

Properties

Optional adjustDepthRange

adjustDepthRange?: boolean

Whether the near and far planes of the map's camera should automatically adjust when the camera or terrain gets updated. See adjustDepthRange for more information.

Since

2022.0

Optional axes

axes?: {
    xAxis?: AxisConfiguration;
    yAxis?: AxisConfiguration;
}

Specifies the configuration of the X and Y axis.

Type declaration

Optional border

border?: {
    bottom?: number;
    left?: number;
}

The border configuration.

Type declaration

  • Optional bottom?: number

    The size - in pixels - of the bottom border.

  • Optional left?: number

    The size - in pixels - of the left border.

Optional globeColor

globeColor?: null | string

A CSS color used in 3D for the globe, if no imagery layers are present. See Map.globeColor for details.

Default

"rgba(204,204,204,1.0)"

Optional maxMemoryUsageHint

maxMemoryUsageHint?: WebGLMapMemoryUsageHint

A hint about the memory consumption allowed by this application. See maxMemoryUsageHint for more information.

Optional reference

reference?: string | CoordinateReference

The reference of the map, that can be a reference retrieved from the ReferenceProvider or a string. This is usually a reference with a cartesian CoordinateType. When a geodetic reference is supplied, the reference will be internally converted to a reference with an equidistant projection.

For 3D, use geocentric reference (EPSG:4978) (only in a WebGLMap).

If not specified, the map will be 2D with an equi-distant cylindrical reference (EPSG:32662).

Optional wrapAroundWorld

wrapAroundWorld?: boolean

Whether the map should wrap around the dateline or not.

This is only supported when the following conditions are fulfilled:

  • The map must be a WebGLMap
  • The map's reference must have a cylindrical projection (e.g. Mercator or Equidistant cylindrical)
  • The cylindrical projection must have a central meridian equal to 0

If any of these conditions are not fulfilled, Map.wrapAroundWorld will be forced to false.

For more information on working with maps that wrap around the dateline, check out the Configuring a map to wrap around the dateline guide.

Default

false

Since

2023.1

Settings

Member Visibility

Theme