LayerListModel QML Type

  • Esri.ArcGISRuntime
  • LayerListModel
  • A list model storing a list of Layers available in a Map. More...

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

    Properties

    Signals

    Methods

    Detailed Description

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

    Modifying this model (adding, removing, moving) will update the Layers available in the Map.

    The model returns data for the following roles:

    RoleTypeDescription
    namestringThe layer's name.
    descriptionstringThe layer's description.
    layerVisibleboolWhether the layer is visible.
    canChangeVisibilityboolWhether the layer's visibility can be changed.
    loadStatusEnums.LoadStatusThe layer's load status.
    layerTypeEnums.LayerTypeThe layer's type.
    attributionstringThe layer's attribution if any is available.
    showInLegendboolWhether the layer will be shown in the legend.
    layerIdstringThe layer's ID specified in the web map JSON.
    minScaledoubleThe minimum scale at which the layer displays.
    maxScaledoubleThe maximum scale at which the layer displays.
    layerOpacityrealThe opacity of the layer between 0.0 and 1.0.

    Property Documentation

    [read-only] count : int

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


    [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.


    [since Esri.ArcGISRuntime 100.15] 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.


    [since 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(Layer layer)

    Appends a layer to the layer list model.


    void clear()

    Removes all layers from the list model.


    bool contains(Layer layer)

    Returns true if the list model contains the specified layer.


    error forEach(callback)

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

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

    • element Current layer.
    • index Current index in array.
    • array Reference to LayerListModel.

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

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

    Layer get(int index)

    Returns the Layer at the specified index.


    [since Esri::ArcGISRuntime 100.5.] int indexOf(Layer layer)

    Returns the index of a specific layer (layer) from the list model.

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


    void insert(int index, Layer layer)

    Inserts a layer 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.

    [since Esri::ArcGISRuntime 100.5.] void removeOne(Layer layer)

    Removes the specified layer (layer) from the list model.

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


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.