Skip To Content ArcGIS for Developers Sign In Dashboard

BackgroundGrid QML Type

Background for contents of MapView or SceneView. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Detailed Description

BackgroundGrid is the grid that displays behind a Map in a MapView, or a Surface in a SceneView. If there is no map or surface provided, an empty view will display with only the BackgroundGrid.

Example:

Change the MapView's background grid (JavaScript):

var newGrid = ArcGISRuntimeEnvironment.createObject("BackgroundGrid");
newGrid.color = "white";
newGrid.gridLineColor = "black";
newGrid.gridLineSize = 5;
newGrid.gridSize = 50;
mapView.backgroundGrid = newGrid;

Property Documentation

color : color

The fill color of the background. The default value is Silver ("#C0C0C0").


gridLineColor : color

The color of the background grid lines. The default value is Black ("#FFFFFF").


gridLineWidth : double

The width (in DIPs) of the background grid lines. The default value is 1.


gridSize : double

The size (in DIPs) of background grid. The default value is 20.0.


visible : bool

Whether the grid should be visible in the background. The default value is true.

This QML property was introduced in Esri.ArcGISRuntime 100.3.


Signal Documentation

colorChanged()

Emitted when the color property of this BackgroundGrid changes.


gridLineColorChanged()

Emitted when the gridLineColor property of this BackgroundGrid changes.


gridLineWidthChanged()

Emitted when the gridLineWidth property of this BackgroundGrid changes.


gridSizeChanged()

Emitted when the gridSize property of this BackgroundGrid changes.


visibleChanged()

Emitted when the visible property of this BackgroundGrid changes.

This QML signal was introduced in Esri.ArcGISRuntime 100.3.



Feedback on this topic?