DisplayFilter QML Type

  • Esri.ArcGISRuntime
  • DisplayFilter
  • Represents a type used for limiting which features are rendered. More...

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


    Inherited By:




    Detailed Description

    Features filtered from display remain available for query and analysis. Use display filter when only a subset of features needs to be visible while maintaining access to all features.

    See also ScaleDisplayFilterDefinition::filters and ManualDisplayFilterDefinition::activeFilter.

    Property Documentation

    [read-only] filterId : string

    The identifier for this display filter (read-only).

    Use a unique name to identify this display filter when used in a webmap as a ManualDisplayFilterDefinition::activeFilter.

    name : string

    A descriptive name for this display filter.

    [read-only] objectType : Enums.DisplayFilterType

    The object type of this object (read-only).

    whereClause : string

    A SQL expression that defines which features are rendered.

    The where clause string that is used as the whereClause should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS.

    A where clause that is not valid for the data may result in no features being drawn when this display filter is applied either by ManualDisplayFilterDefinition::activeFilter or by ScaleRangeDisplayFilter::maxScale. Check the layer's LayerViewState if there exists a Enums.LayerViewStatusWarning with an LayerViewState::error describing that the display filter's where clause is invalid.

    Signal Documentation


    Emitted when the name property changes.

    Note: The corresponding handler is onNameChanged.


    Emitted when the whereClause property changes.

    Note: The corresponding handler is onWhereClauseChanged.

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