[CascadingTypeParameter("TItem")]
public class RadzenPivotDataGrid<TItem> : PagedDataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Type Parameters

Name	Description
TItem	The 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()

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

Declaration

public RadzenPivotDataGrid()

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>

Properties

Aggregates

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

Declaration

[Parameter]
public RenderFragment Aggregates { get; set; }

Property Value

Type	Description
RenderFragment

AggregatesText

Gets or sets the Aggregates text.

Declaration

[Parameter]
public string AggregatesText { get; set; }

Property Value

Type	Description
string

AllowAlternatingRows

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

Declaration

[Parameter]
public bool AllowAlternatingRows { get; set; }

Property Value

Type	Description
bool

AllowDrillDown

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

Declaration

[Parameter]
public bool AllowDrillDown { get; set; }

Property Value

Type	Description
bool

AllowFieldsPicking

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

Declaration

[Parameter]
public bool AllowFieldsPicking { get; set; }

Property Value

Type	Description
bool	`true` if picking of fields runtime is allowed; otherwise, `false`.

AllowFilterDateInput

Gets or sets whether to allow filter date input.

Declaration

[Parameter]
public bool AllowFilterDateInput { get; set; }

Property Value

Type	Description
bool

AllowFiltering

Gets or sets a value indicating whether filtering is enabled.

Declaration

[Parameter]
public bool AllowFiltering { get; set; }

Property Value

Type	Description
bool

AllowSorting

Gets or sets a value indicating whether sorting is enabled.

Declaration

[Parameter]
public bool AllowSorting { get; set; }

Property Value

Type	Description
bool

AndOperatorText

Gets or sets the and operator text.

Declaration

[Parameter]
public string AndOperatorText { get; set; }

Property Value

Type	Description
string

ApplyText

Gets or sets the apply text.

Declaration

[Parameter]
public string ApplyText { get; set; }

Property Value

Type	Description
string

ClearText

Gets or sets the clear text.

Declaration

[Parameter]
public string ClearText { get; set; }

Property Value

Type	Description
string

Columns

Gets or sets the columns collection for pivot columns.

Declaration

[Parameter]
public RenderFragment Columns { get; set; }

Property Value

Type	Description
RenderFragment

ColumnsText

Gets or sets the Columns text.

Declaration

[Parameter]
public string ColumnsText { get; set; }

Property Value

Type	Description
string

ContainsText

Gets or sets the contains text.

Declaration

[Parameter]
public string ContainsText { get; set; }

Property Value

Type	Description
string	The contains text.

CustomText

Gets or sets the custom filter operator text.

Declaration

[Parameter]
public string CustomText { get; set; }

Property Value

Type	Description
string	The custom filter operator text.

DoesNotContainText

Gets or sets the does not contain text.

Declaration

[Parameter]
public string DoesNotContainText { get; set; }

Property Value

Type	Description
string	The does not contain text.

EmptyTemplate

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

Declaration

[Parameter]
public RenderFragment EmptyTemplate { get; set; }

Property Value

Type	Description
RenderFragment

EmptyText

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

Declaration

[Parameter]
public string EmptyText { get; set; }

Property Value

Type	Description
string

EndsWithText

Gets or sets the ends with text.

Declaration

[Parameter]
public string EndsWithText { get; set; }

Property Value

Type	Description
string	The ends with text.

EnumFilterSelectText

Gets or sets the enum filter select text.

Declaration

[Parameter]
public string EnumFilterSelectText { get; set; }

Property Value

Type	Description
string

EnumFilterTranslationFunc

Gets or sets the enum filter translation function.

Declaration

[Parameter]
public Func<object, string> EnumFilterTranslationFunc { get; set; }

Property Value

Type	Description
Func<object, string>

EqualsText

Gets or sets the equals text.

Declaration

[Parameter]
public string EqualsText { get; set; }

Property Value

Type	Description
string	The equals text.

FieldsPickerExpanded

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

Declaration

[Parameter]
public bool FieldsPickerExpanded { get; set; }

Property Value

Type	Description
bool	The fields picker expanded.

FieldsPickerHeaderTemplate

Gets or sets the fields picker header template.

Declaration

[Parameter]
public RenderFragment FieldsPickerHeaderTemplate { get; set; }

Property Value

Type	Description
RenderFragment	The fields picker header template.

FieldsPickerHeaderText

Gets or sets the fields picker header text.

Declaration

[Parameter]
public string FieldsPickerHeaderText { get; set; }

Property Value

Type	Description
string	The fields picker header text.

FilterCaseSensitivity

Gets or sets the filter case sensitivity.

Declaration

[Parameter]
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }

Property Value

Type	Description
FilterCaseSensitivity

FilterIcon

Gets or set the filter icon to use.

Declaration

[Parameter]
public string FilterIcon { get; set; }

Property Value

Type	Description
string

FilterOperatorAriaLabel

Gets or sets the filter operator aria label.

Declaration

[Parameter]
public string FilterOperatorAriaLabel { get; set; }

Property Value

Type	Description
string

FilterText

Gets or sets the filter text.

Declaration

[Parameter]
public string FilterText { get; set; }

Property Value

Type	Description
string

FilterValueAriaLabel

Gets or sets the filter value aria label.

Declaration

[Parameter]
public string FilterValueAriaLabel { get; set; }

Property Value

Type	Description
string

GreaterThanOrEqualsText

Gets or sets the greater than or equals text.

Declaration

[Parameter]
public string GreaterThanOrEqualsText { get; set; }

Property Value

Type	Description
string	The greater than or equals text.

GreaterThanText

Gets or sets the greater than text.

Declaration

[Parameter]
public string GreaterThanText { get; set; }

Property Value

Type	Description
string	The greater than text.

GridLines

Gets or sets the grid lines style.

Declaration

[Parameter]
public DataGridGridLines GridLines { get; set; }

Property Value

Type	Description
DataGridGridLines

InText

Gets or sets the in operator text.

Declaration

[Parameter]
public string InText { get; set; }

Property Value

Type	Description
string	The in operator text.

IsEmptyText

Gets or sets the is empty text.

Declaration

[Parameter]
public string IsEmptyText { get; set; }

Property Value

Type	Description
string	The empty text.

IsLoading

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

Declaration

[Parameter]
public bool IsLoading { get; set; }

Property Value

Type	Description
bool	`true` if this instance loading indicator is shown; otherwise, `false`.

IsNotEmptyText

Gets or sets the is not empty text.

Declaration

[Parameter]
public string IsNotEmptyText { get; set; }

Property Value

Type	Description
string	The not empty text.

IsNotNullText

Gets or sets the not null text.

Declaration

[Parameter]
public string IsNotNullText { get; set; }

Property Value

Type	Description
string	The not null text.

IsNullText

Gets or sets the is null text.

Declaration

[Parameter]
public string IsNullText { get; set; }

Property Value

Type	Description
string	The null text.

LessThanOrEqualsText

Gets or sets the less than or equals text.

Declaration

[Parameter]
public string LessThanOrEqualsText { get; set; }

Property Value

Type	Description
string	The less than or equals text.

LessThanText

Gets or sets the less than text.

Declaration

[Parameter]
public string LessThanText { get; set; }

Property Value

Type	Description
string	The less than text.

LogicalFilterOperator

Gets or sets the logical filter operator.

Declaration

[Parameter]
public LogicalFilterOperator LogicalFilterOperator { get; set; }

Property Value

Type	Description
LogicalFilterOperator

LogicalOperatorAriaLabel

Gets or sets the logical operator aria label.

Declaration

[Parameter]
public string LogicalOperatorAriaLabel { get; set; }

Property Value

Type	Description
string

NotEqualsText

Gets or sets the not equals text.

Declaration

[Parameter]
public string NotEqualsText { get; set; }

Property Value

Type	Description
string	The not equals text.

NotInText

Gets or sets the not in operator text.

Declaration

[Parameter]
public string NotInText { get; set; }

Property Value

Type	Description
string	The not in operator text.

OrOperatorText

Gets or sets the or operator text.

Declaration

[Parameter]
public string OrOperatorText { get; set; }

Property Value

Type	Description
string

Rows

Gets or sets the rows collection for pivot rows.

Declaration

[Parameter]
public RenderFragment Rows { get; set; }

Property Value

Type	Description
RenderFragment

RowsText

Gets or sets the Rows text.

Declaration

[Parameter]
public string RowsText { get; set; }

Property Value

Type	Description
string

SecondFilterOperatorAriaLabel

Gets or sets the second filter operator aria label.

Declaration

[Parameter]
public string SecondFilterOperatorAriaLabel { get; set; }

Property Value

Type	Description
string

SecondFilterValueAriaLabel

Gets or sets the second filter value aria label.

Declaration

[Parameter]
public string SecondFilterValueAriaLabel { get; set; }

Property Value

Type	Description
string

ShowColumnsTotals

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

Declaration

[Parameter]
public bool ShowColumnsTotals { get; set; }

Property Value

Type	Description
bool

ShowRowsTotals

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

Declaration

[Parameter]
public bool ShowRowsTotals { get; set; }

Property Value

Type	Description
bool

StartsWithText

Gets or sets the starts with text.

Declaration

[Parameter]
public string StartsWithText { get; set; }

Property Value

Type	Description
string	The starts with text.

View

Override the View property to apply sorting and filtering.

Declaration

public override IQueryable<TItem> View { get; }

Property Value

Type	Description
IQueryable<TItem>

Overrides

PagedDataBoundComponent<TItem>.View

Methods

BuildRenderTree(RenderTreeBuilder)

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

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

GetAggregateValue(IQueryable<TItem>, RadzenPivotAggregate<TItem>)

Gets the aggregate value for items.

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
object	The aggregated value.

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

GetFilterOperatorText(FilterOperator?)

Gets the filter operator text.

Declaration

public string GetFilterOperatorText(FilterOperator? filterOperator)

Parameters

Type	Name	Description
FilterOperator?	filterOperator

Returns

Type	Description
string

GetTableCssClass()

Gets the table CSS class.

Declaration

protected virtual string GetTableCssClass()

Returns

Type	Description
string

OnDataChanged()

Called when [data changed].

Declaration

protected override void OnDataChanged()

Overrides

PagedDataBoundComponent<TItem>.OnDataChanged()

Reload()

Reloads this instance.

Declaration

public override Task Reload()

Returns

Type	Description
Task

Overrides

PagedDataBoundComponent<TItem>.Reload()

RenderFooter()

Renders footer with grand totals for each value column.

Declaration

protected RenderFragment RenderFooter()

Returns

Type	Description
RenderFragment

RenderPivotRows()

Renders pivot rows with real data aggregation and grouping.

Declaration

protected virtual RenderFragment RenderPivotRows()

Returns

Type	Description
RenderFragment

ToggleColumnDrillDown(string)

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

ToggleRowDrillDown(string)

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

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable