Type Alias MapLightingOptions

MapLightingOptions: {
    elevationLayersOnly?: boolean;
    enabled?: boolean;
    hillshadeAzimuth?: number;
    hillshadeIntensity?: number;
    hillshadeZenith?: number;
    mode?: MapLightingMode;
    zFactor?: number;
}

Options for map shading.

Type declaration

  • OptionalelevationLayersOnly?: boolean

    If true, only elevation layers are shaded leaving the color layers unshaded.

    Default Value

    false
  • Optionalenabled?: boolean

    Enables shading.

    Default Value

    false
  • OptionalhillshadeAzimuth?: number

    The azimuth of the sunlight direction, in degrees (0 = north, 180 = south, etc.). Note: only available if mode is MapLightingMode.Hillshade

    Default Value

    135
  • OptionalhillshadeIntensity?: number

    The intensity of the shade (0 = no shade, 1 = completely opaque shade). Note: only available if mode is MapLightingMode.Hillshade

    Default Value

    1
  • OptionalhillshadeZenith?: number

    The vertical angle of the sun, in degrees. (90 = zenith). Note: only available if mode is MapLightingMode.Hillshade

    Default Value

    45
  • Optionalmode?: MapLightingMode

    The shading mode.

    Default Value

    MapLightingMode.Hillshade

  • OptionalzFactor?: number

    The z-factor (vertical exaggeration) to apply to slopes before computing shading.

    Default Value

    1

Settings

Member Visibility