/sap-sac-scripting

OSE API: Chart & Visualization

Version: 2025.20 | SAC Release: Q2 2026 (2026.8) | Full API Docs: SAP Help Portal

Visualization classes: Chart, Table, GeoMap, R Visualization, Value Driver Tree, and associated axis/format/rank configuration classes.

Classes in This File

• Chart
• ChartAxisScale
• ChartAxisScaleEffective
• ChartDataChangeInsights
• ChartNumberFormat
• ChartQuickActionsVisibility
• ChartRankOptions
• GeoMap
• GeoMapLayer
• GeoMapQuickActionsVisibility
• RVisualization
• RVisualizationQuickActionsVisibility
• RVisualizationStatus
• Table
• TableAxis
• TableComments
• TableNumberFormat
• TableQuickActionsVisibility
• TableRankOptions
• ValueDriverTree

<a name="chart"></a>

Chart

extends Widget

Last Update

2025.6

Method Summary

Event Summary

Method Detail

Adds the dimension to the feed, at the specified position. If no position is specified, then the dimension is added at the end of the feed.

Parameters

Last Update

2019.7 |

Deprecated This method is deprecated, use addMember() instead. Adds the measure to the feed, at the specified position. If no position is specified, then the measure is added at the end of the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.Color and Feed.bubbleWidth.

Parameters

Last Update

2019.7

Deprecated

2021.6 |

Adds the structure member to the feed, at the specified position. If no position is specified, then the member is added at the end of the feed. Specify for the structure member either a measure member for a model with measures only or an account member for a model with accounts. When the structure member is a measure, it can be only added to Feed.ValueAxis, Feed.ValueAxis2, Feed.TooltipValueAxis, Feed.Color and Feed.bubbleWidth.

Parameters

Since

2021.6 |

Returns the dimensions of the feed.

Parameters

Returns

string[]

Since

2019.1

Last Update

2019.7 |

Returns effective scale's min/max of chart

Parameters

Returns

ChartAxisScaleEffective

Since

2022.7 |

Deprecated This method is deprecated, use getMembers() instead. Returns the measures of the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures.

Parameters

Returns

string[]

Since

2019.1

Last Update

2019.7

Deprecated

2021.6 |

Returns the structure members of the feed. The structure members are either measure members from a model with measures only or account members from a model with accounts.

Parameters

Returns

string[]

Since

2021.6 |

Opens Data Analyzer for the chart.

Parameters

Mobile Support

Not supported on mobile devices.

Since

2024.25 |

(Only available in optimized view mode) Creates a Top N filter to show a specified number of the lowest or highest ranked members. Note that it is not supported in charts with Structures.

Parameters

Since

2022.7 |

Removes the dimension from the feed.

Parameters

Last Update

2019.7 |

Deprecated This method is deprecated, use removeMember() instead. Removes the measure from the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.Color and Feed.bubbleWidth.

Parameters

Last Update

2019.7

Deprecated

2021.6 |

Removes the structure member from the feed. Specify for the structure member either a measure member for a model with measures only or an account member for a model with accounts. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.TooltipValueAxis, Feed.Color and Feed.bubbleWidth.

Parameters

Since

2021.6 |

Specifies the axis scale of chart.

Parameters

Since

2022.7 |

(Only available in optimized view mode) Enables or disables Break Grouping when sorting.

Parameters

Since

2022.7 |

Shows or hides the More Actions button and the context menu.

Parameters

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

Enables or disables the user interaction with the chart.

Parameters

Since

2020.20 |

Sets the model and replaces the old one.

Parameters

Returns

boolean

Since

2024.24

Last Update

2025.6 |

Shows or hides Quick Actions specified by the Quick Actions visibility.

Parameters

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

(Only available in optimized view mode) Sorts dimension members in a chart. You can specify the dimension that you want to sort and the sort order.

Parameters

Since

2022.7 |

(Only available in optimized view mode) Sorts measure values in a chart. You can specify the measure that you want to sort, the sort order, and, optionally, a secondary structure member.

Parameters

Since

2022.7 |

Event Detail

Type Library chart

C

<a name="chartaxisscale"></a>

ChartAxisScale

can be passed as a JSON object to method arguments

Since

2022.7

Property Summary

Property Detail

Type Library chart

C

<a name="chartaxisscaleeffective"></a>

ChartAxisScaleEffective

can be passed as a JSON object to method arguments

Since

2022.7

Property Summary

Property Detail

Type Library chart

C

<a name="chartdatachangeinsights"></a>

ChartDataChangeInsights

Since

2021.5

Method Summary

Method Detail

Sets the subscription level.

Parameters

Sets the subscription range settings.

Parameters

Type Library chart

C

<a name="chartnumberformat"></a>

ChartNumberFormat

Since

2020.11

Method Summary

Method Detail

Specifies the number of decimal places for specific or all measures. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example. Note: Not supported for universal account models.

Parameters

Specifies the scale format of the chart. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example.

Parameters

Specifies the scale unit of the labels of the feed. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example.

Parameters

Specifies how signs are displayed for specific or all measures. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example. Note: Not supported for universal account models.

Parameters

Type Library chart

C

<a name="chartquickactionsvisibility"></a>

ChartQuickActionsVisibility

Since

2021.11

Last Update

2024.24

Property Summary

Property Detail

Type Library chart

C

<a name="chartrankoptions"></a>

ChartRankOptions

can be passed as a JSON object to method arguments

A set of values to describe a ranking operation on a chart.

Since

2022.7

Property Summary

Property Detail

Type Library input-controls

C

<a name="geomap"></a>

GeoMap

extends Widget

Since

2019.13

Last Update

2021.11

Method Summary

Method Detail

Returns the layer. The layer is specified by an index.

Parameters

Returns

GeoMapLayer

Mobile Support

Not supported on mobile devices.

Since

2019.14 |

Shows or hides the More Actions button and the context menu.

Parameters

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

Shows or hides Quick Actions specified by the Quick Actions visibility.

Parameters

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

Type Library advanced-controls

C

<a name="geomaplayer"></a>

GeoMapLayer

Since

2019.13

Last Update

2023.7

Method Summary

Method Detail

Shows or hides the layer.

Parameters

Type Library advanced-controls

C

<a name="geomapquickactionsvisibility"></a>

GeoMapQuickActionsVisibility

Since

2021.11

Last Update

2023.2

Property Summary

Property Detail

Type Library datasource

C

<a name="rvisualization"></a>

RVisualization

extends Widget

Last Update

2021.11

Method Summary

| |
| --- |
| Name and Description |
| getDataFrame(dataframeName: string): RDataFrame<br>Returns the data frame. |
| getEnvironmentValues(): REnvironmentValues<br>Returns the environment values. |
| getInputParameters(): RInputParameters<br>Returns the input parameters. |
| getMessages(): string[]<br>Returns the console output. |
| getStatus(): RVisualizationStatus<br>Returns the execution status of the R code. |
| openInNewStory(): void<br>Creates a new story with this widget. |
| setContextMenuVisible(visible: boolean): void<br>Shows or hides the More Actions button and the context menu. |
| setHyperlink(type: UrlType, value?: string): void<br>Sets the hyperlink that the R widget will navigate to. |
| setQuickActionsVisibility(quickActionsVisibility: RVisualizationQuickActionsVisibility): void<br>Shows or hides Quick Actions specified by the Quick Actions visibility. |

| |
| --- |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |

Event Summary

| |
| --- |
| Name and Description |
| onResultChanged(): void<br>Called when the result set in the R visualization changes. |

Method Detail

| | | |
| --- | --- | --- |
| getDataFrame |
| getDataFrame(dataframeName: string): RDataFrame

Returns the data frame.

Parameters

| | | |
| --- | --- | --- |
| dataframeName: | string | |

Returns

RDataFrame

Mobile Support

Not supported on mobile devices. |

| |
| --- |
| getEnvironmentValues |
| getEnvironmentValues(): REnvironmentValues<br>Returns the environment values.<br>Returns<br>REnvironmentValues<br>Mobile Support<br>Not supported on mobile devices. |

| |
| --- |
| getInputParameters |
| getInputParameters(): RInputParameters<br>Returns the input parameters.<br>Returns<br>RInputParameters<br>Mobile Support<br>Not supported on mobile devices. |

| |
| --- |
| getMessages |
| getMessages(): string[]<br>Returns the console output.<br>Returns<br>string[]<br>Mobile Support<br>Not supported on mobile devices. |

| |
| --- |
| getStatus |
| getStatus(): RVisualizationStatus<br>Returns the execution status of the R code.<br>Returns<br>RVisualizationStatus<br>Mobile Support<br>Not supported on mobile devices. |

| |
| --- |
| openInNewStory |
| openInNewStory(): void<br>Creates a new story with this widget.<br>Mobile Support<br>Not supported on mobile devices.<br>Since<br>2021.3 |

| | | |
| --- | --- | --- |
| setContextMenuVisible |
| setContextMenuVisible(visible: boolean): void

Shows or hides the More Actions button and the context menu.

Parameters

| | | |
| --- | --- | --- |
| visible: | boolean | |

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

| | | |
| --- | --- | --- |
| setHyperlink |
| setHyperlink(type: UrlType, value?: string): void

Sets the hyperlink that the R widget will navigate to.

Parameters

| | | |
| --- | --- | --- |
| type: | UrlType | |
| valueOptional: | string | |

Mobile Support

Not supported on mobile devices.

Since

2019.21 |

| | | |
| --- | --- | --- |
| setQuickActionsVisibility |
| setQuickActionsVisibility(quickActionsVisibility: RVisualizationQuickActionsVisibility): void

Shows or hides Quick Actions specified by the Quick Actions visibility.

Parameters

| | | |
| --- | --- | --- |
| quickActionsVisibility: | RVisualizationQuickActionsVisibility | |

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

Event Detail

| |
| --- |
| onResultChanged |
| onResultChanged(): void<br>Called when the result set in the R visualization changes. |

Type Library
advanced-controls

C
\

<a name="rvisualizationquickactionsvisibility"></a>

RVisualizationQuickActionsVisibility

Since

2021.11

Last Update

2023.3

Property Summary

| |
| --- |
| Name and Description |
| static addComment: boolean<br>Comment |
| static fullscreen: boolean<br>Fullscreen |
| static rDetail: boolean<br>Applied to R Visualization |

Property Detail

| |
| --- |
| addComment |
| staticaddComment: boolean<br>Comment |

| |
| --- |
| fullscreen |
| staticfullscreen: boolean<br>Fullscreen |

| |
| --- |
| rDetail |
| staticrDetail: boolean<br>Applied to R Visualization<br>Since<br>2023.3 |

Type Library
advanced-controls

E
\

<a name="rvisualizationstatus"></a>

RVisualizationStatus

Property Summary

| |
| --- |
| Name and Description |
| static Error: RVisualizationStatus<br>The R request failed to execute the R script. |
| static Running: RVisualizationStatus<br>The R request is processed by the R server. |
| static Success: RVisualizationStatus<br>The R request was executed successfully. |

Property Detail

| |
| --- |
| Error |
| staticError: RVisualizationStatus<br>The R request failed to execute the R script. |

| |
| --- |
| Running |
| staticRunning: RVisualizationStatus<br>The R request is processed by the R server. |

| |
| --- |
| Success |
| staticSuccess: RVisualizationStatus<br>The R request was executed successfully. |

Type Library
standard

C
\

<a name="table"></a>

Table

extends Widget

Last Update

2025.13

Method Summary

| |
| --- |
| Name and Description |
| addDimensionToColumns(dimension: string | DimensionInfo JSON, position?: integer): void<br>Adds the dimension to the Columns axis, at the specified position. |
| addDimensionToRows(dimension: string | DimensionInfo JSON, position?: integer): void<br>Adds the dimension to the Rows axis, at the specified position. |
| closeNavigationPanel(): void<br>Closes the navigation panel. |
| getActiveDimensionProperties(dimension: string | DimensionInfo JSON): string[]<br>Returns the IDs of the currently active properties of the dimension. |
| getColumnCount(): integer<br>Returns the number of columns of the table. |
| getComments(): TableComments<br>Returns the comments of the data source. |
| getDataSource(): DataSource<br>Returns the data source of the table. |
| getDimensionsOnColumns(): string[]<br>Returns the dimensions on the Columns axis. |
| getDimensionsOnRows(): string[]<br>Returns the dimensions on the Rows axis. |
| getNumberFormat(): TableNumberFormat<br>Returns the table number format. |
| getPlanning(): Planning<br>Returns the Planning object of the table. |
| getRowCount(): integer<br>Returns the number of rows of the table. |
| getSelections(): Selection[]<br>Returns the selections of the table. |
| isCompactDisplayEnabled(axis: TableAxis): boolean<br>Returns whether the compact display is enabled for the axis. |
| isEnabled(): boolean<br>Returns whether the user interaction with the table is enabled. |
| isZeroSuppressionEnabled(axis: TableAxis): boolean<br>Returns whether zero suppression is enabled for the axis. |
| openDataAnalyzer(newTab?: boolean): void<br>Opens Data Analyzer for the table. |
| openInNewStory(): void<br>Creates a new story with this widget. |
| openNavigationPanel(navigationPanelOptions?: NavigationPanelOptions JSON): void<br>Opens the navigation panel. |
| openSelectModelDialog(): void<br>Opens the select model dialog. |
| rankBy(rankOptions: TableRankOptions JSON): void<br>Creates a Top N filter to show a specified number of the lowest or highest ranked values. |
| removeDimension(dimension: string | DimensionInfo JSON): void<br>Removes the dimension from whichever axis it is present on. |
| removeRanking(): void<br>Clears ranking and shows all the members with sort order retained, if applicable. |
| removeSorting(): void<br>Clears sorting and shows the members in default order. |
| setActiveDimensionProperties(dimension: string | DimensionInfo JSON, properties: string[] | DimensionPropertyInfo[]): void<br>Sets the active properties of the dimension. |
| setBreakGroupingEnabled(axis: TableAxis, enabled: boolean): void<br>Enables or disables Break Grouping when sorting. |
| setCompactDisplayEnabled(axis: TableAxis, enabled: boolean): void<br>Enables or disables the compact display for the axis. |
| setContextMenuVisible(visible: boolean): void<br>Shows or hides the More Actions button and the context menu. |
| setEnabled(enabled: boolean): void<br>Enables or disables the user interaction with the table. |
| setModel(modelId: string): boolean<br>Sets the model and replaces the old one. |
| setQuickActionsVisibility(quickActionsVisibility: TableQuickActionsVisibility): void<br>Shows or hides Quick Actions specified by the Quick Actions visibility. |
| setZeroSuppressionEnabled(axis: TableAxis, enabled: boolean): void<br>Enables or disables zero suppression for the axis. |
| sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void<br>Sorts dimension members in a table. |
| sortByValue(relatedDimensions: Selection JSON, sortOrder: SortOrder, direction: Direction): void<br>Sorts measure values in a table. |

| |
| --- |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |

Event Summary

| |
| --- |
| Name and Description |
| onAfterDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext JSON): void<br>Called when the table data is changed via manual data entry, copy and paste, or submitData() API. |
| onResultChanged(): void<br>Called when the result set displayed by the table changes. |
| onSelect(): void<br>Called when the user makes a selection within the table. |

Method Detail

| | | |
| --- | --- | --- |
| addDimensionToColumns |
| addDimensionToColumns(dimension: string | DimensionInfo JSON, position?: integer): void

Adds the dimension to the Columns axis, at the specified position. If no position is specified, then the dimension is added as the last dimension of the Columns axis.

Parameters

| | | |
| --- | --- | --- |
| dimension: | string | DimensionInfo JSON | |
| positionOptional: | integer | |

Last Update

2019.7 |

| | | |
| --- | --- | --- |
| addDimensionToRows |
| addDimensionToRows(dimension: string | DimensionInfo JSON, position?: integer): void

Adds the dimension to the Rows axis, at the specified position. If no position is specified, then the dimension is added as the last dimension of the Rows axis.

Parameters

| | | |
| --- | --- | --- |
| dimension: | string | DimensionInfo JSON | |
| positionOptional: | integer | |

Last Update

2019.7 |

| |
| --- |
| closeNavigationPanel |
| closeNavigationPanel(): void<br>Closes the navigation panel.<br>Since<br>2020.13 |

| | | |
| --- | --- | --- |
| getActiveDimensionProperties |
| getActiveDimensionProperties(dimension: string | DimensionInfo JSON): string[]

Returns the IDs of the currently active properties of the dimension.

Parameters

| | | |
| --- | --- | --- |
| dimension: | string | DimensionInfo JSON | |

Returns

string[]

Since

2020.7 |

| |
| --- |
| getColumnCount |
| getColumnCount(): integer<br>Returns the number of columns of the table.<br>Returns<br>integer<br>Since<br>2019.20<br>Last Update<br>2020.6 |

| |
| --- |
| getComments |
| getComments(): TableComments<br>Returns the comments of the data source. Note: Currently, this operation is only supported for data sources associated with tables. If the data source isn't associated with a table, then undefined is returned.<br>Returns<br>TableComments<br>Since<br>2022.20 |

| |
| --- |
| getDataSource |
| getDataSource(): DataSource<br>Returns the data source of the table.<br>Returns<br>DataSource |

| |
| --- |
| getDimensionsOnColumns |
| getDimensionsOnColumns(): string[]<br>Returns the dimensions on the Columns axis.<br>Returns<br>string[]<br>Since<br>2019.1<br>Last Update<br>2019.7 |

| |
| --- |
| getDimensionsOnRows |
| getDimensionsOnRows(): string[]<br>Returns the dimensions on the Rows axis.<br>Returns<br>string[]<br>Since<br>2019.1<br>Last Update<br>2019.7 |

| |
| --- |
| getNumberFormat |
| getNumberFormat(): TableNumberFormat<br>Returns the table number format.<br>Returns<br>TableNumberFormat<br>Since<br>2020.11 |

| |
| --- |
| getPlanning |
| getPlanning(): Planning<br>Returns the Planning object of the table. If the data source associated with the table doesn't support planning, then undefined is returned.<br>Returns<br>Planning<br>Since<br>2019.3 |

| |
| --- |
| getRowCount |
| getRowCount(): integer<br>Returns the number of rows of the table.<br>Returns<br>integer<br>Since<br>2019.20<br>Last Update<br>2020.6 |

| |
| --- |
| getSelections |
| getSelections(): Selection[]<br>Returns the selections of the table. You can use elements of the returned array with DataSource.getData() to get the value of a cell. See also the documentation of Selection.<br>Returns<br>Selection[]<br>Since<br>2019.7 |

| | | |
| --- | --- | --- |
| isCompactDisplayEnabled |
| isCompactDisplayEnabled(axis: TableAxis): boolean

Returns whether the compact display is enabled for the axis. Note: Compact display is only supported for SAP BW models.

Parameters

| | | |
| --- | --- | --- |
| axis: | TableAxis | |

Returns

boolean

Since

2020.7 |

| |
| --- |
| isEnabled |
| isEnabled(): boolean<br>Returns whether the user interaction with the table is enabled.<br>Returns<br>boolean<br>Since<br>2020.20 |

| | | |
| --- | --- | --- |
| isZeroSuppressionEnabled |
| isZeroSuppressionEnabled(axis: TableAxis): boolean

Returns whether zero suppression is enabled for the axis. Note: Zero suppression is only supported for SAP BW models.

Parameters

| | | |
| --- | --- | --- |
| axis: | TableAxis | |

Returns

boolean

Since

2020.7 |

| | | |
| --- | --- | --- |
| openDataAnalyzer |
| openDataAnalyzer(newTab?: boolean): void

Opens Data Analyzer for the table.

Parameters

| | | |
| --- | --- | --- |
| newTabOptional: | boolean | |

Mobile Support

Not supported on mobile devices.

Since

2024.25 |

| |
| --- |
| openInNewStory |
| openInNewStory(): void<br>Creates a new story with this widget.<br>Mobile Support<br>Not supported on mobile devices.<br>Since<br>2021.3 |

| | | |
| --- | --- | --- |
| openNavigationPanel |
| openNavigationPanel(navigationPanelOptions?: NavigationPanelOptions JSON): void

Opens the navigation panel. Note: This operation is ignored if the table is contained in a mobile application or a popup.

Parameters

| | | |
| --- | --- | --- |
| navigationPanelOptionsOptional: | NavigationPanelOptions JSON | |

Since

2020.13 |

| |
| --- |
| openSelectModelDialog |
| openSelectModelDialog(): void<br>Opens the select model dialog. Selecting a model replaces the model of the table.<br>Since<br>2020.20 |

| | | |
| --- | --- | --- |
| rankBy |
| rankBy(rankOptions: TableRankOptions JSON): void

Creates a Top N filter to show a specified number of the lowest or highest ranked values.

Parameters

| | | |
| --- | --- | --- |
| rankOptions: | TableRankOptions JSON | |

Since

2021.19 |

| | | |
| --- | --- | --- |
| removeDimension |
| removeDimension(dimension: string | DimensionInfo JSON): void

Removes the dimension from whichever axis it is present on. If the dimension is neither on the Rows nor Columns axis, then this operation is ignored.

Parameters

| | | |
| --- | --- | --- |
| dimension: | string | DimensionInfo JSON | |

Last Update

2019.7 |

| |
| --- |
| removeRanking |
| removeRanking(): void<br>Clears ranking and shows all the members with sort order retained, if applicable.<br>Since<br>2021.19 |

| |
| --- |
| removeSorting |
| removeSorting(): void<br>Clears sorting and shows the members in default order.<br>Since<br>2021.19 |

| | | |
| --- | --- | --- |
| setActiveDimensionProperties |
| setActiveDimensionProperties(dimension: string | DimensionInfo JSON, properties: string[] | DimensionPropertyInfo[]): void

Sets the active properties of the dimension.

Parameters

| | | |
| --- | --- | --- |
| dimension: | string | DimensionInfo JSON | |
| properties: | string[] | DimensionPropertyInfo[] | |

Since

2020.7 |

| | | |
| --- | --- | --- |
| setBreakGroupingEnabled |
| setBreakGroupingEnabled(axis: TableAxis, enabled: boolean): void

Enables or disables Break Grouping when sorting.

Parameters

| | | |
| --- | --- | --- |
| axis: | TableAxis | |
| enabled: | boolean | |

Since

2021.19 |

| | | |
| --- | --- | --- |
| setCompactDisplayEnabled |
| setCompactDisplayEnabled(axis: TableAxis, enabled: boolean): void

Enables or disables the compact display for the axis. Note: Compact display is only supported for SAP BW models.

Parameters

| | | |
| --- | --- | --- |
| axis: | TableAxis | |
| enabled: | boolean | |

Since

2020.7 |

| | | |
| --- | --- | --- |
| setContextMenuVisible |
| setContextMenuVisible(visible: boolean): void

Shows or hides the More Actions button and the context menu.

Parameters

| | | |
| --- | --- | --- |
| visible: | boolean | |

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

| | | |
| --- | --- | --- |
| setEnabled |
| setEnabled(enabled: boolean): void

Enables or disables the user interaction with the table.

Parameters

| | | |
| --- | --- | --- |
| enabled: | boolean | |

Since

2020.20 |

| | | |
| --- | --- | --- |
| setModel |
| setModel(modelId: string): boolean

Sets the model and replaces the old one.

Parameters

| | | |
| --- | --- | --- |
| modelId: | string | |

Returns

boolean

Since

2020.20 |

| | | |
| --- | --- | --- |
| setQuickActionsVisibility |
| setQuickActionsVisibility(quickActionsVisibility: TableQuickActionsVisibility): void

Shows or hides Quick Actions specified by the Quick Actions visibility.

Parameters

| | | |
| --- | --- | --- |
| quickActionsVisibility: | TableQuickActionsVisibility | |

Mobile Support

Not supported on mobile devices.

Since

2021.11 |

| | | |
| --- | --- | --- |
| setZeroSuppressionEnabled |
| setZeroSuppressionEnabled(axis: TableAxis, enabled: boolean): void

Enables or disables zero suppression for the axis. Note: Zero suppression is only supported for SAP BW models.

Parameters

| | | |
| --- | --- | --- |
| axis: | TableAxis | |
| enabled: | boolean | |

Since

2020.7 |

| | | |
| --- | --- | --- |
| sortByMember |
| sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void

Sorts dimension members in a table. You can specify the dimension that you want to sort and the sort order. Note: Creating a custom order for members in a table isn't supported.

Parameters

| | | |
| --- | --- | --- |
| dimension: | string | DimensionInfo JSON | |
| sortOrder: | SortOrder | |

Since

2021.19 |

| | | |
| --- | --- | --- |
| sortByValue |
| sortByValue(relatedDimensions: Selection JSON, sortOrder: SortOrder, direction: Direction): void

Sorts measure values in a table. You can specify the related dimensions, the sort order, and the sort direction in the table.

Parameters

| | | |
| --- | --- | --- |
| relatedDimensions: | Selection JSON | |
| sortOrder: | SortOrder | |
| direction: | Direction | |

Since

2021.19 |

Event Detail

| | | |
| --- | --- | --- |
| onAfterDataEntryProcess |
| onAfterDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext JSON): void

Called when the table data is changed via manual data entry, copy and paste, or submitData() API.

Parameters

| | | |
| --- | --- | --- |
| cells: | IChangedCell[] | |
| effectiveContext: | SelectionContext JSON | |

Since

2024.25 |

| |
| --- |
| onResultChanged |
| onResultChanged(): void<br>Called when the result set displayed by the table changes.<br>Since<br>2025.13 |

| |
| --- |
| onSelect |
| onSelect(): void<br>Called when the user makes a selection within the table.<br>Since<br>2025.13 |

Type Library
table2

E
\

<a name="tableaxis"></a>

TableAxis

Since

2020.7

Property Summary

| |
| --- |
| Name and Description |
| static Columns: TableAxis<br>Columns axis of a table |
| static Rows: TableAxis<br>Rows axis of a table |

Property Detail

| |
| --- |
| Columns |
| staticColumns: TableAxis<br>Columns axis of a table |

| |
| --- |
| Rows |
| staticRows: TableAxis<br>Rows axis of a table |

Type Library
table2

C
\

<a name="tablecomments"></a>

TableComments

Since

2022.20

Last Update

2023.6

Method Summary

| |
| --- |
| Name and Description |
| addComment(selection: Selection JSON, value: string): CommentInfo<br>Adds a comment to data cells. |
| addComments(selection: Selection JSON, value: string[]): CommentInfo[]<br>Adds multiple comments to data cells. |
| getAllComments(selection: Selection JSON): CommentInfo[]<br>Returns all comments of data cells. |
| getComment(commentId: string): CommentInfo<br>Returns a comment. |
| getDimensionComment(selection: Selection JSON): CommentInfo<br>Returns the dimension comment of a data cell. |
| removeAllComments(selection: Selection JSON): boolean<br>Removes all comments on data cells. |
| removeComment(commentId: string): boolean<br>Removes a comment. |
| removeDimensionComment(selection: Selection JSON): void<br>Removes the dimension comment of a data cell. |
| setCommentLiked(commentId: string, isLiked: boolean): boolean<br>Switches the Like flag of a comment on or off. |
| setDimensionComment(selection: Selection JSON, value: string): void<br>Sets the dimension comment of a data cell. |
| updateComment(commentId: string, value: string): CommentInfo<br>Updates a comment. |

Method Detail

| | | |
| --- | --- | --- |
| addComment |
| addComment(selection: Selection JSON, value: string): CommentInfo

Adds a comment to data cells. The data cells are specified by the selection. If this operation was successful, then the comment is returned, and undefined if it wasn't.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |
| value: | string | |

Returns

CommentInfo

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| addComments |
| addComments(selection: Selection JSON, value: string[]): CommentInfo[]

Adds multiple comments to data cells. The data cells are specified by the selection. If this operation was successful, then the comments are returned, and undefined if it wasn't. Note: Not supported for SAP BW live data models.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |
| value: | string[] | |

Returns

CommentInfo[]

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| getAllComments |
| getAllComments(selection: Selection JSON): CommentInfo[]

Returns all comments of data cells. The data cells are specified by the selection. If no comments exist, then an empty array is returned. Note: For SAP BW live data models, returns the only comment of the latest version.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |

Returns

CommentInfo[]

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| getComment |
| getComment(commentId: string): CommentInfo

Returns a comment. The comment is specified by the comment ID. If the comment ID is invalid, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| commentId: | string | |

Returns

CommentInfo

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| getDimensionComment |
| getDimensionComment(selection: Selection JSON): CommentInfo

Returns the dimension comment of a data cell. The data cell is specified by the selection. If no dimension comment exists, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |

Returns

CommentInfo

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| removeAllComments |
| removeAllComments(selection: Selection JSON): boolean

Removes all comments on data cells. The data cells are specified by the selection. If this operation was successful, then true is returned, and false if it wasn't. Note: For SAP BW live data models, removes the only comment along with all history versions.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |

Returns

boolean

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| removeComment |
| removeComment(commentId: string): boolean

Removes a comment. The comment is specified by the comment ID. If this operation was successful, then true is returned, and false if it wasn't.

Parameters

| | | |
| --- | --- | --- |
| commentId: | string | |

Returns

boolean

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| removeDimensionComment |
| removeDimensionComment(selection: Selection JSON): void

Removes the dimension comment of a data cell. The data cell is specified by the selection.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| setCommentLiked |
| setCommentLiked(commentId: string, isLiked: boolean): boolean

Switches the Like flag of a comment on or off. The comment is specified by the comment ID. If the comment ID is valid, then true is returned, and false if it isn't. Note: Not supported for SAP BW live data models.

Parameters

| | | |
| --- | --- | --- |
| commentId: | string | |
| isLiked: | boolean | |

Returns

boolean

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| setDimensionComment |
| setDimensionComment(selection: Selection JSON, value: string): void

Sets the dimension comment of a data cell. The data cell is specified by the selection.

Parameters

| | | |
| --- | --- | --- |
| selection: | Selection JSON | |
| value: | string | |

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| updateComment |
| updateComment(commentId: string, value: string): CommentInfo

Updates a comment. The comment is specified by the comment ID. Returns the latest comment if this operation is successful, and undefined if it fails. Note: Only supported for SAP BW live data models.

Parameters

| | | |
| --- | --- | --- |
| commentId: | string | |
| value: | string | |

Returns

CommentInfo

Mobile Support

Not supported on mobile devices.

Since

2023.6 |

Type Library
table2

C
\

<a name="tablenumberformat"></a>

TableNumberFormat

Since

2020.11

Method Summary

| |
| --- |
| Name and Description |
| setDecimalPlaces(decimalPlaces: integer, measures?: string[]): void<br>Specifies the number of decimal places for specific or all measures. |
| setDisplayUnit(displayUnit: NumberFormatDisplayUnit): void<br>Specifies where the units or currencies of the measures are displayed. |
| setScaleFormat(scaleFormat: NumberFormatScaleFormat): void<br>Specifies the scale format of the table. |
| setScaleUnit(scaleUnit: NumberFormatScaleUnit, measures?: string[]): void<br>Specifies the scale unit for specific or all measures. |
| setSignDisplay(signDisplay: NumberFormatSignDisplay, measures?: string[]): void<br>Specifies how signs are displayed for specific or all measures. |

Method Detail

| | | |
| --- | --- | --- |
| setDecimalPlaces |
| setDecimalPlaces(decimalPlaces: integer, measures?: string[]): void

Specifies the number of decimal places for specific or all measures.

Parameters

| | | |
| --- | --- | --- |
| decimalPlaces: | integer | |
| measuresOptional: | string[] | | |

| | | |
| --- | --- | --- |
| setDisplayUnit |
| setDisplayUnit(displayUnit: NumberFormatDisplayUnit): void

Specifies where the units or currencies of the measures are displayed.

Parameters

| | | |
| --- | --- | --- |
| displayUnit: | NumberFormatDisplayUnit | | |

| | | |
| --- | --- | --- |
| setScaleFormat |
| setScaleFormat(scaleFormat: NumberFormatScaleFormat): void

Specifies the scale format of the table.

Parameters

| | | |
| --- | --- | --- |
| scaleFormat: | NumberFormatScaleFormat | | |

| | | |
| --- | --- | --- |
| setScaleUnit |
| setScaleUnit(scaleUnit: NumberFormatScaleUnit, measures?: string[]): void

Specifies the scale unit for specific or all measures.

Parameters

| | | |
| --- | --- | --- |
| scaleUnit: | NumberFormatScaleUnit | |
| measuresOptional: | string[] | | |

| | | |
| --- | --- | --- |
| setSignDisplay |
| setSignDisplay(signDisplay: NumberFormatSignDisplay, measures?: string[]): void

Specifies how signs are displayed for specific or all measures.

Parameters

| | | |
| --- | --- | --- |
| signDisplay: | NumberFormatSignDisplay | |
| measuresOptional: | string[] | | |

Type Library
table2

C
\

<a name="tablequickactionsvisibility"></a>

TableQuickActionsVisibility

Since

2021.11

Last Update

2023.3

Property Summary

| |
| --- |
| Name and Description |
| static addClientCalculation: boolean<br>Add Calculation |
| static addClientRowColumn: boolean<br>Add/Remove Row/Column |
| static addComment: boolean<br>Comment |
| static addMember: boolean<br>Add Member |
| static conditions: boolean<br>Conditions |
| static dataLocks: boolean<br>Data Locks |
| static displayOptions: boolean<br>Display Options |
| static distributeValue: boolean<br>Distribute Value |
| static drill: boolean<br>Drill |
| static exporting: boolean<br>Export |
| static filter: boolean<br>Filter/Exclude |
| static freeze: boolean<br>Freeze |
| static fullscreen: boolean<br>Fullscreen |
| static gotoHyperLink: boolean<br>Go To HyperLink |
| static lockCell: boolean<br>Lock Cell |
| static massDataEntry: boolean<br>Mass Data Entry |
| static publish: boolean<br>Publish |
| static rank: boolean<br>Ranking |
| static removeCellReference: boolean<br>Remove Reference |
| static revert: boolean<br>Revert |
| static selectConversions: boolean<br>Select Conversions |
| static selectHierarchy: boolean<br>Select Hierarchy |
| static showHide: boolean<br>Show/Hide |
| static sort: boolean<br>Sorting |
| static swapAxis: boolean<br>Swap Axis |
| static tableDetail: boolean<br>Applied to Table |
| static undoRedoDataChange: boolean<br>Undo/Redo Data Entry |
| static valueLockManagement: boolean<br>Value Lock |
| static version: boolean<br>Version |
| static versionHistory: boolean<br>History |

Property Detail

| |
| --- |
| addClientCalculation |
| staticaddClientCalculation: boolean<br>Add Calculation |

| |
| --- |
| addClientRowColumn |
| staticaddClientRowColumn: boolean<br>Add/Remove Row/Column |

| |
| --- |
| addComment |
| staticaddComment: boolean<br>Comment |

| |
| --- |
| addMember |
| staticaddMember: boolean<br>Add Member |

| |
| --- |
| conditions |
| staticconditions: boolean<br>Conditions<br>Since<br>2021.18 |

| |
| --- |
| dataLocks |
| staticdataLocks: boolean<br>Data Locks |

| |
| --- |
| displayOptions |
| staticdisplayOptions: boolean<br>Display Options |

| |
| --- |
| distributeValue |
| staticdistributeValue: boolean<br>Distribute Value |

| |
| --- |
| drill |
| staticdrill: boolean<br>Drill |

| |
| --- |
| exporting |
| staticexporting: boolean<br>Export |

| |
| --- |
| filter |
| staticfilter: boolean<br>Filter/Exclude |

| |
| --- |
| freeze |
| staticfreeze: boolean<br>Freeze |

| |
| --- |
| fullscreen |
| staticfullscreen: boolean<br>Fullscreen |

| |
| --- |
| gotoHyperLink |
| staticgotoHyperLink: boolean<br>Go To HyperLink<br>Since<br>2023.3 |

| |
| --- |
| lockCell |
| staticlockCell: boolean<br>Lock Cell |

| |
| --- |
| massDataEntry |
| staticmassDataEntry: boolean<br>Mass Data Entry |

| |
| --- |
| publish |
| staticpublish: boolean<br>Publish |

| |
| --- |
| rank |
| staticrank: boolean<br>Ranking |

| |
| --- |
| removeCellReference |
| staticremoveCellReference: boolean<br>Remove Reference<br>Since<br>2023.3 |

| |
| --- |
| revert |
| staticrevert: boolean<br>Revert |

| |
| --- |
| selectConversions |
| staticselectConversions: boolean<br>Select Conversions |

| |
| --- |
| selectHierarchy |
| staticselectHierarchy: boolean<br>Select Hierarchy |

| |
| --- |
| showHide |
| staticshowHide: boolean<br>Show/Hide |

| |
| --- |
| sort |
| staticsort: boolean<br>Sorting |

| |
| --- |
| swapAxis |
| staticswapAxis: boolean<br>Swap Axis |

| |
| --- |
| tableDetail |
| statictableDetail: boolean<br>Applied to Table<br>Since<br>2023.3 |

| |
| --- |
| undoRedoDataChange |
| staticundoRedoDataChange: boolean<br>Undo/Redo Data Entry |

| |
| --- |
| valueLockManagement |
| staticvalueLockManagement: boolean<br>Value Lock |

| |
| --- |
| version |
| staticversion: boolean<br>Version |

| |
| --- |
| versionHistory |
| staticversionHistory: boolean<br>History |

Type Library
table2

C
\

<a name="tablerankoptions"></a>

TableRankOptions

can be passed as a JSON object to method arguments

A set of values to describe a ranking operation on a table.

Since

2021.19

Property Summary

| |
| --- |
| Name and Description |
| applyToEachDimension: boolean<br>Shows the top values for each dimension instead of for the group of dimensions. |
| direction: Direction<br>Direction of sorting in the table. |
| rankOrder: RankOrder<br>Order used for ranking. |
| relatedDimensions: Selection JSON<br>Related dimension used for ranking |
| value: integer<br>Number of values to include in the ranking filter |

Property Detail

| |
| --- |
| applyToEachDimension |
| applyToEachDimension: boolean<br>Shows the top values for each dimension instead of for the group of dimensions. If you have a hierarchical measure in your table, then this option is enabled and can't be disabled. |

| |
| --- |
| direction |
| direction: Direction<br>Direction of sorting in the table. The values Direction.Vertical or Direction.Horizontal correspond to a vertical or horizontal sort direction in the table, respectively. |

| |
| --- |
| rankOrder |
| rankOrder: RankOrder<br>Order used for ranking. The values RankOrder.Top or RankOrder.Bottom, for example, correspond to a descending or an ascending order of ranking, respectively. |

| |
| --- |
| relatedDimensions |
| relatedDimensions: Selection JSON<br>Related dimension used for ranking |

| |
| --- |
| value |
| value: integer<br>Number of values to include in the ranking filter |

Type Library
containers

C
\

<a name="valuedrivertree"></a>

ValueDriverTree

extends Widget

Since

2020.16

Method Summary

| |
| --- |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |

Type Library
datasource

C
\

ChartVariance

Since: 2025.18

Accessed via Chart_1.getChartVariance() on a chart widget instance. Methods for managing chart variance display — add, get, update, and remove variances on charts.

Methods:

var variance = Chart_1.getChartVariance().addVariance();
variance.setSourceMeasure("Actuals");
variance.setTargetMeasure("Budget");
variance.setShowDifferenceType([VarianceDifferenceType.Number, VarianceDifferenceType.Percentage]);
variance.setShowVariance(VarianceShowType.Integrated);

Variance

Since: 2025.18

Represents a single variance configuration on a chart. Provides methods to configure source/target measures, versions, time intervals, display settings, and formatting.

Methods:

var variances = Chart_1.getChartVariance().getVariances();
variances[0].setShowDifferenceType([VarianceDifferenceType.Number]);
variances[0].setShowVariance(VarianceShowType.Bar);
variances[0].setSourceTimeInterval("Date", VarianceTime.PreviousYear);
Chart_1.getChartVariance().updateVariance(variances[0]);

VarianceDifferenceType

Since: 2025.18 | Enum

Specifies how to display variance differences.

variance.setShowDifferenceType([VarianceDifferenceType.Number, VarianceDifferenceType.Percentage]);

VarianceShowType

Since: 2025.18 | Enum

Specifies the visualization type for chart variance.

variance.setShowVariance(VarianceShowType.Integrated);

VarianceTime

Since: 2025.18 | Enum

Specifies the time comparison period for variance calculations.

variance.setSourceTimeInterval("Date", VarianceTime.PreviousYear);
variance.setTargetTimeInterval("Date", VarianceTime.CurrentTimeInterval);

VarianceAllMeasuresInUse

Since: 2025.18 | Enum

Specifies whether variance applies to all measures in use on the chart. Used as a parameter in variance configuration when all active measures should be included in variance calculations.

Related: ChartVariance, Variance, VarianceDifferenceType, VarianceShowType, VarianceTime

DataLabelType

Type Library: datasource | Since: 2026.4 | Enum

Specifies how data labels are displayed on charts.

Chart_1.setDataLabelType(DataLabelType.Both);