API Reference > imodeljs-frontend > Views > DisplayStyleState > setBackgroundMap

setBackgroundMap Method

Deprecated  

Modify the background map display settings.

setBackgroundMap(mapProps: BackgroundMapProps): void

see backgroundMap for toggling display of the map.

see DisplayStyleState.backgroundMapSettings and DisplayStyleState.changeBackgroundMapProps for a more convenient API, particularly when you want to change only a subset of the map settings.

note Currently the behavior of this method is not ideal.

  • If this display style is associated with a Viewport, you must call Viewport.invalidateScene for the view to display the new map.
  • Any properties omitted from mapProps will be reset to their defaults.
  • All loaded tiles will be discarded and new ones will be requested, even if only changing the groundBias.
Parameter Type Description
mapProps BackgroundMapProps JSON representation of the new settings.

Returns - void

Defined in

Last Updated: 13 June, 2024