Configuration of a pivot dimension.

Constructors

Section titled "Constructors"

IgxPivotDateDimension

Creates additional pivot date dimensions based on a provided dimension describing date data:

 
new IgxPivotDateDimension(inBaseDimension: IPivotDimension, inOptions: IPivotDateDimensionOptions): IgxPivotDateDimension

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:128

Returns IgxPivotDateDimension

Properties

Section titled "Properties"

Optional dataType

Section titled "dataType"

Gets/Sets data type

 
dataType: GridColumnDataType

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:55

defaultOptions

Section titled "defaultOptions"

Default options.

 
defaultOptions: object

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:59

displayName

Section titled "displayName"

Display name to show instead of the field name of this value. *

 
displayName: string

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:112

enabled

Section titled "enabled"

Enables/Disables a particular dimension from pivot structure.

 
enabled: boolean = true

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:50

Accessors

Section titled "Accessors"

baseDimension

Section titled "baseDimension"

Gets/Sets the base dimension that is used by this class to determine the other dimensions and their values. Having base dimension set is required in order for the Date Dimensions to show.

 
get baseDimension(): IPivotDimension

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:85

Returns IPivotDimension 

set baseDimension(value: IPivotDimension): void

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:88

Parameters

Returns void

options

Section titled "options"

Gets/Sets the options for the predefined date dimensions whether to show quarter, years and etc.

 
get options(): IPivotDateDimensionOptions

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:96

Returns IPivotDateDimensionOptions

resourceStrings

Section titled "resourceStrings"

Gets/Sets the resource strings.

 
set resourceStrings(value: IGridResourceStrings): void

Defined in projects/igniteui-angular/grids/core/src/pivot-grid-dimensions.ts:73

Parameters

Returns void