Back to all docs
API Reference / Telerik.Blazor.Components / TelerikPivotGrid<TItem>
New to Telerik UI for Blazor? Start a free 30-day trial

TelerikPivotGrid<TItem>

Class

A component that lets you analyze data in a pivot table with rows, columns, and measures. Supports local and OLAP (XMLA) data providers, load-on-demand, sorting, filtering (label/set/interval), expand/collapse, totals, custom templates for headers and data cells, a Configurator for field management, and programmatic APIs to rebind and reorder fields. Children: PivotGridRows, PivotGridColumns, PivotGridMeasures, PivotGridSettings.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:
C#
public class TelerikPivotGrid<TItem> : DataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikPivotGrid<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)...

Constructors

TelerikPivotGrid()

C#
public TelerikPivotGrid()

Properties

ColumnHeadersWidth

Specifies the width of the column headers.

C#
[Parameter]
public string ColumnHeadersWidth { get; set; }

ColumnHeaderTemplate

Specifies the column header template.

C#
[Parameter]
public RenderFragment<object> ColumnHeaderTemplate { get; set; }

DataCellTemplate

Specifies the data cell template.

C#
[Parameter]
public RenderFragment<object> DataCellTemplate { get; set; }

DataProviderType

Specifies the data provider type.

C#
[Parameter]
public PivotGridDataProviderType DataProviderType { get; set; }

EnableLoaderContainer

Defines if a loading indicator displays during long-running operations.

C#
[Parameter]
public bool EnableLoaderContainer { get; set; }

Height

Specifies the height of the component.

C#
[Parameter]
public string Height { get; set; }

LoadOnDemand

Specifies if load on demand is enabled.

C#
[Parameter]
public bool LoadOnDemand { get; set; }

PivotGridColumns

Defines the columns configuration section of the component. Children: PivotGridColumn.

C#
[Parameter]
public RenderFragment PivotGridColumns { get; set; }

PivotGridMeasures

Defines the measures configuration section of the component. Children: PivotGridMeasure.

C#
[Parameter]
public RenderFragment PivotGridMeasures { get; set; }

PivotGridRows

Defines the rows configuration section of the component. Children: PivotGridRow.

C#
[Parameter]
public RenderFragment PivotGridRows { get; set; }

PivotGridSettings

Defines the settings configuration section of the component. Children: PivotGridXmlaDataProviderSettings.

C#
[Parameter]
public RenderFragment PivotGridSettings { get; set; }

RowHeadersWidth

Specifies the width of the row headers.

C#
[Parameter]
public string RowHeadersWidth { get; set; }

RowHeaderTemplate

Specifies the row header template.

C#
[Parameter]
public RenderFragment<object> RowHeaderTemplate { get; set; }

Width

Specifies the width of the component.

C#
[Parameter]
public string Width { get; set; }

Methods

AddXmlaDataProviderSettings(PivotGridXmlaDataProviderSettings)

C#
public void AddXmlaDataProviderSettings(PivotGridXmlaDataProviderSettings item)
Parameters:itemPivotGridXmlaDataProviderSettings

BuildRenderTree(RenderTreeBuilder)

C#
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

C#
public override void Dispose()

Overrides: DataBoundComponent<TItem>.Dispose()

OnAfterRenderAsync(bool)

C#
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

OnInitializedAsync()

C#
protected override Task OnInitializedAsync()
Returns:

Task

Overrides: BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

C#
protected override Task OnParametersSetAsync()
Returns:

Task

Overrides: DataBoundComponent<TItem>.OnParametersSetAsync()

Rebind()

Processes the available data with applied all data operations. Useful in scenarios where the data might change from an outside source. If the component contains OnRead, the method triggers the event so that fresh data can be supplied.

C#
public override void Rebind()

Overrides: DataBoundComponent<TItem>.Rebind()

RemoveXmlaConnectionSettings()

C#
public void RemoveXmlaConnectionSettings()

SetParametersAsync(ParameterView)

C#
public override Task SetParametersAsync(ParameterView parameters)
Parameters:parametersParameterViewReturns:

Task

Overrides: DataBoundComponent<TItem>.SetParametersAsync(ParameterView)

In this article
DefinitionConstructorsTelerikPivotGrid()PropertiesColumnHeaderTemplateColumnHeadersWidthDataCellTemplateDataProviderTypeEnableLoaderContainerHeightLoadOnDemandPivotGridColumnsPivotGridMeasuresPivotGridRowsPivotGridSettingsRowHeaderTemplateRowHeadersWidthWidthMethodsAddXmlaDataProviderSettings(PivotGridXmlaDataProviderSettings)BuildRenderTree(RenderTreeBuilder)Dispose()OnAfterRenderAsync(bool)OnInitializedAsync()OnParametersSetAsync()Rebind()RemoveXmlaConnectionSettings()SetParametersAsync(ParameterView)
Not finding the help you need?
Contact Support