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

    Interface MapLightingOptions

    Options for map shading.

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

    Properties

    elevationLayersOnly? enabled? hillshadeAzimuth? hillshadeIntensity? hillshadeZenith? mode? zFactor?

    Properties

    elevationLayersOnly?: boolean

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

    false
    enabled?: boolean

    Enables shading.

    false
    hillshadeAzimuth?: number

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

    135
    hillshadeIntensity?: number

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

    1
    hillshadeZenith?: number

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

    45
    mode?: MapLightingMode

    The shading mode.

    MapLightingMode.Hillshade

    zFactor?: number

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

    1

    Settings

    Member Visibility

    On This Page

    Properties