此类定义了前几项过滤器参数,用于对来自 FeatureLayer 的要素执行前几项要素查询。在 FeatureLayer 上调用任何前几项查询方法时,必须在 TopFeaturesQuery 对象上设置此参数。它用于设置使用前几项要素查询的 groupByFields、orderByFields 和 count 条件。例如,您可以使用 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"] }) });
方法概述
名称 | 返回值类值 | 描述 | 类 |
---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | Accessor | ||
TopFilter | 创建 TopFilter 对象的深度克隆。 更多详情 | TopFilter | |
* | 创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。 更多详情 | TopFilter | |
Boolean | 如果存在指定的句柄组,则返回 true。 更多详情 | Accessor | |
移除对象拥有的句柄组。 更多详情 | Accessor | ||
Object | 将此类的实例转换为 GeoScene Portal JSON 表示。 更多详情 | TopFilter |
方法详细说明
-
addHandles(handleOrHandles, groupKey)inherited起始版本:GeoScene Maps SDK for JavaScript 4.25
-
添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时,将移除句柄。
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); // Handle gets removed when the object is destroyed. this.addHandles(handle);
参数handleOrHandles WatchHandle|WatchHandle[]对象销毁后,标记为要移除的句柄。
groupKey *optional标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键,则句柄将被添加到默认组。
-
fromJSON(json){*}static
-
创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入
json
参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例,请参阅指南中的使用 fromJSON() 主题。参数json ObjectGeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档。
返回类型 描述 * 返回该类的新实例。
-
起始版本:GeoScene Maps SDK for JavaScript 4.25
-
如果存在指定的句柄组,则返回 true。
参数groupKey *optional组键。
返回类型 描述 Boolean 如果存在指定的句柄组,则返回 true
。示例// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inherited起始版本:GeoScene Maps SDK for JavaScript 4.25
-
移除对象拥有的句柄组。
参数groupKey *optional要移除的组键或组键的数组或集合。
示例obj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。
返回类型 描述 Object 此类实例的 GeoScene Portal JSON 表示。