Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcPivotDimension

Configuration of a pivot dimension.

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Constructors

constructor

Properties

Optional childLevel

childLevel?: IgcPivotDimension

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

Optional dataType

dataType?: GridColumnDataType

The dataType of the related data field.

Optional displayName

displayName?: string

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

Optional filter

filter?: IgcFilteringExpressionsTree

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

Optional horizontalSummary

horizontalSummary?: boolean

Optional level

level?: number

Level of the dimension.

Optional memberFunction

memberFunction?: any

Function that extracts the value

Optional sortDirection

sortDirection?: SortingDirection

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

Optional sortable

sortable?: boolean

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

Optional width

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): void

  • Enables/Disables a particular dimension from pivot structure.

    Parameters

    • value: boolean

    Returns void

memberName

  • get memberName(): string

  • Returns string

  • set memberName(value): void

  • Field name to use in order to extract value.

    Parameters

    • value: string

    Returns void