Search results

Overview API in JavaScript (ES5) Pivot Table API control

Name Description
Authentication Allows you to set the credential information to access the specified SSAS cube.
> It is applicable only for OLAP data source.
CalculatedFieldSettings Allows options to create new calculated fields from the bound data source or using simple formula with basic arithmetic operators in the pivot table.
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.
CustomGroups Allows to specify the custom group information of specific field to create custom groups.
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.
* 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.
DrillOptions Allows specific fields used to display their the headers to be either expanded or collapsed in the pivot table.
FieldListFieldOptions Allows specific fields associated with field information that needs to be displayed in the field axes of pivot table. The following configurations which are applicable are as follows:
* name: Allows you to set the field name that needs to be displayed in row/column/value/filter axis of pivot table.
* caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component’s UI.
* type: Allows to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… Note: It is applicable only for relational data source.
* axis: Allows you to set the axis name to the specific field. This will help to display the field in specified axis such as row/column/value/filter axis of pivot table.
* showNoDataItems: Allows you to display all members items of a specific field to the pivot table,
even doesn’t have any data in its row/column intersection in data source. Note: It is applicable only for relational data source.
* baseField: Allows you to set the selective field, which used to display the values with either
DifferenceFrom or PercentageOfDifferenceFrom or PercentageOfParentTotal aggregate types. Note: It is applicable only for relational data source.
* baseItem: Allows you to set the selective item of a specific field, which used to display the values with either DifferenceFrom or PercentageOfDifferenceFrom aggregate types.
The selective item should be set the from field specified in the baseField property. Note: It is applicable only for relational data source.
* showSubTotals: Allows to show or hide sub-totals to a specific field in row/column axis of the pivot table.
* isNamedSet: Allows you to set whether the specified field is a named set or not. In general,
the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: It is applicable only for OLAP data source.
* isCalculatedField: Allows to set whether the specified field is a calculated field or not.
In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source.
* showFilterIcon: Allows you to show or hide the filter icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI.
This filter icon is used to filter the members of a specified field at runtime in the pivot table.
* showSortIcon: Allows you to show or hide the sort icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI.
This sort icon is used to order members of a specified field either in ascending or descending at runtime.
* showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI.
This remove icon is used to remove the specified field during runtime.
* showValueTypeIcon: Allows you to show or hide the value type icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI.
This value type icon helps to select the appropriate aggregation type to specified value field at runtime.
* showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI.
This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table.
* allowDragAndDrop: Allows you to restrict the specific field’s pivot button that is used to drag on runtime in the grouping bar and field list UI.
This will prevent you from modifying the current report.
* expandAll: Allows you to expand or collapse all of the pivot table’s headers for a specific field.
FieldOptions Allows specific fields associated with field information that needs to be displayed in the field axes of pivot table. The following configurations which are applicable are as follows:
* name: Allows you to set the field name that needs to be displayed in row/column/value/filter axis of pivot table.
* caption: Allows you to set caption to the specific field. It will be used to display instead of its name in pivot table component’s UI.
* type: Allows to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… Note: It is applicable only for relational data source.
* axis: Allows you to set the axis name to the specific field. This will help to display the field in specified axis such as row/column/value/filter axis of pivot table.
* showNoDataItems: Allows you to display all members items of a specific field to the pivot table,
even doesn’t have any data in its row/column intersection in data source. Note: It is applicable only for relational data source.
* baseField: Allows you to set the selective field, which used to display the values with either
DifferenceFrom or PercentageOfDifferenceFrom or PercentageOfParentTotal aggregate types. Note: It is applicable only for relational data source.
* baseItem: Allows you to set the selective item of a specific field, which used to display the values with either DifferenceFrom or PercentageOfDifferenceFrom aggregate types.
The selective item should be set the from field specified in the baseField property. Note: It is applicable only for relational data source.
* showSubTotals: Allows to show or hide sub-totals to a specific field in row/column axis of the pivot table.
* isNamedSet: Allows you to set whether the specified field is a named set or not. In general,
the named set is a set of dimension members or a set expression (MDX query) to be created as a dimension in the SSAS OLAP cube itself. Note: It is applicable only for OLAP data source.
* isCalculatedField: Allows to set whether the specified field is a calculated field or not.
In general, the calculated field is created from the bound data source or using simple formula with basic arithmetic operators in the pivot table. Note: It is applicable only for OLAP data source.
* showFilterIcon: Allows you to show or hide the filter icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI.
This filter icon is used to filter the members of a specified field at runtime in the pivot table.
* showSortIcon: Allows you to show or hide the sort icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI.
This sort icon is used to order members of a specified field either in ascending or descending at runtime.
* showRemoveIcon: Allows you to show or hide the remove icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI.
This remove icon is used to remove the specified field during runtime.
* showValueTypeIcon: Allows you to show or hide the value type icon of a specific field that used to be displayed in the pivot button of the grouping bar and field list UI.
This value type icon helps to select the appropriate aggregation type to specified value field at runtime.
* showEditIcon: Allows you to show or hide the edit icon of a specific field that used to be displayed on the pivot button of the grouping bar and field list UI.
This edit icon is used to modify caption, formula, and format of a specified calculated field at runtime that to be displayed in the pivot table.
* allowDragAndDrop: Allows you to restrict the specific field’s pivot button that is used to drag on runtime in the grouping bar and field list UI.
This will prevent you from modifying the current report.
* expandAll: Allows you to either expand or collapse all of the headers in the pivot table for a specific field.
Filter Allows specific fields associated with either selective or conditional-based filter members 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.
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.
Sort 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.
Style Allows the style information to customize the pivot table cell appearance.
ValueSortSettings Allows to sort individual value field and its aggregated values either in row or column axis to ascending or descending order.
CellEditSettings 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.
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.
> This feature is applicable only for the relational data source.
ConditionalSettings Allow options for setting the visibility of hyperlink based on specific condition. The options available here are as follows:
* measure: Allows you to specify the value field caption to get visibility of hyperlink option for specific measure.
* condition: Allows you to choose the operator type such as equals, greater than, less than, etc.
* value1: Allows you to set the start value.
* value2: Allows you to set the end value. This option will be used by default when the operator Between and NotBetween is chosen to apply.
DisplayOption Allow options to configure the view port as either pivot table or pivot chart or both table and chart. The options available are:
* 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.
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.
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.
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 hyperlinkSettings class.
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.
> By default, the hyperlink options are disabled for all cells in the pivot table.
PageSettings Allows you to configure page information such as page size and current page details for each axis in order to display the pivot table with a specific page when paging.
PagerSettings Allows a set of options for customizing the paging UI with a variety of settings such as UI position, template and visibility to a specific axis info such as page size, paging data.
> To use this option, it requires the property enablePaging to be true.
PivotView Represents the PivotView component.
Animation Allows to configure the animation behavior for chart series such as animation duration and delay.
AxisLine Allows to configure the axis line such as line width, dashArray and color in a chart.
Border Allow options to customize the border of the chart such as color and border size in the pivot chart.
For example, to display the chart 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.
ChartLocation Allows to configure the position of the legend such as top and left in the chart.
ChartSegment Allows to customize specific region for line type series with a variety of means such as value, color, pattern of dashes.
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, crosshairs, theme, title, tooltip, zooming, etc.
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.
* enableCanvas: Allows you to render the pivot chart in canvas mode.
* 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.
CornerRadius Allows to customize the rounded corners of the column series in the chart.
CrosshairSettings 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.
CrosshairTooltip Allows to configure the crosshair tooltip with text style and fill color in the chart.
DataLabelSettings Allows to configure the data label with different settings such as name, fill color, opacity, rotation angle, border, margins, etc in the chart.
EmptyPointSettings Allows to configure the empty points with a variety of means such as fill color, border and mode in the chart.
ErrorBarCapSettings Allows to configure the error bar cap settings such as cap width, length, color, opacity.
ErrorBarSettings Allows options for customize the error bar chart with different settings such as type, direction, mode, color, width, etc.
Font Allows to customize the appearance of the text in the chart such as font style, font size, font weight, font color, font family, text alignment, opacity, text overflow.
Indexes 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.
LabelBorder Allows to customize the label border with a variety of means such as label color, width and label type in the chart.
MajorGridLines Allows to configure the major grid lines such as line width, color and dashArray in the axis.
MajorTickLines Allows to configure the major tick lines such as width, height and color in the chart.
Margin Allow options to customize the left, right, top and bottom margins of the pivot chart.
MarkerSettings Allows to configure the marker of the series such as shape, width, height, border, position, fill color, opacity, data label etc in the chart
MinorGridLines Allows to configure the minor grid lines such as line width, dashArray and color in the axis.
MinorTickLines Allows to configure the minor tick lines such as width, height and color in the chart.
Offset Allows to configure the position of the marker such as top and left in the chart.
PivotAxis Allow options to customize the 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.
PivotChartAxisAxisLine Allows to configure the axis line such as line width, dashArray and color in a chart.
PivotChartAxisCrosshairTooltip Allows to configure the crosshair tooltip with text style and fill color in the chart.
PivotChartAxisFont Allows to customize the appearance of the text in the chart such as font style, font size, font weight, font color, font family, text alignment, opacity, text overflow.
PivotChartAxisLabelBorder Allows to customize the label border with a variety of means such as label color, width and label type in the chart.
PivotChartAxisMajorGridLines Allows to configure the major grid lines such as line width, color and dashArray in the axis.
PivotChartAxisMajorTickLines Allows to configure the major tick lines such as width, height and color in the chart.
PivotChartAxisMinorGridLines Allows to configure the minor grid lines such as line width, dashArray and color in the axis.
PivotChartAxisMinorTickLines Allows to configure the minor tick lines such as width, height and color in the chart.
PivotChartAxisStripLineSettings Allows to configure the strip line properties such as line position, size, color, size type, border, text and opacity in the chart.
PivotChartConnectorStyle Allow options to customize the pie, funnel, doughnut and pyramid chart data label connector.
PivotChartDataLabel Allow options to customize the pie, funnel, doughnut and pyramid chart data label connector.
PivotChartSeriesAnimation Allows to configure the animation behavior for chart series such as animation duration and delay.
PivotChartSeriesBorder 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.
PivotChartSeriesCornerRadius Allows to customize the rounded corners of the column series in the chart.
PivotChartSeriesEmptyPointSettings Allows to configure the empty points with a variety of means such as fill color, border and mode in the chart.
PivotChartSeriesErrorSettings Allows options for customize the error bar chart series with different settings such as type, direction, mode, color, width, etc.
PivotChartSeriesMarkerSettings Allows to configure the marker of the series such as shape, width, height, border, position, fill color, opacity, data label etc in the chart
PivotChartSeriesSegment Allows to customize specific region for line type series with a variety of means such as value, color, pattern of dashes.
PivotChartSeriesTrendline Allows to configure the trendlines of the chart series such as name, period, type, tooltip, marker, animation, color, legend shape, etc.
PivotChartSettingsChartArea 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.
PivotChartSettingsCrosshairSettings 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.
PivotChartSettingsIndexes 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.
PivotChartSettingsLegendSettings 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.
PivotChartSettingsMargin Allow options to customize the left, right, top and bottom margins of the pivot chart.
PivotPieChartCenter Allow options to customize the center of the pivot pie series chart.
PivotSeries 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.
PivotTooltipSettings 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.
PivotZoomSettings Allow options to customize the pivot chart zooming with different properties such as enablePinchZooming, enableSelectionZooming,
enableDeferredZooming, enableMouseWheelZooming, zoom modes, toolbarItems, enableScrollbar and enablePan.
StripLineSettings Allows to configure the strip line properties such as line position, size, color, size type, border, text and opacity in the chart.
Trendline Allows to configure the trendlines of the chart such as name, period, type, tooltip, marker, animation, color, legend shape, etc.
GridSettings Represents Pivot widget model class.
PivotSelectionSettings Interface for a class SelectionSettings
FieldItemInfo Allows to configure the specific field information during UI operation at runtime.
IAuthenticationInfo Allows you to set the credential information to access the specified SSAS cube.
> It is applicable only for OLAP data source.
IAxisSet Allows you to configure the pivot cell information retrieved from the data source.
ICalculatedFieldSettings Allows options to create new calculated fields from the bound data source or using simple formula with basic arithmetic operators in the pivot table.
ICalculatedFields Configures the specific calculated field information.
IConditionalFormatSettings 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.
ICustomGroups Allows to specify the custom group information of specific field to create custom groups.
IDataOptions Allows the following pivot report information such as rows, columns, values, filters, etc., that are used to render the pivot table and field list.
* 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.
* grandTotalsPosition: Allows the grand totals to be position at first position in the row and column 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.
IDrillOptions Allows specific fields used to display their the headers to be either expanded or collapsed in the pivot table.
IDrilledItem Allows you to configure the drill information of a specific field item that used to display the pivot table.
IField Allows you to configure the information retrieved from the data source for the field list.
IFieldOptions Allows specific fields associated with field information that needs to be displayed in the field axes of pivot table. The following configurations which are applicable are as follows:
IFilter Allows specific fields associated with either selective or conditional-based filter members that used to be displayed in the pivot table.
IFormatSettings 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.
IGroupRange Allows to configure the group range information to perform date and number grouping on specific fields.
IGroupSettings 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.
IPageSettings Allows to set the page information to display the pivot table with specific page during virtual scrolling.
ISort 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.
IStyle Allows the style information to customize the pivot table cell appearance.
IValueSortSettings Allows to sort individual value field and its aggregated values either in row or column axis to ascending or descending order.
AfterServiceInvokeEventArgs Represents the arguments that provide necessary information about the service after it has been invoked.
AggregateEventArgs The aggregate event arguments provide the necessary information on each pivot value cell framing in the pivot engine for pivot table render.
AggregateMenuOpenEventArgs The aggregate menu open event arguments provide the necessary information to customize the aggregate menu options before it opens.
BeforeExportEventArgs The before export event arguments provides the necessary information to customize before exporting the file.
BeforeServiceInvokeEventArgs The before service invoke event arguments provide the necessary information about the service before it get invoked.
BeginDrillThroughEventArgs The begin drill-through event arguments provide the necessary information about the cell clicked on the pivot table for drill-through and editing.
CalculatedFieldCreateEventArgs The calculated field create event arguments provide the necessary information about the calculated field settings before it creates to update the pivot table.
CellClickEventArgs The cell click event arguments provides the necessary information about the cell clicked in the pivot table.
CellSelectedObject Defines the selected cells information on the pivot table.
CellTemplateArgs Defines the cell template information
ChartSeriesCreatedEventArgs The chart series created event arguments provide the necessary information about the chart series that used to create the pivot chart.
ColumnRenderEventArgs The column render event arguments provide the necessary information about the pivot table column headers before rendering.
DrillArgs The drill event arguments provide the necessary information about the pivot cell that performing drill operation.
DrillThroughEventArgs The drill-through event arguments provides the necessary information about the cell clicked in the pivot table for drill-through.
EditCompletedEventArgs The event argument which holds the editing information of the raw data made in corresponding aggregated cell.
EnginePopulatedEventArgs The engine populated event arguments provides the necessary information about the engine populated using updated report.
EnginePopulatingEventArgs The engine populating event arguments provides the necessary information to customize the report before populating the pivot engine.
ExcelCell Defines the cell information for excel export
ExcelColumn Defines the column on excel export
ExcelRow Defines the row on excel export
ExcelStyles Defines the style options for excel export
ExportCompleteEventArgs The export complete event arguments provide the necessary information about the exported data after completing the file export.
FetchRawDataArgs Defines the raw data needs to be updated.
FetchReportArgs The fetch report event arguments provides the necessary information to fetch reports from storage.
FieldDragStartEventArgs The field drag start event arguments provides the necessary information about the drag field and its axis.
FieldDropEventArgs The field drop event arguments provides the necessary information to customize the drop field and its drop axis.
FieldDroppedEventArgs The field dropped event arguments provides the necessary information about the dropped field and its dropped axis.
FieldListRefreshedEventArgs The field list refreshed event arguments provide the necessary information to render the pivot table.
FieldRemoveEventArgs The field remove event arguments provide the necessary information about the selected field information before it removes.
HeadersSortEventArgs Defines the current sorting information such as field name, sort order and members which is to be sorted.
HyperCellClickEventArgs The hyperlink cell click event arguments provides the necessary information about the cell clicked in the pivot table for hyperlink.
LoadEventArgs The load event arguments provides the necessary information to customize the pivot table before initializing the component.
LoadReportArgs The load report event arguments provides the necessary information to load the report.
MemberEditorOpenEventArgs The member editor open event arguments provide the necessary information about the selected field and its filter settings on before filter popup opens.
MemberFilteringEventArgs The member filtering event arguments provides the necessary information about the filtering which is performing.
MemberItems Defines the filter members information that used to render member filter dialog.
MultiLevelLabelClickEventArgs The event argument which holds the information of the clicked multi-level label.
MultiLevelLabelRenderEventArgs The event argument which holds the information of the multi-level labels that renders.
NewReportArgs The new report event arguments provides the necessary information to create a new report.
NumberFormattingEventArgs The number formatting event arguments provide the necessary information about the format settings of the selected field before it creates to update the pivot table.
PdfBorder Defines the border options for PDF export
PdfCellRenderArgs The PDF cell render event arguments provides the necessary information to customize the pivot cells while PDF exporting.
PdfMargins Interface for defining the margins of the PDF document when exporting a pivot table or pivot chart.
PdfStyle Defines the styles information to customize the PDF cell.
PdfTheme Defines the theme options for PDF export
PdfThemeStyle Defines the theme options for PDF export
PivotActionBeginEventArgs The action begins event arguments provide information about the current UI action, such as the action name, current datasource settings,
and the selected field information which are configured based on the UI actions like
drill down/up,
value sorting,
built-in toolbar options,
grouping bar and
field list buttons actions such as
sorting, filtering,
editing,
aggregate type change and so on,
CRUD operation in editing in the Pivot Table.
PivotActionCompleteEventArgs The action complete event arguments provide information about the current UI action, such as the current action name, current datasource settings, selected field information, and the current action information
which are configured based on the UI actions like
drill down/up,
value sorting,
built-in toolbar options,
grouping bar and
field list buttons actions such as
sorting, filtering,
editing,
aggregate type change and so on,
CRUD operation in editing in the Pivot Table.
PivotActionFailureEventArgs When the current UI action fails to achieve the desired result, the action failure event arguments provide necessary information about the current UI action, such as the current action name and failure information
which are configured based on the UI actions like
drill down/up,
value sorting,
built-in toolbar options,
grouping bar and
field list buttons actions such as
sorting, filtering,
editing,
aggregate type change and so on,
CRUD operation in editing in the Pivot Table.
PivotActionInfo Defines the unique information of the current UI action performed such as sorting, filtering, drill, editing, report manipulation, summarization, etc.
PivotCellSelectedEventArgs The cell selected event arguments provide the necessary information about the pivot cells that have been selected.
PivotColumn Defines the grid columns information that used to render as the pivot table header.
PivotEditInfo Defines the edited information such as current edit type, action and its edited record information such as edited data, previous data and index positions of before editing performed.
PivotExportInfo Defines the export information such as current export type and its additional settings such as page size, orientation, header, footer, etc.
PivotReportInfo Defines the report name that used to create, load, rename save and save as current report.
PivotToolbarInfo Defines the current toolbar information such as current display options and its settings such as chart settings, grid settings, etc.
QueryCellInfoEventArgs The query cell event arguments provide the necessary information on each pivot cell rendering in the pivot table.
RemoveReportArgs The remove report event arguments provides the necessary information to remove the report.
RenameReportArgs The rename report event arguments provides the necessary information to rename the report.
SaveReportArgs The save report event arguments provides the necessary information to save the report.
SelectionSettings Defines the cell selection settings
ToolbarArgs The toolbar event arguments provides the necessary information to customize options of the toolbar creating.
UpdateRawDataArgs Defines the raw data needs to be fetched.
Condition Defines the conditional formatting operators. They are
DataSourceType Allows to define the data source type. They are,
DateGroup Defines group of date field. They are:
DateOperators Defines the conditional operators for date type fields. They are
FilterType Allows you to set the specific filter type to display the filter members in the pivot table. They are:
GroupType Defines the group types. They are:
LabelOperators Defines the conditional operators for string type fields. They are
Operators Defines the conditional operators for filtering settings. They are
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. The following options are:
RenderMode Allows to set the mode of rendering the pivot table. They are,
Sorting Allows to apply sorting to the specified field either by ascending or descending or JSON order. The types are,
SummaryTypes Allows to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… The available types are,
ValueOperators Defines the conditional operators for value type fields. They are
AggregateTypes Allows to display the values in the pivot table with appropriate aggregations such as sum, product, count, average, etc… The available types are,
ChartSelectionMode Defines the pivot chart selection mode. They are
ChartSeriesType Defines the pivot chart types.
The available chart types are:
EditMode 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 as follows:
ExportView Allows the table or chart to be exported in the PDF export document. The available options are:
GrandTotalsPosition Allows the grand totals to be displayed in either the top or bottom position in the pivot table’s row and column axes.
The options available are:
LabelPosition Defines the data label position. They are,
Mode It defines the field list render modes. The available modes are:
MultipleAxisMode Allows the chart series to be displayed, depending on the value fields specified, in either a stacked or single chart area.
The options available are:
PagerPosition Allows to display the pager UI either at top or bottom of the Pivot Table UI.
The options available are:
PdfBorderStyle Defines border style to PDF export file. They are
PivotAccumulationChartSelectionMode Defines the SelectionMode for chart types pie, doughnut, Funnel and pyramid.
PivotCellSelectionMode Defines mode of cell selection. The modes available are:
PivotChartAlignment Defines the Alignment. They are
PivotChartAnchor Defines the strip line text position.
PivotChartAxisPosition Defines the Position. They are
PivotChartBorderType Defines border type for multi level labels.
PivotChartConnectorType Defines the ConnectorType for chart types pie, doughnut, Funnel and pyramid. They are
PivotChartDrawType Type of series to be drawn in radar or polar series. They are
PivotChartEdgeLabelPlacement Defines the Edge Label Placement for an axis. They are
PivotChartEmptyPointMode Defines the empty point mode of the chart.
PivotChartErrorBarDirection Defines the direction of error bar. They are
PivotChartErrorBarMode Defines the modes of error bar. They are
PivotChartErrorBarType Defines the type of error bar. They are
PivotChartGroupModes Defines the mode of the group mode for chart types pie, doughnut, Funnel and pyramid
PivotChartLabelIntersectAction Defines the Alignment. They are
PivotChartLabelPlacement Defines the Label Placement for category axis. They are
PivotChartLabelPosition Defines the LabelPosition for chart types pie, doughnut, Funnel and pyramid. They are
PivotChartLegendPosition Defines the position of the legend. They are
PivotChartLegendShape Defines the shape of legend. They are
PivotChartLineType Defines the mode of line in crosshair. They are
PivotChartPyramidModes Defines the mode of the pyramid
PivotChartShape Defines the shape of marker. They are
PivotChartSizeType Defines the unit of Strip line Size. They are
PivotChartSplineType It defines type of spline.
PivotChartTextOverflow Defines the Text overflow.
PivotChartTheme Defines Theme of the chart. They are
PivotChartToolbarItems Defines the ZoomingToolkit, They are.
PivotChartTrendlineTypes Defines the type of trendlines. They are:
PivotChartZIndex Specifies the order of the strip line. Over
PivotChartZoomMode Defines the zooming mode, They are.
PivotTableCheckboxSelectionType Defines modes of checkbox Selection. They are:
PivotTableClipMode Defines the cell content’s overflow mode. The available modes are
PivotTableContextMenuItem Defines the pivot table context menu items. They are
PivotTableGridLine Defines modes of GridLine, They are
PivotTablePrintMode Print mode options are
PivotTableSelectionType Defines types of Selection. They are:
Primary Allows you to set the primary view to be either table or chart.The available options are:
SelectionMode Defines mode of selection. They are
SubTotalsPosition Specifies different types of positions that will allow the row and column sub-totals to be displayed at the top or bottom of the header group in the pivot table.
The available options are:
ToolbarItems 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.
The available toolbar options are:
View It defines the view port as either table or chart or both table and chart. The available options are: