BackgroundGrid QML Type

  • Esri.ArcGISRuntime
  • BackgroundGrid
  • Defines the default color and context grid for display behind a map or scene surface. More...

    Import Statement: import Esri.ArcGISRuntime
    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. The BackgroundGrid is not associated with the Grid that can be displayed over a MapView. The Map displays on top of the background grid or the optional Map.backgroundColor to determine what is displayed under transparent areas of the map.

    An instance of this class can be used to set a default backdrop that a Map or Scene will display on top of.

    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 of the grid lines in device-independent pixels (DIP). The default value is 1.

    This value must be greater than or equal to 0. Setting the grid line width to 0 will make grid lines invisible.


    gridSize : double

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


    [since Esri.ArcGISRuntime 100.3] visible : bool

    true if grid lines are visible on the color, false otherwise.

    In the context of MapView, this value indicates if the gridLineColor is visible. In the context of SceneView, this value indicates if both the color and the gridLineColor are visible. The default value is true.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    Signal Documentation

    colorChanged()

    Emitted when the color property of this BackgroundGrid changes.

    Note: The corresponding handler is onColorChanged.


    gridLineColorChanged()

    Emitted when the gridLineColor property of this BackgroundGrid changes.

    Note: The corresponding handler is onGridLineColorChanged.


    gridLineWidthChanged()

    Emitted when the gridLineWidth property of this BackgroundGrid changes.

    Note: The corresponding handler is onGridLineWidthChanged.


    gridSizeChanged()

    Emitted when the gridSize property of this BackgroundGrid changes.

    Note: The corresponding handler is onGridSizeChanged.


    [since Esri.ArcGISRuntime 100.3] visibleChanged()

    Emitted when the visible property of this BackgroundGrid changes.

    Note: The corresponding handler is onVisibleChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.