Search results

GridSettings API in JavaScript Pivot Table API control

Represents Pivot widget model class.

Properties

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.

Defaults to false

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.

Defaults to true

allowSelection

boolean

Allows a row or column or cell to be highlighted by simply clicking or arrow key in the pivot table.

Defaults to false

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.

Defaults to false

clipMode

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.

Defaults to Ellipsis

columnWidth

number

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.

Defaults to 110

contextMenuItems

string[] | ContextMenuItemModel[]

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 collaped row or column headers in the pivot table.
  • Collapse: Allows to collapse the expaned 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 repect to the values on selected cell contained row or column in the pivot table.
  • Sort Descending: Allows to perform descending order with repect 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.

Defaults to null

gridLines

GridLine

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.

Defaults to Both

height

number | 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.

Defaults to ‘auto’

printMode

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.

Defaults to AllPages

rowHeight

number

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.

Defaults to null

selectedRowIndex

number

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.

Defaults to -1

selectionSettings

SelectionSettingsModel | 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 expample, to highlight the columns, set the propertymode` to 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 cellSelectionMode to 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 type to 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 checkboxMode to Default.
  • enableSimpleMultiRowSelection: Allows to perform multiple selection in rows with single clicks without using SHIFT or CTRL keys.

Defaults to {mode: ‘Row’, cellSelectionMode: ‘Flow’, type: ‘Single’}

textWrapSettings

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.

Defaults to { wrapMode: ‘Both’}

width

number | 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.

Defaults to ‘auto’

Events

beforeCopy

EmitType<BeforeCopyEventArgs>

It triggers before copy information from the pivot table.

beforeExcelExport

EmitType<Object>

It triggers before the Excel export starts.

beforePdfExport

EmitType<Object>

It triggers before the PDF export starts.

beforePrint

EmitType<PrintEventArgs>

It triggers before the print action starts.

cellDeselected

EmitType<CellDeselectEventArgs>

It triggers when a particular selected cell is deselected from the pivot table.

cellDeselecting

EmitType<CellDeselectEventArgs>

It triggers before the selected cell is deselecting from the pivot table.

cellSelected

EmitType<CellSelectEventArgs>

It triggers after a cell is selected in the pivot table.

cellSelecting

EmitType<CellSelectingEventArgs>

It triggers before any cell selection occurs in the pivot table.

columnDrag

EmitType<ColumnDragEventArgs>

It triggers when column header element is dragged (moved) continuously.

columnDragStart

EmitType<ColumnDragEventArgs>

It triggers when column header element drag (move) starts.

columnDrop

EmitType<ColumnDragEventArgs>

It triggers when a column header element is dropped on the target column.

columnRender

EmitType<ColumnRenderEventArgs>

It allows to configure the column before it renders.

contextMenuClick

EmitType<MenuEventArgs>

It triggers when click on context menu.

contextMenuOpen

EmitType<BeforeOpenCloseMenuEventArgs>

It triggers before context menu opens.

excelHeaderQueryCellInfo

EmitType<ExcelHeaderQueryCellInfoEventArgs>

It triggers before exporting each header cell to Excel file. You can also customize the Excel cells.

excelQueryCellInfo

EmitType<ExcelQueryCellInfoEventArgs>

It triggers before exporting each cell to Excel file. You can also customize the Excel cells.

headerCellInfo

EmitType<HeaderCellInfoEventArgs>

Triggered for column header. It will get triggered before the cell element is appended to the Grid element.

pdfHeaderQueryCellInfo

EmitType<PdfHeaderQueryCellInfoEventArgs>

It triggers before exporting each header cell to PDF document. You can also customize the PDF cells.

pdfQueryCellInfo

EmitType<PdfQueryCellInfoEventArgs>

It triggers before exporting each cell to PDF document. You can also customize the PDF cells.

printComplete

EmitType<PrintEventArgs>

It triggers after print action is completed.

queryCellInfo

EmitType<QueryCellInfoEventArgs>

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.

resizeStart

EmitType<ResizeArgs>

It triggers when column resize starts in the pivot table.

resizeStop

EmitType<ResizeArgs>

It triggers when column resize ends in the pivot table.

resizing

EmitType<ResizeArgs>

It triggers on column resizing in the pivot table.

rowDeselected

EmitType<RowDeselectEventArgs>

It triggers when a selected row is deselected from the pivot table.

rowDeselecting

EmitType<RowDeselectEventArgs>

It triggers before deselecting the selected row from the pivot table.

rowSelected

EmitType<RowSelectEventArgs>

It triggers after a row is selected in the pivot table.

rowSelecting

EmitType<RowSelectEventArgs>

It triggers before row selection occurs in the pivot table.