Class IgbPivotDimension

Configuration of a pivot dimension.

Inheritance
System.Object
BaseRendererElement
IgbPivotDimension
IgbPivotDateDimension
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbPivotDimension : BaseRendererElement, JsonSerializable

Constructors

IgbPivotDimension()

Declaration
public IgbPivotDimension()

Properties

ChildLevel

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

Declaration
public IgbPivotDimension ChildLevel { get; set; }
Property Value
Type Description
IgbPivotDimension

DataType

The dataType of the related data field.

Declaration
public GridColumnDataType DataType { get; set; }
Property Value
Type Description
GridColumnDataType

DisplayName

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

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

Enabled

Enables/Disables a particular dimension from pivot structure.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

Filter

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

Declaration
public IgbFilteringExpressionsTree Filter { get; set; }
Property Value
Type Description
IgbFilteringExpressionsTree

HorizontalSummary

Declaration
public bool HorizontalSummary { get; set; }
Property Value
Type Description
System.Boolean

Level

Level of the dimension.

Declaration
public double Level { get; set; }
Property Value
Type Description
System.Double

MemberFunctionScript

Declaration
public string MemberFunctionScript { get; set; }
Property Value
Type Description
System.String

MemberName

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

Declaration
public string MemberName { get; set; }
Property Value
Type Description
System.String

Sortable

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

Declaration
public bool Sortable { get; set; }
Property Value
Type Description
System.Boolean

SortDirection

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

Declaration
public SortingDirection SortDirection { get; set; }
Property Value
Type Description
SortingDirection

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Width

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

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

Methods

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FromEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides

Implements