TopFilter

AMD: require(["esri/rest/support/TopFilter"], (TopFilter) => { /* code goes here */ });
ESM: import TopFilter from "@arcgis/core/rest/support/TopFilter";
Class: esri/rest/support/TopFilter
Inheritance: TopFilter Accessor
Since: ArcGIS API for JavaScript 4.20

This class defines the top filter parameters for executing top features queries for features from a FeatureLayer. This parameter must be set on the TopFeaturesQuery object when calling any of top query methods on a FeatureLayer. It is used to set the groupByFields, orderByFields, and count criteria used the top features query. For example, you can use FeatureLayer's queryTopFeatures() method to query the most populous three counties in each state of the United States.

// query the top three most populous counties from each state.
// Results will be ordered based the population of each county in descending order
// top query will run against all features available in the service
const query = new TopFeaturesQuery({
  outFields: ["State, Pop_total, County"],
  topFilter: new TopFilter({
    topCount: 3,
    groupByFields: ["State"],
    orderByFields: ["Pop_total DESC"]
  })
});
featureLayer.queryTopFeatures(query)
  .then(function(response){
     // returns a feature set with features containing the most populous
     // three counties in each state ordered by the number of population.
     // The following attributes are returned as well: State, Pop_total, County
   });
See also:

Constructors

new TopFilter(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
String[]more details

When one or more field names are provided in this property, the output result will be grouped based on unique values from those fields.

more detailsTopFilter
String[]more details

One or more field names used to order the query results.

more detailsTopFilter
Numbermore details

Defines the number of features to be returned from the top features query.

more detailsTopFilter

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

groupByFields String[]

When one or more field names are provided in this property, the output result will be grouped based on unique values from those fields.

orderByFields String[]

One or more field names used to order the query results. Specify ASC (ascending) or DESC (descending) after the field name to control the order. The default order is ASC.

Example:
const query = new TopFeaturesQuery({
  outFields: ["State, Pop_total, County"],
  topFilter: new TopFilter({
    topCount: 3,
    groupByFields: ["State"],
    orderByFields: ["Pop_total DESC"]
  })
});
topCount Number

Defines the number of features to be returned from the top features query.

Example:
const query = new TopFeaturesQuery({
  outFields: ["State, Pop_total, County"],
  topFilter: new TopFilter({
    topCount: 3,
    groupByFields: ["State"],
    orderByFields: ["Pop_total DESC"]
  })
});

Method Overview

Name Return Type Summary Class
TopFiltermore details

Creates a deep clone of TopFilter object.

more detailsTopFilter
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsTopFilter
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsTopFilter

Method Details

clone(){TopFilter}

Creates a deep clone of TopFilter object.

Returns:
Type Description
TopFilter A new instance of a TopFilter object equal to the object used to call .clone().
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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