Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace PivotField

The type representing the pivot field. Pivot fields have an expression to define a macro and a pattern to generate the column name

Properties

Optional columnNamePattern

columnNamePattern: undefined | string

column name pattern can be used to generate the name structure of the generated columns. By default column names are of %PIVOT_KEY_VALUE% or %MACRO_INPUT%%PIVOT_KEY_VALUE%, but we can change it something by passing something like MY_PREFIX%PIVOT_KEY_VALUE%MY_SUFFIX or MY_PREFIX%MACRO_INPUT%%PIVOT_KEY_VALUE%MY_SUFFIX which will add custom prefix and suffix to the column name.

Optional configValues

configValues: model.ConfigValues

Optional description

description: undefined | string

Detailed description for the object.

Optional expr

expr: model.Expression

Optional key

key: undefined | string

The key of the object.

Const modelType

modelType: string = "PIVOT_FIELD"

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional type

Optional useType

useType: model.ConfiguredType

Methods

getDeserializedJsonObj

getJsonObj