GraphicsOverlayListModel QML Type

Properties
Signals
Methods
Detailed Description

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

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

List of all members, including inherited members

Properties

count : int

Signals

countChanged()
graphicsOverlayAdded(index)
graphicsOverlayRemoved(index)

Methods

void append(graphicsOverlay)
void clear()
bool contains(graphicsOverlay)
void forEach(callback)
GraphicsOverlay get(index)
int indexOf(graphicsOverlay)
void insert(index, GraphicsOverlay graphicsOverlay)
void move(from, int to)
void remove(index, int count = 1)
void removeOne(graphicsOverlay)
void setProperty(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:

Role	Type	Description
minScale	double	The minimum scale at which the graphics should be displayed.
maxScale	double	The maximum scale at which the graphics should be displayed.
graphicsOverlayOpacity	real	The opacity of the graphics.
graphicsOverlayVisible	bool	Whether the graphics overlay is visible.
selectionColor	color	The selection color applied to selected graphics.
overlayId	string	The 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.

Note: The corresponding handler is onCountChanged.

graphicsOverlayAdded(index)

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

Note: The corresponding handler is onGraphicsOverlayAdded.

graphicsOverlayRemoved(index)

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

Note: The corresponding handler is onGraphicsOverlayRemoved.

Method Documentation

void append(graphicsOverlay)

Appends a graphicsOverlay to the GraphicsOverlay list model.

void clear()

Removes all GraphicsOverlays from the list model.

bool contains(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:

element Current graphics overlay.
index Current index in array.
array Reference to GraphicsOverlayListModel.

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(index)

Returns the GraphicsOverlay at the specified index.

int indexOf(graphicsOverlay)

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

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

void insert(index, GraphicsOverlay graphicsOverlay)

Inserts a graphicsOverlay at a specified index in the list.

void move(from, int to)

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

void remove(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)

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

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

void setProperty(index, string property, variant value)

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

Qt SDK

Contents