arcgis-maps-kotlin/com.arcgismaps.mapping.view/BackgroundGrid

BackgroundGrid

class BackgroundGrid

A background grid defines the default color and context grid for display behind a map or scene surface. The background grid determines what an empty MapView or scene Surface looks like. An instance of this class can be used to set a default backdrop that an ArcGISMap or ArcGISScene will display on top of.

Since

200.1.0

See also

Surface.backgroundGrid
ArcGISMap.backgroundColor

Constructors

Link copied to clipboard
constructor(color: Color = Color.white, lineColor: Color = Color.black, lineWidth: Float = 0.1f, size: Float = 20.0f)

Creates a background grid with the specified properties.

Properties

Link copied to clipboard
var color: Color

The background color of the grid. The default value is gray - RGBA(192,192,192,255).

Link copied to clipboard
var isVisible: Boolean

True if grid lines are visible on the BackgroundGrid.color, false otherwise. In the context of MapView, this value indicates if the BackgroundGrid.lineColor is visible. In the context of SceneView, this value indicates if both the BackgroundGrid.color and the BackgroundGrid.lineColor are visible. The default value is true.

Link copied to clipboard
var lineColor: Color

The color of the grid lines. The default value is black - RGBA(0,0,0,255).

Link copied to clipboard
var lineWidth: Float

The width of the grid lines in device-independent pixels (DIP). This value must be greater than or equal to 0. Setting the grid line width to 0 will make grid lines invisible. The default value is 0.1.

Link copied to clipboard
var size: Float

The size of each grid square in device-independent pixels (DIP). The default value is 20 x 20 pixels.