changeBackgroundMapProps Method

Beta  

Modify a subset of the background map display settings.

changeBackgroundMapProps(props: BackgroundMapProps): void

note If the style is associated with a Viewport, Viewport.changeBackgroundMapProps should be used instead to ensure the view updates immediately.

see backgroundMap for toggling display of the map.

Example that changes only the elevation, leaving the provider and type unchanged:

 style.changeBackgroundMapProps({ groundBias: 16.2 });

Returns - void

Defined in

• core/frontend/src/DisplayStyleState.ts Line 129

Last Updated: 13 June, 2024