Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace GeoStatsCommandDescriptor

Command descriptor for querylanguage GEOSTATS command. This is similiar to STATS with some built in functions for City, State and Country by Coordinates.

Properties

Optional category

category: undefined | string

querylanguage command designation for example; reporting vs filtering

Optional cityField

The city field to use. Only applicable when include = CUSTOM.

Optional continentField

The continent field to use. Only applicable when include = CUSTOM.

Optional coordinatesField

The coordinates field to use. Only applicable when include = CUSTOM.

Optional countryField

The country field to use. Only applicable when include = CUSTOM.

Optional declaredFields

declaredFields: Array<AbstractField>

Fields declared in command fragment from user specified query string.

displayQueryString

displayQueryString: string

Command fragment display string from user specified query string formatted by query builder.

Optional functions

functions: Array<FunctionField>

Statistical functions specified in the query string. At least 1 is required for a GEOSTATS command.

Optional groupByFields

groupByFields: Array<AbstractField>

Group by fields if specified in the query string. Required if include = CUSTOM.

Optional include

include: Include

Indicates which coordinates to show. Either client, server, client and server or custom. If custom is specified at least one of coordinatesField, regionField or countryField is required. Defaults to client.

internalQueryString

internalQueryString: string

Command fragment internal string from user specified query string formatted by query builder.

Optional isHidden

isHidden: undefined | false | true

Field denoting if this is a hidden command that is not shown in the query string.

Const name

name: string = "GEO_STATS"

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Optional regionField

The region field to use. Only applicable when include = CUSTOM.

Methods

getDeserializedJsonObj

getJsonObj