The graphics effects that can be applied to a map.
You cannot create a GraphicsEffects. Instead, you can retrieve it from Map.effects and assign properties.
For example:

  map.effects.light = null;
map.effects.atmosphere = false;

The order in which effects are applied, if enabled, is:

  • Star field
  • Atmosphere
  • Environment map
  • Lighting + shadows
  • Ambient occlusion
  • Eye-dome lighting
  • Anti-aliasing
  • Bloom
  • Fog
  • Depth-of-field

Implements

Constructors

Accessors

  • get antiAliasing(): boolean
  • Enable anti-aliasing on the entire map.

    The anti-aliasing algorithm is FXAA.

    Note that anti-aliasing is only applied in 3D views. In 2D views, most content is already anti-aliased anyway: imagery, lines and icons.

    Returns boolean

    off
    

    2020.0

  • set antiAliasing(fxaa): void
  • Parameters

    • fxaa: boolean

    Returns void

  • get atmosphere(): null | boolean | LightScatteringAtmosphere
  • Configures the atmosphere to be painted on a 3D view.

    By default, a basic atmosphere effect is on.
    This look is unaffected by lighting. You can also use a LightScatteringAtmosphere that approximates the behavior of light in the atmosphere. This provides more accurate time of day effects.
    Set to null or false to disable the atmosphere.

    Returns null | boolean | LightScatteringAtmosphere

    on in 3D
    
  • set atmosphere(atmosphere): void
  • Parameters

    Returns void

  • get bloom(): null | BloomEffect
  • This property allows you to configure blooming. Shapes with a bloom style will display blooming if this effect is enabled.

    Returns null | BloomEffect

    on
    

    2022.1

  • set bloom(bloom): void
  • Parameters

    Returns void

  • get environmentMap(): null | EnvironmentMapEffect
  • This property allows you to visualize an environment map instead of for example an atmosphere. It can be used to create scenes with detailed background imagery.

    Note that this effect is applied after the atmosphere.

    Returns null | EnvironmentMapEffect

    off
    

    2021.1

  • set environmentMap(map): void
  • Parameters

    Returns void

  • get eyeDomeLighting(): null | EyeDomeLightingEffect
  • The eye-dome lighting effect that is used.

    Eye-dome lighting (EDL) is a non-photorealistic lighting model, which helps accentuate the shapes of different objects to improve depth perception, by shading their outlines.

    Note that eye-dome lighting is only applied in 3D views.

    Returns null | EyeDomeLightingEffect

    off
    

    2020.0

  • set eyeDomeLighting(edl): void
  • Parameters

    Returns void

  • get fog(): null | FogEffect
  • The fog effect that is used.

    Note that fog is only applied in 3D views.

    Returns null | FogEffect

    off
    

    2023.1

  • set fog(fog): void
  • Parameters

    Returns void

  • get light(): unknown
  • The light effect that is used.

    You can use the factory methods in the LightEffect module to create new instances.
    See the LightEffect module for more information on what lights are supported on what views.

    By default a head light is used.
    Set to null to disable lighting.

    Returns unknown

    headlight in 3D
    
  • set light(light): void
  • Parameters

    • light: unknown

    Returns void

  • get starfield(): boolean
  • Indicates if a starfield should be painted when zoomed in on a 3D view.

    By default, the starfield property is set to true on geocentric maps and false on 3D cartesian maps.
    Set to false to disable the starfield.

    Returns boolean

    on in 3D geocentric, off in 3D cartesian
    
  • set starfield(starfield): void
  • Parameters

    • starfield: boolean

    Returns void

Events

  • Event hook that is called when effect has changed.

    Parameters

    • event: "LightEffectChanged"

      The "LightEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the light effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when effect has changed.

    Parameters

    • event: "AtmosphereEffectChanged"

      The "AtmosphereEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the atmosphere effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when effect has changed.

    Parameters

    • event: "StarfieldEffectChanged"

      The "StarfieldEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the starfield effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when ambient occlusion effect has changed.

    Parameters

    • event: "AmbientOcclusionEffectChanged"

      The "AmbientOcclusionEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the ambient occlusion effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when effect has changed.

    Parameters

    • event: "FogEffectChanged"

      The "FogEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the fog effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when depth of field effect has changed.

    Parameters

    • event: "DepthOfFieldEffectChanged"

      The "DepthOfFieldEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the depth of field effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when eye-dome lighting effect has changed.

    Parameters

    • event: "EyeDomeLightingEffectChanged"

      The "EyeDomeLightingEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the eye-dome lighting effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when anti-aliasing effect has changed.

    Parameters

    • event: "AntiAliasingEffectChanged"

      The "AntiAliasingEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the anti-aliasing effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when effect has changed.

    Parameters

    • event: "BloomEffectChanged"

      The "BloomEffectChanged" event type

    • callback: (() => void)

      Callback to be invoked when the bloom effect has changed.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when GraphicsEffects.environmentMap is set and loading has started. The new environment map is not guaranteed to have finished loading when this event is triggered.

    Parameters

    • event: "EnvironmentMapEffectLoadingStarted"

      The "EnvironmentMapEffectLoadingStarted" event type

    • callback: (() => void)

      Callback to be invoked when the environment map effect is set and has started loading.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when a previously set GraphicsEffects.environmentMap has finished loading.

    Parameters

    • event: "EnvironmentMapEffectLoadingFinished"

      The "EnvironmentMapEffectLoadingFinished" event type

    • callback: (() => void)

      Callback to be invoked when a previously set environment map effect has finished loading.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01

  • Event hook that is called when a previously set GraphicsEffects.environmentMap cannot be loaded.

    Parameters

    • event: "EnvironmentMapEffectError"

      The "EnvironmentMapEffectError" event type

    • callback: (() => void)

      Callback to be invoked when a previously set environment map effect failed to load.

        • (): void
        • Returns void

    Returns Handle

    2024.1.01