ArcGISSublayerListModel QML Type

A list model storing a list of sublayers available in a Layer. More...

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

Properties

count : int
error : Error

Signals

countChanged()
errorChanged()
itemAdded(int index)
itemRemoved(int index)

Methods

void append(ArcGISSublayer subLayer)
void clear()
bool contains(ArcGISSublayer subLayer)
error forEach(callback)
ArcGISSublayer get(int index)
int indexOf(ArcGISSublayer sublayer)
void insert(int index, ArcGISSublayer subLayer)
void move(int from, int to)
void remove(int index, int count)
void removeOne(ArcGISSublayer subLayer)

Detailed Description

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

A list model storing a list of sublayers.

Modifying this model (adding, removing, moving) results in updates to any objects that are currently referencing these sublayers.

The model returns data for the following roles:

Role	Type	Description
name	string	The sublayer's name.
sublayerVisible	bool	Whether the sublayer is enabled to be visible.
showInLegend	bool	Whether the sublayer will be shown in the legend.
sublayerId	int	The sublayer's ID.
minScale	double	The minumum scale at which the sublayer displays.
maxScale	double	The maximum scale at which the sublayer displays.
sublayerType	Enums.ArcGISSublayerType	The sublayer's type.
canChangeVisibility	bool	Whether the sublayer's visibility can be changed.
definitionExpression	string	The sublayer's definition expression (since Esri.ArcGISRuntime 100.1)
sublayerOpacity	real	The sublayer's opacity (since Esri.ArcGISRuntime 100.1)
scaleSymbols	bool	Whether the sublayer renderers its symbols based on scale (since Esri.ArcGISRuntime 100.1)
labelsEnabled	bool	Whether the sublayer's labels are displayed (since Esri.ArcGISRuntime 100.1)

Property Documentation

count : int

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

error : Error

Returns the Error object (read-only).

Signal Documentation

countChanged()

Emitted when the count property of the model changes.

Note: The corresponding handler is onCountChanged.

errorChanged()

Emitted when the error property changes, which can indicate that an error occurred.

Note: The corresponding handler is onErrorChanged.

itemAdded(int index)

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

Note: The corresponding handler is onItemAdded.

This signal was introduced in Esri.ArcGISRuntime 100.15.

itemRemoved(int index)

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

Note: The corresponding handler is onItemRemoved.

This signal was introduced in Esri.ArcGISRuntime 100.15.

Method Documentation

void append(ArcGISSublayer subLayer)

Appends a subLayer to the ArcGISSublayer list model.

void clear()

Removes all layers from the list model.

bool contains(ArcGISSublayer subLayer)

Returns true if the list model contains the specified subLayer.

error forEach(callback)

Receives a callback function to execute for each sub-layer in the model.

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

element Current sub-layer.
index Current index in array.
array Reference to ArcGISSublayerListModel.

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

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

ArcGISSublayer get(int index)

Returns the Sublayer at the specified index.

int indexOf(ArcGISSublayer sublayer)

Returns the index of the sublayer specified.

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

void insert(int index, ArcGISSublayer subLayer)

Inserts a subLayer at a specified index in the list.

void move(int from, int to)

Moves one layer 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(ArcGISSublayer subLayer)

Removes the specified sublayer (subLayer) from the list model.

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