Search results

PivotViewComponent

PivotViewComponent represents the react PivotView.

<PivotViewComponent/>

Properties

allowCalculatedField

boolean

It allows to enable calculated field in PivotView.

Defaults to false

allowConditionalFormatting

boolean

It allows to enable Conditional Formatting in PivotView.

Defaults to false

allowDeferLayoutUpdate

boolean

If allowDeferLayoutUpdate is set to true, then it will enable defer layout update to pivotview.

Defaults to false

allowDrillThrough

boolean

If allowDrillThrough set to true, then you can view the raw items that are used to create a specified value cell in the pivot grid.

Defaults to false

allowExcelExport

boolean

If allowExcelExport is set to true, then it will allow the user to export pivotview to Excel file.

Defaults to false

allowPdfExport

boolean

If allowPdfExport is set to true, then it will allow the user to export pivotview to Pdf file.

Defaults to false

cellTemplate

string

The template option which is used to render the pivot cells on the pivotview. Here, the template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the pivot cells.

Defaults to null

chartSettings

ChartSettingsModel

Configures the features settings of Pivot widget.

dataSource

DataSourceModel

It allows the user to configure the pivot report as per the user need.

displayOption

DisplayOptionModel

Configures the settings of displayOption.

editSettings

CellEditSettingsModel

Configures the edit behavior of the Pivot Grid.

Defaults to { allowAdding: false, allowEditing: false, allowDeleting: false, allowCommandColumns: false,mode:‘Normal’, allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }

enablePersistence

boolean

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

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableValueSorting

boolean

It allows to enable Value Sorting in PivotView.

Defaults to false

enableVirtualization

boolean

If enableVirtualization set to true, then the Grid will render only the rows and the columns visible within the view-port and load subsequent rows and columns on vertical scrolling. This helps to load large dataset in Pivot Grid.

Defaults to false

gridSettings

GridSettingsModel

Configures the features settings of Pivot widget.

groupingBarSettings

GroupingBarSettingsModel

Configures the settings of GroupingBar.

height

string | number

Pivot widget. (Note change all occurrences)

Defaults to ‘auto’

hyperlinkSettings

HyperlinkSettingsModel

Configures the settings of hyperlink settings.

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to

maxNodeLimitInMemberEditor

number

It allows to set the maximum number of nodes to be displayed in the member editor.

Defaults to 1000

pivotValues

IPivotValues

It holds the pivot engine data which renders the Pivot widget.

showFieldList

boolean

It allows to render pivotfieldlist.

Defaults to false

showGroupingBar

boolean

Enables the display of GroupingBar allowing you to filter, sort, and remove fields obtained from the datasource.

Defaults to false

showToolbar

boolean

It allows to enable/disable toolbar in pivot table.

Defaults to false

showTooltip

boolean

Allows to display the Tooltip on hovering value cells in pivot grid.

Defaults to true

showValuesButton

boolean

It shows a common button for value fields to move together in column or row axis

Defaults to false

toolbar

string[]

It allows to set toolbar items in pivot table.

Defaults to []

width

string | number

It allows to set the width of Pivot widget.

Defaults to ‘auto’

Methods

chartExport

Export method for the chart.

Parameter Type Description
type ExportType Defines the export type.
fileName string Defines file name of export document.
orientation (optional) PdfPageOrientation Defines the page orientation on pdf export(0 for Portrait mode, 1 for Landscape mode).
width (optional) number Defines width of the export document.
height (optional) number Defines height of the export document.

Returns void

csvExport

Export PivotGrid data to CSV file.

Parameter Type Description
excelExportProperties (optional) ExcelExportProperties Defines the export properties of the Grid.
isMultipleExport (optional) boolean Define to enable multiple export.
workbook (optional) any Defines the Workbook if multiple export is enabled.
isBlob (optional) boolean If ‘isBlob’ set to true, then it will be returned as blob data.

Returns void

destroy

To destroy the PivotView elements.

Returns void

excelExport

Export Pivot widget data to Excel file(.xlsx).

Parameter Type Description
excelExportProperties (optional) ExcelExportProperties Defines the export properties of the Grid.
isMultipleExport (optional) boolean Define to enable multiple export.
workbook (optional) any Defines the Workbook if multiple export is enabled.
isBlob (optional) boolean If ‘isBlob’ set to true, then it will be returned as blob data.

Returns void

pdfExport

Export Pivot widget data to PDF document.

Returns void

printChart

Print method for the chart.

Returns void

Events

aggregateCellInfo

EmitType<AggregateEventArgs>

This allows to change the cell value.

beforeExport

EmitType<BeforeExportEventArgs>

This allows to set properties for exporting.

beginDrillThrough

EmitType<BeginDrillThroughEventArgs>

Triggers when value cell is clicked in the Pivot widget on Editing.

cellClick

EmitType<CellClickEventArgs>

Triggers when cell is clicked in the Pivot widget.

cellSelected

EmitType<PivotCellSelectedEventArgs>

Triggers when cell got selected in Pivot widget.

cellSelecting

EmitType<PivotCellSelectedEventArgs>

Triggers before cell got selected in Pivot widget.

chartSeriesCreated

EmitType<ChartSeriesCreatedEventArgs>

Triggers when chart series are created.

created

EmitType<Object>

Triggers when data source is created in the Pivot View.

dataBound

EmitType<Object>

Triggers when data source is populated in the Pivot View.

destroyed

EmitType<Object>

Triggers when data source is destroyed in the Pivot View.

drill

EmitType<DrillArgs>

Triggers before drill down/ drill up Pivot widget.

drillThrough

EmitType<DrillThroughEventArgs>

Triggers when value cell is clicked in the Pivot widget on Drill-Through.

enginePopulated

EmitType<EnginePopulatedEventArgs>

Triggers after the pivot engine populated and allows to customize the pivot widget.

enginePopulating

EmitType<EnginePopulatingEventArgs>

Triggers before the pivot engine starts to populate and allows to customize the pivot datasource settings.

fetchReport

EmitType<FetchReportArgs>

This allows to fetch the report names from storage.

hyperlinkCellClick

EmitType<HyperCellClickEventArgs>

Triggers when hyperlink cell is clicked in the Pivot widget.

load

EmitType<LoadEventArgs>

This allows any customization of PivotView properties on initial rendering.

loadReport

EmitType<LoadReportArgs>

This allows to load the report from storage.

newReport

EmitType<NewReportArgs>

This allows to set the new report.

onFieldDropped

EmitType<FieldDroppedEventArgs>

Triggers when a field getting dropped into any axis.

onPdfCellRender

EmitType<PdfCellRenderArgs>

This allows any customization of Pivot cell style while PDF exporting.

removeReport

EmitType<RemoveReportArgs>

This allows to remove the report from storage.

renameReport

EmitType<RenameReportArgs>

This allows to rename the report.

saveReport

EmitType<SaveReportArgs>

This allows to save the report in any storage.

toolbarClick

EmitType<ClickEventArgs>

This allows to change the toolbar items.

toolbarRender

EmitType<ToolbarArgs>

This allows to change the toolbar items.