此类定义了顶级过滤器参数,用于对来自FeatureLayer的要素执行顶级要素查询。调用 FeatureLayer 上的任何顶级查询方法时,必须在TopFeaturesQuery对象上设置此参数。它用于设置使用 top features 查询的groupByFields、orderByFields和计数条件。例如,您可以使用 FeatureLayer 的queryTopFeatures()方法查询美国每个州人口最多的三个县。
// 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
});
构造函数
属性列表
属性 | 类型 | 描述 | 类 | |
---|---|---|---|---|
String | 更多信息 类名。 | 更多信息 | Accessor | |
String[] | 更多信息 当此属性中提供一个或多个字段名称时,输出结果将根据这些字段的唯一值进行分组。 | 更多信息 | TopFilter | |
String[] | 更多信息 用于对查询结果进行排序的一个或多个字段名称。 | 更多信息 | TopFilter | |
Number | 更多信息 定义要从顶部特征查询返回的特征数。 | 更多信息 | TopFilter |
属性详细说明
-
类名。类的名称声明格式为
geoscene.folder.className
。
-
当此属性中提供一个或多个字段名称时,输出结果将根据这些字段的唯一值进行分组。
-
用于对查询结果进行排序的一个或多个字段名称。 在字段名称后指定
ASC
(升序)或DESC
(降序)以控制顺序。默认顺序是ASC
。示例代码:const query = new TopFeaturesQuery({ outFields: ["State, Pop_total, County"], topFilter: new TopFilter({ topCount: 3, groupByFields: ["State"], orderByFields: ["Pop_total DESC"] }) });
-
topCount Number
-
定义要从顶部特征查询返回的特征数。
示例代码:const query = new TopFeaturesQuery({ outFields: ["State, Pop_total, County"], topFilter: new TopFilter({ topCount: 3, groupByFields: ["State"], orderByFields: ["Pop_total DESC"] }) });
方法列表
属性 | 返回值类型 | 描述 | 类 | |
---|---|---|---|---|
TopFilter | 更多信息 创建TopFilter对象的深层克隆。 | 更多信息 | TopFilter | |
* | 更多信息 创建此类的新实例并使用从 GeoScene产品生成的 JSON 对象的值对其进行初始化。 | 更多信息 | TopFilter | |
Object | 更多信息 将此类的实例转换为其 GeoScene portal JSON 格式。 | 更多信息 | TopFilter |
方法详细说明
-
fromJSON(json){*}static
-
创建此类的新实例,并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。传递给输入
json
参数的对象通常来自对 REST API 中的查询操作的响应,或者来自另一个 GeoScene产品的 toJSON() 方法。有关何时以及如何使用此函数的详细信息和示例,请参阅指南中的 使用 fromJSON() 主题。参数:json Object实例的 json 表达式,以geoscene 格式显示。
返回值:类型 描述 * 返回一个该类的新实例。
-
toJSON(){Object}
-
将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息,请参阅 使用 fromJSON() 指南。
返回值:类型 描述 Object 此类实例的 GeoScene portal JSON 格式。