Class PivotViewGridSettings
Inheritance
Namespace: Syncfusion.EJ2.PivotView
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotViewGridSettings : EJTagHelper
Constructors
PivotViewGridSettings()
Declaration
public PivotViewGridSettings()
Properties
AllowAutoResizing
Allows the component to be fit based on the width of its columns.
Declaration
public bool AllowAutoResizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowReordering
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 bool AllowReordering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowResizing
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 bool AllowResizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowSelection
Allows a row or column or cell to be highlighted by simply clicking or arrow key in the pivot table.
Declaration
public bool AllowSelection { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowTextWrap
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 bool AllowTextWrap { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
BeforeCopy
Declaration
public string BeforeCopy { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeExcelExport
Declaration
public string BeforeExcelExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePdfExport
Declaration
public string BeforePdfExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePrint
Declaration
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellDeselected
Declaration
public string CellDeselected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellDeselecting
Declaration
public string CellDeselecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSelected
Declaration
public string CellSelected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CellSelecting
Declaration
public string CellSelecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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.
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 object ClipMode { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ColumnDrag
Declaration
public string ColumnDrag { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDragStart
Declaration
public string ColumnDragStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnDrop
Declaration
public string ColumnDrop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnRender
Declaration
public string ColumnRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ColumnWidth
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 double ColumnWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 110 |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type |
---|
Syncfusion.EJ2.MvcTemplate<System.Object> |
ContextMenuClick
Declaration
public string ContextMenuClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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.
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 object ContextMenuItems { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ContextMenuOpen
Declaration
public string ContextMenuOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExcelHeaderQueryCellInfo
Declaration
public string ExcelHeaderQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ExcelQueryCellInfo
Declaration
public string ExcelQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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. 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 object GridLines { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
HeaderCellInfo
Declaration
public string HeaderCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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.
Declaration
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "auto" |
PdfHeaderQueryCellInfo
Declaration
public string PdfHeaderQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PdfQueryCellInfo
Declaration
public string PdfQueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PrintComplete
Declaration
public string PrintComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PrintMode
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 object PrintMode { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
QueryCellInfo
Declaration
public string QueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ResizeStart
Declaration
public string ResizeStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ResizeStop
Declaration
public string ResizeStop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Resizing
Declaration
public string Resizing { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDeselected
Declaration
public string RowDeselected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowDeselecting
Declaration
public string RowDeselecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowHeight
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 double RowHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
RowSelected
Declaration
public string RowSelected { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
RowSelecting
Declaration
public string RowSelecting { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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.
You can get the currently selected row index of the pivot table from the
selectedRowIndex
property using pivot table instance at run-time.
Declaration
public int SelectedRowIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The default value is -1 |
SelectionSettings
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 object SelectionSettings { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
TextWrapSettings
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 object TextWrapSettings { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
Width
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 string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "auto" |