Class PivotViewValue
Represents a value field configuration for the SfPivotView<TValue> component's value axis.
Inheritance
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotViewValue : PivotFieldOptions, IComponent, IHandleEvent, IHandleAfterRender, IDisposableRemarks
The PivotViewValue class defines configuration settings for fields in the value axis of the pivot table. Value fields display aggregated numeric data at the intersection of row and column dimensions, with support for various aggregation types. Each value field configuration specifies how the field should be aggregated and displayed, including caption, aggregation type, and interaction features.
The following configurations are applicable for value fields:
Name: Specifies the field name that will be displayed in the row/column/value/filter axis of the pivot table.Caption: Specifies the caption for the specific field. The caption will be used to display 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, minimum, maximum, etc. Note: Applicable only for relational data sources.BaseField: Specifies the selective field that is used to display the values with either DifferenceFrom, PercentageOfDifferenceFrom, or PercentageOfParentTotal aggregate types. Note: Applicable only for relational data sources.BaseItem: Specifies the selective item of a specific field that is used to display the values with either DifferenceFrom or PercentageOfDifferenceFrom aggregate types. The selective item should be from the field specified in the BaseField property. Note: Applicable only for relational 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.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.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. This 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. 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.ExpandAll: Expands or collapses all of the pivot table's headers for a specific field.
Constructors
PivotViewValue()
Declaration
public PivotViewValue()Methods
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
OnParametersSetAsync()
Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
Declaration
protected override Task OnParametersSetAsync()Returns
| Type | Description |
|---|---|
| Task | A System.Threading.Tasks.Task representing any asynchronous operation. |