Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISSublayerListModel QML Type

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

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

Properties

Signals

Methods

  • void append(ArcGISSublayer subLayer)
  • void clear()
  • bool contains(ArcGISSublayer subLayer)
  • void 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)
  • void setProperty(int index, string property, variant value)

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:

RoleTypeDescription
namestringThe sublayer's name.
sublayerVisibleboolWhether the sublayer is enabled to be visible.
showInLegendboolWhether the sublayer will be shown in the legend.
sublayerIdintThe sublayer's ID.
minScaledoubleThe minumum scale at which the sublayer displays.
maxScaledoubleThe maximum scale at which the sublayer displays.
sublayerTypeEnums.ArcGISSublayerTypeThe sublayer's type.
canChangeVisibilityboolWhether the sublayer's visibility can be changed.
definitionExpressionstringThe sublayer's definition expression (since Esri.ArcGISRuntime 100.1)
sublayerOpacityrealThe sublayer's opacity (since Esri.ArcGISRuntime 100.1)
scaleSymbolsboolWhether the sublayer renderers its symbols based on scale (since Esri.ArcGISRuntime 100.1)
labelsEnabledboolWhether 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.


errorChanged()

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


sublayerAdded(int index)

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


sublayerRemoved(int index)

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


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.


void 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:

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

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

ArcGISSublayer get(int index) const

Returns the Sublayer at the specified index.


int indexOf(ArcGISSublayer subLayer)

Returns the index of the sublayer specified.

This QML 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 QML method was introduced in Esri::ArcGISRuntime 100.5..


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

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



Feedback on this topic?