StatisticDefinition

// query for the sum of the population in all features
let sumPopulation = {
  onStatisticField: "POP_2015",  // service field for 2015 population
  outStatisticFieldName: "Pop_2015_sum",
  statisticType: "sum"
}
let query = layer.createQuery();
query.outStatistics = [ sumPopulation ];
layer.queryFeatures(query)
  .then(function(response){
     let stats = response.features[0].attributes;
     console.log("output stats:", stats);
  });

// query for the average of the population change for all features
let populationChangeDefinition = {
  onStatisticField: "POP_2015 - POP_2010",  // service field for 2015 population
  outStatisticFieldName: "avg_pop_change_2015_2010",
  statisticType: "avg"
}
let query = layer.createQuery();
query.outStatistics = [ populationChangeDefinition ];
layer.queryFeatures(query)
  .then(function(response){
     let stats = response.features[0].attributes;
     console.log("Average change:", stats.avg_pop_change_2015_2010);
  });

属性概述

属性详细信息

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className。

onStatisticField String

定义将为其计算统计数据的字段。这可以是服务字段名称或 SQL 表达式。有关示例，请参阅下面的代码段。

示例

// query for the sum of the population in all features
let sumPopulation = {
  onStatisticField: "POP_2015",  // service field for 2015 population
  outStatisticFieldName: "Pop_2015_sum",
  statisticType: "sum"
}
let query = layer.createQuery();
query.outStatistics = [ sumPopulation ];
layer.queryFeatures(query)
  .then(function(response){
     let stats = response.features[0].attributes;
     console.log("output stats:", stats);
  });

// query for the average of the population change for all features
// Notice that you can pass a SQL expression as a field name to calculate statistics
let populationChangeDefinition = {
  onStatisticField: "POP_2015 - POP_2010",  // service field for 2015 population
  outStatisticFieldName: "avg_pop_change_2015_2010",
  statisticType: "avg"
}
let query = layer.createQuery();
query.outStatistics = [ populationChangeDefinition ];
layer.queryFeatures(query)
  .then(function(response){
     let stats = response.features[0].attributes;
     console.log("Average change:", stats.avg_pop_change_2015_2010);
  });

// query for the average of the population change grouped by regions
// query result will also return an extent for each group encompassing
// all features in each group.
let populationChangeDefinition = {
  onStatisticField: "POP_2015 - POP_2010",  // service field for 2015 population
  outStatisticFieldName: "avg_pop_change_2015_2010",
  statisticType: "avg"
};
let aggregatedExtent = {
  statisticType: "envelope-aggregate"
};
let query = layer.createQuery();
query.groupByFieldsForStatistics = ["Region"];
query.outStatistics = [ populationChangeDefinition, aggregatedExtent ];
layer.queryFeatures(query).then(displayResults);

outStatisticFieldName String

指定所请求统计信息的输出字段名称。输出字段名称只能包含字母数字字符和下划线。如果未指定输出字段名称，则服务器将为返回的统计字段分配字段名称。

statisticParameters Object

百分位统计信息的参数。当 statisticType 设置为 percentile-continuous 或 percentile-discrete 时，必须设置此属性。

属性

value Number 百分位值。此值应是介于 0 到 1 之间的十进制值。

orderBy String optional 指定 ASC (升序) 或 DESC (降序) 来控制数据的顺序。例如，在从 1 到 10 的 10 个值的数据集中，orderBy 设置为升序 (ASC) 时，0.9 的百分位值为 9，但当 orderBy 设置为降序 (DESC) 时，结果为 2。默认值为 ASC。 可能值："ASC"|"DESC"

默认值：null

示例

let query = layer.createQuery();
// find the median value in descending order for response_rate field
// for all features stored in the layer and order
query.outStatistics = [{
  statisticType: "percentile-continuous",
  statisticParameters: {
    value: 0.5,
    orderBy: "DESC"
  },
  onStatisticField: "response_rate",
  outStatisticFieldName: "Resp_rate_median"
}];
// query the features for the median value statistics against the values
// stored in the response_rate field
queryFeatures(query);

// Query the percentile for response time in descending order for all features in the layer
// group the percentile by Division and unit fields
let query = layer.createQuery();
query.orderByFields = ["Division, Unit"];
query.groupByFieldsForStatistics = ["Division, Unit"];
query.outStatistics = [{
  statisticType: "percentile-discrete",
  statisticParameters: {
    value: 0.67,
    orderBy: "DESC"
  },
  onStatisticField: "response_time",
  outStatisticFieldName: "response_time_percentile"
}];
queryFeatures(query);

statisticType String

定义统计信息的类型。

可能值

值	描述
count	与指定条件相匹配的要素数。
sum	与指定条件相匹配的值的总和。
min	给定字段的最小值。
max	给定字段的最大值。
avg	与指定条件匹配的值的平均值。
stddev	与指定条件匹配的值的标准差。
var	指定条件中值的统计方差。
percentile-continuous	一个插值，高于或低于一组数据中给定百分比的值。例如，第九十个百分位数 (值 0.9) 是一个值，在此值以下，可以发现 90% 的数据值。percentile-continuous 可从数据集中返回一个插值。
percentile-discrete	类似于 percentile-continuous，除了 percentile-discrete 可从数据集中返回数据值。
envelope-aggregate	使用 groupByFieldsForStatistics 时，返回分组要素的空间范围。每个统计信息组都有一个范围，表示该组中所有要素的边界框。
centroid-aggregate	使用 groupByFieldsForStatistics 时，返回分组要素的质心。每个统计信息组都有一个质心，表示属于该组的要素的空间中心。
convex-hull-aggregate	使用 groupByFieldsForStatistics 时，返回分组要素的凸包。每个统计信息组将有一个凸包，表示包含该组中所有要素的最小区域。

已知限制

• 计算 percentile-continuous 或 percentile-discrete 统计时，必须设置 statisticParameters。
• percentile-continuous 和 percentile-discrete 统计类型不能与 having 参数一起使用。
• 如果 capabilities.query.supportsPercentileStatistics 为 true，则支持 percentile-continuous 和 percentile-discrete 统计类型。
• GeoScene Enterprise 托管和非托管要素服务不支持 envelope-aggregate、centroid-aggregate 和 convex-hull-aggregate 统计类型。

可能值："count"|"sum"|"min"|"max"|"avg"|"stddev"|"var"|"percentile-continuous"|"percentile-discrete"|"envelope-aggregate"|"centroid-aggregate"|"convex-hull-aggregate"

另请参阅

• Graphic.aggregateGeometries

示例

// average of age fields by regions
const ageStatsByRegion = new StatisticDefinition({
  onStatisticField: field,
  outStatisticFieldName: "avgAge",
  statisticType: "avg"
});

// extent encompassing all features by region
const aggregatedExtent = new StatisticDefinition({
  statisticType: "envelope-aggregate",
  outStatisticFieldName: "aggregateExtent",
});

// group the statistics by Region field
// get avg age by Regions and extent of each region
const query = layer.createQuery();
query.groupByFieldsForStatistics = ["Region"];
query.outStatistics = [consumeStatsByRegion, aggregatedExtent];
layer.queryFeatures(query).then((results) => {
  results.features.forEach((feature) => {
    if (feature.attributes.Region === "Midwest") {
       view.goTo(feature.aggregateGeometries.aggregateExtent);
    }
  });
});

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){StatisticDefinition}

创建 StatisticDefinition 对象的深度克隆。

返回

类型	描述
StatisticDefinition	StatisticDefinition 对象的新实例，其等于用于调用 .clone() 的对象。

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

hasHandles(groupKey){Boolean}inherited

起始版本：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 表示。