/
statisticDefinition.ts
33 lines (32 loc) · 1.15 KB
/
statisticDefinition.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
* Apache-2.0 */
export interface IStatisticDefinition {
/**
* Statistical operation to perform (count, sum, min, max, avg, stddev, var, percentile_cont, percentile_disc).
*/
statisticType:
| "count"
| "sum"
| "min"
| "max"
| "avg"
| "stddev"
| "var"
| "percentile_cont"
| "percentile_disc";
/**
* Parameters to be used along with statisticType. Currently, only applicable for percentile_cont (continuous percentile) and percentile_disc (discrete percentile).
*/
statisticParameters?: {
value: number;
orderBy?: "asc" | "desc";
};
/**
* Field on which to perform the statistical operation.
*/
onStatisticField: string;
/**
* Field name for the returned statistic field. If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
*/
outStatisticFieldName?: string;
}