Skip To Content ArcGIS for Developers Sign In Dashboard

SubtypeSublayerListModel QML Type

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

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

Properties

Signals

Methods

  • void append(SubtypeSublayer subtypeSublayer)
  • void clear()
  • bool contains(SubtypeSublayer subtypeSublayer)
  • void 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)
  • 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 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:

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


errorChanged()

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


subtypeSublayerAdded(int index)

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


subtypeSublayerRemoved(int index)

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


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.


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

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

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

SubtypeSublayer get(int index) const

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.


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?