Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: ReviewerFilters

require(["esri/tasks/datareviewer/ReviewerFilters"], function(ReviewerFilters) { /* code goes here */ });

Description

(Added at v3.14)
ReviewerFilters limit or precisely define which results to generate by applying conditions to a query for dashboard results. Conditions can be spatial or attribute based. You can apply multiple filters to a query.

See getDashboardResults, getResults

Samples

Search for samples that use this class.

Methods

NameReturn typeSummary
addAttributeFilter(fieldName, fieldValues)NoneQueries an attribute by a value.
addRangeFilter(fieldName, min, max)NoneQueries an attribute by a range of values.
addSpatialFilter(geometry)NoneQueries by a polygon.
getCount()NumberReturns the count of ReviewerFilters added.
toJSON()ObjectReturns a JSON representation of a filter object.
Method Details

addAttributeFilter(fieldName, fieldValues)

Queries an attribute by a value.
Parameters:
<String> fieldName Required The field used to perform the filter.
<String | Number | Array> fieldValues Required A value or an Array of values in fieldName to filter.

addRangeFilter(fieldName, min, max)

Queries an attribute by a range of values.
Parameters:
<String> fieldName Required The field used to perform the filter.
<String | Number> min Required Minimum value range.
<String | Number> max Required Maximum value range.

addSpatialFilter(geometry)

Queries by a polygon. Reviewer workspace geometries that intersect the polygon are used to generate results.
Parameters:
<Polygon> geometry Required The geometry used to perform the filter.

getCount()

Returns the count of ReviewerFilters added.
Return type: Number

toJSON()

Returns a JSON representation of a filter object.
Return type: Object