Class PivotViewColumns

Represents a collection of column field configurations for the SfPivotView<TValue> component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
PivotViewColumns
Implements
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotViewColumns : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

The PivotViewColumns class manages a collection of PivotViewColumn instances that define which fields are displayed in the column axis of the pivot table.

The following configurations are applicable for column axis fields:

  • Name: Specifies the field name that needs to be displayed in the column axis of the pivot table.
  • Caption: Specifies the caption to the specific field. The caption will be used to display instead of the field name in the pivot table component's UI.
  • ShowNoDataItems: Displays all member items of a specific field in the pivot table, even when no data exists in the row/column intersection in the data source. Note: Applicable only for relational data sources.
  • ShowSubTotals: Shows or hides sub-totals for a specific field in the column axis of the pivot table.
  • IsNamedSet: Specifies whether the field is a named set or not. In general, the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: Applicable only for OLAP data sources.
  • IsCalculatedField: Specifies whether the field is a calculated field or not. In general, the calculated field is created from the bound data source or using simple formulas with basic arithmetic operators in the pivot table. Note: Applicable only for OLAP data sources.
  • ShowFilterIcon: Shows or hides the filter icon of a specific field that is displayed on the pivot button of the grouping bar and field list UI. This filter icon is used to filter the members of a specified field at runtime in the pivot table.
  • ShowSortIcon: Shows or hides the sort icon of a specific field that is displayed in the pivot button of the grouping bar and field list UI. This sort icon is used to order members of a specified field either in ascending or descending order at runtime.
  • ShowRemoveIcon: Shows or hides the remove icon of a specific field that is displayed in the pivot button of the grouping bar and field list UI. This remove icon is used to remove the specified field during runtime.
  • ShowEditIcon: Shows or hides the edit icon of a specific field that is displayed on the pivot button of the grouping bar and field list UI. This edit icon is used to modify the caption, formula, and format of a specified calculated field at runtime that is displayed in the pivot table.
  • AllowDragAndDrop: Restricts the specific field's pivot button from being dragged at runtime in the grouping bar and field list UI. This prevents modification of the current report.

Constructors

PivotViewColumns()

Declaration
public PivotViewColumns()

Methods

BuildRenderTree(RenderTreeBuilder)

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

Dispose(bool)

Dispose unmanaged resources in the component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

Implements