backgroundMapSettings

Accessor

The settings controlling how a background map is displayed within a view.

get: BackgroundMapSettings

see backgroundMap for toggling display of the map on or off.

note If this display style is associated with a Viewport, prefer to use Viewport.backgroundMapSettings to change the settings to ensure the Viewport's display updates immediately.

Returns - BackgroundMapSettings


Setter

The settings controlling how a background map is displayed within a view.

set(settings: BackgroundMapSettings): void

see backgroundMap for toggling display of the map on or off.

note If this display style is associated with a Viewport, prefer to use Viewport.backgroundMapSettings to change the settings to ensure the Viewport's display updates immediately.

Parameter Type Description
settings BackgroundMapSettings  

Returns - void

Defined in

Last Updated: 13 June, 2024