Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace FieldSummaryCommandDescriptor

Command descriptor for querylanguage FIELDSUMMARY command.

Properties

Optional category

category: undefined | string

querylanguage command designation for example; reporting vs filtering

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.

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.

Optional maxValues

maxValues: undefined | number

Limit on number of distinct values to process for each field specified in the field summary command in the query string. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Const name

name: string = "FIELD_SUMMARY"

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Methods

getDeserializedJsonObj

getJsonObj