Class PivotViewValues

Represents a collection of value field configurations for the SfPivotView<TValue> component's value axis.

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

The PivotViewValues class manages a collection of PivotViewValue instances that define value fields in the pivot table. Value fields display aggregated numeric data at the intersection of row and column dimensions, with support for various aggregation types such as sum, product, count, average, minimum, and maximum. Multiple value fields can be configured to display different aggregations or calculated fields simultaneously.

The following configurations are applicable for each PivotViewValue instance in the collection:

  • Name: Specifies the field name that needs to be displayed in the row/column/value/filter axis of the pivot table.
  • Caption: Specifies the caption for the specific field. The caption is displayed instead of the field name in the pivot table component's UI.
  • Type: Displays the values in the pivot table with appropriate aggregations such as sum, product, count, average, and other aggregation types. This configuration is applicable only for relational data sources.
  • BaseField: Specifies the selective field, which is used to display the values with either DifferenceFrom, PercentageOfDifferenceFrom, or PercentageOfParentTotal aggregate types. This configuration is applicable only for relational data sources.
  • BaseItem: Specifies the selective item of a specific field, which is used to display the values with either DifferenceFrom or PercentageOfDifferenceFrom aggregate types. The selective item should be set from the field specified in the BaseField property. This configuration is applicable only for relational data sources.
  • IsCalculatedField: Specifies whether the specified field is a calculated field or not. In general, calculated fields are created from the bound data source or using simple formulas with basic arithmetic operators in the pivot table. This configuration is applicable only for OLAP data sources.
  • 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. The remove icon is used to remove the specified field during runtime.
  • ShowValueTypeIcon: Shows or hides the value type icon of a specific field that is displayed in the pivot button of the grouping bar and field list UI. The value type icon helps to select the appropriate aggregation type for the specified value field at 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. The 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 that is used to drag at runtime in the grouping bar and field list UI. This configuration prevents modification of the current report.

Constructors

PivotViewValues()

Declaration
public PivotViewValues()

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