Class PivotViewGridSettingsBuilder
Inheritance
Namespace: Syncfusion.EJ2.PivotView
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotViewGridSettingsBuilder : ControlBuilderConstructors
PivotViewGridSettingsBuilder()
Declaration
public PivotViewGridSettingsBuilder()PivotViewGridSettingsBuilder(PivotViewGridSettings)
Declaration
public PivotViewGridSettingsBuilder(PivotViewGridSettings model)Parameters
| Type | Name | Description |
|---|---|---|
| PivotViewGridSettings | model |
Methods
AllowAutoResizing(Boolean)
Allows the component to be fit based on the width of its columns.
Declaration
public PivotViewGridSettingsBuilder AllowAutoResizing(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
AllowReordering(Boolean)
Allows to reorder a specific column header from one index to another index in the pivot table by drag-and-drop.
Reordering allows only at the same level as the column headers in the pivot table.
Declaration
public PivotViewGridSettingsBuilder AllowReordering(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
AllowResizing(Boolean)
Allows the columns to be resized by clicking and dragging the right edge of the column headers.
In RTL mode, user can click and drag the left edge of the header cell to resize the column.
Declaration
public PivotViewGridSettingsBuilder AllowResizing(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
AllowSelection(Boolean)
Allows a row or column or cell to be highlighted by simply clicking or arrow key in the pivot table.
Declaration
public PivotViewGridSettingsBuilder AllowSelection(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
AllowTextWrap(Boolean)
Allow to enable the content of the cells to be wrapped when they exceed the width of the cells in the pivot table.
Declaration
public PivotViewGridSettingsBuilder AllowTextWrap(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
BeforeCopy(String)
It triggers before copy information from the pivot table.
Declaration
public PivotViewGridSettingsBuilder BeforeCopy(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
BeforeExcelExport(String)
It triggers before the Excel export starts.
Declaration
public PivotViewGridSettingsBuilder BeforeExcelExport(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
BeforePdfExport(String)
It triggers before the PDF export starts.
Declaration
public PivotViewGridSettingsBuilder BeforePdfExport(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
BeforePrint(String)
It triggers before the print action starts.
Declaration
public PivotViewGridSettingsBuilder BeforePrint(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
CellDeselected(String)
It triggers when a particular selected cell is deselected from the pivot table.
Declaration
public PivotViewGridSettingsBuilder CellDeselected(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
CellDeselecting(String)
It triggers before the selected cell is deselecting from the pivot table.
Declaration
public PivotViewGridSettingsBuilder CellDeselecting(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
CellSelected(String)
It triggers after a cell is selected in the pivot table.\
Declaration
public PivotViewGridSettingsBuilder CellSelected(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
CellSelecting(String)
It triggers before any cell selection occurs in the pivot table.
Declaration
public PivotViewGridSettingsBuilder CellSelecting(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ClipMode(Object)
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.
The modes available are:
Clip: Allow the content of a cell to truncate when it overflows its content area.
Ellipsis: Allows the content of a cell to be displayed as an ellipse when it overflows its content area.
EllipsisWithTooltip: Allows the cell content to be displayed as an ellipse when its content area is overflowing.
And the tooltip will also be displayed while hovering on the ellipsis applied cell.
Declaration
public PivotViewGridSettingsBuilder ClipMode(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
ColumnDrag(String)
It triggers when column header element is dragged (moved) continuously.
Declaration
public PivotViewGridSettingsBuilder ColumnDrag(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ColumnDragStart(String)
It triggers when column header element drag (move) starts.
Declaration
public PivotViewGridSettingsBuilder ColumnDragStart(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ColumnDrop(String)
It triggers when a column header element is dropped on the target column.
Declaration
public PivotViewGridSettingsBuilder ColumnDrop(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ColumnRender(String)
It allows to configure the column before it renders.
Declaration
public PivotViewGridSettingsBuilder ColumnRender(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ColumnWidth(Double)
Allow to set width to the pivot table columns commonly.
By default, the columnWidth property is set as 110 pixels to each column except the first column. The first column always defined as row headers in the pivot table. For first column, 250 pixels and 200 pixels are set respectively with and without grouping bar.
Declaration
public PivotViewGridSettingsBuilder ColumnWidth(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value |
Returns
ContextMenuClick(String)
It triggers when click on context menu.
Declaration
public PivotViewGridSettingsBuilder ContextMenuClick(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ContextMenuItems(Object)
Allows to show built-in context with pre-defined menu option or custom menu options by simply right clicking on the pivot table cell.
The options available are:
Drillthrough: Allows to show the drill-through dialog over the pivot table to perform drill-through operations.
Expand: Allows to expand the collapsed row or column headers in the pivot table.
Collapse: Allows to collapse the expanded row or column headers in the pivot table.
CalculatedField: Allows to show the calculated field dialog over the pivot table to perform calculated field operations.
Pdf Export: Allows to export the pivot table as PDF format.
Excel Export: Allows to export the pivot table as Excel format.
Csv Export: Allows to export the pivot table as CSV format.
Sort Ascending: Allows to perform ascending order with respect to the values on selected cell contained row or column in the pivot table.
Sort Descending: Allows to perform descending order with respect to the values on selected cell contained row or column in the pivot table.
Aggregate: Allow options to perform calculations over a group of values (exclusively for value fields bound in value axis) using the aggregation option in the pivot table.
Declaration
public PivotViewGridSettingsBuilder ContextMenuItems(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
ContextMenuOpen(String)
It triggers before context menu opens.
Declaration
public PivotViewGridSettingsBuilder ContextMenuOpen(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ExcelHeaderQueryCellInfo(String)
It triggers before exporting each header cell to Excel file. You can also customize the Excel cells.
Declaration
public PivotViewGridSettingsBuilder ExcelHeaderQueryCellInfo(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ExcelQueryCellInfo(String)
It triggers before exporting each cell to Excel file. You can also customize the Excel cells.
Declaration
public PivotViewGridSettingsBuilder ExcelQueryCellInfo(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
GridLines(Object)
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. The modes available are,
Both: Allows the cell border to be displayed both horizontally and vertically in the pivot table.
None: Allows no cell borders to be displayed in the pivot table.
Horizontal: Allows the cell border to be shown horizontally in the pivot table.
Vertical: Allows the cell border to be shown vertically in the pivot table.
Default: Allows the display of the cell borders based on the theme used in the pivot table.
Declaration
public PivotViewGridSettingsBuilder GridLines(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
HeaderCellInfo(String)
Triggered for column header. It will get triggered before the cell element is appended to the Grid element.
Declaration
public PivotViewGridSettingsBuilder HeaderCellInfo(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
Height(Double)
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.
Declaration
public PivotViewGridSettingsBuilder Height(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value |
Returns
Height(String)
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.
Declaration
public PivotViewGridSettingsBuilder Height(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
Layout(GridLayout)
Specifies the layout options for displaying the pivot table in either a compact or tabular format.
The available options are:
Compact: Displays the pivot table in a compact format, merging row headers into a single column.
Tabular: Displays the pivot table in a traditional format with separate columns for row headers, creating a more detailed table format.
Declaration
public PivotViewGridSettingsBuilder Layout(GridLayout value)Parameters
| Type | Name | Description |
|---|---|---|
| GridLayout | value |
Returns
PdfHeaderQueryCellInfo(String)
It triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
Declaration
public PivotViewGridSettingsBuilder PdfHeaderQueryCellInfo(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
PdfQueryCellInfo(String)
It triggers before exporting each cell to PDF document. You can also customize the PDF cells.
Declaration
public PivotViewGridSettingsBuilder PdfQueryCellInfo(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
PrintComplete(String)
It triggers after print action is completed.
Declaration
public PivotViewGridSettingsBuilder PrintComplete(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
PrintMode(Object)
Allow options to print either the current page shown in the pivot table on its own or the entire pivot table.
The options available are:
AllPages: Prints the entire pivot table.
CurrentPage: Prints the current page shown in the pivot table on its own.
Declaration
public PivotViewGridSettingsBuilder PrintMode(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
QueryCellInfo(String)
Triggered every time a request is made to access cell information, element, or data. It will get triggered before the cell element is appended to the Grid element.
Declaration
public PivotViewGridSettingsBuilder QueryCellInfo(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ResizeStart(String)
It triggers when column resize starts in the pivot table.
Declaration
public PivotViewGridSettingsBuilder ResizeStart(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
ResizeStop(String)
It triggers when column resize ends in the pivot table.
Declaration
public PivotViewGridSettingsBuilder ResizeStop(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
Resizing(String)
It triggers on column resizing in the pivot table.
Declaration
public PivotViewGridSettingsBuilder Resizing(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
RowDeselected(String)
It triggers when a selected row is deselected from the pivot table.
Declaration
public PivotViewGridSettingsBuilder RowDeselected(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
RowDeselecting(String)
It triggers before deselecting the selected row from the pivot table.
Declaration
public PivotViewGridSettingsBuilder RowDeselecting(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
RowHeight(Double)
Allow to set height to the pivot table rows commonly.
By default, the rowHeight property is set as 36 pixels for desktop layout and 48 pixels for mobile layout. The height of the column headers alone may vary when grouping bar feature is enabled.
Declaration
public PivotViewGridSettingsBuilder RowHeight(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value |
Returns
RowSelected(String)
It triggers after a row is selected in the pivot table.
Declaration
public PivotViewGridSettingsBuilder RowSelected(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
RowSelecting(String)
It triggers before row selection occurs in the pivot table.
Declaration
public PivotViewGridSettingsBuilder RowSelecting(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |
Returns
SelectedRowIndex(Int32)
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.
You can get the currently selected row index of the pivot table from the
selectedRowIndexproperty using pivot table instance at run-time.
Declaration
public PivotViewGridSettingsBuilder SelectedRowIndex(int value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | value |
Returns
SelectionSettings(PivotViewPivotSelectionSettings)
Allows 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.
The options available are:
mode - Allow options to highlight either row wise or column wise or specific cells in the pivot table. For example, to highlight the columns, set the property modeto Column.cellSelectionMode: Allow options to customize the mode of selection to highlight either row wise or column wise or specific cell in the pivot table. For example, to apply the selection that includes in between cells of rows within the range, set the property cellSelectionModeto Box.type: Allow options to customize the selection type to highlight either row wise or column wise or specific cell in the pivot table. For example, to highlight multiple rows or columns or cells, set the property typeto Multiple.checkboxOnly: Allows the selection options to highlight the rows in the pivot table using checkbox selection on their own. persistSelection: Allows you to keep selections in rows or columns or cells while performing all operations in the pivot table. checkboxMode: Allow options to customize the checkbox selection mode in the pivot table. For example, to select multiple rows one by one through simple clicking on rows, set the property checkboxModeto Default.enableSimpleMultiRowSelection`: Allows to perform multiple selection in rows with single clicks without using SHIFT or CTRL keys.
Declaration
public PivotViewGridSettingsBuilder SelectionSettings(PivotViewPivotSelectionSettings value)Parameters
| Type | Name | Description |
|---|---|---|
| PivotViewPivotSelectionSettings | value |
Returns
SelectionSettings(Action<PivotViewPivotSelectionSettingsBuilder>)
Declaration
public PivotViewGridSettingsBuilder SelectionSettings(Action<PivotViewPivotSelectionSettingsBuilder> selectionSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<PivotViewPivotSelectionSettingsBuilder> | selectionSettings |
Returns
SelectionSettings(Object)
Allows 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.
The options available are:
mode - Allow options to highlight either row wise or column wise or specific cells in the pivot table. For example, to highlight the columns, set the property modeto Column.cellSelectionMode: Allow options to customize the mode of selection to highlight either row wise or column wise or specific cell in the pivot table. For example, to apply the selection that includes in between cells of rows within the range, set the property cellSelectionModeto Box.type: Allow options to customize the selection type to highlight either row wise or column wise or specific cell in the pivot table. For example, to highlight multiple rows or columns or cells, set the property typeto Multiple.checkboxOnly: Allows the selection options to highlight the rows in the pivot table using checkbox selection on their own. persistSelection: Allows you to keep selections in rows or columns or cells while performing all operations in the pivot table. checkboxMode: Allow options to customize the checkbox selection mode in the pivot table. For example, to select multiple rows one by one through simple clicking on rows, set the property checkboxModeto Default.enableSimpleMultiRowSelection`: Allows to perform multiple selection in rows with single clicks without using SHIFT or CTRL keys.
Declaration
public PivotViewGridSettingsBuilder SelectionSettings(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
TextWrapSettings(Object)
Allows the options for customizing the content of the cells to be wrapped in either rows and column headers or values or both headers and values in the pivot table.
For example, to wrap the contents of the value cells in the pivot table, then set the property wrapMode to Content in the textWrapSettings class.
The options available are:
Both: Allows the content of the cells to be wrapped in both headers and values.
Header: Allows the content of the cells to be wrapped in rows and column headers alone.
Content: Allows the content of the cells to be packed for the value cells alone.
Declaration
public PivotViewGridSettingsBuilder TextWrapSettings(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
Width(Double)
Allow to set width of the pivot table.
The pivot table will not display less than 400px, as it is the minimum width to the component.
Declaration
public PivotViewGridSettingsBuilder Width(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value |
Returns
Width(String)
Allow to set width of the pivot table.
The pivot table will not display less than 400px, as it is the minimum width to the component.
Declaration
public PivotViewGridSettingsBuilder Width(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value |