PivotOptions

PivotOptions class

Represents a complex type that specifies the pivot controls that appear on the chart

class PivotOptions;

Properties

PropertyTypeDescription
showExpandCollapseFieldButtonsbooleanGets or sets a value indicating whether to show expand/collapse field buttons
dropZoneFilterbooleanSpecifies whether a control for each PivotTable field on the PivotTable page axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
dropZoneCategoriesbooleanSpecifies whether a control for each PivotTable field on the PivotTable row axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
dropZoneDatabooleanSpecifies whether a control for each PivotTable field on the PivotTable data axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
dropZoneSeriesbooleanSpecifies whether a control for each PivotTable field on the PivotTable column axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
dropZonesVisiblebooleanSpecifies whether any pivot controls can appear on the pivot chart.

Methods

MethodDescription
getShowExpandCollapseFieldButtons()@deprecated. Please use the ‘showExpandCollapseFieldButtons’ property instead. Gets or sets a value indicating whether to show expand/collapse field buttons
setShowExpandCollapseFieldButtons(boolean)@deprecated. Please use the ‘showExpandCollapseFieldButtons’ property instead. Gets or sets a value indicating whether to show expand/collapse field buttons
getDropZoneFilter()@deprecated. Please use the ‘dropZoneFilter’ property instead. Specifies whether a control for each PivotTable field on the PivotTable page axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
setDropZoneFilter(boolean)@deprecated. Please use the ‘dropZoneFilter’ property instead. Specifies whether a control for each PivotTable field on the PivotTable page axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
getDropZoneCategories()@deprecated. Please use the ‘dropZoneCategories’ property instead. Specifies whether a control for each PivotTable field on the PivotTable row axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
setDropZoneCategories(boolean)@deprecated. Please use the ‘dropZoneCategories’ property instead. Specifies whether a control for each PivotTable field on the PivotTable row axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
getDropZoneData()@deprecated. Please use the ‘dropZoneData’ property instead. Specifies whether a control for each PivotTable field on the PivotTable data axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
setDropZoneData(boolean)@deprecated. Please use the ‘dropZoneData’ property instead. Specifies whether a control for each PivotTable field on the PivotTable data axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
getDropZoneSeries()@deprecated. Please use the ‘dropZoneSeries’ property instead. Specifies whether a control for each PivotTable field on the PivotTable column axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
setDropZoneSeries(boolean)@deprecated. Please use the ‘dropZoneSeries’ property instead. Specifies whether a control for each PivotTable field on the PivotTable column axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.
getDropZonesVisible()@deprecated. Please use the ‘dropZonesVisible’ property instead. Specifies whether any pivot controls can appear on the pivot chart.
setDropZonesVisible(boolean)@deprecated. Please use the ‘dropZonesVisible’ property instead. Specifies whether any pivot controls can appear on the pivot chart.
isNull()Checks whether the implementation object is null.

showExpandCollapseFieldButtons

Gets or sets a value indicating whether to show expand/collapse field buttons

showExpandCollapseFieldButtons : boolean;

dropZoneFilter

Specifies whether a control for each PivotTable field on the PivotTable page axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

dropZoneFilter : boolean;

dropZoneCategories

Specifies whether a control for each PivotTable field on the PivotTable row axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

dropZoneCategories : boolean;

dropZoneData

Specifies whether a control for each PivotTable field on the PivotTable data axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

dropZoneData : boolean;

dropZoneSeries

Specifies whether a control for each PivotTable field on the PivotTable column axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

dropZoneSeries : boolean;

dropZonesVisible

Specifies whether any pivot controls can appear on the pivot chart.

dropZonesVisible : boolean;

getShowExpandCollapseFieldButtons()

@deprecated. Please use the ‘showExpandCollapseFieldButtons’ property instead. Gets or sets a value indicating whether to show expand/collapse field buttons

getShowExpandCollapseFieldButtons() : boolean;

setShowExpandCollapseFieldButtons(boolean)

@deprecated. Please use the ‘showExpandCollapseFieldButtons’ property instead. Gets or sets a value indicating whether to show expand/collapse field buttons

setShowExpandCollapseFieldButtons(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDropZoneFilter()

@deprecated. Please use the ‘dropZoneFilter’ property instead. Specifies whether a control for each PivotTable field on the PivotTable page axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

getDropZoneFilter() : boolean;

setDropZoneFilter(boolean)

@deprecated. Please use the ‘dropZoneFilter’ property instead. Specifies whether a control for each PivotTable field on the PivotTable page axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

setDropZoneFilter(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDropZoneCategories()

@deprecated. Please use the ‘dropZoneCategories’ property instead. Specifies whether a control for each PivotTable field on the PivotTable row axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

getDropZoneCategories() : boolean;

setDropZoneCategories(boolean)

@deprecated. Please use the ‘dropZoneCategories’ property instead. Specifies whether a control for each PivotTable field on the PivotTable row axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

setDropZoneCategories(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDropZoneData()

@deprecated. Please use the ‘dropZoneData’ property instead. Specifies whether a control for each PivotTable field on the PivotTable data axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

getDropZoneData() : boolean;

setDropZoneData(boolean)

@deprecated. Please use the ‘dropZoneData’ property instead. Specifies whether a control for each PivotTable field on the PivotTable data axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

setDropZoneData(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDropZoneSeries()

@deprecated. Please use the ‘dropZoneSeries’ property instead. Specifies whether a control for each PivotTable field on the PivotTable column axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

getDropZoneSeries() : boolean;

setDropZoneSeries(boolean)

@deprecated. Please use the ‘dropZoneSeries’ property instead. Specifies whether a control for each PivotTable field on the PivotTable column axis of the source PivotTable appears on the chart when dropZonesVisible is set to true.

setDropZoneSeries(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getDropZonesVisible()

@deprecated. Please use the ‘dropZonesVisible’ property instead. Specifies whether any pivot controls can appear on the pivot chart.

getDropZonesVisible() : boolean;

setDropZonesVisible(boolean)

@deprecated. Please use the ‘dropZonesVisible’ property instead. Specifies whether any pivot controls can appear on the pivot chart.

setDropZonesVisible(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;