Configuration of a pivot dimension.

Hierarchy

Hierarchy

Constructors

Accessors

  • get baseDimension(): 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.

    Returns IgrPivotDimension

  • set baseDimension(v): void
  • Parameters

    Returns void

  • get childLevel(): IgrPivotDimension
  • Allows defining a hierarchy when multiple sub groups need to be extracted from single member.

    Returns IgrPivotDimension

  • set childLevel(v): void
  • Parameters

    Returns void

  • get dataType(): GridColumnDataType
  • Gets/Sets data type

    Returns GridColumnDataType

  • set dataType(v): void
  • Parameters

    Returns void

  • get displayName(): string
  • Display name to show instead of the field name of this value. *

    Returns string

  • set displayName(v): void
  • Parameters

    • v: string

    Returns void

  • get enabled(): boolean
  • Enables/Disables a particular dimension from pivot structure.

    Returns boolean

  • set enabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get filter(): IgrFilteringExpressionsTree
  • A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe.

    Returns IgrFilteringExpressionsTree

  • set filter(v): void
  • Parameters

    Returns void

  • get horizontalSummary(): boolean
  • Returns boolean

  • set horizontalSummary(v): void
  • Parameters

    • v: boolean

    Returns void

  • get level(): number
  • Level of the dimension.

    Returns number

  • set level(v): void
  • Parameters

    • v: number

    Returns void

  • get memberName(): string
  • Field name to use in order to extract value.

    Returns string

  • set memberName(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get resourceStrings(): IgrGridResourceStrings
  • Gets/Sets the resource strings.

    Remarks

    By default it uses EN resources.

    Returns IgrGridResourceStrings

  • set resourceStrings(v): void
  • Parameters

    Returns void

  • get sortDirection(): SortingDirection
  • The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension.

    Returns SortingDirection

  • set sortDirection(v): void
  • Parameters

    Returns void

  • get sortable(): boolean
  • Enable/disable sorting for a particular dimension. True by default.

    Returns boolean

  • set sortable(v): void
  • Parameters

    • v: boolean

    Returns void

  • get width(): string
  • The width of the dimension cells to be rendered.Can be pixel, % or "auto".

    Returns string

  • set width(v): void
  • Parameters

    • v: string

    Returns void

Methods

  • Parameters

    • name: string

    Returns any

  • Parameters

    • element: any

    Returns void