SubtypeSublayerListModel QML Type

A list model storing a list of subtype sublayers available in a SubtypeFeatureLayer. More...

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

Properties

count : int
error : Error

Signals

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

Methods

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

Detailed Description

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

A list model storing a list of subtype sublayers.

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

All of the roles are read-only in the current release.

The model returns data for the following roles:

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

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(SubtypeSublayer subtypeSublayer)

Appends a subtypeSublayer to the SubtypeSublayer list model.

void clear()

Removes all layers from the list model.

bool contains(SubtypeSublayer subtypeSublayer)

Returns true if the list model contains the specified subtypeSublayer.

error forEach(callback)

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

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

element - Current SubtypeSublayer.
index - Current index in array.
array - Reference to SubtypeSublayerListModel.

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

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

SubtypeSublayer get(int index)

Returns the SubtypeSublayer at the specified index.

int indexOf(SubtypeSublayer subtypeSublayer)

Returns the index of the specified subtypeSublayer.

void insert(int index, SubtypeSublayer subtypeSublayer)

Inserts subtypeSublayer at a specified index in the list.

void move(int from, int to)

Moves one SubtypeSublayer 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(SubtypeSublayer subtypeSublayer)

Removes the specified subtypeSublayer from the list model.