Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcPivotDateDimension

Configuration of a pivot dimension.

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Constructors

constructor

Properties

OptionalchildLevel

childLevel?: IgcPivotDimension

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

OptionaldataType

dataType?: GridColumnDataType

Gets/Sets data type

displayName

displayName: string

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

Optionalfilter

filter?: IgcFilteringExpressionsTree

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

OptionalhorizontalSummary

horizontalSummary?: boolean

Optionallevel

level?: number

Level of the dimension.

OptionalmemberFunction

memberFunction?: any

Function that extracts the value

OptionalsortDirection

sortDirection?: SortingDirection

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

Optionalsortable

sortable?: boolean

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

Optionalwidth

width?: string

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

Accessors

baseDimension

  • get baseDimension(): IgcPivotDimension

  • Returns IgcPivotDimension

  • set baseDimension(value): void

  • 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.

    Parameters

    Returns void

enabled

  • get enabled(): boolean

  • Enables/Disables a particular dimension from pivot structure.

    Returns boolean

  • set enabled(value): void

  • Enables/Disables a particular dimension from pivot structure.

    Parameters

    • value: boolean

    Returns void

memberName

  • get memberName(): string

  • Returns string

  • set memberName(value): void

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

    Parameters

    • value: string

    Returns void

options

  • get options(): IgcPivotDateDimensionOptions

  • Returns IgcPivotDateDimensionOptions

  • set options(value): void

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

    Parameters

    Returns void

resourceStrings

  • get resourceStrings(): IgcGridResourceStrings

  • Returns IgcGridResourceStrings

  • set resourceStrings(value): void

  • Gets/Sets the resource strings.

    Remarks

    By default it uses EN resources.

    Parameters

    Returns void