Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace FunctionField

Field outlining queryString aggregate function entries.

Properties

Methods

Properties

Optional alias

alias: undefined | string

Alias of field if renamed by queryStrng.

Optional arguments

arguments: Array<Argument>

List of function arguments if specified.

Optional displayName

displayName: undefined | string

Field display name - will be alias if field is renamed by queryStrng.

Optional filterQueryString

filterQueryString: undefined | string

Query used to derive this field if specified.

Optional function

function: undefined | string

Name of the aggregate function.

Optional internalName

internalName: undefined | string

Internal identifier for the field.

Optional isDeclared

isDeclared: undefined | false | true

Field denoting if this is a declaration of the field in the queryString.

Optional isDuration

isDuration: undefined | false | true

Identifies if this field format is a duration.

Optional isGroupable

isGroupable: undefined | false | true

Identifies if this field can be used as a grouping field in any grouping command.

Const name

name: string = "FUNCTION"

Optional originalDisplayNames

originalDisplayNames: Array<string>

Same as displayName unless field renamed in which case this will hold the original display names for the field across all renames.

Optional unitType

unitType: undefined | string

Field denoting field unit type.

Optional valueType

valueType: model.ValueType

Field denoting field data type.

Methods

getDeserializedJsonObj

getJsonObj