ArcGIS Developers
Dashboard

UtilityNetworkListModel QML Type

A container class storing a list of UtilityNetworks. More...

Import Statement: import Esri.ArcGISRuntime 100.11
Since: Esri.ArcGISRuntime 100.10

Properties

Signals

Methods

  • void append(UtilityNetwork utilityNetwork)
  • void clear()
  • bool contains(UtilityNetwork utilityNetwork)
  • void forEach(callback)
  • UtilityNetwork get(int index)
  • int indexOf(UtilityNetwork utilityNetwork)
  • void insert(int index, UtilityNetwork utilityNetwork)
  • void move(int from, int to)
  • void remove(int index, int count)
  • void removeOne(UtilityNetwork utilityNetwork)
  • void setProperty(int index, string property, variant value)

Detailed Description

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

The model returns data for the following roles:

RoleTypeDescription
definitionUtilityNetworkDefinitionThe UtilityNetworkDefinition of the UtilityNetwork
nameQStringThe name of the UtilityNetwork

See also UtilityNetwork.

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.


utilityNetworkAdded(int index)

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

Note: The corresponding handler is onUtilityNetworkAdded.


utilityNetworkRemoved(int index)

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

Note: The corresponding handler is onUtilityNetworkRemoved.


Method Documentation

void append(UtilityNetwork utilityNetwork)

Appends a utilityNetwork to the UtilityNetwork list model.


void clear()

Removes all utility networks from the list model.


bool contains(UtilityNetwork utilityNetwork)

Returns true if the list model contains the specified utilityNetwork.


void forEach(callback)

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

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

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

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

UtilityNetwork get(int index)

Returns the utility network at the specified index.


int indexOf(UtilityNetwork utilityNetwork)

Returns the index of a specific utilityNetwork from the list model.


void insert(int index, UtilityNetwork utilityNetwork)

Inserts a utilityNetwork at a specified index in the list.


void move(int from, int to)

Moves one utility network 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(UtilityNetwork utilityNetwork)

Removes the specified utilityNetwork from the list model.


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

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



Feedback on this topic?