Configuration of a pivot dimension.

Constructors

Section titled "Constructors"

IgrPivotDateDimension 

new IgrPivotDateDimension(inBaseDimension: IgrPivotDimension, inOptions: IgrPivotDateDimensionOptions): IgrPivotDateDimension

Returns IgrPivotDateDimension

Properties

Section titled "Properties"

Optional childLevel

Section titled "childLevel"

Inherited from: IgcPivotDimension

Allows defining a hierarchy when multiple sub groups need to be extracted from single member.

 
childLevel: IgrPivotDimension

Optional dataType

Section titled "dataType"

Gets/Sets data type

 
dataType: GridColumnDataType

displayName

Section titled "displayName"

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

 
displayName: string

Optional filter

Section titled "filter"

Inherited from: IgcPivotDimension

A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe.

 
filter: IgrFilteringExpressionsTree

Optional horizontalSummary

Section titled "horizontalSummary"

Inherited from: IgcPivotDimension 

horizontalSummary: boolean

Optional level

Section titled "level"

Inherited from: IgcPivotDimension

Level of the dimension.

 
level: number

Optional memberFunction

Section titled "memberFunction"

Inherited from: IgcPivotDimension

Function that extracts the value

 
memberFunction: any

Optional sortable

Section titled "sortable"

Inherited from: IgcPivotDimension

Enable/disable sorting for a particular dimension. True by default.

 
sortable: boolean

Optional sortDirection

Section titled "sortDirection"

Inherited from: IgcPivotDimension

The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.

 
sortDirection: SortingDirection

Optional width

Section titled "width"

Inherited from: IgcPivotDimension

The width of the dimension cells to be rendered.Can be pixel, % or "auto".

 
width: string

Accessors

Section titled "Accessors"

baseDimension

Section titled "baseDimension" 
get baseDimension(): IgrPivotDimension

Returns IgrPivotDimension

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.

 
set baseDimension(value: IgrPivotDimension): void

Parameters

Returns void

enabled

Section titled "enabled"

Enables/Disables a particular dimension from pivot structure.

 
get enabled(): boolean

Returns boolean

Enables/Disables a particular dimension from pivot structure.

 
set enabled(value: boolean): void

Parameters

  • value: boolean

Returns void

memberName

Section titled "memberName"

Inherited from: IgcPivotDimension 

get memberName(): string

Returns string

Unique member to extract related data field value or the result of the memberFunction.

 
set memberName(value: string): void

Parameters

  • value: string

Returns void

options

Section titled "options"

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

 
set options(value: IgrPivotDateDimensionOptions): void

Parameters

Returns void

resourceStrings

Section titled "resourceStrings" 
get resourceStrings(): IgrGridResourceStrings

Returns IgrGridResourceStrings

Gets/Sets the resource strings.

 
set resourceStrings(value: IgrGridResourceStrings): void

Parameters

Returns void