Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LinkCommandDescriptor

Command descriptor for querylanguage LINK 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.

Const name

name: string = "LINK"

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Optional shouldIncludeNulls

shouldIncludeNulls: undefined | false | true

Option to return groups with a null value if specified.

Optional shouldIncludeTrends

shouldIncludeTrends: undefined | false | true

Option to calculate trends of each group if specified.

Optional span

span: undefined | string

Option to control the size of buckets in the histogram e.g 8hrs - each bar other than first and last should represent 8hr time span. Will be adjusted to a larger span if time range is very large.

Methods

getDeserializedJsonObj

getJsonObj