ScaleRangeDisplayFilterListModel QML Type

  • Esri.ArcGISRuntime
  • ScaleRangeDisplayFilterListModel
  • A container class storing a list of scale range display filters. More...

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

    Properties

    Signals

    Methods

    • void append(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
    • void clear()
    • bool contains(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
    • void forEach(void callback)
    • ScaleRangeDisplayFilter get(int index)
    • int indexOf(ScaleRangeDisplayFilter scaleRangeDisplayFilter)
    • void insert(int index, ScaleRangeDisplayFilter scaleRangeDisplayFilter)
    • void move(int from, int to)
    • void remove(int index, int count)
    • void removeOne(ScaleRangeDisplayFilter scaleRangeDisplayFilter)

    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
    nameQStringThe name of the scale range display filter.
    whereClauseQStringSQL expression that defines which features are rendered.
    filterIdQStringThe identifier for the scale range display filter (read only).
    minScaledoubleThe minimum scale at which this scale range display filter is applied.
    maxScaledoubleThe maximum scale at which this scale range display filter is applied.

    See also ScaleRangeDisplayFilter.

    Property Documentation

    [read-only] count : int

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


    [read-only] error : Error

    Returns the error object in case an error occurs (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)

    Signal emitted when an item is added to the list.

    index is the index of the added item.

    Note: The corresponding handler is onItemAdded.

    This signal was introduced in Esri.ArcGISRuntime 100.15.


    [since Esri.ArcGISRuntime 100.15] itemRemoved(int index)

    Signal emitted when an item is removed from the list.

    index is the index of the removed item

    Note: The corresponding handler is onItemRemoved.

    This signal was introduced in Esri.ArcGISRuntime 100.15.


    Method Documentation

    void append(ScaleRangeDisplayFilter scaleRangeDisplayFilter)

    Appends the scaleRangeDisplayFilter to the scale range display filter list model.


    void clear()

    Removes all scale range display filters from the list model.


    bool contains(ScaleRangeDisplayFilter scaleRangeDisplayFilter)

    Returns true if the list model contains the specified scaleRangeDisplayFilter.


    void forEach(void callback)

    Receives a callback function to execute for each scale range display filter 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 = scaleRangeDisplayFilterListModel.forEach(function(element, index, array) {
        ...
    });
    if (error) {
        console.error(error.message);
    }

    ScaleRangeDisplayFilter get(int index)

    Returns the scale range display filter at the specified index.


    int indexOf(ScaleRangeDisplayFilter scaleRangeDisplayFilter)

    Returns the index of the scaleRangeDisplayFilter specified.


    void insert(int index, ScaleRangeDisplayFilter scaleRangeDisplayFilter)

    Inserts a scaleRangeDisplayFilter at a specified index in the list model.


    void move(int from, int to)

    Moves one scale range display filter 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(ScaleRangeDisplayFilter scaleRangeDisplayFilter)

    Removes the specified scaleRangeDisplayFilter from the list model.


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