Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TimeClusterColumn

Column returned by querylanguage TIMECLUSTER command.

Properties

Optional clusters

clusters: undefined | object

Timeseries clusters identified by the command.

Optional displayName

displayName: undefined | string

Column display name - will be alias if column is renamed by queryStrng.

Optional groupByColumns

groupByColumns: Array<AbstractColumn>

Group by columns specified in the command.

Optional internalName

internalName: undefined | string

Internal identifier for the column.

Optional intervalGap

intervalGap: undefined | string

Time span between each timestamp in the timeseries datapoints.

Optional intervals

intervals: Array<number>

List of timestamps making up the timeseries datapoints.

Optional isCaseSensitive

isCaseSensitive: undefined | false | true

A flag indicating whether or not the field is a case sensitive field. Only applies to string fields.

Optional isEvaluable

isEvaluable: undefined | false | true

Identifies if this column can be used as an expression parameter in any command that accepts querylanguage expressions.

Optional isGroupable

isGroupable: undefined | false | true

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

Optional isHidden

isHidden: undefined | false | true

Identifies if this column should be hidden by default but can be displayed in the UI on demand.

Optional isListOfValues

isListOfValues: undefined | false | true

Identifies if all values in this column come from a pre-defined list of values.

Optional isMultiValued

isMultiValued: undefined | false | true

Identifies if this column allows multiple values to exist in a single row.

Optional originalDisplayName

originalDisplayName: undefined | string

Same as displayName unless column renamed in which case this will hold the original display name for the column.

Optional series

List of series data sets for each statistical function specified in the command.

Optional subSystem

subSystem: model.SubSystemName

Subsystem column belongs to.

Const type

type: string = "TIME_CLUSTER_COLUMN"

Optional valueType

valueType: model.ValueType

Field denoting column data type.

Optional values

values: Array<FieldValue>

If the column is a 'List of Values' column, this array contains the field values that are applicable to query results or all if no filters applied.

Methods

getDeserializedJsonObj

getJsonObj