Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrPivotDimension

Configuration of a pivot dimension.

Hierarchy

Hierarchy (View Summary)

Constructors

Properties

Accessors

Constructors

constructor

Properties

OptionalchildLevel

childLevel?: IgrPivotDimension

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

OptionaldataType

dataType?: GridColumnDataType

The dataType of the related data field.

OptionaldisplayName

displayName?: string

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

Optionalfilter

filter?: IgrFilteringExpressionsTree

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

Optionalsortable

sortable?: boolean

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

OptionalsortDirection

sortDirection?: SortingDirection

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

Optionalwidth

width?: string

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

Accessors

enabled

  • get enabled(): boolean

    Returns boolean

  • set enabled(value: boolean): void

    Enables/Disables a particular dimension from pivot structure.

    Parameters

    • value: boolean

    Returns void

memberName

  • get memberName(): string

    Returns string

  • set memberName(value: string): void

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

    Parameters

    • value: string

    Returns void