Class IgbPivotGrid

Inheritance
System.Object
BaseRendererControl
IgbGridBaseDirective
IgbPivotGrid
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbPivotGrid : IgbGridBaseDirective, RefSink, JsonSerializable, IDisposable

Constructors

IgbPivotGrid()

Declaration
public IgbPivotGrid()

Properties

AutoGenerateConfig

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

Data

Declaration
public object Data { get; set; }
Property Value
Type Description
System.Object

DataScript

Provides a means of setting Data in the JavaScript environment.

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

DefaultExpandState

Gets/Sets the default expand state for all rows.

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

DimensionInit

Declaration
public EventCallback<IgbPivotDimensionEventArgs> DimensionInit { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbPivotDimensionEventArgs>

DimensionInitScript

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

DimensionsChange

Declaration
public EventCallback<IgbDimensionsChangeEventArgs> DimensionsChange { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbDimensionsChangeEventArgs>

DimensionsChangeScript

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

DimensionsSortingExpressionsChange

Declaration
public EventCallback<IgbSortingExpressionEventArgs> DimensionsSortingExpressionsChange { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbSortingExpressionEventArgs>

DimensionsSortingExpressionsChangeScript

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

EmptyPivotGridTemplate

Declaration
public RenderFragment<object> EmptyPivotGridTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

EmptyPivotGridTemplateScript

Provides a means of setting EmptyPivotGridTemplate in the JavaScript environment.

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

PivotConfiguration

Declaration
public IgbPivotConfiguration PivotConfiguration { get; set; }
Property Value
Type Description
IgbPivotConfiguration

PivotConfigurationChange

Declaration
public EventCallback<IgbPivotConfigurationChangedEventArgs> PivotConfigurationChange { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbPivotConfigurationChangedEventArgs>

PivotConfigurationChanged

Declaration
public EventCallback<IgbPivotConfiguration> PivotConfigurationChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbPivotConfiguration>

PivotConfigurationChangeScript

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

PivotUI

Declaration
public IgbPivotUISettings PivotUI { get; set; }
Property Value
Type Description
IgbPivotUISettings

RowDimensionHeaderTemplate

Declaration
public RenderFragment<IgbColumnTemplateContext> RowDimensionHeaderTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbColumnTemplateContext>

RowDimensionHeaderTemplateScript

Provides a means of setting RowDimensionHeaderTemplate in the JavaScript environment.

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

SuperCompactMode

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

Type

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

ValueChipTemplate

Declaration
public RenderFragment<IgbPivotGridValueTemplateContext> ValueChipTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbPivotGridValueTemplateContext>

ValueChipTemplateScript

Provides a means of setting ValueChipTemplate in the JavaScript environment.

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

ValueInit

Declaration
public EventCallback<IgbPivotValueEventArgs> ValueInit { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbPivotValueEventArgs>

ValueInitScript

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

ValuesChange

Declaration
public EventCallback<IgbValuesChangeEventArgs> ValuesChange { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbValuesChangeEventArgs>

ValuesChangeScript

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

Methods

AutoSizeRowDimension(IgbPivotDimension)

Declaration
public void AutoSizeRowDimension(IgbPivotDimension dimension)
Parameters
Type Name Description
IgbPivotDimension dimension

AutoSizeRowDimensionAsync(IgbPivotDimension)

Auto-sizes row dimension cells. @remarks Only sizes based on the dimension cells in view. @example

this.grid.autoSizeRowDimension(dimension);

dimension The row dimension to size.

Declaration
public Task AutoSizeRowDimensionAsync(IgbPivotDimension dimension)
Parameters
Type Name Description
IgbPivotDimension dimension

The row dimension to size.
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FilterDimension(IgbPivotDimension, Object, IgbFilteringExpressionsTreeOrFilteringOperation)

Declaration
public void FilterDimension(IgbPivotDimension dimension, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree)
Parameters
Type Name Description
IgbPivotDimension dimension
System.Object value
IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree

FilterDimensionAsync(IgbPivotDimension, Object, IgbFilteringExpressionsTreeOrFilteringOperation)

Declaration
public Task FilterDimensionAsync(IgbPivotDimension dimension, object value, IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree)
Parameters
Type Name Description
IgbPivotDimension dimension
System.Object value
IgbFilteringExpressionsTreeOrFilteringOperation conditionOrExpressionTree
Returns
Type Description
System.Threading.Tasks.Task

FindByName(String)

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

GetAllDimensions()

Declaration
public IgbPivotDimension[] GetAllDimensions()
Returns
Type Description
IgbPivotDimension[]

GetAllDimensionsAsync()

Declaration
public Task<IgbPivotDimension[]> GetAllDimensionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbPivotDimension[]>

GetColumnGroupExpandState(IgbColumn)

Declaration
public void GetColumnGroupExpandState(IgbColumn col)
Parameters
Type Name Description
IgbColumn col

GetColumnGroupExpandStateAsync(IgbColumn)

Declaration
public Task GetColumnGroupExpandStateAsync(IgbColumn col)
Parameters
Type Name Description
IgbColumn col
Returns
Type Description
System.Threading.Tasks.Task

GetCurrentPivotConfiguration()

Declaration
public IgbPivotConfiguration GetCurrentPivotConfiguration()
Returns
Type Description
IgbPivotConfiguration

GetCurrentPivotConfigurationAsync()

Declaration
public Task<IgbPivotConfiguration> GetCurrentPivotConfigurationAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbPivotConfiguration>

GetDimensionsSortingExpressions()

Declaration
public IgbSortingExpression[] GetDimensionsSortingExpressions()
Returns
Type Description
IgbSortingExpression[]

GetDimensionsSortingExpressionsAsync()

Declaration
public Task<IgbSortingExpression[]> GetDimensionsSortingExpressionsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbSortingExpression[]>

InsertDimensionAt(IgbPivotDimension, PivotDimensionType, Double)

Declaration
public void InsertDimensionAt(IgbPivotDimension dimension, PivotDimensionType targetCollectionType, double index = -1)
Parameters
Type Name Description
IgbPivotDimension dimension
PivotDimensionType targetCollectionType
System.Double index

InsertDimensionAtAsync(IgbPivotDimension, PivotDimensionType, Double)

Declaration
public Task InsertDimensionAtAsync(IgbPivotDimension dimension, PivotDimensionType targetCollectionType, double index = -1)
Parameters
Type Name Description
IgbPivotDimension dimension
PivotDimensionType targetCollectionType
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

InsertValueAt(IgbPivotValue, Double)

Declaration
public void InsertValueAt(IgbPivotValue value, double index = -1)
Parameters
Type Name Description
IgbPivotValue value
System.Double index

InsertValueAtAsync(IgbPivotValue, Double)

Declaration
public Task InsertValueAtAsync(IgbPivotValue value, double index = -1)
Parameters
Type Name Description
IgbPivotValue value
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

MoveDimension(IgbPivotDimension, PivotDimensionType, Double)

Declaration
public void MoveDimension(IgbPivotDimension dimension, PivotDimensionType targetCollectionType, double index = -1)
Parameters
Type Name Description
IgbPivotDimension dimension
PivotDimensionType targetCollectionType
System.Double index

MoveDimensionAsync(IgbPivotDimension, PivotDimensionType, Double)

Declaration
public Task MoveDimensionAsync(IgbPivotDimension dimension, PivotDimensionType targetCollectionType, double index = -1)
Parameters
Type Name Description
IgbPivotDimension dimension
PivotDimensionType targetCollectionType
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

MoveValue(IgbPivotValue, Double)

Declaration
public void MoveValue(IgbPivotValue value, double index = -1)
Parameters
Type Name Description
IgbPivotValue value
System.Double index

MoveValueAsync(IgbPivotValue, Double)

Declaration
public Task MoveValueAsync(IgbPivotValue value, double index = -1)
Parameters
Type Name Description
IgbPivotValue value
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

NotifyDimensionChange(Boolean)

Declaration
public void NotifyDimensionChange(bool regenerateColumns = false)
Parameters
Type Name Description
System.Boolean regenerateColumns

NotifyDimensionChangeAsync(Boolean)

Notifies for dimension change.

Declaration
public Task NotifyDimensionChangeAsync(bool regenerateColumns = false)
Parameters
Type Name Description
System.Boolean regenerateColumns
Returns
Type Description
System.Threading.Tasks.Task

RemoveDimension(IgbPivotDimension)

Declaration
public void RemoveDimension(IgbPivotDimension dimension)
Parameters
Type Name Description
IgbPivotDimension dimension

RemoveDimensionAsync(IgbPivotDimension)

Removes dimension from its currently collection. @remarks This is different than toggleDimension that enabled/disables the dimension. This completely removes the specified dimension from the collection. @example

this.grid.removeDimension(dimension);

dimension The dimension to be removed.

Declaration
public Task RemoveDimensionAsync(IgbPivotDimension dimension)
Parameters
Type Name Description
IgbPivotDimension dimension

The dimension to be removed.
Returns
Type Description
System.Threading.Tasks.Task

RemoveValue(IgbPivotValue)

Declaration
public void RemoveValue(IgbPivotValue value)
Parameters
Type Name Description
IgbPivotValue value

RemoveValueAsync(IgbPivotValue)

Removes value from collection. @remarks This is different than toggleValue that enabled/disables the value. This completely removes the specified value from the collection. @example

this.grid.removeValue(dimension);

value The value to be removed.

Declaration
public Task RemoveValueAsync(IgbPivotValue value)
Parameters
Type Name Description
IgbPivotValue value

The value to be removed.
Returns
Type Description
System.Threading.Tasks.Task

SortDimension(IgbPivotDimension, SortingDirection)

Declaration
public void SortDimension(IgbPivotDimension dimension, SortingDirection sortDirection)
Parameters
Type Name Description
IgbPivotDimension dimension
SortingDirection sortDirection

SortDimensionAsync(IgbPivotDimension, SortingDirection)

Declaration
public Task SortDimensionAsync(IgbPivotDimension dimension, SortingDirection sortDirection)
Parameters
Type Name Description
IgbPivotDimension dimension
SortingDirection sortDirection
Returns
Type Description
System.Threading.Tasks.Task

ToggleColumn(IgbColumn)

Declaration
public void ToggleColumn(IgbColumn col)
Parameters
Type Name Description
IgbColumn col

ToggleColumnAsync(IgbColumn)

Declaration
public Task ToggleColumnAsync(IgbColumn col)
Parameters
Type Name Description
IgbColumn col
Returns
Type Description
System.Threading.Tasks.Task

ToggleDimension(IgbPivotDimension)

Declaration
public void ToggleDimension(IgbPivotDimension dimension)
Parameters
Type Name Description
IgbPivotDimension dimension

ToggleDimensionAsync(IgbPivotDimension)

Toggles the dimension's enabled state on or off. @remarks The dimension remains in its current collection. This just changes its enabled state. @example

this.grid.toggleDimension(dimension);

dimension The dimension to be toggled.

Declaration
public Task ToggleDimensionAsync(IgbPivotDimension dimension)
Parameters
Type Name Description
IgbPivotDimension dimension

The dimension to be toggled.
Returns
Type Description
System.Threading.Tasks.Task

ToggleRowGroup(IgbColumn, Boolean)

Declaration
public void ToggleRowGroup(IgbColumn col, bool newState)
Parameters
Type Name Description
IgbColumn col
System.Boolean newState

ToggleRowGroupAsync(IgbColumn, Boolean)

Declaration
public Task ToggleRowGroupAsync(IgbColumn col, bool newState)
Parameters
Type Name Description
IgbColumn col
System.Boolean newState
Returns
Type Description
System.Threading.Tasks.Task

ToggleValue(IgbPivotValue)

Declaration
public void ToggleValue(IgbPivotValue value)
Parameters
Type Name Description
IgbPivotValue value

ToggleValueAsync(IgbPivotValue)

Toggles the value's enabled state on or off. @remarks The value remains in its current collection. This just changes its enabled state. @example

this.grid.toggleValue(value);

value The value to be toggled.

Declaration
public Task ToggleValueAsync(IgbPivotValue value)
Parameters
Type Name Description
IgbPivotValue value

The value to be toggled.
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable