Class SfPivotFieldList<TValue>

The Blazor Pivot Field List component allows to add or remove fields and also rearrange them between different axes, including column, row, value, and filter along with sort and filter options dynamically at runtime. It can be displayed in two different formats either in-built (Popup) or stand-alone (Fixed) field list to interact with pivot table.

Inheritance
System.Object
SfBaseComponent
SfDataBoundComponent
SfPivotFieldList<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class SfPivotFieldList<TValue> : SfDataBoundComponent, IPivotFieldList, ISfCircularComponent
Type Parameters
Name Description
TValue

A type which provides schema for the pivot component.

Constructors

SfPivotFieldList()

Declaration
public SfPivotFieldList()

Properties

AggregateTypes

Allows you to show a menu with built-in aggregate options displayed in the pivot button's dropdown icon of fieldList UI. These aggregate options help to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… easily at runtime. The available aggregate options are: Sum: Allows to display the pivot table values with sum. Product: Allows to display the pivot table values with product. Count: Allows to display the pivot table values with count. DistinctCount: Allows to display the pivot table values with distinct count. Min: Allows to display the pivot table with minimum value. Max: Allows to display the pivot table with maximum value. Avg: Allows to display the pivot table values with average. Index: Allows to display the pivot table values with index. PopulationStDev: Allows to display the pivot table values with population standard deviation. SampleStDev: Allows to display the pivot table values with sample standard deviation. PopulationVar: Allows to display the pivot table values with population variance. SampleVar: Allows to display the pivot table values with sample variance. RunningTotals: Allows to display the pivot table values with running totals. DifferenceFrom: Allows to display the pivot table values with difference from the value of the base item in the base field. PercentageOfDifferenceFrom: Allows to display the pivot table values with percentage difference from the value of the base item in the base field. PercentageOfGrandTotal: Allows to display the pivot table values with percentage of grand total of all values. PercentageOfColumnTotal: Allows to display the pivot table values in each column with percentage of total values for the column. PercentageOfRowTotal: Allows to display the pivot table values in each row with percentage of total values for the row. PercentageOfParentTotal: Allows to display the pivot table values with percentage of total of all values based on selected field. PercentageOfParentColumnTotal: Allows to display the pivot table values with percentage of its parent total in each column. PercentageOfParentRowTotal: Allows to display the pivot table values with percentage of its parent total in each row.

Declaration
public List<AggregateTypes> AggregateTypes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<AggregateTypes>

AllowCalculatedField

Allows the built-in calculated field dialog to be displayed in the component. You can view the calculated field dialog by clicking the "Calculated Field" button in the field list UI. This dialog will helps you to create a new calculated field in the pivot table, based on available fields from the bound data source or using simple formula with basic arithmetic operators at runtime.

Declaration
public bool AllowCalculatedField { get; set; }
Property Value
Type Description
System.Boolean

AllowDeferLayoutUpdate

Allows the pivot table component to be updated only on demand, meaning, you can perform a variety of operations such as drag-and-drop fields between row, column, value and filter axes, apply sorting and filtering inside the Field List, resulting the field list UI would be updated on its own, but not the pivot table. On clicking the “Apply” button in the Field List, the pivot table will updates the last modified report. This helps to improve the performance of the pivot table component rendering.

Declaration
public bool AllowDeferLayoutUpdate { get; set; }
Property Value
Type Description
System.Boolean

CssClass

Allows you to add the CSS class name to the field list element. Use this class name, you can customize the field list easily at your end.

Declaration
public string CssClass { get; set; }
Property Value
Type Description
System.String

DataSourceSettings

Allows the following pivot report information such as rows, columns, values, filters, etc., that are used to render the pivot table and field list. Catalog: Allows to set the database name of SSAS cube as string type that used to retrieve the data from the specified connection string. Note: It is applicable only for OLAP data source. cube: Allows you to set the SSAS cube name as string type that used to retrieve data for pivot table rendering. Note: It is applicable only for OLAP data source. providerType: Allows to set the provider type to identify the given connection is either Relational or SSAS to render the pivot table and field list. Note: It is applicable only for OLAP data source. url: Allows to set the URL as string type, which helps to identify the service endpoint where the data are processed and retrieved to render the pivot table and field list. Note: It is applicable only for OLAP data source. localeIdentifier: Allows you to set the specific culture code as number type to render pivot table with desired localization. By default, the pivot table displays with culture code 1033, which indicates "en-US" locale. Note: It is applicale only for OLAP data source. dataSource: Allows you to set the data source to the pivot report either as JSON data collection or from remote data server using DataManager to the render the pivot that and field list. Note: It is applicable only for relational data source. rows: Allows specific fields associated with field information that needs to be displayed in row axis of pivot table. columns: Allows specific fields associated with field information that needs to be displayed in column axis of pivot table. values: Allows specific fields associated with field information that needs to be displayed as aggregated numeric values in pivot table. filters: Allows to filter the values in other axis based on the collection of filter fields in pivot table. excludeFields: Allows you to restrict the specific field(s) from displaying it in the field list UI. You may also be unable to render the pivot table with this field(s) by doing so. Note: It is applicable only for relational data source. expandAll: Allows you to either expand or collapse all the headers that are displayed in the pivot table. By default, all the headers are collapsed in the pivot table. Note: It is applicable only for Relational data. valueAxis: Allows you to set the value fields that to be plotted either in row or column axis in the pivot table. filterSettings: Allows specific fields associated with either selective or conditional-based filter members that used to be displayed in the pivot table. sortSettings: Allows specific fields associated with sort settings to order their members either in ascending or descending that used to be displayed in the pivot table. By default, the data source containing fields are display with Ascending order alone. To use this option, it requires the enableSorting property to be true. enableSorting: Allows to perform sort operation to order members of a specific fields either in ascending or descending that used to be displayed in the pivot table. formatSettings: Allows specific fields used to display the values with specific format that used to be displayed in the pivot table. For example, to display a specific field with currency formatted values in the pivot table, the set the format property to be C. drilledMembers: Allows specific fields to with specify the headers that used to be either expanded or collapsed in the pivot table. valueSortSettings: Allows to sort individual value field and its aggregated values either in row or column axis to ascending or descending order. calculatedFieldSettings: Allows to create new calculated fields from the bound data source or using simple formula with basic arithmetic operators in the pivot table. allowMemberFilter: Allows to perform filter operation based on the selective filter members of the specific fields used to be displayed in the pivot table. allowLabelFilter: Allows to perform filter operation based on the selective headers used to be displayed in the pivot table. allowValueFilter: Allows to perform filter operation based only on value fields and its resultant aggregated values over other fields defined in row and column axes that used to be displayed in the pivot table. showSubTotals: Allows to show or hide sub-totals in both rows and columns axis of the pivot table. showRowSubTotals: Allows to show or hide sub-totals in row axis of the pivot table. showColumnSubTotals: Allows to show or hide sub-totals in column axis of the pivot table. showGrandTotals: Allows to show or hide grand totals in both rows and columns axis of the pivot table. showRowGrandTotals: Allows to show or hide grand totals in row axis of the pivot table. showColumnGrandTotals: Allows to show or hide grand totals in column axis of the pivot table. showHeaderWhenEmpty: Allows the undefined headers to be displayed in the pivot table, when the specific field(s) are not defined in the raw data. For example, if the raw data for the field ‘Country’ is defined as “United Kingdom” and “State” is not defined means, it will be shown as “United Kingdom >> Undefined” in the header section. alwaysShowValueHeader: Allows to show the value field header always in pivot table, even if it holds a single field in the value field axis. conditionalFormatSettings: Allows a collection of values fields to change the appearance of the pivot table value cells with different style properties such as background color, font color, font family, and font size based on specific conditions. emptyCellsTextContent: Allows to show custom string to the empty value cells that used to display in the pivot table. You can fill empty value cells with any value like “0”, ”-”, ””, “(blank)”, etc. groupSettings: Allows specific fields to group their data on the basis of their type. For example, the date type fields can be formatted and displayed based on year, quarter, month, and more. Likewise, the number type fields can be grouped range-wise, such as 1-5, 6-10, etc. You can perform custom group to the string type fields that used to displayed in the pivot table. authentication: Allows you to set the credential information to access the specified SSAS cube. Note: It is applicable only for OLAP data source.

Declaration
public IPivotFieldListDataSourceSettings DataSourceSettings { get; set; }
Property Value
Type Description
IPivotFieldListDataSourceSettings

ElementAttributes

Catches unmatched attributes from the component. This can be used to specify custom style, class and other attributes to the pivot table.

Declaration
public IDictionary<string, object> ElementAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

ID

Defines the ID for PivotFieldList component.

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

ijsRuntime

Declaration
protected IJSRuntime ijsRuntime { get; set; }
Property Value
Type Description
Microsoft.JSInterop.IJSRuntime

LoadOnDemandInMemberEditor

Allows to load members inside the member filter dialog on-demand. The first level members will be loaded from the OLAP cube to display the member editor by default. As a result, the member editor will be opened quickly, without any performance constraints. You can use either of the following actions to load your next level members. The actions are: By clicking on the respective member's expander button. By doing so, only the child members of the respective member will be loaded. Choose the level from the drop-down button. By doing so, all the members up to the level chosen will be loaded from the cube.

Declaration
public bool LoadOnDemandInMemberEditor { get; set; }
Property Value
Type Description
System.Boolean

MaxNodeLimitInMemberEditor

Allows you to set the limit for displaying members while loading large data in the member filter dialog. Based on this limit, initial loading will be completed quickly without any performance constraint. A message with remaining member count, that are not currently shown in the member filter dialog UI, will be displayed in the member editor.

This property is not applicable to user-defined hierarchies in the OLAP data source.

Declaration
public int MaxNodeLimitInMemberEditor { get; set; }
Property Value
Type Description
System.Int32

RenderMode

Allows to show field list either in static or popup mode. The available modes are: Popup: To display the field list icon in pivot table UI to invoke the built-in dialog. It hepls to display over the pivot table UI without affecting any form of UI shrink within a web page. Fixed: To display the field list in a static position within a web page.

Declaration
public Mode RenderMode { get; set; }
Property Value
Type Description
Mode

ShowValuesButton

Allows you to create a pivot button with "Values" as a caption used to display in the field list UI. It helps you to plot the value fields to either column or row axis during runtime.

The showValuesButton property is enabled by default for the OLAP data source. And the pivot button can be displayed with "Measures" as a caption used to display in the field list UI.

Declaration
public bool ShowValuesButton { get; set; }
Property Value
Type Description
System.Boolean

Target

Allows you to set the specific target element to the fieldlist dialog. This helps the field list dialog to display the appropriate position on its target element.

To use thsi option, set the property RenderMode to be Popup.

Declaration
public string Target { get; set; }
Property Value
Type Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

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

GetPersistDataAsync()

Get the Pivot widget properties to be maintained in the persisted state.

Declaration
public Task<string> GetPersistDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

void.

LoadPersistDataAsync(String)

Loads pivot layout.

Declaration
public Task LoadPersistDataAsync(string persistData)
Parameters
Type Name Description
System.String persistData

Local report from browser storage.
Returns
Type Description
System.Threading.Tasks.Task

void.

OnFieldDropped(String, String, String, Boolean, String)

Method invokes on Field drop.

Declaration
public Task OnFieldDropped(string target, string dropTarget, string element, bool cancel, string fieldName)
Parameters
Type Name Description
System.String target

Target element of the name.
System.String dropTarget

Part of the name.
System.String element

Dom elemet.
System.Boolean cancel

To restrict drag and drop.
System.String fieldName

Fieldname for element dropped.
Returns
Type Description
System.Threading.Tasks.Task

void.

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
System.Threading.Tasks.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
System.Threading.Tasks.Task

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

ResetPersistDataAsync()

Resets the state of the pivot table.

Declaration
public Task ResetPersistDataAsync()
Returns
Type Description
System.Threading.Tasks.Task

void.
Remarks

This method will clear the current state and refreshes the pivot table with original state given delcaratively. If EnablePersistence is used then this will clear the state which is stored in window.localStorage too.

ShouldRender()

Declaration
protected override bool ShouldRender()
Returns
Type Description
System.Boolean

ShowFieldListDialogAsync()

This method opens the field list dialog programmatically. You can use this dialog to add or remove fields, as well as rearrange them between different axes, such as column, row, value, and filter, as well as sort and filter options dynamically at runtime. In addition, by enabling the AllowDeferLayoutUpdate property, you can perform all UI actions within the field list UI, resulting in a change in the pivot report but not in the pivot table UI. When you click the "Apply" button in the field list UI, the pivot table will begin to update with the most recently modified report. This improves better performance in pivot table component rendering.

This option is only available when the RenderMode property is set to Mode.Popup.

Declaration
public Task ShowFieldListDialogAsync()
Returns
Type Description
System.Threading.Tasks.Task

void.
Examples
<SfPivotFieldList TValue="ProductDetails" ID="fieldlist" @ref="fieldList" RenderMode="Mode.Popup" >
</SfPivotFieldList>
<SfButton CssClass="fieldlist-button" IsPrimary="true" OnClick="@OnClick">FieldList</SfButton>

@code {
    public async Task OnClick(Microsoft.AspNetCore.Components.Web.MouseEventArgs arg)
    {
        if(this.fieldList != null)
        {
            await this.fieldList.ShowFieldListDialogAsync();
        }
    }
}

TriggerNodeDraggingEvent(String)

Method invokes on Field drag start.

Declaration
public Task<FieldDragStartEventArgs> TriggerNodeDraggingEvent(string fieldName)
Parameters
Type Name Description
System.String fieldName

FieldName of the drag element.
Returns
Type Description
System.Threading.Tasks.Task<FieldDragStartEventArgs>

FieldDragStartEventArgs.

UpdateAsync(SfPivotView<TValue>)

Updates the PivotFieldList component using dataSource from PivotView component.

Declaration
public Task UpdateAsync(SfPivotView<TValue> control)
Parameters
Type Name Description
SfPivotView<TValue> control

PivotView control to update Fieldlist.
Returns
Type Description
System.Threading.Tasks.Task

void.

UpdateCalcDroppable(String, Int32, String)

Method invokes on Field drop in Calculated Field Dialog.

Declaration
public void UpdateCalcDroppable(string nodeId, int cursorPos, string targetId)
Parameters
Type Name Description
System.String nodeId

Node Id of field.
System.Int32 cursorPos

Cursor position.
System.String targetId

Target ID.

UpdateViewAsync(SfPivotView<TValue>)

Updates the PivotView component using dataSource from Pivot FieldList component.

Declaration
public Task UpdateViewAsync(SfPivotView<TValue> control)
Parameters
Type Name Description
SfPivotView<TValue> control

PivotView control to update Table.
Returns
Type Description
System.Threading.Tasks.Task

void.

Explicit Interface Implementations

IPivotFieldList.PivotFieldListTemplates

Declaration
PivotFieldListTemplates IPivotFieldList.PivotFieldListTemplates { get; set; }
Returns
Type Description
PivotFieldListTemplates

Implements