OSE API: Types & Enums

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

Enum types and type definitions: export scopes, feed types, number formats, layout units, member access modes, planning conflict types, variable values, and more.

Classes in This File

BackendCondition
CheckboxGroup
Commenting
Composite
CurrentDateTime
DateFormat
DeviceOrientation
Direction
ExportCsv
ExportExcel
ExportPdf
ExportPptx
ExportScope
Feed
FileUploadTrigger
FiscalTime
FiscalTimeGranularity
FlowPanel
Forecast
ForecastType
IChangedCell
InputFieldStyle
Layout
LayoutUnit
LayoutValue
LinkedAnalysis
MemberAccessMode
MemberDisplayMode
MultiAction
MultiActionBackgroundExecutionResponse
MultiActionBackgroundExecutionResponseStatus
MultiActionDatetimeParameterValue
MultiActionExecutionResponse
MultiActionExecutionResponseStatus
MultiActionMemberParameterValue
MultiActionNumberParameterValue
MultiActionParameterValue
MultiActionParameterValueType
MultiActionStringParameterValue
MultiActionTrigger
MultipleVariableValue
NumberFormat
NumberFormatDisplayUnit
NumberFormatScaleFormat
NumberFormatScaleUnit
NumberFormatSignDisplay
PageDateLocation
PageNumberLocation
PageOrientation
PageSize
PauseMode
PostMessageReceiver
PrivatePublishConflict
PublicPublishConflict
Range
RangeVariableValue
RankOrder
REnvironmentValues
ResultSet
RInputParameters
ShapeStyle
SingleVariableValue
SmartGrouping
StringUtils
TabStrip
TextStyle
UrlType
UserType
VariableValue
VariableValueType

BackendCondition

Since

2024.20

Method Summary


Name and Description
getProperties(): BackendConditionProperties<br>Returns properties of the BEx condition.
isSelected(): boolean<br>Returns whether the BEx condition is applied to the current chart.
setSelected(selected: boolean): void<br>Selects or deselects the BEx condition, and applies to the current chart.

Method Detail


getProperties
getProperties(): BackendConditionProperties<br>Returns properties of the BEx condition.<br>Returns<br>BackendConditionProperties


isSelected
isSelected(): boolean<br>Returns whether the BEx condition is applied to the current chart.<br>Returns<br>boolean


setSelected
setSelected(selected: boolean): void

Selects or deselects the BEx condition, and applies to the current chart. If the condition is not applicable, the chart isn't affected.

Parameters


selected:	boolean

CheckboxGroup

extends Widget

Method Summary


Name and Description
addItem(key: string, text?: string): void<br>Adds a new item to the checkbox group.
getSelectedKeys(): string[]<br>Returns the keys of the selected items in the checkbox group.
getSelectedTexts(): string[]<br>Returns the texts of the selected items in the checkbox group.
removeAllItems(): void<br>Removes all items from the checkbox group.
removeItem(key: string): void<br>Removes an item from the checkbox group.
setSelectedKeys(keys: string[]): void<br>Selects items in the checkbox group.


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

Event Summary


Name and Description
onSelect(): void<br>Called when the user changes the selection of a checkbox in the checkbox group.

Method Detail


addItem
addItem(key: string, text?: string): void

Adds a new item to the checkbox group. The item is specified by a key and an optional text. If the key or the text already exists, then this operation is ignored.

Parameters


key:	string
textOptional:	string


getSelectedKeys
getSelectedKeys(): string[]<br>Returns the keys of the selected items in the checkbox group. If no items are selected, then an empty array is returned.<br>Returns<br>string[]


getSelectedTexts
getSelectedTexts(): string[]<br>Returns the texts of the selected items in the checkbox group. If no items are selected, then an empty array is returned.<br>Returns<br>string[]


removeAllItems
removeAllItems(): void<br>Removes all items from the checkbox group.


removeItem
removeItem(key: string): void

Removes an item from the checkbox group. The item is specified by its key. If the key isn't present, then this operation is ignored.

Parameters


key:	string


setSelectedKeys
setSelectedKeys(keys: string[]): void

Selects items in the checkbox group. The items are specified by their keys. If the keys aren't present, then nothing is selected.

Parameters


keys:	string[]

Event Detail


onSelect
onSelect(): void<br>Called when the user changes the selection of a checkbox in the checkbox group.

Type Library datasource

Commenting

extends Widget

Since

2021.1

Last Update

2021.5

Method Summary


Name and Description
getCommentingDataSource(): CommentingDataSource<br>Returns the data source of the commenting widget.


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

Method Detail


getCommentingDataSource
getCommentingDataSource(): CommentingDataSource<br>Returns the data source of the commenting widget.<br>Returns<br>CommentingDataSource<br>Since<br>2021.5

Type Library visualization-controls

Composite

extends Widget

Since

2023.19

Last Update

2023.21

Method Summary


Name and Description
static fireEvent(eventName: string): Event<br>Fires composite interface event.
hideBusyIndicator(): void<br>Hides the busy indicator.
showBusyIndicator(text?: string): void<br>Shows the busy indicator.


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

Method Detail


fireEvent
staticfireEvent(eventName: string): Event

Fires composite interface event.

Parameters


eventName:	string

Returns

Event

Since

2023.21 |


hideBusyIndicator
hideBusyIndicator(): void<br>Hides the busy indicator.<br>Since<br>2023.21


showBusyIndicator
showBusyIndicator(text?: string): void

Shows the busy indicator.

Parameters


textOptional:	string

Since

2023.21 |

Type Library standard

console

Last Update

2019.12

Method Summary


Name and Description
static log(arg: any): void<br>Outputs a message to the Web Console.

Method Detail


log
staticlog(arg: any): void

Outputs a message to the Web Console.

Parameters


arg:	any

Last Update

2019.12 |

Type Library standard

CurrentDateTime

Since

2023.13

Method Summary


Name and Description
static createCalendarDateTime(calendartime: CalendarTime JSON): CurrentDateTime<br>Creates a calendar date/time with the specified calendarTime.
static createFiscalDateTime(modelId: string, dimension: string \| DimensionInfo JSON, fiscalTime: FiscalTime JSON): CurrentDateTime<br>Creates a fiscal date/time with the specified modelId, time-based dimension and fiscalTime.

Method Detail


createCalendarDateTime
staticcreateCalendarDateTime(calendartime: CalendarTime JSON): CurrentDateTime

Creates a calendar date/time with the specified calendarTime. See also the documentation of CalendarTime.

Parameters


calendartime:	CalendarTime JSON

Returns

CurrentDateTime |


createFiscalDateTime
staticcreateFiscalDateTime(modelId: string, dimension: string \| DimensionInfo JSON, fiscalTime: FiscalTime JSON): CurrentDateTime

Creates a fiscal date/time with the specified modelId, time-based dimension and fiscalTime. See also the documentation of FiscalTime.

Parameters


modelId:	string
dimension:	string \| DimensionInfo JSON
fiscalTime:	FiscalTime JSON

Returns

CurrentDateTime |

Type Library data-action

DateFormat

Since

2019.5

Last Update

2020.2

Method Summary


Name and Description
static format(date: Date, pattern?: string): string<br>Returns a string representation of the date.

Method Detail


format
staticformat(date: Date, pattern?: string): string

Returns a string representation of the date. Optionally, you can format the date by supplying a pattern in the Unicode Locale Data Markup Language (LDML) format. For example, with the English language set in the Profile Settings, a date representing March, 5, 2018 is formatted by the pattern "MMM dd, yyyy" as "Mar 05, 2018". Other common patterns include "yyyy/MM/dd" (resulting in "2018/03/05"), "yyyy-MM-dd" ("2018-03-05"), "yy/M/d" ("18/3/5"), "y/M/d" ("2018/3/5"), "MMM dd" ("Mar 05"), and "yyyy.QQQ" ("2018.Q1"). The letters in the patterns are case-sensitive and represent various aspects of a date. See the Date Field Symbol Table of the LDML format on the Internet for more details.

Parameters


date:	Date
patternOptional:	string

Returns

string

Since

2020.2 |

Type Library standard

DeviceOrientation

Since

2020.13

Property Summary


Name and Description
static Angle0: DeviceOrientation
static Angle180: DeviceOrientation
static Angle90Clockwise: DeviceOrientation
static Angle90Counterclockwise: DeviceOrientation

Property Detail


Angle0
staticAngle0: DeviceOrientation


Angle180
staticAngle180: DeviceOrientation


Angle90Clockwise
staticAngle90Clockwise: DeviceOrientation


Angle90Counterclockwise
staticAngle90Counterclockwise: DeviceOrientation

Type Library datasource

Direction

A set of values describing a direction

Since

2021.19

Property Summary


Name and Description
static Horizontal: Direction<br>Horizontal direction
static Vertical: Direction<br>Vertical direction

Property Detail


Horizontal
staticHorizontal: Direction<br>Horizontal direction


Vertical
staticVertical: Direction<br>Vertical direction

Type Library input-controls

ExportCsv

Since

2021.5

Last Update

2024.25

Method Summary


Name and Description
exportReport(): void<br>Exports the included table to a CSV file.
getFileName(): string<br>Returns the filename of the exported CSV file.
getScope(): ExportScope<br>Returns the scope of the exported CSV file.
isAppendixIncluded(): boolean<br>Returns whether the table metadata is included in the exported CSV file.
isDateIncluded(): boolean<br>Returns whether the date info is included in the appendix of the exported CSV file.
isExportFormattedValues(): boolean<br>Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
isHierarchyLevelsInIndividualCells(): boolean<br>Returns whether hierarchy levels are exported in individual columns.
setAppendixIncluded(included: boolean): void<br>Includes or excludes the table metadata from the exported CSV file.
setDateIncluded(included: boolean): void<br>Includes or excludes the date info in appendix of the exported CSV file.
setExportFormattedValues(exportFormattedValues: boolean): void<br>Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
setFileName(text: string): void<br>Sets the filename of the exported CSV file.
setHierarchyLevelsInIndividualCells(separate: boolean): void<br>Specifies whether hierarchy levels are exported in individual columns.
setScope(scope: ExportScope): void<br>Sets the scope of the exported CSV file.
setWidget(table: Table): void<br>Sets the table of the exported CSV file.

Method Detail


exportReport
exportReport(): void<br>Exports the included table to a CSV file.<br>Mobile Support<br>Not supported on mobile devices.


getFileName
getFileName(): string<br>Returns the filename of the exported CSV file.<br>Returns<br>string


getScope
getScope(): ExportScope<br>Returns the scope of the exported CSV file.<br>Returns<br>ExportScope


isAppendixIncluded
isAppendixIncluded(): boolean<br>Returns whether the table metadata is included in the exported CSV file.<br>Returns<br>boolean<br>Since<br>2024.25


isDateIncluded
isDateIncluded(): boolean<br>Returns whether the date info is included in the appendix of the exported CSV file.<br>Returns<br>boolean<br>Since<br>2024.25


isExportFormattedValues
isExportFormattedValues(): boolean<br>Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.<br>Returns<br>boolean


isHierarchyLevelsInIndividualCells
isHierarchyLevelsInIndividualCells(): boolean<br>Returns whether hierarchy levels are exported in individual columns.<br>Returns<br>boolean


setAppendixIncluded
setAppendixIncluded(included: boolean): void

Includes or excludes the table metadata from the exported CSV file.

Parameters


included:	boolean

Since

2024.25 |


setDateIncluded
setDateIncluded(included: boolean): void

Includes or excludes the date info in appendix of the exported CSV file.

Parameters


included:	boolean

Since

2024.25 |


setExportFormattedValues
setExportFormattedValues(exportFormattedValues: boolean): void

Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.

Parameters


exportFormattedValues:	boolean


setFileName
setFileName(text: string): void

Sets the filename of the exported CSV file.

Parameters


text:	string


setHierarchyLevelsInIndividualCells
setHierarchyLevelsInIndividualCells(separate: boolean): void

Specifies whether hierarchy levels are exported in individual columns.

Parameters


separate:	boolean


setScope
setScope(scope: ExportScope): void

Sets the scope of the exported CSV file.

Parameters


scope:	ExportScope


setWidget
setWidget(table: Table): void

Sets the table of the exported CSV file.

Parameters


table:	Table

Type Library exportxlsx

ExportExcel

Since

2021.5

Last Update

2024.25

Method Summary


Name and Description
exportReport(): void<br>Exports the included tables to an XLSX file.
getFileName(): string<br>Returns the filename of the exported XLSX file.
getScope(): ExportScope<br>Returns the scope of the exported XLSX file.
isAppendixIncluded(): boolean<br>Returns whether the table metadata is included in the exported XLSX file.
isDateIncluded(): boolean<br>Returns whether the date info is included in the appendix of the exported XLSX file.
isExportFormattedValues(): boolean<br>Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
isIndentedHierarchy(): boolean<br>Returns whether to indent hierarchical data labels (row headers).
setAppendixIncluded(included: boolean): void<br>Includes or excludes the table metadata from the exported XLSX file.
setDateIncluded(date: boolean): void<br>Includes or excludes the date info in appendix of the exported XLSX file.
setExportFormattedValues(exportFormattedValues: boolean): void<br>Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
setFileName(text: string): void<br>Sets the filename of the exported XLSX file.
setIndentedHierarchy(indentedHierarchy: boolean): void<br>Specifies whether to indent hierarchical data labels (row headers).
setScope(scope: ExportScope): void<br>Sets the scope of the exported XLSX file.
setWidget(table: Table \| Table[]): void<br>Sets the tables of the exported XLSX file.

Method Detail


exportReport
exportReport(): void<br>Exports the included tables to an XLSX file.<br>Mobile Support<br>Not supported on mobile devices.


getFileName
getFileName(): string<br>Returns the filename of the exported XLSX file.<br>Returns<br>string


getScope
getScope(): ExportScope<br>Returns the scope of the exported XLSX file.<br>Returns<br>ExportScope<br>Since<br>2024.12


isAppendixIncluded
isAppendixIncluded(): boolean<br>Returns whether the table metadata is included in the exported XLSX file.<br>Returns<br>boolean


isDateIncluded
isDateIncluded(): boolean<br>Returns whether the date info is included in the appendix of the exported XLSX file.<br>Returns<br>boolean<br>Since<br>2024.25


isExportFormattedValues
isExportFormattedValues(): boolean<br>Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.<br>Returns<br>boolean


isIndentedHierarchy
isIndentedHierarchy(): boolean<br>Returns whether to indent hierarchical data labels (row headers).<br>Returns<br>boolean


setAppendixIncluded
setAppendixIncluded(included: boolean): void

Includes or excludes the table metadata from the exported XLSX file.

Parameters


included:	boolean


setDateIncluded
setDateIncluded(date: boolean): void

Includes or excludes the date info in appendix of the exported XLSX file.

Parameters


date:	boolean

Since

2024.25 |


setExportFormattedValues
setExportFormattedValues(exportFormattedValues: boolean): void

Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.

Parameters


exportFormattedValues:	boolean


setFileName
setFileName(text: string): void

Sets the filename of the exported XLSX file.

Parameters


text:	string


setIndentedHierarchy
setIndentedHierarchy(indentedHierarchy: boolean): void

Specifies whether to indent hierarchical data labels (row headers).

Parameters


indentedHierarchy:	boolean


setScope
setScope(scope: ExportScope): void

Sets the scope of the exported XLSX file.

Parameters


scope:	ExportScope

Since

2024.12 |


setWidget
setWidget(table: Table \| Table[]): void

Sets the tables of the exported XLSX file.

Parameters


table:	Table \| Table[]

Type Library exportpdf

ExportPdf

Since

2019.20

Last Update

2024.7

Method Summary


Name and Description
excludeComponent(component: Widget \| Popup): void<br>Excludes a widget or a popup from the exported PDF file.
exportReport(): void<br>Exports all included tables in full length (report) to a PDF file.
exportView(): boolean<br>Exports the story to a PDF file.
getBatchExportDataSource(modelId: string): BatchExportDataSource<br>Returns the data source of related modelId.
getDateLocation(): PageDateLocation<br>Returns the location of the date in the exported PDF file.
getFileName(): string<br>Returns the filename of the exported PDF file.
getFooterText(): string<br>Returns the text shown in the page footer of the exported PDF file.
getHeaderText(): string<br>Returns the text shown in the page header of the exported PDF file.
getPageNumberLocation(): PageNumberLocation<br>Returns the location of the page number in the exported PDF file.
getPageOrientation(): PageOrientation<br>Returns the page orientation of the exported PDF file.
getPageRange(): number[]<br>Returns the numbers of the pages to be exported to PDF.
getPageSize(): PageSize<br>Returns the page size of the exported PDF file.
includeComponent(component: Widget \| Popup): void<br>Includes a widget or a popup in the exported PDF file.
isAppendixVisible(): boolean<br>Returns whether the appendix is visible in the exported PDF file.
isBatchExportEnabled(): boolean<br>Returns whether batch export is enabled.
isCommentsVisible(): boolean<br>Returns whether the comments are visible in the exported PDF file.
isExportInBackgroundEnabled(): boolean<br>Returns whether the export of the PDF file in the background is enabled.
isFooterVisible(): boolean<br>Returns whether the page footer is visible in the exported PDF file.
isHeaderVisible(): boolean<br>Returns whether the page header is visible in the exported PDF file.
isReportIncluded(): boolean<br>Returns whether the export of all included tables in full length (report) is enabled when the analytic application is exported to a PDF file with exportView().
setAppendixVisible(visible: boolean): void<br>Shows or hides the appendix in the exported PDF file.
setBatchExportEnabled(isEnabled: boolean): void<br>Enable or disable batch export.
setCommentsVisible(visible: boolean): void<br>Shows or hides the comments in the exported PDF file.
setDateLocation(location: PageDateLocation): void<br>Sets the location of the date in the exported PDF file.
setExportInBackgroundEnabled(isEnabled: boolean): void<br>Enables or disables the export of the PDF file in the background.
setFileName(fileName: string): void<br>Sets the filename of the exported PDF file.
setFooterText(text: string): void<br>Sets the text shown in the page footer of the exported PDF file.
setFooterVisible(visible: boolean): void<br>Shows or hides the page footer in the exported PDF file.
setHeaderText(text: string): void<br>Sets the text shown in the page header of the exported PDF file.
setHeaderVisible(visible: boolean): void<br>Shows or hides the page header in the exported PDF file.
setPageNumberLocation(location: PageNumberLocation): void<br>Sets the location of the page number in the exported PDF file.
setPageOrientation(orientation: PageOrientation): void<br>Sets the page orientation of the exported PDF file.
setPageRange(value: number[]): void<br>Sets the pages to be exported to PDF.
setPageSize(size: PageSize): void<br>Sets the page size of the exported PDF file.
setReportIncluded(included: boolean): void<br>Includes or excludes the export of all included tables in full length (report) when the analytic application is exported to a PDF file with exportView().

Method Detail


excludeComponent
excludeComponent(component: Widget \| Popup): void

Excludes a widget or a popup from the exported PDF file.

Parameters


component:	Widget \| Popup

Since

2020.10 |


exportReport
exportReport(): void<br>Exports all included tables in full length (report) to a PDF file.<br>Mobile Support<br>Not supported on mobile devices.<br>Since<br>2020.16


exportView
exportView(): boolean<br>Exports the story to a PDF file.<br>Returns<br>boolean<br>Mobile Support<br>Not supported on mobile devices.


getBatchExportDataSource
getBatchExportDataSource(modelId: string): BatchExportDataSource

Returns the data source of related modelId.

Parameters


modelId:	string

Returns

BatchExportDataSource

Since

2024.7 |


getDateLocation
getDateLocation(): PageDateLocation<br>Returns the location of the date in the exported PDF file.<br>Returns<br>PageDateLocation


getFileName
getFileName(): string<br>Returns the filename of the exported PDF file.<br>Returns<br>string


getFooterText
getFooterText(): string<br>Returns the text shown in the page footer of the exported PDF file.<br>Returns<br>string


getHeaderText
getHeaderText(): string<br>Returns the text shown in the page header of the exported PDF file.<br>Returns<br>string


getPageNumberLocation
getPageNumberLocation(): PageNumberLocation<br>Returns the location of the page number in the exported PDF file.<br>Returns<br>PageNumberLocation


getPageOrientation
getPageOrientation(): PageOrientation<br>Returns the page orientation of the exported PDF file.<br>Returns<br>PageOrientation


getPageRange
getPageRange(): number[]<br>Returns the numbers of the pages to be exported to PDF.<br>Returns<br>number[]<br>Since<br>2023.3


getPageSize
getPageSize(): PageSize<br>Returns the page size of the exported PDF file.<br>Returns<br>PageSize


includeComponent
includeComponent(component: Widget \| Popup): void

Includes a widget or a popup in the exported PDF file.

Parameters


component:	Widget \| Popup

Since

2020.10 |


isAppendixVisible
isAppendixVisible(): boolean<br>Returns whether the appendix is visible in the exported PDF file.<br>Returns<br>boolean


isBatchExportEnabled
isBatchExportEnabled(): boolean<br>Returns whether batch export is enabled.<br>Returns<br>boolean<br>Since<br>2024.7


isCommentsVisible
isCommentsVisible(): boolean<br>Returns whether the comments are visible in the exported PDF file.<br>Returns<br>boolean


isExportInBackgroundEnabled
isExportInBackgroundEnabled(): boolean<br>Returns whether the export of the PDF file in the background is enabled.<br>Returns<br>boolean<br>Since<br>2019.23


isFooterVisible
isFooterVisible(): boolean<br>Returns whether the page footer is visible in the exported PDF file.<br>Returns<br>boolean


isHeaderVisible
isHeaderVisible(): boolean<br>Returns whether the page header is visible in the exported PDF file.<br>Returns<br>boolean


isReportIncluded
isReportIncluded(): boolean<br>Returns whether the export of all included tables in full length (report) is enabled when the analytic application is exported to a PDF file with exportView().<br>Returns<br>boolean<br>Since<br>2020.16


setAppendixVisible
setAppendixVisible(visible: boolean): void

Shows or hides the appendix in the exported PDF file.

Parameters


visible:	boolean


setBatchExportEnabled
setBatchExportEnabled(isEnabled: boolean): void

Enable or disable batch export.

Parameters


isEnabled:	boolean

Since

2024.7 |


setCommentsVisible
setCommentsVisible(visible: boolean): void

Shows or hides the comments in the exported PDF file.

Parameters


visible:	boolean


setDateLocation
setDateLocation(location: PageDateLocation): void

Sets the location of the date in the exported PDF file.

Parameters


location:	PageDateLocation


setExportInBackgroundEnabled
setExportInBackgroundEnabled(isEnabled: boolean): void

Enables or disables the export of the PDF file in the background.

Parameters


isEnabled:	boolean

Since

2019.23 |


setFileName
setFileName(fileName: string): void

Sets the filename of the exported PDF file.

Parameters


fileName:	string


setFooterText
setFooterText(text: string): void

Sets the text shown in the page footer of the exported PDF file.

Parameters


text:	string


setFooterVisible
setFooterVisible(visible: boolean): void

Shows or hides the page footer in the exported PDF file.

Parameters


visible:	boolean


setHeaderText
setHeaderText(text: string): void

Sets the text shown in the page header of the exported PDF file.

Parameters


text:	string


setHeaderVisible
setHeaderVisible(visible: boolean): void

Shows or hides the page header in the exported PDF file.

Parameters


visible:	boolean


setPageNumberLocation
setPageNumberLocation(location: PageNumberLocation): void

Sets the location of the page number in the exported PDF file.

Parameters


location:	PageNumberLocation


setPageOrientation
setPageOrientation(orientation: PageOrientation): void

Sets the page orientation of the exported PDF file.

Parameters


orientation:	PageOrientation


setPageRange
setPageRange(value: number[]): void

Sets the pages to be exported to PDF. All pages are exported if you don’t specify the page numbers. Page number starts from 1.

Parameters


value:	number[]

Since

2023.3 |


setPageSize
setPageSize(size: PageSize): void

Sets the page size of the exported PDF file.

Parameters


size:	PageSize


setReportIncluded
setReportIncluded(included: boolean): void

Includes or excludes the export of all included tables in full length (report) when the analytic application is exported to a PDF file with exportView().

Parameters


included:	boolean

Since

2020.16 |

Type Library exportpptx

ExportPptx

Since

2023.25

Last Update

2024.25

Method Summary


Name and Description
exportView(): boolean<br>Exports the story to a power point file.
getBatchExportDataSource(modelId: string): BatchExportDataSource<br>Returns the data source of related modelId.
getFileName(): string<br>Returns the filename of the exported power point file.
getPageRange(): number[]<br>Returns the numbers of the pages to be exported to PPTX.
isAppendixVisible(): boolean<br>Returns whether the appendix is visible in the exported power point file.
isBatchExportEnabled(): boolean<br>Returns whether batch export is enabled.
isDateIncluded(): boolean<br>Returns whether date is included in the appendix of the exported power point file.
setAppendixVisible(visible: boolean): void<br>Shows or hides the appendix in the exported power point file.
setBatchExportEnabled(isEnabled: boolean): void<br>Enable or disable batch export.
setDateIncluded(included: boolean): void<br>Includes or excludes date in the appendix of the exported power point file.
setFileName(fileName: string): void<br>Sets the filename of the exported power point file.
setPageRange(value: number[]): void<br>Sets the pages to be exported to PPTX.

Method Detail


exportView
exportView(): boolean<br>Exports the story to a power point file.<br>Returns<br>boolean<br>Mobile Support<br>Not supported on mobile devices.


getBatchExportDataSource
getBatchExportDataSource(modelId: string): BatchExportDataSource

Returns the data source of related modelId.

Parameters


modelId:	string

Returns

BatchExportDataSource

Since

2024.7 |


getFileName
getFileName(): string<br>Returns the filename of the exported power point file.<br>Returns<br>string


getPageRange
getPageRange(): number[]<br>Returns the numbers of the pages to be exported to PPTX.<br>Returns<br>number[]


isAppendixVisible
isAppendixVisible(): boolean<br>Returns whether the appendix is visible in the exported power point file.<br>Returns<br>boolean


isBatchExportEnabled
isBatchExportEnabled(): boolean<br>Returns whether batch export is enabled.<br>Returns<br>boolean<br>Since<br>2024.7


isDateIncluded
isDateIncluded(): boolean<br>Returns whether date is included in the appendix of the exported power point file.<br>Returns<br>boolean<br>Since<br>2024.25


setAppendixVisible
setAppendixVisible(visible: boolean): void

Shows or hides the appendix in the exported power point file.

Parameters


visible:	boolean


setBatchExportEnabled
setBatchExportEnabled(isEnabled: boolean): void

Enable or disable batch export.

Parameters


isEnabled:	boolean

Since

2024.7 |


setDateIncluded
setDateIncluded(included: boolean): void

Includes or excludes date in the appendix of the exported power point file.

Parameters


included:	boolean

Since

2024.25 |


setFileName
setFileName(fileName: string): void

Sets the filename of the exported power point file.

Parameters


fileName:	string


setPageRange
setPageRange(value: number[]): void

Sets the pages to be exported to PPTX. All pages are exported if you don’t specify the page numbers. Page number starts from 1.

Parameters


value:	number[]

Type Library exportcsv

ExportScope

Since

2021.5

Property Summary


Name and Description
static All: ExportScope<br>Export scope of "All"
static PointOfView: ExportScope<br>Export scope of "Point of View"

Property Detail


All
staticAll: ExportScope<br>Export scope of "All"


PointOfView
staticPointOfView: ExportScope<br>Export scope of "Point of View"

Type Library chart

Feed

Last Update

2019.10

Property Summary


Name and Description
static BubbleWidth: Feed<br>The "BubbleWidth" feed
static CategoryAxis: Feed<br>The "CategoryAxis" feed
static CategoryAxis2: Feed<br>The "CategoryAxis2" feed
static Color: Feed<br>The "Color" feed
static CrossCalculations: Feed<br>The "CrossCalculations" feed
static DataContext: Feed<br>The "DataContext" feed
static DataContext2: Feed<br>The "DataContext2" feed
static Pattern: Feed<br>The "Pattern" feed
static Pattern2: Feed<br>The "Pattern2" feed
static Size: Feed<br>The "Size" feed
static TimeAxis: Feed<br>The "TimeAxis" feed
static Title: Feed<br>The "Title" feed
static TooltipCategoryAxis: Feed<br>The "TooltipCategoryAxis" feed
static TooltipValueAxis: Feed<br>The "TooltipValueAxis" feed
static Trellis: Feed<br>The "Trellis" feed
static ValueAxis: Feed<br>The "ValueAxis" feed
static ValueAxis2: Feed<br>The "ValueAxis2" feed
static Weight: Feed<br>The "Weight" feed

Property Detail


BubbleWidth
staticBubbleWidth: Feed<br>The "BubbleWidth" feed


CategoryAxis
staticCategoryAxis: Feed<br>The "CategoryAxis" feed


CategoryAxis2
staticCategoryAxis2: Feed<br>The "CategoryAxis2" feed


Color
staticColor: Feed<br>The "Color" feed


CrossCalculations
staticCrossCalculations: Feed<br>The "CrossCalculations" feed


DataContext
staticDataContext: Feed<br>The "DataContext" feed


DataContext2
staticDataContext2: Feed<br>The "DataContext2" feed


Pattern
staticPattern: Feed<br>The "Pattern" feed


Pattern2
staticPattern2: Feed<br>The "Pattern2" feed


Size
staticSize: Feed<br>The "Size" feed


TimeAxis
staticTimeAxis: Feed<br>The "TimeAxis" feed


Title
staticTitle: Feed<br>The "Title" feed


TooltipCategoryAxis
staticTooltipCategoryAxis: Feed<br>The "TooltipCategoryAxis" feed


TooltipValueAxis
staticTooltipValueAxis: Feed<br>The "TooltipValueAxis" feed


Trellis
staticTrellis: Feed<br>The "Trellis" feed


ValueAxis
staticValueAxis: Feed<br>The "ValueAxis" feed


ValueAxis2
staticValueAxis2: Feed<br>The "ValueAxis2" feed


Weight
staticWeight: Feed<br>The "Weight" feed<br>Since<br>2019.10

FileUploadTrigger

extends Widget

Since

2024.14

Last Update

2024.17

Method Summary


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

Event Summary


Name and Description
onAfterExecute(status: DataUploadExecutionResponseStatus): void<br>Called when the Data Upload Starter execution ends.
onBeforeExecute(): boolean<br>Called when the user clicks the Data Upload Starter.

Event Detail


onAfterExecute
onAfterExecute(status: DataUploadExecutionResponseStatus): void

Called when the Data Upload Starter execution ends.

Parameters


status:	DataUploadExecutionResponseStatus

Last Update

2024.17 |


onBeforeExecute
onBeforeExecute(): boolean<br>Called when the user clicks the Data Upload Starter. If this method returns true or returns no value, then the data upload is executed. If this method returns false, then the data upload is ignored.<br>Returns<br>booleanDefault value:true

Type Library datasource-controls

FiscalTime

can be passed as a JSON object to method arguments

An object representing fiscal time

Since

2023.13

Property Summary


Name and Description
fiscalDay: integer<br>fiscalDay
fiscalQuarter: integer<br>fiscalQuarter
fiscalYear: integer<br>fiscalYear
granularity: FiscalTimeGranularity<br>granularity
period: integer<br>period

Property Detail


fiscalDay
fiscalDay: integer<br>fiscalDay


fiscalQuarter
fiscalQuarter: integer<br>fiscalQuarter


fiscalYear
fiscalYear: integer<br>fiscalYear


granularity
granularity: FiscalTimeGranularity<br>granularity


period
period: integer<br>period

FiscalTimeGranularity

Since

2023.13

Property Summary


Name and Description
static FiscalDay: FiscalTimeGranularity<br>fiscal days
static FiscalQuarter: FiscalTimeGranularity<br>fiscal quarters
static FiscalYear: FiscalTimeGranularity<br>fiscal years
static Period: FiscalTimeGranularity<br>fiscal periods

Property Detail


FiscalDay
staticFiscalDay: FiscalTimeGranularity<br>fiscal days


FiscalQuarter
staticFiscalQuarter: FiscalTimeGranularity<br>fiscal quarters


FiscalYear
staticFiscalYear: FiscalTimeGranularity<br>fiscal years


Period
staticPeriod: FiscalTimeGranularity<br>fiscal periods

Type Library containers

FlowPanel

extends Widget

Since

2020.20

Method Summary


Name and Description
hideBusyIndicator(): void<br>Hides the busy indicator.
moveWidget(widget: Widget): void<br>Moves the widget into the panel.
showBusyIndicator(text?: string): void<br>Shows the busy indicator.


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

Method Detail


hideBusyIndicator
hideBusyIndicator(): void<br>Hides the busy indicator.


moveWidget
moveWidget(widget: Widget): void

Moves the widget into the panel.

Parameters


widget:	Widget


showBusyIndicator
showBusyIndicator(text?: string): void

Shows the busy indicator.

Parameters


textOptional:	string

Type Library chart

Forecast

Method Summary


Name and Description
setNumberOfPeriods(number: integer): void<br>Sets the number of forecast periods.
setType(forecastType: ForecastType): void<br>Sets the forecast type.

Method Detail


setNumberOfPeriods
setNumberOfPeriods(number: integer): void

Sets the number of forecast periods. If the value is out of the forecast range, then it is set to the default min-max period number.

Parameters


number:	integer


setType
setType(forecastType: ForecastType): void

Sets the forecast type.

Parameters


forecastType:	ForecastType

Type Library chart

ForecastType

Property Summary


Name and Description
static Auto: ForecastType<br>The forecast is performed on the available data.
static None: ForecastType<br>No forecast is performed.
static TripleExponentialSmoothing: ForecastType<br>The forecast is performed using the Triple Exponential Smoothing algorithm to account for seasonal changes as well as trends.

Property Detail


Auto
staticAuto: ForecastType<br>The forecast is performed on the available data.


None
staticNone: ForecastType<br>No forecast is performed.


TripleExponentialSmoothing
staticTripleExponentialSmoothing: ForecastType<br>The forecast is performed using the Triple Exponential Smoothing algorithm to account for seasonal changes as well as trends.

Type Library advanced-controls

IChangedCell

Since

2024.25

Property Summary


Name and Description
context: Selection JSON<br>Dimension the cell corresponds to, whose value is its dimension ID
newValue: string<br>Cell value after change
oldValue: string<br>Cell value before change

Property Detail


context
context: Selection JSON<br>Dimension the cell corresponds to, whose value is its dimension ID


newValue
newValue: string<br>Cell value after change


oldValue
oldValue: string<br>Cell value before change

Type Library visualization-controls

InputFieldStyle

can be passed as a JSON object to method arguments

Since

2020.9

Property Summary


Name and Description
backgroundColor: string<br>Background color of the input field
borderColor: string<br>Border color of the input field
color: string<br>Font color of the input field

Property Detail


backgroundColor
backgroundColor: string<br>Background color of the input field


borderColor
borderColor: string<br>Border color of the input field


color
color: string<br>Font color of the input field

Type Library standard

Layout

Since

2019.14

Last Update

2019.20

Method Summary


Name and Description
getBottom(): LayoutValue<br>Returns the bottom margin between the widget and the widget's parent container.
getHeight(): LayoutValue<br>Returns the height of the widget.
getLeft(): LayoutValue<br>Returns the left margin between the widget and the widget's parent container.
getRight(): LayoutValue<br>Returns the right margin between the widget and the widget's parent container.
getTop(): LayoutValue<br>Returns the top margin between the widget and the widget's parent container.
getWidth(): LayoutValue<br>Returns the width of the widget.
setBottom(value: LayoutValue \| integer): void<br>Sets the bottom margin between the widget and the widget's parent container.
setHeight(value: LayoutValue \| integer): void<br>Sets the height of the widget.
setLeft(value: LayoutValue \| integer): void<br>Sets the left margin between the widget and the widget's parent container.
setRight(value: LayoutValue \| integer): void<br>Sets the right margin between the widget and the widget's parent container.
setTop(value: LayoutValue \| integer): void<br>Sets the top margin between the widget and the widget's parent container.
setWidth(value: LayoutValue \| integer): void<br>Sets the width of the widget.

Method Detail


getBottom
getBottom(): LayoutValue<br>Returns the bottom margin between the widget and the widget's parent container.<br>Returns<br>LayoutValue<br>Since<br>2019.20


getHeight
getHeight(): LayoutValue<br>Returns the height of the widget.<br>Returns<br>LayoutValue


getLeft
getLeft(): LayoutValue<br>Returns the left margin between the widget and the widget's parent container.<br>Returns<br>LayoutValue


getRight
getRight(): LayoutValue<br>Returns the right margin between the widget and the widget's parent container.<br>Returns<br>LayoutValue<br>Since<br>2019.20


getTop
getTop(): LayoutValue<br>Returns the top margin between the widget and the widget's parent container.<br>Returns<br>LayoutValue


getWidth
getWidth(): LayoutValue<br>Returns the width of the widget.<br>Returns<br>LayoutValue


setBottom
setBottom(value: LayoutValue \| integer): void

Sets the bottom margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.

Parameters


value:	LayoutValue \| integer

Since

2019.20 |


setHeight
setHeight(value: LayoutValue \| integer): void

Sets the height of the widget. If you specify an integer, then pixel units are used.

Parameters


value:	LayoutValue \| integer

Last Update

2019.15 |


setLeft
setLeft(value: LayoutValue \| integer): void

Sets the left margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.

Parameters


value:	LayoutValue \| integer

Last Update

2019.15 |


setRight
setRight(value: LayoutValue \| integer): void

Sets the right margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.

Parameters


value:	LayoutValue \| integer

Since

2019.20 |


setTop
setTop(value: LayoutValue \| integer): void

Sets the top margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.

Parameters


value:	LayoutValue \| integer

Last Update

2019.15 |


setWidth
setWidth(value: LayoutValue \| integer): void

Sets the width of the widget. If you specify an integer, then pixel units are used.

Parameters


value:	LayoutValue \| integer

Last Update

2019.15 |

Type Library standard

LayoutUnit

Since

2019.14

Last Update

2023.8

Property Summary


Name and Description
static Auto: LayoutUnit
static Grid: LayoutUnit
static Percent: LayoutUnit
static Pixel: LayoutUnit

Property Detail


Auto
staticAuto: LayoutUnit<br>Since<br>2019.20


Grid
staticGrid: LayoutUnit<br>Since<br>2023.8


Percent
staticPercent: LayoutUnit<br>Since<br>2019.20


Pixel
staticPixel: LayoutUnit

Type Library standard

LayoutValue

Since

2019.14

Last Update

2019.20

Property Summary


Name and Description
static Auto: LayoutValue
numberValue: number
unit: LayoutUnit
value: integer

Method Summary


Name and Description
static create(value: number, unit: LayoutUnit): LayoutValue<br>Creates a Unit with a value and type.

Property Detail


Auto
staticAuto: LayoutValue<br>Since<br>2019.20


numberValue
numberValue: number<br>Since<br>2019.20


unit
unit: LayoutUnit<br>Since<br>2019.15


value
value: integer<br>Since<br>2019.15

Method Detail


create
staticcreate(value: number, unit: LayoutUnit): LayoutValue

Creates a Unit with a value and type.

Parameters


value:	number
unit:	LayoutUnit

Returns

LayoutValue

Last Update

2019.20 |

Type Library data-binding

LinkedAnalysis

Since

2023.15

Method Summary


Name and Description
isDataPointSelectionEnabled(): boolean<br>Whether it supports filter on data point selection
removeFilters(): void<br>Remove the filters on data point selection
setFilters(selections: Selection JSON \| Selection[]JSON): void<br>Set the filter on data point selection

Method Detail


isDataPointSelectionEnabled
isDataPointSelectionEnabled(): boolean<br>Whether it supports filter on data point selection<br>Returns<br>boolean


removeFilters
removeFilters(): void<br>Remove the filters on data point selection


setFilters
setFilters(selections: Selection JSON \| Selection[]JSON): void

Set the filter on data point selection

Parameters


selections:	Selection JSON \| Selection[]JSON

Type Library input-controls

MemberAccessMode

A set of values to describe the type of members

Since

2021.1

Property Summary

| |
| --- |
| Name and Description |
| static BookedValues: MemberAccessMode Only members which have booked values |
| static MasterData: MemberAccessMode Full set of available members |

Property Detail

| |
| --- |
| BookedValues |
| staticBookedValues: MemberAccessMode Only members which have booked values |

| |
| --- |
| MasterData |
| staticMasterData: MemberAccessMode Full set of available members |

Type Library
datasource

E
\

MemberDisplayMode

Since

2019.1

Property Summary

| |
| --- |
| Name and Description |
| static Description: MemberDisplayMode Members are visualized using their description. |
| static DisplayId: MemberDisplayMode Members are visualized using their display ID. |
| static DisplayIdAndDescription: MemberDisplayMode Members are visualized using their display ID and description. |

Property Detail

| |
| --- |
| Description |
| staticDescription: MemberDisplayMode Members are visualized using their description. |

| |
| --- |
| DisplayId |
| staticDisplayId: MemberDisplayMode Members are visualized using their display ID. |

| |
| --- |
| DisplayIdAndDescription |
| staticDisplayIdAndDescription: MemberDisplayMode Members are visualized using their display ID and description. |

Type Library
datasource

C
\

MultiAction

Since

2022.25

Last Update

2025.13

Method Summary

| |
| --- |
| Name and Description |
| execute(): MultiActionExecutionResponse Executes the multi action as a blocking operation, which prevents other scripts from running until the multi action execution is complete. |
| executeInBackground(executionName: string): MultiActionBackgroundExecutionResponse Executes the multi action as a non-blocking operation. |
| getParameterValue(id: string): MultiActionParameterValue Returns the value of the parameter. |
| isAllMembersSelected(id: string): boolean Returns whether the parameter has the all member as value. |
| setAllMembersSelected(id: string, hierarchy?: string): void Sets the all member as parameter value. |
| setParameterValue(id: string, value: string | string[] | MultiActionParameterValue JSON | number): void Sets the value of the parameter. |

Event Summary

| |
| --- |
| Name and Description |
| onExecutionStatusUpdate(status: MultiActionExecutionResponseStatus, executionId: string, executionName: string, message: string): void Called when an asynchronous Multi Action execution changes its status. |

Method Detail

| |
| --- |
| execute |
| execute(): MultiActionExecutionResponse Executes the multi action as a blocking operation, which prevents other scripts from running until the multi action execution is complete. Best to use it for multi actions that take a short time to run. Returns MultiActionExecutionResponse Mobile Support Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| executeInBackground |
| executeInBackground(executionName: string): MultiActionBackgroundExecutionResponse

Executes the multi action as a non-blocking operation. Other scripts can be running at the same time without waiting for the multi action execution to complete.

Parameters

| | | |
| --- | --- | --- |
| executionName: | string | |

Returns

MultiActionBackgroundExecutionResponse

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| getParameterValue |
| getParameterValue(id: string): MultiActionParameterValue

Returns the value of the parameter.

Parameters

| | | |
| --- | --- | --- |
| id: | string | |

Returns

MultiActionParameterValue

Mobile Support

Not supported on mobile devices. |

| | | |
| --- | --- | --- |
| isAllMembersSelected |
| isAllMembersSelected(id: string): boolean

Returns whether the parameter has the all member as value.

Parameters

| | | |
| --- | --- | --- |
| id: | string | |

Returns

boolean

Since

2025.13 |

| | | |
| --- | --- | --- |
| setAllMembersSelected |
| setAllMembersSelected(id: string, hierarchy?: string): void

Sets the all member as parameter value.

Parameters

| | | |
| --- | --- | --- |
| id: | string | |
| hierarchyOptional: | string | |

Since

2025.13 |

| | | |
| --- | --- | --- |
| setParameterValue |
| setParameterValue(id: string, value: string | string[] | MultiActionParameterValue JSON | number): void

Sets the value of the parameter.

Parameters

| | | |
| --- | --- | --- |
| id: | string | |
| value: | string | string[] | MultiActionParameterValue JSON | number | |

Mobile Support

Not supported on mobile devices. |

Event Detail

| | | |
| --- | --- | --- |
| onExecutionStatusUpdate |
| onExecutionStatusUpdate(status: MultiActionExecutionResponseStatus, executionId: string, executionName: string, message: string): void

Called when an asynchronous Multi Action execution changes its status.

Parameters

| | | |
| --- | --- | --- |
| status: | MultiActionExecutionResponseStatus | |
| executionId: | string | |
| executionName: | string | |
| message: | string | |

Last Update

2023.13 |

Type Library
multi-action

C
\

MultiActionBackgroundExecutionResponse

Since

2022.25

Property Summary

| |
| --- |
| Name and Description |
| executionId: string Generated execution ID. |
| status: MultiActionBackgroundExecutionResponseStatus Execution status |

Property Detail

| |
| --- |
| executionId |
| executionId: string Generated execution ID. |

| |
| --- |
| status |
| status: MultiActionBackgroundExecutionResponseStatus Execution status |

Type Library
multi-action

E
\

MultiActionBackgroundExecutionResponseStatus

Since

2022.25

Property Summary

| |
| --- |
| Name and Description |
| static Accepted: MultiActionBackgroundExecutionResponseStatus Execution is accepted. |
| static Error: MultiActionBackgroundExecutionResponseStatus Execution ended with errors. |

Property Detail

| |
| --- |
| Accepted |
| staticAccepted: MultiActionBackgroundExecutionResponseStatus Execution is accepted. |

| |
| --- |
| Error |
| staticError: MultiActionBackgroundExecutionResponseStatus Execution ended with errors. |

Type Library
multi-action

C
\

MultiActionDatetimeParameterValue

extends MultiActionParameterValue, can be passed as a JSON object to method arguments

An object defining a multi action datetime parameter value

Since

2025.7

Property Summary

| |
| --- |
| Name and Description |
| values: string[] Datetime values |

| |
| --- |
| Inherited from MultiActionParameterValue |
| type |

Property Detail

| |
| --- |
| values |
| values: string[] Datetime values |

Type Library
multi-action

C
\

MultiActionExecutionResponse

Since

2022.25

Last Update

2023.13

Property Summary

| |
| --- |
| Name and Description |
| message: string Execution result message |
| status: MultiActionExecutionResponseStatus Execution result status |

Property Detail

| |
| --- |
| message |
| message: string Execution result message Since 2023.13 |

| |
| --- |
| status |
| status: MultiActionExecutionResponseStatus Execution result status |

Type Library
multi-action

E
\

MultiActionExecutionResponseStatus

Since

2022.25

Last Update

2023.6

Property Summary

| |
| --- |
| Name and Description |
| static Error: MultiActionExecutionResponseStatus Execution ended with errors. |
| static Running: MultiActionExecutionResponseStatus Execution is running. |
| static Success: MultiActionExecutionResponseStatus Execution ended successfully. |
| static Warning: MultiActionExecutionResponseStatus Execution ended with warning. |

Property Detail

| |
| --- |
| Error |
| staticError: MultiActionExecutionResponseStatus Execution ended with errors. |

| |
| --- |
| Running |
| staticRunning: MultiActionExecutionResponseStatus Execution is running. |

| |
| --- |
| Success |
| staticSuccess: MultiActionExecutionResponseStatus Execution ended successfully. |

| |
| --- |
| Warning |
| staticWarning: MultiActionExecutionResponseStatus Execution ended with warning. Since 2023.6 |

Type Library
multi-action

C
\

MultiActionMemberParameterValue

extends MultiActionParameterValue, can be passed as a JSON object to method arguments

An object defining a multi action member parameter value

Since

2022.25

Property Summary

| |
| --- |
| Name and Description |
| members: string[] Member IDs |

| |
| --- |
| Inherited from MultiActionParameterValue |
| type |

Property Detail

| |
| --- |
| members |
| members: string[] Member IDs |

Type Library
multi-action

C
\

MultiActionNumberParameterValue

extends MultiActionParameterValue, can be passed as a JSON object to method arguments

An object defining a multi action number parameter value

Since

2022.25

Property Summary

| |
| --- |
| Name and Description |
| value: number Number value |

| |
| --- |
| Inherited from MultiActionParameterValue |
| type |

Property Detail

| |
| --- |
| value |
| value: number Number value |

Type Library
multi-action

C
\

MultiActionParameterValue

can be passed as a JSON object to method arguments

An object defining a multi action parameter value

Direct Subclasses

MultiActionAllMemberSelection, MultiActionDatetimeParameterValue, MultiActionMemberParameterValue, MultiActionNumberParameterValue, MultiActionStringParameterValue

Since

2022.25

Property Summary

| |
| --- |
| Name and Description |
| type: MultiActionParameterValueType Type of the parameter value |

Property Detail

| |
| --- |
| type |
| type: MultiActionParameterValueType Type of the parameter value |

Type Library
multi-action

E
\

MultiActionParameterValueType

Since

2022.25

Last Update

2025.13

Property Summary

| |
| --- |
| Name and Description |
| static All: MultiActionParameterValueType All member selection type |
| static Datetime: MultiActionParameterValueType Datetime value type |
| static Member: MultiActionParameterValueType Member value type |
| static Number: MultiActionParameterValueType Number value type |
| static String: MultiActionParameterValueType String value type |

Property Detail

| |
| --- |
| All |
| staticAll: MultiActionParameterValueType All member selection type Since 2025.13 |

| |
| --- |
| Datetime |
| staticDatetime: MultiActionParameterValueType Datetime value type Since 2025.7 |

| |
| --- |
| Member |
| staticMember: MultiActionParameterValueType Member value type |

| |
| --- |
| Number |
| staticNumber: MultiActionParameterValueType Number value type |

| |
| --- |
| String |
| staticString: MultiActionParameterValueType String value type Since 2025.7 |

Type Library
multi-action

C
\

MultiActionStringParameterValue

extends MultiActionParameterValue, can be passed as a JSON object to method arguments

An object defining a multi action string parameter value

Since

2025.7

Property Summary

| |
| --- |
| Name and Description |
| values: string[] String values |

| |
| --- |
| Inherited from MultiActionParameterValue |
| type |

Property Detail

| |
| --- |
| values |
| values: string[] String values |

Type Library
planning

C
\

MultiActionTrigger

extends Widget

Since

2021.13

Method Summary

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

Event Summary

| |
| --- |
| Name and Description |
| onBeforeExecute(): boolean Called when the user clicks the multi action starter. |

Event Detail

| |
| --- |
| onBeforeExecute |
| onBeforeExecute(): boolean Called when the user clicks the multi action starter. If this method returns true or returns no value, then the multi action is executed. If this method returns false, then the multi action is ignored. Returns booleanDefault value:true |

Type Library
datasource

C
\

MultipleVariableValue

extends VariableValue, can be passed as a JSON object to method arguments

Since

2019.22

Property Summary

| |
| --- |
| Name and Description |
| exclude: boolean Indicates whether to exclude the variable values. |
| values: string[] Multiple variable values |

| |
| --- |
| Inherited from VariableValue |
| type |

Property Detail

| |
| --- |
| exclude |
| exclude: boolean Indicates whether to exclude the variable values. |

| |
| --- |
| values |
| values: string[] Multiple variable values |

Type Library
table2

C
\

NumberFormat

Since

2019.5

Method Summary

| |
| --- |
| Name and Description |
| static create(): NumberFormat Creates a number format. |
| static format(value: number): string Formats a number by applying the current user settings. |
| format(value: number): string Formats a number by applying the settings of this number format. |
| getDecimalSeparator(): string Returns the decimal separator. |
| getGroupingSeparator(): string Returns the grouping separator. |
| getMaximumDecimalPlaces(): integer Returns the maximum number of decimal places. |
| getMinimumDecimalPlaces(): integer Returns the minimum number of decimal places. |
| getScalingFactor(): number Returns the scaling factor. |
| getScalingText(): string Returns the scaling text. |
| getSignDisplay(): NumberFormatSignDisplay Returns how signs are displayed. |
| setDecimalSeparator(decimalSeparator: string): void Sets the decimal separator. |
| setGroupingSeparator(groupingSeparator: string): void Sets the grouping separator. |
| setMaximumDecimalPlaces(maximumDecimalPlaces: integer): void Sets the maximum number of decimal places. |
| setMinimumDecimalPlaces(minimumDecimalPlaces: integer): void Sets the minimum number of decimal places. |
| setScalingFactor(factor: number): void Sets the scaling factor. |
| setScalingText(text: string): void Sets the scaling text. |
| setSignDisplay(mode: NumberFormatSignDisplay): void Specifies how signs are displayed. |

Method Detail

| |
| --- |
| create |
| staticcreate(): NumberFormat Creates a number format. Returns NumberFormat |

| | | |
| --- | --- | --- |
| format |
| staticformat(value: number): string

Formats a number by applying the current user settings.

Parameters

| | | |
| --- | --- | --- |
| value: | number | |

Returns

string |

| | | |
| --- | --- | --- |
| format |
| format(value: number): string

Formats a number by applying the settings of this number format.

Parameters

| | | |
| --- | --- | --- |
| value: | number | |

Returns

string |

| |
| --- |
| getDecimalSeparator |
| getDecimalSeparator(): string Returns the decimal separator. Returns string |

| |
| --- |
| getGroupingSeparator |
| getGroupingSeparator(): string Returns the grouping separator. Returns string |

| |
| --- |
| getMaximumDecimalPlaces |
| getMaximumDecimalPlaces(): integer Returns the maximum number of decimal places. Returns integer |

| |
| --- |
| getMinimumDecimalPlaces |
| getMinimumDecimalPlaces(): integer Returns the minimum number of decimal places. Returns integer |

| |
| --- |
| getScalingFactor |
| getScalingFactor(): number Returns the scaling factor. Returns number |

| |
| --- |
| getScalingText |
| getScalingText(): string Returns the scaling text. Returns string |

| |
| --- |
| getSignDisplay |
| getSignDisplay(): NumberFormatSignDisplay Returns how signs are displayed. Returns NumberFormatSignDisplay |

| | | |
| --- | --- | --- |
| setDecimalSeparator |
| setDecimalSeparator(decimalSeparator: string): void

Sets the decimal separator.

Parameters

| | | |
| --- | --- | --- |
| decimalSeparator: | string | | |

| | | |
| --- | --- | --- |
| setGroupingSeparator |
| setGroupingSeparator(groupingSeparator: string): void

Sets the grouping separator. If the grouping separator is an empty string (""), then the digits of the number aren't grouped.

Parameters

| | | |
| --- | --- | --- |
| groupingSeparator: | string | | |

| | | |
| --- | --- | --- |
| setMaximumDecimalPlaces |
| setMaximumDecimalPlaces(maximumDecimalPlaces: integer): void

Sets the maximum number of decimal places.

Parameters

| | | |
| --- | --- | --- |
| maximumDecimalPlaces: | integer | | |

| | | |
| --- | --- | --- |
| setMinimumDecimalPlaces |
| setMinimumDecimalPlaces(minimumDecimalPlaces: integer): void

Sets the minimum number of decimal places.

Parameters

| | | |
| --- | --- | --- |
| minimumDecimalPlaces: | integer | | |

| | | |
| --- | --- | --- |
| setScalingFactor |
| setScalingFactor(factor: number): void

Sets the scaling factor. If the scaling factor is 0 or 1, then the number isn't scaled.

Parameters

| | | |
| --- | --- | --- |
| factor: | number | | |

| | | |
| --- | --- | --- |
| setScalingText |
| setScalingText(text: string): void

Sets the scaling text.

Parameters

| | | |
| --- | --- | --- |
| text: | string | | |

| | | |
| --- | --- | --- |
| setSignDisplay |
| setSignDisplay(mode: NumberFormatSignDisplay): void

Specifies how signs are displayed.

Parameters

| | | |
| --- | --- | --- |
| mode: | NumberFormatSignDisplay | | |

Type Library
standard

E
\

NumberFormatDisplayUnit

Since

2020.11

Property Summary

| |
| --- |
| Name and Description |
| static Cells: NumberFormatDisplayUnit |
| static Column: NumberFormatDisplayUnit |
| static Default: NumberFormatDisplayUnit |
| static Row: NumberFormatDisplayUnit |

Property Detail

| |
| --- |
| Cells |
| staticCells: NumberFormatDisplayUnit |

| |
| --- |
| Column |
| staticColumn: NumberFormatDisplayUnit |

| |
| --- |
| Default |
| staticDefault: NumberFormatDisplayUnit |

| |
| --- |
| Row |
| staticRow: NumberFormatDisplayUnit |

Type Library
standard

E
\

NumberFormatScaleFormat

Since

2020.11

Property Summary

| |
| --- |
| Name and Description |
| static Default: NumberFormatScaleFormat |
| static Long: NumberFormatScaleFormat |
| static Short: NumberFormatScaleFormat |

Property Detail

| |
| --- |
| Default |
| staticDefault: NumberFormatScaleFormat |

| |
| --- |
| Long |
| staticLong: NumberFormatScaleFormat |

| |
| --- |
| Short |
| staticShort: NumberFormatScaleFormat |

Type Library
standard

E
\

NumberFormatScaleUnit

Since

2020.11

Property Summary

| |
| --- |
| Name and Description |
| static AutoFormatted: NumberFormatScaleUnit |
| static Billion: NumberFormatScaleUnit |
| static Default: NumberFormatScaleUnit |
| static Million: NumberFormatScaleUnit |
| static Thousand: NumberFormatScaleUnit |
| static Unformatted: NumberFormatScaleUnit |

Property Detail

| |
| --- |
| AutoFormatted |
| staticAutoFormatted: NumberFormatScaleUnit |

| |
| --- |
| Billion |
| staticBillion: NumberFormatScaleUnit |

| |
| --- |
| Default |
| staticDefault: NumberFormatScaleUnit |

| |
| --- |
| Million |
| staticMillion: NumberFormatScaleUnit |

| |
| --- |
| Thousand |
| staticThousand: NumberFormatScaleUnit |

| |
| --- |
| Unformatted |
| staticUnformatted: NumberFormatScaleUnit |

Type Library
standard

E
\

NumberFormatSignDisplay

Since

2019.5

Last Update

2020.11

Property Summary

| |
| --- |
| Name and Description |
| static Default: NumberFormatSignDisplay A default format is applied to positive and negative numbers. |
| static MinusAsParentheses: NumberFormatSignDisplay Negative numbers are nested in parentheses (()). |
| static MinusAsPrefix: NumberFormatSignDisplay Negative numbers are prefixed with a minus sign (-). |
| static PlusMinusAsPrefix: NumberFormatSignDisplay Positive numbers are prefixed with a plus sign (+), negative numbers are prefixed with a minus sign (-). |

Property Detail

| |
| --- |
| Default |
| staticDefault: NumberFormatSignDisplay A default format is applied to positive and negative numbers. Since 2020.11 |

| |
| --- |
| MinusAsParentheses |
| staticMinusAsParentheses: NumberFormatSignDisplay Negative numbers are nested in parentheses (()). |

| |
| --- |
| MinusAsPrefix |
| staticMinusAsPrefix: NumberFormatSignDisplay Negative numbers are prefixed with a minus sign (-). |

| |
| --- |
| PlusMinusAsPrefix |
| staticPlusMinusAsPrefix: NumberFormatSignDisplay Positive numbers are prefixed with a plus sign (+), negative numbers are prefixed with a minus sign (-). |

Type Library
oDataService

C
\

PageDateLocation

Since

2019.19

Property Summary

| |
| --- |
| Name and Description |
| static Appendix: PageDateLocation |
| static Header: PageDateLocation |
| static HeaderAndAppendix: PageDateLocation |
| static None: PageDateLocation |

Property Detail

| |
| --- |
| Appendix |
| staticAppendix: PageDateLocation |

| |
| --- |
| Header |
| staticHeader: PageDateLocation |

| |
| --- |
| HeaderAndAppendix |
| staticHeaderAndAppendix: PageDateLocation |

| |
| --- |
| None |
| staticNone: PageDateLocation |

Type Library
exportpdf

E
\

PageNumberLocation

Since

2019.19

Last Update

2023.7

Property Summary

| |
| --- |
| Name and Description |
| static Footer: PageNumberLocation |
| static Header: PageNumberLocation |
| static HeaderAndFooter: PageNumberLocation |
| static None: PageNumberLocation |

Property Detail

| |
| --- |
| Footer |
| staticFooter: PageNumberLocation |

| |
| --- |
| Header |
| staticHeader: PageNumberLocation |

| |
| --- |
| HeaderAndFooter |
| staticHeaderAndFooter: PageNumberLocation Since 2023.7 |

| |
| --- |
| None |
| staticNone: PageNumberLocation |

Type Library
exportpdf

E
\

PageOrientation

Since

2019.19

Property Summary

| |
| --- |
| Name and Description |
| static Landscape: PageOrientation |
| static Portrait: PageOrientation |

Property Detail

| |
| --- |
| Landscape |
| staticLandscape: PageOrientation |

| |
| --- |
| Portrait |
| staticPortrait: PageOrientation |

Type Library
exportpdf

E
\

PageSize

Since

2019.19

Property Summary

| |
| --- |
| Name and Description |
| static A2: PageSize |
| static A3: PageSize |
| static A4: PageSize |
| static A5: PageSize |
| static Auto: PageSize |
| static Legal: PageSize |
| static Letter: PageSize |

Property Detail

| |
| --- |
| A2 |
| staticA2: PageSize |

| |
| --- |
| A3 |
| staticA3: PageSize |

| |
| --- |
| A4 |
| staticA4: PageSize |

| |
| --- |
| A5 |
| staticA5: PageSize |

| |
| --- |
| Auto |
| staticAuto: PageSize |

| |
| --- |
| Legal |
| staticLegal: PageSize |

| |
| --- |
| Letter |
| staticLetter: PageSize |

Type Library
containers

C
\

PauseMode

A set of values to describe the pause mode. For more information about the different modes, see the chapter "Using Pause Refresh APIs" in SAP Analytics Cloud Help.

Since

2021.18

Property Summary

| |
| --- |
| Name and Description |
| static Auto: PauseMode Pause data refresh is automatically turned on for invisible widgets. |
| static Off: PauseMode Pause data refresh is turned off. |
| static On: PauseMode Pause data refresh is turned on. |

Property Detail

| |
| --- |
| Auto |
| staticAuto: PauseMode Pause data refresh is automatically turned on for invisible widgets. For example, result set-related methods return the latest result set. Some specific restrictions apply for this value for tables. |

| |
| --- |
| Off |
| staticOff: PauseMode Pause data refresh is turned off. |

| |
| --- |
| On |
| staticOn: PauseMode Pause data refresh is turned on. Any operations resulting in a data refresh are paused. |

Type Library
planning

C
\

PostMessageReceiver

Since

2019.1

Property Summary

| |
| --- |
| Name and Description |
| static Parent: PostMessageReceiver |
| static Top: PostMessageReceiver |

Property Detail

| |
| --- |
| Parent |
| staticParent: PostMessageReceiver |

| |
| --- |
| Top |
| staticTop: PostMessageReceiver |

Type Library
planning

E
\

PrivatePublishConflict

Since

2023.15

Property Summary

| |
| --- |
| Name and Description |
| static PublishWithoutWarning: PrivatePublishConflict Publishes the version without showing the conflict warning dialog, and the user's changes in conflict with the other's will be lost. |
| static ShowWarning: PrivatePublishConflict Shows the warning dialog for the user to handle conflicting changes. |

Property Detail

| |
| --- |
| PublishWithoutWarning |
| staticPublishWithoutWarning: PrivatePublishConflict Publishes the version without showing the conflict warning dialog, and the user's changes in conflict with the other's will be lost. |

| |
| --- |
| ShowWarning |
| staticShowWarning: PrivatePublishConflict Shows the warning dialog for the user to handle conflicting changes. |

Type Library
planning

C
\

PublicPublishConflict

Since

2023.15

Property Summary

| |
| --- |
| Name and Description |
| static PublishWithoutWarning: PublicPublishConflict Publishes the version without showing the conflict warning dialog, and the user's changes in conflict with the other's will be lost. |
| static RevertWithoutWarning: PublicPublishConflict Reverts the version without showing the conflict warning dialog. |
| static ShowWarning: PublicPublishConflict Shows the warning dialog for the user to handle conflicting changes. |

Property Detail

| |
| --- |
| PublishWithoutWarning |
| staticPublishWithoutWarning: PublicPublishConflict Publishes the version without showing the conflict warning dialog, and the user's changes in conflict with the other's will be lost. |

| |
| --- |
| RevertWithoutWarning |
| staticRevertWithoutWarning: PublicPublishConflict Reverts the version without showing the conflict warning dialog. |

| |
| --- |
| ShowWarning |
| staticShowWarning: PublicPublishConflict Shows the warning dialog for the user to handle conflicting changes. |

Type Library
planning

C
\

Range

Since

2019.7

Method Summary

| |
| --- |
| Name and Description |
| static create(startValue: number, endValue: number): Range Creates a range with a start and an end value. |
| getEndValue(): number Returns the end value of the range. |
| getStartValue(): number Returns the start value of the range. |
| setEndValue(value: number): void Sets the end value of the range. |
| setStartValue(value: number): void Sets the start value of the range. |

Method Detail

| | | |
| --- | --- | --- |
| create |
| staticcreate(startValue: number, endValue: number): Range

Creates a range with a start and an end value.

Parameters

| | | |
| --- | --- | --- |
| startValue: | number | |
| endValue: | number | |

Returns

Range |

| |
| --- |
| getEndValue |
| getEndValue(): number Returns the end value of the range. Returns number |

| |
| --- |
| getStartValue |
| getStartValue(): number Returns the start value of the range. Returns number |

| | | |
| --- | --- | --- |
| setEndValue |
| setEndValue(value: number): void

Sets the end value of the range.

Parameters

| | | |
| --- | --- | --- |
| value: | number | | |

| | | |
| --- | --- | --- |
| setStartValue |
| setStartValue(value: number): void

Sets the start value of the range.

Parameters

| | | |
| --- | --- | --- |
| value: | number | | |

Type Library
datasource

C
\

RangeVariableValue

extends VariableValue, can be passed as a JSON object to method arguments

Since

2019.22

Property Summary

| |
| --- |
| Name and Description |
| exclude: boolean Indicates whether to exclude the variable values. |
| from: string Start variable value of a range |
| greater: string Variable value specifying a range of variable values greater than this variable value |
| greaterOrEqual: string Variable value specifying a range of variable values greater or equal than this variable value |
| less: string Variable value specifying a range of variable values less than this variable value |
| lessOrEqual: string Variable value specifying a range of variable values less or equal than this variable value |
| to: string End variable value of a range |

| |
| --- |
| Inherited from VariableValue |
| type |

Property Detail

| |
| --- |
| exclude |
| exclude: boolean Indicates whether to exclude the variable values. |

| |
| --- |
| from |
| from: string Start variable value of a range |

| |
| --- |
| greater |
| greater: string Variable value specifying a range of variable values greater than this variable value |

| |
| --- |
| greaterOrEqual |
| greaterOrEqual: string Variable value specifying a range of variable values greater or equal than this variable value |

| |
| --- |
| less |
| less: string Variable value specifying a range of variable values less than this variable value |

| |
| --- |
| lessOrEqual |
| lessOrEqual: string Variable value specifying a range of variable values less or equal than this variable value |

| |
| --- |
| to |
| to: string End variable value of a range |

Type Library
datasource

E
\

RankOrder

A set of values describing the rank order

Since

2021.12

Property Summary

| |
| --- |
| Name and Description |
| static Bottom: RankOrder Ascending order of ranking (lowest first) |
| static Top: RankOrder Descending order of ranking (highest first) |

Property Detail

| |
| --- |
| Bottom |
| staticBottom: RankOrder Ascending order of ranking (lowest first) |

| |
| --- |
| Top |
| staticTop: RankOrder Descending order of ranking (highest first) |

Type Library
advanced-controls

C
\

REnvironmentValues

Method Summary

| |
| --- |
| Name and Description |
| getNumber(key: string): number Returns the number value of an R code variable. |

Method Detail

| | | |
| --- | --- | --- |
| getNumber |
| getNumber(key: string): number

Returns the number value of an R code variable. The variable is specified by its name.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |

Returns

number |

Type Library
datasource

C
\

ResultSet

is an object< DataContext >

A result set consists of property-value pairs. The property is a dimension name. The value contains information about the member or measure. You can get an array of result sets with DataSource.getResultSet(). For example, a return value of Chart_1.getDataSource().getResultSet() is [{"@MeasureDimension": {"id": "[Account_BestRunJ_sold].[parentId].&[Gross_Margin]", "description": "Gross Margin", "formattedValue": "48971999.74", "rawValue": "48971999.74"}, "Location_4nm2e04531": {"id": "[Location_4nm2e04531].[State_47acc246_4m5x6u3k6s].&[CT1]", "description": "California"}, "Smart Group": {"id": "Predictive Clustering Group 1", "description": "Predictive Clustering Group 1"}}]. The value of "@MeasureDimension" contains the data context for the measure. "Location_4nm2e04531" is the dimension metadata ID. "Smart Group" is a special member for Bubble and Scatter charts using Smart Grouping. If a data point of a chart or a data cell of a table has no value, then it isn't returned in the array.

Since

2019.20

Type Library
advanced-controls

C
\

RInputParameters

Method Summary

| |
| --- |
| Name and Description |
| getNumber(key: string): number Returns the value of an input parameter that is a number. |
| getNumberArray(key: string): number[] Returns the value of an input parameter that is a number array. |
| getString(key: string): string Returns the value of an input parameter that is a string. |
| getStringArray(key: string): string[] Returns the value of an input parameter that is a string array. |
| setNumber(key: string, param: number): void Sets the value of an input parameter. |
| setNumberArray(key: string, params: number[]): void Sets the value of an input parameter. |
| setString(key: string, param: string): void Sets the value of an input parameter. |
| setStringArray(key: string, params: string[]): void Sets the value of an input parameter. |

Method Detail

| | | |
| --- | --- | --- |
| getNumber |
| getNumber(key: string): number

Returns the value of an input parameter that is a number. If the input parameter doesn't exist or the type is invalid, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |

Returns

number |

| | | |
| --- | --- | --- |
| getNumberArray |
| getNumberArray(key: string): number[]

Returns the value of an input parameter that is a number array. If the input parameter doesn't exist or the type is invalid, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |

Returns

number[] |

| | | |
| --- | --- | --- |
| getString |
| getString(key: string): string

Returns the value of an input parameter that is a string. If the input parameter doesn't exist or the type is invalid, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |

Returns

string |

| | | |
| --- | --- | --- |
| getStringArray |
| getStringArray(key: string): string[]

Returns the value of an input parameter that is a string array. If the input parameter doesn't exist or the type is invalid, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |

Returns

string[] |

| | | |
| --- | --- | --- |
| setNumber |
| setNumber(key: string, param: number): void

Sets the value of an input parameter. This overwrites any previous value of the input parameter, regardless of its type.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |
| param: | number | | |

| | | |
| --- | --- | --- |
| setNumberArray |
| setNumberArray(key: string, params: number[]): void

Sets the value of an input parameter. This overwrites any previous value of the input parameter, regardless of its type.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |
| params: | number[] | | |

| | | |
| --- | --- | --- |
| setString |
| setString(key: string, param: string): void

Sets the value of an input parameter. This overwrites any previous value of the input parameter, regardless of its type.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |
| param: | string | | |

| | | |
| --- | --- | --- |
| setStringArray |
| setStringArray(key: string, params: string[]): void

Sets the value of an input parameter. This overwrites any previous value of the input parameter, regardless of its type.

Parameters

| | | |
| --- | --- | --- |
| key: | string | |
| params: | string[] | | |

Type Library
visualization-controls

C
\

ShapeStyle

can be passed as a JSON object to method arguments

Since

2020.9

Property Summary

| |
| --- |
| Name and Description |
| fillColor: string Fill color of the shape |
| lineColor: string Line color of the shape |

Property Detail

| |
| --- |
| fillColor |
| fillColor: string Fill color of the shape |

| |
| --- |
| lineColor |
| lineColor: string Line color of the shape |

Type Library
datasource

C
\

SingleVariableValue

extends VariableValue, can be passed as a JSON object to method arguments

Since

2019.22

Property Summary

| |
| --- |
| Name and Description |
| exclude: boolean Indicates whether to exclude the variable value. |
| value: string Variable value |

| |
| --- |
| Inherited from VariableValue |
| type |

Property Detail

| |
| --- |
| exclude |
| exclude: boolean Indicates whether to exclude the variable value. |

| |
| --- |
| value |
| value: string Variable value |

Type Library
input-controls

C
\

SmartGrouping

Last Update

2021.6

Method Summary

| |
| --- |
| Name and Description |
| setGroupLabel(label: string): void Sets the group prefix label. |
| setNumberOfGroups(number: integer): void Sets the group number. |
| setTooltipFeedsIncluded(included: boolean): void Includes or excludes the tooltip feeds. |
| setTooltipMeasureIncluded(included: boolean): void Deprecated This method is deprecated, use setTooltipFeedsIncluded() instead. |
| setVisible(visible: boolean): void Enables or disables Smart Grouping. |

Method Detail

| | | |
| --- | --- | --- |
| setGroupLabel |
| setGroupLabel(label: string): void

Sets the group prefix label.

Parameters

| | | |
| --- | --- | --- |
| label: | string | | |

| | | |
| --- | --- | --- |
| setNumberOfGroups |
| setNumberOfGroups(number: integer): void

Sets the group number. If the number is invalid, then it is set to the min-max value of the valid range.

Parameters

| | | |
| --- | --- | --- |
| number: | integer | | |

| | | |
| --- | --- | --- |
| setTooltipFeedsIncluded |
| setTooltipFeedsIncluded(included: boolean): void

Includes or excludes the tooltip feeds.

Parameters

| | | |
| --- | --- | --- |
| included: | boolean | |

Since

2021.6 |

| | | |
| --- | --- | --- |
| setTooltipMeasureIncluded |
| setTooltipMeasureIncluded(included: boolean): void

Deprecated This method is deprecated, use setTooltipFeedsIncluded() instead. Includes or excludes the tooltip measure.

Parameters

| | | |
| --- | --- | --- |
| included: | boolean | |

Deprecated

2021.6 |

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

Enables or disables Smart Grouping.

Parameters

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

Type Library
datasource

E
\

StringUtils

Method Summary

| |
| --- |
| Name and Description |
| static replaceAll(value: string, searchFor: string, replaceWith: string): string Replaces all occurrences of the searchFor string with the replaceWith string. |

Method Detail

| | | |
| --- | --- | --- |
| replaceAll |
| staticreplaceAll(value: string, searchFor: string, replaceWith: string): string

Replaces all occurrences of the searchFor string with the replaceWith string.

Parameters

| | | |
| --- | --- | --- |
| value: | string | |
| searchFor: | string | |
| replaceWith: | string | |

Returns

string |

Type Library
input-controls

C
\

TabStrip

extends Widget

Since

2019.16

Last Update

2020.7

Method Summary

| |
| --- |
| Name and Description |
| getSelectedKey(): string Returns the key of the selected tab of the tab strip. |
| getTab(tabKey: string): Tab Returns a tab of the tab strip. |
| hideBusyIndicator(): void Hides the busy indicator. |
| moveWidget(tabName: string, widget: Widget): void Moves the widget into the specified tab of the tab strip. |
| setSelectedKey(tabKey: string): void Selects a tab. |
| showBusyIndicator(text?: string): void Shows the busy indicator. |

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

Event Summary

| |
| --- |
| Name and Description |
| onSelect(): void Called when the user selects a tab. |

Method Detail

| |
| --- |
| getSelectedKey |
| getSelectedKey(): string Returns the key of the selected tab of the tab strip. Returns string |

| | | |
| --- | --- | --- |
| getTab |
| getTab(tabKey: string): Tab

Returns a tab of the tab strip. The tab is specified by the key of the tab. If the tab doesn't exist, then undefined is returned.

Parameters

| | | |
| --- | --- | --- |
| tabKey: | string | |

Returns

Tab |

| |
| --- |
| hideBusyIndicator |
| hideBusyIndicator(): void Hides the busy indicator. Since 2020.1 |

| | | |
| --- | --- | --- |
| moveWidget |
| moveWidget(tabName: string, widget: Widget): void

Moves the widget into the specified tab of the tab strip.

Parameters

| | | |
| --- | --- | --- |
| tabName: | string | |
| widget: | Widget | |

Since

2020.7 |

| | | |
| --- | --- | --- |
| setSelectedKey |
| setSelectedKey(tabKey: string): void

Selects a tab. The tab is specified by the key of the tab. The selected tab is the visible tab of the tab strip. If the tab doesn't exist, then this operation is ignored.

Parameters

| | | |
| --- | --- | --- |
| tabKey: | string | | |

| | | |
| --- | --- | --- |
| showBusyIndicator |
| showBusyIndicator(text?: string): void

Shows the busy indicator.

Parameters

| | | |
| --- | --- | --- |
| textOptional: | string | |

Since

2020.1 |

Event Detail

| |
| --- |
| onSelect |
| onSelect(): void Called when the user selects a tab. |

Type Library
standard

C
\

TextStyle

can be passed as a JSON object to method arguments

Since

2020.9

Property Summary

| |
| --- |
| Name and Description |
| backgroundColor: string Background color of the text |
| color: string Font color of the text |

Property Detail

| |
| --- |
| backgroundColor |
| backgroundColor: string Background color of the text |

| |
| --- |
| color |
| color: string Font color of the text |

Type Library
timer

C
\

UrlType

Last Update

2022.1

Property Summary

| |
| --- |
| Name and Description |
| static External: UrlType A hyperlink to an external URL is added. |
| static Mobile: UrlType A hyperlink to an mobile URL is added. |
| static None: UrlType No hyperlink is added. |

Property Detail

| |
| --- |
| External |
| staticExternal: UrlType A hyperlink to an external URL is added. |

| |
| --- |
| Mobile |
| staticMobile: UrlType A hyperlink to an mobile URL is added. Since 2022.1 |

| |
| --- |
| None |
| staticNone: UrlType No hyperlink is added. |

Type Library
standard

C
\

UserType

Since

2020.9

Property Summary

| |
| --- |
| Name and Description |
| static Team: UserType Indicates a team. |
| static User: UserType Indicates a single user. |

Property Detail

| |
| --- |
| Team |
| staticTeam: UserType Indicates a team. |

| |
| --- |
| User |
| staticUser: UserType Indicates a single user. |

Type Library
value-driver-tree

C
\

VariableValue

can be passed as a JSON object to method arguments

Direct Subclasses

MultipleVariableValue, RangeVariableValue, SingleVariableValue

Since

2019.22

Last Update

2020.13

Property Summary

| |
| --- |
| Name and Description |
| type: VariableValueType Type of the variable value |

Property Detail

| |
| --- |
| type |
| type: VariableValueType Type of the variable value Since 2020.13 |

Type Library
datasource

E
\

VariableValueType

Since

2020.13

Property Summary

| |
| --- |
| Name and Description |
| static Multiple: VariableValueType An object representing multiple variable values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
| static Range: VariableValueType An object representing a range of dimension members, like: {<operator>: '<memberId>'} or {<operator>: '<memberId>', exclude: true}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
| static Single: VariableValueType An object representing a single variable value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |

Property Detail

| |
| --- |
| Multiple |
| staticMultiple: VariableValueType An object representing multiple variable values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |

| |
| --- |
| Range |
| staticRange: VariableValueType An object representing a range of dimension members, like: {<operator>: '<memberId>'} or {<operator>: '<memberId>', exclude: true}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |

| |
| --- |
| Single |
| staticSingle: VariableValueType An object representing a single variable value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |

Type Library
visualization-controls

C
\

/sap-sac-scripting

referencesose-api-types-enums.md

OSE API: Types & Enums

Classes in This File

Third-party checks

Provenance

Capability

/sap-sac-scripting