Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrPivotDimension

Configuration of a pivot dimension.

Hierarchy

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Accessors

childLevel

  • 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

dataType

  • get dataType(): GridColumnDataType

  • The dataType of the related data field.

    Returns GridColumnDataType

  • set dataType(v): void

  • Parameters

    Returns void

displayName

  • 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

enabled

  • get enabled(): boolean

  • Enables/Disables a particular dimension from pivot structure.

    Returns boolean

  • set enabled(v): void

  • Parameters

    • v: boolean

    Returns void

filter

  • 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

horizontalSummary

  • get horizontalSummary(): boolean

  • Returns boolean

  • set horizontalSummary(v): void

  • Parameters

    • v: boolean

    Returns void

level

  • get level(): number

  • Level of the dimension.

    Returns number

  • set level(v): void

  • Parameters

    • v: number

    Returns void

memberName

  • get memberName(): string

  • Field name to use in order to extract value.

    Returns string

  • set memberName(v): void

  • Parameters

    • v: string

    Returns void

nativeElement

  • get nativeElement(): HTMLElement

  • Returns HTMLElement

sortDirection

  • 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

sortable

  • get sortable(): boolean

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

    Returns boolean

  • set sortable(v): void

  • Parameters

    • v: boolean

    Returns void

width

  • 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

findByName

  • Parameters

    • name: string

    Returns any

setNativeElement

  • Parameters

    • element: any

    Returns void