Skip To Content ArcGIS for Developers Sign In Dashboard

GraphicsOverlayListModel QML Type

A list model storing a list of graphics overlays available in a GeoView. More...

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

Properties

Signals

Methods

  • void append(GraphicsOverlay graphicsOverlay)
  • void clear()
  • bool contains(GraphicsOverlay graphicsOverlay)
  • void forEach(callback )
  • GraphicsOverlay get(int index)
  • int indexOf(GraphicsOverlay graphicsOverlay)
  • void insert(int index, GraphicsOverlay graphicsOverlay)
  • void move(int from, int to)
  • void remove(int index, int count)
  • void removeOne(GraphicsOverlay graphicsOverlay)
  • void setProperty(int index, string property, variant value)

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

Modifying this model (adding, removing, moving) will update the graphics overlays available in the GeoView.

The model returns data for the following roles:

RoleTypeDescription
minScaledoubleThe minimum scale at which the graphics should be displayed.
maxScaledoubleThe maximum scale at which the graphics should be displayed.
graphicsOverlayOpacityrealThe opacity of the graphics.
graphicsOverlayVisibleboolWhether the graphics overlay is visible.
selectionColorcolorThe selection color applied to selected graphics.
overlayIdstringThe ID applied to selected graphics.

Property Documentation

count : int

Returns the number of objects in the model (read-only).


Signal Documentation

countChanged()

Emitted when the count property of the model changes.


graphicsOverlayAdded(int index)

Emitted when an object is added to the list model at the index specified in the parameter.


graphicsOverlayRemoved(int index)

Emitted when an object is removed from the list model at the index specified in the parameter.


Method Documentation

void append(GraphicsOverlay graphicsOverlay)

Appends a graphicsOverlay to the GraphicsOverlay list model.


void clear()

Removes all GraphicsOverlays from the list model.


bool contains(GraphicsOverlay graphicsOverlay)

Returns true if the list model contains the specified graphicsOverlay.


void forEach(callback )

Receives a callback function to execute for each graphics overlay in the model.

The callback function can take 0 to 3 optional arguments, in order:

Returns undefined if no error occurred, and an error message otherwise.

var error = graphicsOverlayListModel.forEach(function(element, index, array) {
    ...
});
if (error) {
    console.error(error.message);
}

GraphicsOverlay get(int index) const

Returns the GraphicsOverlay at the specified index.


int indexOf(GraphicsOverlay graphicsOverlay)

Returns the index of a specific graphics overlay (graphicsOverlay) from the list model.

This QML method was introduced in Esri::ArcGISRuntime 100.5..


void insert(int index, GraphicsOverlay graphicsOverlay)

Inserts a GraphicsOverlay at a specified index in the list.


void move(int from, int to)

Moves one GraphicsOverlay from an index in the list model to a different index.


void remove(int index, int count = 1)

Removes one or more objects starting at the specified index.

  • index Index of first object to remove.
  • count Number of objects to remove. This parameter defaults to 1.

void removeOne(GraphicsOverlay graphicsOverlay)

Removes the specified graphics overlay (graphicsOverlay) from the list model.

This QML method was introduced in Esri::ArcGISRuntime 100.5..


void setProperty(int index, string property, variant value)

Changes the property of the GraphicsOverlay at index in the list model to value.



Feedback on this topic?