Demos Star Radzen Blazor Components on GitHub

RadzenPivotDataGrid<TItem> Class

RadzenPivotDataGrid component for creating pivot tables with cross-tabulation functionality.

Inheritance

Object

ComponentBase

RadzenComponent

PagedDataBoundComponent<TItem>

RadzenPivotDataGrid<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Inherited Members

PagedDataBoundComponent<TItem>.OnCollectionChanged

PagedDataBoundComponent<TItem>.Dispose

PagedDataBoundComponent<TItem>.SetParametersAsync

PagedDataBoundComponent<TItem>.OnParametersSetAsync

PagedDataBoundComponent<TItem>.OnAfterRenderAsync

PagedDataBoundComponent<TItem>.OnPageChanged

PagedDataBoundComponent<TItem>.OnPageSizeChanged

PagedDataBoundComponent<TItem>.CalculatePager

PagedDataBoundComponent<TItem>.GoToPage

PagedDataBoundComponent<TItem>.FirstPage

PagedDataBoundComponent<TItem>.PrevPage

PagedDataBoundComponent<TItem>.NextPage

PagedDataBoundComponent<TItem>.LastPage

PagedDataBoundComponent<TItem>.PagerPosition

PagedDataBoundComponent<TItem>.PagerAlwaysVisible

PagedDataBoundComponent<TItem>.PagerHorizontalAlign

PagedDataBoundComponent<TItem>.Density

PagedDataBoundComponent<TItem>.AllowPaging

PagedDataBoundComponent<TItem>.PageSize

PagedDataBoundComponent<TItem>.PageNumbersCount

PagedDataBoundComponent<TItem>.Count

PagedDataBoundComponent<TItem>.CurrentPage

PagedDataBoundComponent<TItem>.Template

PagedDataBoundComponent<TItem>.LoadingTemplate

PagedDataBoundComponent<TItem>.Data

PagedDataBoundComponent<TItem>.PageSizeOptions

PagedDataBoundComponent<TItem>.PageSizeText

PagedDataBoundComponent<TItem>.ShowPagingSummary

PagedDataBoundComponent<TItem>.PagingSummaryFormat

PagedDataBoundComponent<TItem>.PagingSummaryTemplate

PagedDataBoundComponent<TItem>.FirstPageTitle

PagedDataBoundComponent<TItem>.FirstPageAriaLabel

PagedDataBoundComponent<TItem>.PrevPageLabel

PagedDataBoundComponent<TItem>.PrevPageTitle

PagedDataBoundComponent<TItem>.PrevPageAriaLabel

PagedDataBoundComponent<TItem>.LastPageTitle

PagedDataBoundComponent<TItem>.LastPageAriaLabel

PagedDataBoundComponent<TItem>.NextPageLabel

PagedDataBoundComponent<TItem>.NextPageTitle

PagedDataBoundComponent<TItem>.NextPageAriaLabel

PagedDataBoundComponent<TItem>.PageTitleFormat

PagedDataBoundComponent<TItem>.PageAriaLabelFormat

PagedDataBoundComponent<TItem>.PagedView

PagedDataBoundComponent<TItem>.LoadData

PagedDataBoundComponent<TItem>.Page

PagedDataBoundComponent<TItem>.skip

PagedDataBoundComponent<TItem>.topPager

PagedDataBoundComponent<TItem>.bottomPager

RadzenComponent.OnMouseEnter

RadzenComponent.OnMouseLeave

RadzenComponent.OnContextMenu

RadzenComponent.GetCssClass

RadzenComponent.GetId

RadzenComponent.Debounce

RadzenComponent.Localize

RadzenComponent.OnInitialized

RadzenComponent.RaiseContextMenu

RadzenComponent.RaiseMouseEnter

RadzenComponent.AddContextMenu

RadzenComponent.RaiseMouseLeave

RadzenComponent.OnBecameInvisible

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.UICulture

RadzenComponent.DefaultUICulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync

ComponentBase.OnParametersSet

ComponentBase.StateHasChanged

ComponentBase.ShouldRender

ComponentBase.OnAfterRender

ComponentBase.InvokeAsync

ComponentBase.DispatchExceptionAsync

ComponentBase.RendererInfo

ComponentBase.Assets

ComponentBase.AssignedRenderMode

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenPivotDataGrid<TItem> : PagedDataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender

Type Parameters

Name Description
TItemThe type of the PivotDataGrid data item.

Examples

<RadzenPivotDataGrid @data=@orders TItem="Order" AllowSorting="true" AllowPaging="true" AllowFiltering="true">
    <Columns>
        <RadzenPivotColumn TItem="Order" Property="Category" Title="Category" />
        <RadzenPivotColumn TItem="Order" Property="Region" Title="Region" />
    </Columns>
    <Rows>
        <RadzenPivotRow TItem="Order" Property="Product" Title="Product" />
        <RadzenPivotRow TItem="Order" Property="Year" Title="Year" />
    </Rows>
    <Aggregates>
        <RadzenPivotAggregate TItem="Order" Property="Amount" Title="Amount" Aggregate="AggregateFunction.Sum" />
        <RadzenPivotAggregate TItem="Order" Property="Quantity" Title="Quantity" Aggregate="AggregateFunction.Count" />
    </Aggregates>
</RadzenPivotDataGrid>

Constructors

RadzenPivotDataGrid<TItem>Link to this section

RadzenPivotDataGrid component for creating pivot tables with cross-tabulation functionality.

Declaration
public RadzenPivotDataGrid<TItem>()

Properties

AggregatesLink to this section

Gets or sets the aggregates collection for pivot aggregates/measures.

Declaration
public RenderFragment Aggregates { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the aggregates collection for pivot aggregates/measures.

AggregatesCollectionLink to this section

Gets the aggregates collection.

Declaration
public IList<RadzenPivotAggregate<TItem>> AggregatesCollection { get; }
Property Value
Type Description
IList<RadzenPivotAggregate<TItem>>Gets the aggregates collection.

AggregatesTextLink to this section

Gets or sets the Aggregates text.

Declaration
public string AggregatesText { get; set; }
Property Value
Type Description
stringGets or sets the Aggregates text.

AllowAlternatingRowsLink to this section

Gets or sets a value indicating whether RadzenPivotDataGrid should use alternating row styles.

Declaration
public bool AllowAlternatingRows { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether RadzenPivotDataGrid should use alternating row styles.

AllowDrillDownLink to this section

Gets or sets a value indicating whether drill down functionality is enabled.

Declaration
public bool AllowDrillDown { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether drill down functionality is enabled.

AllowFieldsPickingLink to this section

Gets or sets a value indicating whether picking of fields runtime is allowed. Set to false by default.

Declaration
public bool AllowFieldsPicking { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether picking of fields runtime is allowed. Set to false by default.

AllowFilterDateInputLink to this section

Gets or sets whether to allow filter date input.

Declaration
public bool AllowFilterDateInput { get; set; }
Property Value
Type Description
boolGets or sets whether to allow filter date input.

AllowFilteringLink to this section

Gets or sets a value indicating whether filtering is enabled.

Declaration
public bool AllowFiltering { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether filtering is enabled.

AllowSortingLink to this section

Gets or sets a value indicating whether sorting is enabled.

Declaration
public bool AllowSorting { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether sorting is enabled.

AndOperatorTextLink to this section

Gets or sets the and operator text.

Declaration
public string AndOperatorText { get; set; }
Property Value
Type Description
stringGets or sets the and operator text.

ApplyTextLink to this section

Gets or sets the apply text.

Declaration
public string ApplyText { get; set; }
Property Value
Type Description
stringGets or sets the apply text.

ClearTextLink to this section

Gets or sets the clear text.

Declaration
public string ClearText { get; set; }
Property Value
Type Description
stringGets or sets the clear text.

ColumnsLink to this section

Gets or sets the columns collection for pivot columns.

Declaration
public RenderFragment Columns { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the columns collection for pivot columns.

ColumnsCollectionLink to this section

Gets the columns collection.

Declaration
public IList<RadzenPivotColumn<TItem>> ColumnsCollection { get; }
Property Value
Type Description
IList<RadzenPivotColumn<TItem>>Gets the columns collection.

ColumnsTextLink to this section

Gets or sets the Columns text.

Declaration
public string ColumnsText { get; set; }
Property Value
Type Description
stringGets or sets the Columns text.

ContainsTextLink to this section

Gets or sets the contains text.

Declaration
public string ContainsText { get; set; }
Property Value
Type Description
stringGets or sets the contains text.

CustomTextLink to this section

Gets or sets the custom filter operator text.

Declaration
public string CustomText { get; set; }
Property Value
Type Description
stringGets or sets the custom filter operator text.

DoesNotContainTextLink to this section

Gets or sets the does not contain text.

Declaration
public string DoesNotContainText { get; set; }
Property Value
Type Description
stringGets or sets the does not contain text.

EmptyTemplateLink to this section

Gets or sets the empty template shown when Data is empty collection.

Declaration
public RenderFragment EmptyTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the empty template shown when Data is empty collection.

EmptyTextLink to this section

Gets or sets the empty text shown when Data is empty collection.

Declaration
public string EmptyText { get; set; }
Property Value
Type Description
stringGets or sets the empty text shown when Data is empty collection.

EndsWithTextLink to this section

Gets or sets the ends with text.

Declaration
public string EndsWithText { get; set; }
Property Value
Type Description
stringGets or sets the ends with text.

EnumFilterSelectTextLink to this section

Gets or sets the enum filter select text.

Declaration
public string EnumFilterSelectText { get; set; }
Property Value
Type Description
stringGets or sets the enum filter select text.

EnumFilterTranslationFuncLink to this section

Gets or sets the enum filter translation function.

Declaration
public Func<object, string> EnumFilterTranslationFunc { get; set; }
Property Value
Type Description
Func<object, string>Gets or sets the enum filter translation function.

EqualsTextLink to this section

Gets or sets the equals text.

Declaration
public string EqualsText { get; set; }
Property Value
Type Description
stringGets or sets the equals text.

FieldsPickerExpandedLink to this section

Gets or sets value indicating if the fields picker is expanded.

Declaration
public bool FieldsPickerExpanded { get; set; }
Property Value
Type Description
boolGets or sets value indicating if the fields picker is expanded.

FieldsPickerHeaderTemplateLink to this section

Gets or sets the fields picker header template.

Declaration
public RenderFragment FieldsPickerHeaderTemplate { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the fields picker header template.

FieldsPickerHeaderTextLink to this section

Gets or sets the fields picker header text.

Declaration
public string FieldsPickerHeaderText { get; set; }
Property Value
Type Description
stringGets or sets the fields picker header text.

FilterCaseSensitivityLink to this section

Gets or sets the filter case sensitivity.

Declaration
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }
Property Value
Type Description
FilterCaseSensitivityGets or sets the filter case sensitivity.

FilterIconLink to this section

Gets or set the filter icon to use.

Declaration
public string FilterIcon { get; set; }
Property Value
Type Description
stringGets or set the filter icon to use.

FilterOperatorAriaLabelLink to this section

Gets or sets the filter operator aria label.

Declaration
public string FilterOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the filter operator aria label.

FilterTextLink to this section

Gets or sets the filter text.

Declaration
public string FilterText { get; set; }
Property Value
Type Description
stringGets or sets the filter text.

FilterValueAriaLabelLink to this section

Gets or sets the filter value aria label.

Declaration
public string FilterValueAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the filter value aria label.

GreaterThanOrEqualsTextLink to this section

Gets or sets the greater than or equals text.

Declaration
public string GreaterThanOrEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the greater than or equals text.

GreaterThanTextLink to this section

Gets or sets the greater than text.

Declaration
public string GreaterThanText { get; set; }
Property Value
Type Description
stringGets or sets the greater than text.

GridLinesLink to this section

Gets or sets the grid lines style.

Declaration
public DataGridGridLines GridLines { get; set; }
Property Value
Type Description
DataGridGridLinesGets or sets the grid lines style.

InTextLink to this section

Gets or sets the in operator text.

Declaration
public string InText { get; set; }
Property Value
Type Description
stringGets or sets the in operator text.

IsEmptyTextLink to this section

Gets or sets the is empty text.

Declaration
public string IsEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the is empty text.

IsLoadingLink to this section

Gets or sets a value indicating whether this instance loading indicator is shown.

Declaration
public bool IsLoading { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this instance loading indicator is shown.

IsNotEmptyTextLink to this section

Gets or sets the is not empty text.

Declaration
public string IsNotEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the is not empty text.

IsNotNullTextLink to this section

Gets or sets the not null text.

Declaration
public string IsNotNullText { get; set; }
Property Value
Type Description
stringGets or sets the not null text.

IsNullTextLink to this section

Gets or sets the is null text.

Declaration
public string IsNullText { get; set; }
Property Value
Type Description
stringGets or sets the is null text.

LessThanOrEqualsTextLink to this section

Gets or sets the less than or equals text.

Declaration
public string LessThanOrEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the less than or equals text.

LessThanTextLink to this section

Gets or sets the less than text.

Declaration
public string LessThanText { get; set; }
Property Value
Type Description
stringGets or sets the less than text.

LogicalFilterOperatorLink to this section

Gets or sets the logical filter operator.

Declaration
public LogicalFilterOperator LogicalFilterOperator { get; set; }
Property Value
Type Description
LogicalFilterOperatorGets or sets the logical filter operator.

LogicalOperatorAriaLabelLink to this section

Gets or sets the logical operator aria label.

Declaration
public string LogicalOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the logical operator aria label.

NotEqualsTextLink to this section

Gets or sets the not equals text.

Declaration
public string NotEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the not equals text.

NotInTextLink to this section

Gets or sets the not in operator text.

Declaration
public string NotInText { get; set; }
Property Value
Type Description
stringGets or sets the not in operator text.

OrOperatorTextLink to this section

Gets or sets the or operator text.

Declaration
public string OrOperatorText { get; set; }
Property Value
Type Description
stringGets or sets the or operator text.

RowsLink to this section

Gets or sets the rows collection for pivot rows.

Declaration
public RenderFragment Rows { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the rows collection for pivot rows.

RowsCollectionLink to this section

Gets the rows collection.

Declaration
public IList<RadzenPivotRow<TItem>> RowsCollection { get; }
Property Value
Type Description
IList<RadzenPivotRow<TItem>>Gets the rows collection.

RowsTextLink to this section

Gets or sets the Rows text.

Declaration
public string RowsText { get; set; }
Property Value
Type Description
stringGets or sets the Rows text.

SecondFilterOperatorAriaLabelLink to this section

Gets or sets the second filter operator aria label.

Declaration
public string SecondFilterOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the second filter operator aria label.

SecondFilterValueAriaLabelLink to this section

Gets or sets the second filter value aria label.

Declaration
public string SecondFilterValueAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the second filter value aria label.

ShowColumnsTotalsLink to this section

Gets or sets a value indicating whether to show column totals.

Declaration
public bool ShowColumnsTotals { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether to show column totals.

ShowRowsTotalsLink to this section

Gets or sets a value indicating whether to show row totals.

Declaration
public bool ShowRowsTotals { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether to show row totals.

SortAriaLabelFormatLink to this section

Gets or sets the sort aria label format.

Declaration
public string SortAriaLabelFormat { get; set; }
Property Value
Type Description
stringGets or sets the sort aria label format.

StartsWithTextLink to this section

Gets or sets the starts with text.

Declaration
public string StartsWithText { get; set; }
Property Value
Type Description
stringGets or sets the starts with text.

ViewLink to this section

Override the View property to apply sorting and filtering.

Declaration
public IQueryable<TItem> View { get; }
Property Value
Type Description
IQueryable<TItem>Override the View property to apply sorting and filtering.

Methods

AddPivotAggregateLink to this section

Adds a pivot aggregate to the pivot grid if it does not already exist.

Declaration
public void AddPivotAggregate(RadzenPivotAggregate<TItem> aggregate)
Parameters
Type Name Description
RadzenPivotAggregate<TItem> aggregate The pivot aggregate to add.

AddPivotColumnLink to this section

Adds a pivot column to the pivot grid if it does not already exist.

Declaration
public void AddPivotColumn(RadzenPivotColumn<TItem> column)
Parameters
Type Name Description
RadzenPivotColumn<TItem> column The pivot column to add.

AddPivotFieldLink to this section

Adds a pivot field to the pivot grid if it does not already exist.

Declaration
public void AddPivotField(RadzenPivotField<TItem> field)
Parameters
Type Name Description
RadzenPivotField<TItem> field The pivot field to add.

AddPivotRowLink to this section

Adds a pivot row to the pivot grid if it does not already exist.

Declaration
public void AddPivotRow(RadzenPivotRow<TItem> row)
Parameters
Type Name Description
RadzenPivotRow<TItem> row The pivot row to add.

BuildRenderTreeLink to this section

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

GetAggregateValueLink to this section

Gets the aggregate value for a group, considering collapsed state.

Declaration
public object GetAggregateValue(IQueryable<TItem> items, RadzenPivotAggregate<TItem> aggregate)
Parameters
Type Name Description
IQueryable<TItem> items The items to aggregate.
RadzenPivotAggregate<TItem> aggregate The aggregate configuration.
Returns
Type Description
objectThe aggregated value.

GetComponentCssClassLink to this section

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

GetFilterOperatorTextLink to this section

Gets the filter operator text.

Declaration
public string GetFilterOperatorText(FilterOperator? filterOperator)
Parameters
Type Name Description
FilterOperator? filterOperator
Returns
Type Description
string

GetTableCssClassLink to this section

Gets the table CSS class.

Declaration
protected virtual string GetTableCssClass()
Returns
Type Description
string

OnDataChangedLink to this section

Declaration
protected override void OnDataChanged()

ReloadLink to this section

Declaration
public override Task Reload()
Returns
Type Description
Task

RenderFooterLink to this section

Renders footer with grand totals for each value column.

Declaration
protected RenderFragment RenderFooter()
Returns
Type Description
RenderFragment

RenderPivotRowsLink to this section

Renders pivot rows with real data aggregation and grouping.

Declaration
protected virtual RenderFragment RenderPivotRows()
Returns
Type Description
RenderFragment

ToggleColumnDrillDownLink to this section

Toggles the drill down state for a column group.

Declaration
public Task ToggleColumnDrillDown(string pathKey)
Parameters
Type Name Description
string pathKey The path key identifying the column group.
Returns
Type Description
Task

ToggleRowDrillDownLink to this section

Toggles the drill down state for a row group.

Declaration
public Task ToggleRowDrillDown(string pathKey)
Parameters
Type Name Description
string pathKey The path key identifying the row group.
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙