Class SfPivotView<TValue>

The PivotView component is used to read both OLAP and Relational datasource, allows to create multi-dimensional views for analysis and satisfying business user needs.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfPivotView<TValue>

Implements

IPivotView

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

SfDataBoundComponent.SetDataManager<T>(Object)

Namespace: Syncfusion.Blazor.PivotView

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfPivotView<TValue> : SfDataBoundComponent, IPivotView, ISfCircularComponent

Type Parameters

Name	Description
TValue	A type which provides schema for the pivot component.

Constructors

SfPivotView()

Declaration

public SfPivotView()

Properties

AggregateTypes

Allows you to show a menu with built-in aggregate options displayed in the pivot button's dropdown icon of field list and groupingBar UI. These aggregate options helps to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… easily at runtime.

Declaration

public List<AggregateTypes> AggregateTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<AggregateTypes>	A list of AggregateTypes instances.

Remarks

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.

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	true, if the calculated field dialog can be enabled. Otherwise, false.

AllowConditionalFormatting

Allows you 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. You can apply the conditional formatting at runtime through the built-in dialog, invoked from the toolbar. To do so, set AllowConditionalFormatting and ShowToolbar properties to true to the component. Also, include the toolbar option ConditionalFormatting in the Toolbar property.

Declaration

public bool AllowConditionalFormatting { get; set; }

Property Value

Type	Description
System.Boolean	true, if the conditional formatting dialog can be enabled. Otherwise, false.

Remarks

You can also view the conditional formatting dialog by clicking an external button using the ShowConditionalFormattingDialogAsync() method.

AllowDataCompression

Allows large amounts of data to be loaded without any degradation of performance by compressing raw data on the basis of its uniqueness. These unique records will be provided as input to render the pivot table.

Declaration

public bool AllowDataCompression { get; set; }

Property Value

Type	Description
System.Boolean	true, if the data compression can be enabled. Otherwise, false.

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	true, if the defer layout update option can be enabled. Otherwise, false.

AllowDrillThrough

Allows to view the underlying raw data of a summarized cell in the pivot table. By double-clicking on any value cell, you can view the detailed raw data in a data grid inside a new window. In the new window, row header, column header and measure name of the clicked cell will be shown at the top. You can also include or exclude fields available in the data grid using column chooser option.

Declaration

public bool AllowDrillThrough { get; set; }

Property Value

Type	Description
System.Boolean	true, if the drill through option can be enabled. Otherwise, false.

AllowExcelExport

Allows the pivot table data to be exported as an Excel document. Export can be done in two different file formats such as XLSX and CSV formats. You can export pivot table using the build-in toolbar option. To do so, set AllowExcelExport and ShowToolbar properties to true to the component. Also, include the toolbar option Exporting in the Toolbar property.

Declaration

public bool AllowExcelExport { get; set; }

Property Value

Type	Description
System.Boolean	true, if the excel export option can be enabled. Otherwise, false.

Remarks

You can also export the pivot table data by clicking an external button using the ExportToExcelAsync(ExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>, Boolean) method. Use ExportToCsvAsync(ExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>, Boolean) method to export the pivot table data to CSV format.

AllowGrouping

Allows you to show the grouping UI in the pivot table that automatically groups date, time, number and string at runtime by right clicking on the pivot table’s row or column header, select Group. This will shows a dialog in which you can perform grouping with appropriate options to group the data. To ungroup, right click on the pivot table’s row or column header, select Ungroup.

Declaration

public bool AllowGrouping { get; set; }

Property Value

Type	Description
System.Boolean	true, if the grouping option can be enabled. Otherwise, false.

Remarks

This property is applicable only for relational data source.

AllowNumberFormatting

Allows you to apply required number formatting to the pivot table values such as number, currency, percentage or other custom formats at runtime through a built-in dialog, invoked from the toolbar. To do so, set AllowNumberFormatting and ShowToolbar properties to true to the component. Also, include the toolbar option NumberFormatting in the toolbar property.

Declaration

public bool AllowNumberFormatting { get; set; }

Property Value

Type	Description
System.Boolean	true, if the number format option can be enabled. Otherwise, false.

Remarks

You can also view the number formatting dialog by clicking an external button using the ShowNumberFormattingDialogAsync() method.

AllowPdfExport

Allows the pivot table data to be exported as an PDF document. You can export pivot table using the build-in toolbar option. To do so, set AllowPdfExport and ShowToolbar properties to true to the component. Also, include the toolbar option Exporting in the Toolbar property.

Declaration

public bool AllowPdfExport { get; set; }

Property Value

Type	Description
System.Boolean	true, if the pdf export option can be enabled. Otherwise, false.

Remarks

You can also export the pivot table data by clicking an external button using the ExportToPdfAsync(PdfExportProperties, Nullable<Boolean>, Nullable<Boolean>) method.

ChartSettings

Allows a set of options to customize a pivot chart with a variety of settings, such as chart series, chart area, axis labels, legends, border, crosshair, theme, title, tooltip, zooming, etc.

Declaration

public PivotChartSettings ChartSettings { get; set; }

Property Value

Type	Description
PivotChartSettings	An instance of PivotChartSettings.

Remarks

The following options are available to customize the pivot chart.

• `Background`: Allows you to change the background color of the chart series in the pivot chart. For example, to display the chart series with background color as red, set the property `background` to either "red" or "#FF0000" or "rgba(255,0,0,1.0)".
• `Border`: Allow options to customize the border of the chart series such as color and border size in the pivot chart. For example, to display the chart series border color as red, set the properties `color` to either "red" or "#FF0000" or "rgba(255,0,0,1.0)" and `width` to 0.5.
• `ChartArea`: Allow options to customize the chart area with a variety of settings such as background color, border, opacity and background image in the pivot chart. For example, to change the of the pivot chart's background, set the property `opacity` to 0.5.
• `ChartSeries`: Allow options to customize the chart series with different settings such as fill color, animation of the series, series width, border, visibility of the series, opacity, chart series types, marker, tooltip, trendlines, etc., in the pivot chart. For example, to display the line type pivot chart, set the property `type` to Line.
• `Crosshair`: Allow options to customize the crosshair line with different settings such as color and width of the line, line types that are shown horizontally and vertically to indicate the value of the axis at the mouse hover or touch position in the pivot chart.
• `Description`: Allows you to add a description of the pivot chart.
• `EnableAnimation`: Allows you to enable/disable the tooltip animation while performing the mouse move from one point to another in the pivot chart.
• `EnableExport`: Allows the pivot chart to be exported to either PDF or PNG or JPEG or SVG filter formats.
• `EnableMultipleAxis`: Allows you to draw the pivot chart with multiple value fields as separate chart area.
• `EnableSideBySidePlacement`: Allows you to draw points of the column type pivot chart series as side by side.
• `IsMultiSelect`: Allows you to perform multiple selection in the pivot chart. To enable this option, it requires the property `selectionMode` to be Point or Series or Cluster.
• `IsTransposed`: Allows you to render the pivot chart in a transposed manner or not.
• `LegendSettings`: Allow options for customizing legends with different properties such as legend visibility, height, width, position, legend padding, alignment, textStyle, border, margin, background, opacity, description, tabIndex in the pivot chart.
• `Margin`: Allow options to customize the left, right, top and bottom margins of the pivot chart.
• `Palettes`: Allows you to draw the chart series points with custom color in the pivot chart.
• `PrimaryXAxis`: Allow options to customize the horizontal(row) axis with different properties such as labelIntersectAction, labelStyle, title, description, crosshairTooltip, labelFormat, titleStyle, plotOffset, edgeLabelPlacement, labelPlacement, tickPosition, opposedPosition, minor and major grid lines, minor and major tick lines, border, etc. in the pivot chart.
• `PrimaryYAxis`: Allow options to customize the vertical(value) axis with different properties such as labelIntersectAction, labelStyle, title, description, crosshairTooltip, labelFormat, titleStyle, plotOffset, edgeLabelPlacement, labelPlacement, tickPosition, opposedPosition, minor and major grid lines, minor and major tick lines, border, etc. in the pivot chart.
• `SelectedDataIndexes`: Allows you to highlight a specific point of the series while rendering the pivot chart. For example, to highlight first point in the first series, set the properties series to 0 and points to 1. To use this option, it requires the property `selectionMode` to be Point or Series.
• `SelectionMode`: Allow options for customizing the selection mode to be done either by a specific series or point or cluster or by dragging it to the pivot chart. For example, to highlight a specific point in a specific series of the pivot chart, set the property `selectionMode` to Point.
• `ShowMultiLevelLabels`: Allows you to display the multi-level label feature in the pivot chart. This multi-level labels used to perform drill operation in the pivot chart.
• `SubTitle`: Allows you to add the subtitle to the pivot chart.
• `SubTitleStyle`: Allow options to customize the subtitle in the pivot chart with different properties such as fontStyle, font size, fontWeight, font color, testAlignment, fontFamily, opacity, textOverflow.
• `TabIndex`: Allows you to highlight specific legends by clicking the mouse or by interacting with the keyboard in the pivot chart.
• `Theme`: Allows you to draw a pivot chart with either material, fabric, bootstrap, highcontrast light, material dark, fabric dark, highcontrast, bootstrap dark, bootstrap4 theme.
• `Title`: Allows you to add title to the pivot chart.
• `TitleStyle`: Allow options to customize the title in the pivot chart with different properties such as fontStyle, font size, fontWeight, font color, testAlignment, fontFamily, opacity, textOverflow.
• `Tooltip`: Allow options to customize the tooltip of the pivot chart with different properties such as visibility of the tooltip, enableMarker, fill color, opacity, header for tooltip, format, textStyle, template, border, enableAnimation.
• `UseGroupingSeparator`: Allows the group separator to be shown to the values in the pivot chart.
• `Value`: Allows you to draw a pivot chart with a specific value field during initial loading.
• `ZoomSettings`: Allow options to customize the pivot chart zooming with different properties such as enablePinchZooming, enableSelectionZooming, enableDeferredZooming, enableMouseWheelZooming, zoom modes, toolbarItems, enableScrollbar and enablePan.

ChartTypes

Allows you to display the pivot chart with specific chart types from built-in chart options, invoked from the toolbar.

Declaration

public List<ChartSeriesType> ChartTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartSeriesType>	A list of ChartSeriesType instances.

Remarks

The available chart types are:

• `Line`: Allows to display the pivot chart with line series.
• `Column`: Allows to display the pivot chart with column series.
• `Area`: Allows to display the pivot chart with area series.
• `Bar`: Allows to display the pivot chart with bar series.
• `StackingColumn`: Allows to display the pivot chart with stacked column series.
• `StackingArea`: Allows to display the pivot chart with stacked area series.
• `StackingBar`: Allows to display the pivot chart with stacked bar series.
• `StepLine`: Allows to display the pivot chart with step line series.
• `StepArea`: Allows to display the pivot chart with step area series.
• `SplineArea`: Allows to display the pivot chart with spline area series.
• `Scatter`: Allows to display the pivot chart with scatter series.
• `Spline`: Allows to display the pivot chart with spline series.
• `StackingColumn100`: Allows to display the pivot chart with 100% stacked column series.
• `StackingBar100`: Allows to display the pivot chart with 100% stacked bar series.
• `StackingArea100`: Allows to display the pivot chart with 100% stacked area series.
• `Bubble`: Allows to display the pivot chart with bubble series.
• `Pareto`: Allows to display the pivot chart with pareto series.
• `Polar`: Allows to display the pivot chart with polar series.
• `Radar`: Allows to display the pivot chart with radar series.
• `Pie`: Allows to display the pivot chart with pie series.
• `Doughnut`: Allows to display the pivot chart with doughnut series.
• `Funnel`: Allows to display the pivot chart with funnel series.
• `Pyramid`: Allows to display the pivot chart with pyramid series.

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.

Declaration

public IPivotViewDataSourceSettings DataSourceSettings { get; set; }

Property Value

Type	Description
IPivotViewDataSourceSettings	An instance of IPivotViewDataSourceSettings

Remarks

The following options are available:

• `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.
• `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 applicable only for OLAP data source.
• `DataSource`: Allows you to set the data source as JSON collection to the pivot report either from local or from remote server to the render the pivot that and field list. You can fetch JSON data from remote server by using DataManager. 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 used to display their the headers 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.
• `ShowAggregationOnValueField`: Allows the pivot button with specific value field caption along with the aggregation type, to be displayed in the grouping bar and field list UI. For example, if the value field "Sold Amount" is aggregated with Sum, it will be displayed with caption "Sum of Sold Amount" in its pivot button.
• `Authentication`: Allows you to set the credential information to access the specified SSAS cube. Note: It is applicable only for OLAP data source.

DisplayOption

Allow options to configure the view port as either pivot table or pivot chart or both table and chart. The options available are:

Declaration

public PivotViewDisplayOption DisplayOption { get; set; }

Property Value

Type	Description
PivotViewDisplayOption	An instance of PivotViewDisplayOption.

Remarks

The following options are available:

• View: Allows you to choose the view port as either pivot table or pivot chart or both table and chart.
• Primary: Allows you to set the primary view to be either pivot table or pivot chart. To use this option, it requires the property `view` to be Both.

EditSettings

Allow options for performing CRUD operations, such as add, edit, delete, and update the raw items of any cell from the pivot table. The raw items can be viewed in a data grid that used to be displayed as a dialog by double-clicking the appropriate value cell in the pivot table. CRUD operations can be performed in this data grid either by double-clicking the cells or using toolbar options.

Declaration

public PivotViewCellEditSettings EditSettings { get; set; }

Property Value

Type	Description
PivotViewCellEditSettings	An instance of PivotViewCellEditSettings.

Remarks

The options available are as follows:

• `AllowAdding`: Allows you to add a new record to the data grid used to update the appropriate cells in the pivot table.
• `AllowEditing`: Allows you to edit the existing record in the data grid that used to update the appropriate cells in the pivot table.
• `AllowDeleting`: Allows you to delete the existing record from the data grid that used to update the appropriate cells in the pivot table.
• `AllowCommandColumns`: Allows an additional column appended in the data grid layout holds the command buttons to perform the CRUD operations to edit, delete, and update the raw items to the data grid that used to update the appropriate cells in the pivot table.
• `Mode`: Allow options for performing CRUD operations with different modes in the data grid that used to update the appropriate cells in the pivot table. The available modes are normal, batch and dialog. Normal mode is enabled for CRUD operations in the data grid by default.
• `AllowEditOnDblClick`: Allows you to restrict CRUD operations by double-clicking the appropriate value cell in the pivot table.
• `ShowConfirmDialog`: Allows you to show the confirmation dialog to save and discard CRUD operations performed in the data grid that used to update the appropriate cells in the pivot table.
• `ShowDeleteConfirmDialog`: Allows you to show the confirmation dialog to delete any records from the data grid.

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
System.Collections.Generic.IDictionary<System.String, System.Object>

EnableHtmlSanitizer

Allows to restrict the cross-site scripting while using cell template, meaning it will remove the unwanted scripts,styles or HTML in your cell template.

Declaration

public bool EnableHtmlSanitizer { get; set; }

Property Value

Type	Description
System.Boolean	true, if the cross-site scripting can be enabled. Otherwise, false. The default value is true.

Remarks

In general, the cross-site scripting known as XSS is a type of computer security vulnerability typically found in web applications. It attacks enable attackers to inject client-side scripts into web pages viewed by other users.

EnablePaging

Gets or sets a boolean value that used to display large amounts of data in the pivot table page by page. It also helps to display the rows and columns by configuring the page size and current page in the pivot table using the PivotViewPageSettings option.

Declaration

public bool EnablePaging { get; set; }

Property Value

Type	Description
System.Boolean	true if the paging option can be enabled; otherwise, false.

EnablePersistence

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

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	true, if the persistence can be enabled. Otherwise, false.

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	true, if the right to left direction can be enabled for the component. Otherwise, false. The default value is false.

EnableValueSorting

Allows you to sort individual value field and its aggregated values either in row or column axis to ascending or descending order. You can sort the values by clicking directly on the value field header positioned either in row or column axis of the pivot table.

Declaration

public bool EnableValueSorting { get; set; }

Property Value

Type	Description
System.Boolean	true, if the value sorting option can be enabled. Otherwise, false.

EnableVirtualization

Allows to load the large amounts of data without any performance degradation by rendering rows and columns only in the current content view port. Rest of the aggregated data will be brought into view port dynamically based on vertical or horizontal scroll position.

Declaration

public bool EnableVirtualization { get; set; }

Property Value

Type	Description
System.Boolean	true, if the virtualization can be enabled. Otherwise, false.

ExportAllPages

Allows you to export the pivot table data of all pages, i.e. the data that holds all the records given to render the pivot table will be exported as either an Excel or a PDF document.

Declaration

public bool ExportAllPages { get; set; }

Property Value

Type	Description
System.Boolean	true, if the export option of all pages can be enabled. Otherwise, false. The default value is true.

GridSettings

Allows the set of options to customize rows, columns, values cell and its content in the pivot table.

Declaration

public PivotViewGridSettings GridSettings { get; set; }

Property Value

Type	Description
PivotViewGridSettings	An instance of PivotViewGridSettings.

Remarks

The following options to customize the pivot table are:

• `Height`: Allow the height of the pivot table content to be set, meaning that the height given should be applied without considering the column headers in the pivot table.
• `Width`: Allow to set width of the pivot table. Note: The pivot table will not display less than 400px, as it is the minimum width to the component.
• `GridLines`: Allow the options for customizing the cell borders of each cell to be displayed in the pivot table. For example, to display a pivot table without cell borders, set the property `gridLines` to None.
• `AllowTextWrap`: Allow the contents of the cells to be wrapped when they exceed the width of the cells in the pivot table.
• `TextWrapSettings`: Allows options to wrap either column and row header or value or both header and cell content. For example, to allow the wrap option to value cells alone, then set the property `wrapMode` to Content in the `textWrapSettings` class.
• `AllowReordering`: Allows to reorder a specific column header from one index to another index in the pivot table by drag-and-drop.
• `AllowResizing`: Allows the columns to be resized by clicking and dragging the right edge of the column headers.
• `RowHeight`: Allow to set height to the pivot table rows commonly.
• `ColumnWidth`: Allow to set width to the pivot table columns commonly.
• `ClipMode`: Allows the contents of the cell overflow to be displayed in the pivot table. For example, to truncate the cell content of a cell when it overflows with respect to its cell width, set the property `clipMode` to Clip.
• `AllowSelection`: Allows a row or column or cell to be highlighted by simply clicking or arrow key in the pivot table.
• `SelectionSettings`: Allow set of options to customize the selection of a row or column or cell by simply clicking on the arrow key in the pivot table. For example, to highlight both rows and columns with multiple selection, set the properties `mode` to Both and `type` to Multiple in `selectionSettings` class.
• `SelectedRowIndex`: Allows to highlight specific row in the pivot table during initial rendering. For example, to highlight the pivot table's first row, set the property `selectedRowIndex` to 0.
• `ContextMenuItems`: Allows to show built-in context with pre-defined menu option or custom menu options by simply right clicking on the pivot table cell.

GroupingBarSettings

Allows a set of options for customizing the grouping bar UI with a variety of settings such as UI visibility to a specific view port, customizing the pivot button features such as filtering, sorting, changing aggregate types, removing any fields.

Declaration

public PivotViewGroupingBarSettings GroupingBarSettings { get; set; }

Property Value

Type	Description
PivotViewGroupingBarSettings	An instance of PivotViewGroupingBarSettings.

Remarks

The options available to customize the grouping bar UI are:

• `ShowFilterIcon`: Allows you to show or hide the filter icon that used to be displayed on the pivot button of the grouping bar UI. This filter icon is used to filter the members of a particular field at runtime in the pivot table.
• `ShowSortIcon`: Allows you to show or hide the sort icon that used to be displayed in the pivot button of the grouping bar UI. This sort icon is used to order members of a particular fields either in ascending or descending at runtime.
• `ShowRemoveIcon`: Allows you to show or hide the remove icon that used to be displayed in the pivot button of the grouping bar UI. This remove icon is used to remove any field during runtime.
• `ShowValueTypeIcon`: Allows you to show or hide the value type icon that used to be displayed in the pivot button of the grouping bar UI. This value type icon helps to select the appropriate aggregation type to value fields at runtime.
• `DisplayMode`: Allow options to show the grouping bar UI to specific view port such as either pivot table or pivot chart or both table and chart. For example, to show the grouping bar UI to pivot table on its own, set the property `displayMode` to Table.
• `AllowDragAndDrop`: Allows you to restrict the pivot buttons that were used to drag on runtime in the grouping bar UI. This will prevent you from modifying the current report.

Height

Allow the height of the pivot table to be set.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 100%.

HyperlinkSettings

Allow a set of options to display a hyperlink to link data for individual cells that are shown in the pivot table. These options allow you to enable a separate hyperlink for row headers, column headers, value cells, and summary cells in the PivotViewHyperlinkSettings class.

Declaration

public PivotViewHyperlinkSettings HyperlinkSettings { get; set; }

Property Value

Type	Description
PivotViewHyperlinkSettings	An instance of PivotViewHyperlinkSettings.

Remarks

The options available are:

• `ShowHyperlink`: Allows you to set the visibility of hyperlink in all cells
• `ShowRowHeaderHyperlink`: Allows you to set the visibility of hyperlink in row headers
• `ShowColumnHeaderHyperlink`: Allows you to set the visibility of hyperlink in column headers
• `ShowValueCellHyperlink`: Allows you to set the visibility of hyperlink in value cells
• `ShowSummaryCellHyperlink`: Allows you to set the visibility of hyperlink in summary cells
• `HeaderText`: Allows you to set the visibility of hyperlink based on header text
• `ConditionalSettings`: Allows you to set the visibility of hyperlink based on specific condition
• `CssClass`:Allows you to add CSS class name to the hyperlink options

ID

Defines the ID for the PivotTable.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

ijsRuntime

Declaration

protected IJSRuntime ijsRuntime { get; set; }

Property Value

Type
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	true, allows to load members inside the member filter dialog on-demand. Otherwise, false. The default value is true.

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.

Declaration

public int MaxNodeLimitInMemberEditor { get; set; }

Property Value

Type	Description
System.Int32	Accepts an integer value. The default value is 1000.

Remarks

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

MaxRowsInDrillThrough

Allows you to set the maximum number of raw data that used to view it in a data grid inside a new window while performing drill through on summarized cells in the pivot table. For example, if the value cell has a combination of more than 50,000 records, it allows only 10,000 records fetch from the cube and displayed in the data grid.

Declaration

public int MaxRowsInDrillThrough { get; set; }

Property Value

Type	Description
System.Int32	Accepts an integer value. The default value is 10000.

Remarks

This property is applicable only for the OLAP data source.

MinHeight

Allow the min-height of the pivot table to be set.

Declaration

public string MinHeight { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 300px.

Remarks

The default value of the MinHeight property is set to “300px”.

MinWidth

Allow the min-width of the pivot table to be set.

Declaration

public string MinWidth { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 400px.

Remarks

The default value of the MinWidth property is set to “400px”.

PagerSettings

Gets or sets the paging UI option with a variety of settings, such as UI position, template and visibility to a specific axis info, such as page size and paging data.

Declaration

public PivotViewPagerSettings PagerSettings { get; set; }

Property Value

Type	Description
PivotViewPagerSettings	An instance of PivotViewPagerSettings.

Remarks

To use this option, it requires the EnablePaging property to be true.

PageSettings

Gets or sets the page information such as page size and current page details for each axis in order to display the pivot table with specific page during paging and virtual scrolling.

Declaration

public PivotViewPageSettings PageSettings { get; set; }

Property Value

Type	Description
PivotViewPageSettings	An instance of PivotViewPageSettings.

PivotValues

It holds the collection of cell information that has been populated from the engine on the basis of the given pivot report to render the component as table and chart.

Declaration

public Matrix<Matrix<AxisSet>> PivotValues { get; set; }

Property Value

Type	Description
Syncfusion.Blazor.PivotView.Matrix<Syncfusion.Blazor.PivotView.Matrix<AxisSet>>	The pivot values in a matrix of axis sets.

ShowFieldList

Allows built-in popup field list to be enabled in the pivot table UI. The popup field list will be displayed over the pivot table UI without affecting any form of UI shrink, and allows to manipulate the pivot report through different ways such as 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 to update the pivot table.

Declaration

public bool ShowFieldList { get; set; }

Property Value

Type	Description
System.Boolean	true, if the field list popup should be shown. Otherwise, false.

Remarks

By default, the icon used to display the field list will be positioned at the top left corner of the pivot table UI. When groupingBar is enabled, the icon will be placed at the top right corner of the pivot table.

ShowFieldSearch

Gets or sets a value indicating whether the field search bar is enabled in the field list to search for fields.

Declaration

public bool ShowFieldSearch { get; set; }

Property Value

Type	Description
System.Boolean	true if the field search bar is enabled; otherwise, false.

Remarks

Use this property to control the visibility of the field search bar in the field list. When set to true, the field search bar will be shown, allowing users to search for fields. When set to false, the field search bar will be hidden.

ShowGroupingBar

Allows you to show the grouping bar UI in the pivot table that automatically populates fields from the bound report. It also allows you to modify the report with a variety of actions using the pivot buttons to update the pivot table during runtime. The following are: Re-arranging fields through drag-and-drop operation between row, column, value and filter axes. Remove fields from the existing report using remove icon. Filtering members of specific fields using filter icon. Sorting members of specific fields using sort icon. Editing the calculated fields using edit icon. Selecting required aggregate types to value field using dropdown icon.

Declaration

public bool ShowGroupingBar { get; set; }

Property Value

Type	Description
System.Boolean	true, if the grouping bar should be shown. Otherwise, false.

ShowToolbar

Allows you to show the toolbar UI that holds built-in toolbar options to accessing frequently used features like switching between pivot table and pivot chart, changing chart types, conditional formatting, number formatting, exporting, etc… with ease at runtime.

Declaration

public bool ShowToolbar { get; set; }

Property Value

Type	Description
System.Boolean	true, if the toolbar should be shown. Otherwise, false.

ShowTooltip

Allows you to display the tooltip to the value cells either by mouse hovering or by touch in the pivot table. The information used to be displayed in the tooltip is: Row: Holds the row header information of a specific value cell. Column: Holds the column header information of a specific value cell. Value: Holds the value field caption along with its value of a specific value cell.

Declaration

public bool ShowTooltip { get; set; }

Property Value

Type	Description
System.Boolean	true, if the tooltip should be shown. Otherwise, false. The default value is true.

ShowValuesButton

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

Declaration

public bool ShowValuesButton { get; set; }

Property Value

Type	Description
System.Boolean	true, if the pivot values button should be shown. Otherwise, false.

Remarks

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 grouping bar and field list UI.

Target

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

Declaration

public string Target { get; set; }

Property Value

Type
System.String

Toolbar

Allows the built-in toolbar options that used to access features like switching between pivot table and pivot chart, changing chart types, conditional formatting, number formatting, exporting, etc… with ease at runtime.

Declaration

public List<ToolbarItems> Toolbar { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ToolbarItems>	A list of ToolbarItems instances.

Remarks

The available toolbar options are:

• `New`: Allows to create a new report.
• `Save`: Allows to save the current report.
• `Save As`: Allows to perform save as the current report.
• `Rename`: Allows to rename the current report.
• `Remove`: Allows to delete the current report.
• `Load`: Allows to load any report from the report list.
• `Grid`: Allows to show the pivot table.
• `Chart`: Allows to show the pivot chart with specific type from the built-in list. It also has the option to show the chart with multiple axes based on the value fields bound to the report. You can do this by selecting the checkbox at the bottom of the list.
• `Exporting`: Allow set of options to export the pivot table as PDF/Excel/CSV and the pivot chart as PDF and image format such as PNG, JPEG, SVG.
• `Sub-total`: Allow set of options to show or hide the sub totals in the pivot table. The subtotals will not be displayed in the pivot chart by default.
• `Grand Total`: Allow set of options to show or hides the grand totals in the pivot table. By default, the grand totals will not be displayed in the pivot chart.
• `Conditional Formatting`: Allows to show the conditional formatting pop-up to apply formatting to the values.
• `Number Formatting`: Allows to show the number formatting pop-up to apply number formatting to the values.
• `Formatting`: Allow options to show the conditional formatting and the number formatting pop-up that used to apply formatting to the values in the component.
• `Field List`: Allows you to show the field list pop-up. It allows you to modify the report with a variety of actions such as re-arrange the fields between axes by drag-and-drop, add new fields to report, remove any fields from report, filtering and sorting a specific field members, etc., that are used to update the pivot table during runtime.
• `MDX`: Allows ro show the MDX query that was run to retrieve data from the OLAP data source. Note: It is applicable only for OLAP data source.

VirtualScrollSettings

Gets or sets values for options relating to the virtual scrolling experience in the pivot table.

To use this option effectively, it is necessary to have the EnableVirtualization property set to true.

Declaration

public PivotViewVirtualScrollSettings VirtualScrollSettings { get; set; }

Property Value

Type	Description
PivotViewVirtualScrollSettings	An instance of PivotViewVirtualScrollSettings.

Width

Allow the width of the pivot table to be set.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 100%.

Remarks

The pivot table will not display less than 400px, as it is the minimum width to the component.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

CreateCalculatedFieldDialogAsync()

Method to open calculated field dialog.

Declaration

public Task CreateCalculatedFieldDialogAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToChartAsync(ExportType)

The method allows to export the pivot chart as PDF and image formats like PNG, JPEG, and SVG. By default, the exported file will be named "PivotChart".

Declaration

public Task ExportToChartAsync(ExportType type)

Parameters

Type	Name	Description
ExportType	type	Defines the export type used to export PNG, JPEG, SVG, and PDF file formats.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToChartAsync(ExportType, String)

The method allows to export the pivot chart as PDF and image formats like PNG, JPEG, and SVG. By default, the exported file will be named "PivotChart".

Declaration

public Task ExportToChartAsync(ExportType type, string fileName)

Parameters

Type	Name	Description
ExportType	type	Defines the export type used to export PNG, JPEG, SVG, and PDF file formats.
System.String	fileName	Specifies the file name for the exported file. The default export file name is "PivotChart".

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToChartAsync(ExportType, String, Nullable<PdfPageOrientation>)

The method allows to export the pivot chart as PDF and image formats like PNG, JPEG, and SVG. By default, the exported file will be named "PivotChart".

Declaration

public Task ExportToChartAsync(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation)

Parameters

Type	Name	Description
ExportType	type	Defines the export type used to export PNG, JPEG, SVG, and PDF file formats.
System.String	fileName	Specifies the file name for the exported file. The default export file name is "PivotChart".
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the portrait or landscape orientation of the page.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToChartAsync(ExportType, String, Nullable<PdfPageOrientation>, Nullable<Boolean>)

The method allows to export the pivot chart as PDF and image formats like PNG, JPEG, and SVG. By default, the exported file will be named "PivotChart".

Declaration

public Task<string> ExportToChartAsync(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation, Nullable<bool> asBase64)

Parameters

Type	Name	Description
ExportType	type	Defines the export type used to export PNG, JPEG, SVG, and PDF file formats.
System.String	fileName	Specifies the file name for the exported file. The default export file name is "PivotChart".
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the portrait or landscape orientation of the page.
System.Nullable<System.Boolean>	asBase64	Specify whether to obtain the chart image as a base64 string or not.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	A System.Threading.Tasks.Task representing the asynchronous operation, which returns a System.String containing the chart image as a base64-encoded string.

ExportToCsvAsync(ExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>, Boolean)

Export the Pivot Table data to a CSV file (.csv).

Declaration

public Task ExportToCsvAsync(ExcelExportProperties excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null, bool isServerExport = false)

Parameters

Type	Name	Description
ExcelExportProperties	excelExportProperties	Provides the export properties for customizing the table, such as custom columns, data source, and theme.
System.Nullable<System.Boolean>	isMultipleExport	Specifies whether multiple exports are enabled.
System.Object	workbook	An instance of the workbook to export.
System.Nullable<System.Boolean>	isBlob	Specifies whether to export as a blob instead of writing to the response.
System.Boolean	isServerExport	Specifies whether server-side CSV export is enabled.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.TaskRepresenting the asynchronous operation.

ExportToExcelAsync(ExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>, Boolean)

Export the Pivot Table data to an Excel file (.xlsx).

Declaration

public Task ExportToExcelAsync(ExcelExportProperties excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null, bool isServerExport = false)

Parameters

Type	Name	Description
ExcelExportProperties	excelExportProperties	Specifies the export properties for customizing the table, such as custom columns, data source, and theme.
System.Nullable<System.Boolean>	isMultipleExport	Specifies whether multiple exports are enabled.
System.Object	workbook	An instance of the workbook to export.
System.Nullable<System.Boolean>	isBlob	Specifies whether to export as a blob instead of writing to the response.
System.Boolean	isServerExport	Specifies whether server-side Excel export is enabled.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.TaskRepresenting the asynchronous operation.

ExportToPdfAsync(PdfExportProperties)

The method allows to export the pivot table data as a PDF document. By default, the exported file will be named "default".

Declaration

public Task ExportToPdfAsync(PdfExportProperties pdfExportProperties = null)

Parameters

Type	Name	Description
PdfExportProperties	pdfExportProperties	Provides the export properties for the table and chart for customizing the table, such as custom columns, data source, and theme.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToPdfAsync(PdfExportProperties, Nullable<Boolean>)

The method allows to export the pivot table data as a PDF document. By default, the exported file will be named "default".

Declaration

public Task ExportToPdfAsync(PdfExportProperties pdfExportProperties, Nullable<bool> exportTableAndChart)

Parameters

Type	Name	Description
PdfExportProperties	pdfExportProperties	Provides the export properties for the table and chart for customizing the table, such as custom columns, data source, and theme.
System.Nullable<System.Boolean>	exportTableAndChart	When set to true, both table and chart data will be exported into a single PDF document if the View property in DisplayOption is set to Both.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToPdfAsync(PdfExportProperties, Nullable<Boolean>, Nullable<Boolean>)

The method allows to export the pivot table data as a PDF document. By default, the exported file will be named "default".

Declaration

public Task<MemoryStream> ExportToPdfAsync(PdfExportProperties pdfExportProperties, Nullable<bool> exportTableAndChart, Nullable<bool> asBlob)

Parameters

Type	Name	Description
PdfExportProperties	pdfExportProperties	Provides the export properties for the table and chart for customizing the table, such as custom columns, data source, and theme.
System.Nullable<System.Boolean>	exportTableAndChart	When set to true, both table and chart data will be exported into a single PDF document if the View property in DisplayOption is set to Both.
System.Nullable<System.Boolean>	asBlob	If true, exports pivot table data as a memory stream instead of a document.

Returns

Type	Description
System.Threading.Tasks.Task<System.IO.MemoryStream>	A System.Threading.Tasks.Task representing the asynchronous operation, which returns a System.IO.MemoryStream containing the exported PDF data.

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

LayoutRefreshAsync()

Method to refresh the component UI.

Declaration

public Task LayoutRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

LoadPersistDataAsync(String)

Loads pivot Layout.

Declaration

public Task LoadPersistDataAsync(string persistData)

Parameters

Type	Name	Description
System.String	persistData

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

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

SfDataBoundComponent.OnInitializedAsync()

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

SfDataBoundComponent.OnParametersSetAsync()

PreventRender(Boolean)

Sets a flag that indicate whether the component should render. Call this method to manage UI refreshing.

Declaration

public void PreventRender(bool preventRender = true)

Parameters

Type	Name	Description
System.Boolean	preventRender	Default value is true. Once PreventRender(true) called, component won't re-render until PreventRender(false) called.

PrintChart()

Print method for the chart.

Declaration

public void PrintChart()

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
System.Boolean

ShowConditionalFormattingDialogAsync()

Method to open conditional formatting dialog.

Declaration

public Task ShowConditionalFormattingDialogAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShowFieldListDialogAsync()

This method allows to open the built-in field list dialog in the pivot table 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. Furthermore, 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 ShowFieldList property is set to true.

Declaration

public Task ShowFieldListDialogAsync()

Returns

Type	Description
System.Threading.Tasks.Task	void.

Examples

<SfPivotView TValue="ProductDetails" @ref="Pivot" ShowFieldList="true">
</SfPivotView>
<SfButton CssClass="fieldlist-button" IsPrimary="true" OnClick="@OnClick">FieldList</SfButton>

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

ShowNumberFormattingDialogAsync()

Method to open the number formatting dialog to set the format dynamically.

Declaration

public Task ShowNumberFormattingDialogAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Explicit Interface Implementations

IPivotView.PivotViewTemplates

Declaration

PivotViewTemplates IPivotView.PivotViewTemplates { get; set; }

Returns

Type
PivotViewTemplates

Implements

IPivotView