skilld
All skills
secondsky avatar

/sap-sac-scripting

@620a19a
by Eddiesecondsky/sap-skills456 stars
120

Comprehensive SAC scripting skill for SAP Analytics Cloud Analytics Designer and Optimized Story Experience. This skill should be used when the user asks to "create SAC script", "debug Analytics Designer", "optimize SAC performance", "planning operations in SAC", "filter data in SAC", "use DataSource API", "chart scripting", "table manipulation", "SAC event handlers", "version management", "data locking", "Optimized Story Experience API", "OSE scripting", "OSE widget API", "OSE DataSource", "story scripting API", "OSE planning API", "OSE method", "optimized story", "SAC story scripting", "story script", "SAC scripting", "debug SAC runtime in Microsoft Edge via CDP", or works with SAC widgets, planning models, or analytics applications.

Ask your Agent

Use this Skill: https://skilld.dev/gh/secondsky/sap-skills/sap-sac-scripting

This session only. Nothing lands on disk.

referencesose-api-application-core.md

≈25k tokens on demand. Your agent reads this file only when SKILL.md points to it.

OSE API: Application & Core

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

Core application classes for Optimized Story Experience: Application lifecycle, page management, panels, popups, and widget base types.

Classes in This File

<a name="application"></a>

Application

Since

2019.1

Last Update

2023.13

Method Summary
Name and Description
getActivePage(): ApplicationPage<br>Get the active page.
getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the canvas of the first page.
getFileDataSource(modelId: string): FileDataSource<br>Returns the data source of related modelId.
getGlobalCssClass(): string<br>Returns the global default Cascading Style Sheet (CSS) class name.
getInfo(): ApplicationInfo<br>Returns information about the analytic application.
getInnerHeight(): LayoutValue<br>Get InnerHeight of first page.
getInnerWidth(): LayoutValue<br>Get InnerWidth of first page.
getMode(): ApplicationMode<br>Returns the mode in which the analytic application is displayed.
getRolesInfo(): string[]<br>Returns role information about the current user.
getTeamsInfo(): TeamInfo[]<br>Returns team information about the current user.
getTheme(): string<br>Returns the theme ID of the analytic application.
getUserInfo(): UserInfo<br>Returns information about the current user.
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type><br>Returns an array of widgets described by the widget search options.
hideBusyIndicator(): void<br>Hides the busy indicator.
isCommentModeEnabled(): boolean<br>Returns whether the comment mode is enabled.
isMobile(): boolean<br>Returns whether the analytic application is in mobile mode.
moveWidget(widget: Widget): void<br>Moves the widget into the first page canvas.
openShareApplicationDialog(): void<br>Opens the Share Application dialog for the currently opened analytic application.
postMessage(receiver: PostMessageReceiver, message: string, targetOrigin: string): void<br>Posts a message to the parent window or the top-level window.
refreshData(dataSources?: DataSource[]): void<br>Triggers data refresh.
sendNotification(notification: NotificationOptions JSON): boolean<br>Sends a notification.
setActivePage(page: ApplicationPage | string | integer): void<br>Switch page.
setAutomaticBusyIndicatorEnabled(enabled: boolean): void<br>Enables or disables the automatic busy indicator.
setCommentModeEnabled(isEnabled: boolean): void<br>Enables or disables the comment mode.
setCssClass(className: string): void<br>Sets the Cascading Style Sheet (CSS) class name of the canvas of the first page.
setCurrentDateTime(currentDateTime: CurrentDateTime): void<br>Sets current date/time.
setGlobalCssClass(className: string): void<br>Sets the global default Cascading Style Sheet (CSS) class name.
setMessageTypesToShow(messageTypes: ApplicationMessageType[]): void<br>Specifies which messages are shown, depending on their message type.
setPageVisible(page: ApplicationPage | string | integer, visible: boolean): void<br>Set the page visible or not.
setRefreshPaused(dataSources: DataSource[], paused: boolean): void<br>Enables or disables the pause of the data refresh and at the same time updates the widgets associated with the data sources when the pause of data refresh is disabled.
setTheme(themeId?: string): void<br>Applies a theme to the analytic application.
showBusyIndicator(text?: string): void<br>Shows the busy indicator.
showMessage(messageType: ApplicationMessageType, message: string): void<br>Shows a message.

Event Summary
Name and Description
onInitialization(): void<br>Called when the analytic application has finished loading.
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void<br>Called when the user changes the orientation of the mobile device.
onPostMessageReceived(message: string, origin: string): void<br>Called when the analytic application receives a message from the hosting page or an embedded page.
onResize(): void<br>Called when the user resizes the browser window.
onShake(): void<br>Called when the user shakes the mobile device.

Method Detail
getActivePage
getActivePage(): ApplicationPage<br>Get the active page.<br>Returns<br>ApplicationPage<br>Since<br>2023.3
getCssClass
getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the canvas of the first page.<br>Returns<br>string<br>Since<br>2020.20
getFileDataSource
getFileDataSource(modelId: string): FileDataSource

Returns the data source of related modelId.

Parameters
modelId: string

Returns

FileDataSource

Since

2023.13 |
getGlobalCssClass
getGlobalCssClass(): string<br>Returns the global default Cascading Style Sheet (CSS) class name.<br>Returns<br>string<br>Since<br>2021.2
getInfo
getInfo(): ApplicationInfo<br>Returns information about the analytic application.<br>Returns<br>ApplicationInfo<br>Since<br>2020.9
getInnerHeight
getInnerHeight(): LayoutValue<br>Get InnerHeight of first page. If the canvas size is fixed, then the height of the canvas is returned. If the canvas size is dynamic, then the height of the viewport (the visible area of the window) is returned.<br>Returns<br>LayoutValue<br>Since<br>2019.14
getInnerWidth
getInnerWidth(): LayoutValue<br>Get InnerWidth of first page. If the canvas size is fixed, then the width of the canvas is returned. If the canvas size is dynamic, then the width of the viewport (the visible area of the window) is returned.<br>Returns<br>LayoutValue<br>Since<br>2019.14
getMode
getMode(): ApplicationMode<br>Returns the mode in which the analytic application is displayed.<br>Returns<br>ApplicationMode<br>Since<br>2020.11
getRolesInfo
getRolesInfo(): string[]<br>Returns role information about the current user.<br>Returns<br>string[]<br>Since<br>2023.13
getTeamsInfo
getTeamsInfo(): TeamInfo[]<br>Returns team information about the current user.<br>Returns<br>TeamInfo[]<br>Since<br>2023.13
getTheme
getTheme(): string<br>Returns the theme ID of the analytic application. If the default theme has been applied, then the value represented by Alias.DefaultTheme is returned.<br>Returns<br>string<br>Since<br>2020.13
getUserInfo
getUserInfo(): UserInfo<br>Returns information about the current user.<br>Returns<br>UserInfo<br>Since<br>2019.5
getWidgets
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>

Returns an array of widgets described by the widget search options. Just Including widgets from first page.

Parameters
widgetSearchOptions: WidgetSearchOptions

Returns

<type of type>

Since

2021.23 |
hideBusyIndicator
hideBusyIndicator(): void<br>Hides the busy indicator.<br>Since<br>2020.1
isCommentModeEnabled
isCommentModeEnabled(): boolean<br>Returns whether the comment mode is enabled.<br>Returns<br>boolean<br>Since<br>2019.18
isMobile
isMobile(): boolean<br>Returns whether the analytic application is in mobile mode. If the analytic application is displayed on a mobile device, for example, on a smartphone or on a tablet, then true is returned, and false if it isn't. Note: The returned value may not be accurate for specific devices. For example, for some versions of Microsoft Surface Book false is returned. Note: If the analytic application was requested as a desktop website by a Safari browser on iOS, then false is returned.<br>Returns<br>boolean<br>Since<br>2020.3
moveWidget
moveWidget(widget: Widget): void

Moves the widget into the first page canvas.

Parameters
widget: Widget

Since

2020.7 |
openShareApplicationDialog
openShareApplicationDialog(): void<br>Opens the Share Application dialog for the currently opened analytic application.<br>Mobile Support<br>Not supported on mobile devices.<br>Since<br>2021.11
postMessage
postMessage(receiver: PostMessageReceiver, message: string, targetOrigin: string): void

Posts a message to the parent window or the top-level window.

Parameters
receiver: PostMessageReceiver
message: string
targetOrigin: string

Since

2019.2 |
refreshData
refreshData(dataSources?: DataSource[]): void

Triggers data refresh. The script is fully executed without waiting for all the associated widgets to be updated. If no data sources are specified, then all widgets bound to data sources are refreshed. If data source is specified, then only associated charts or tables are refreshed.

Parameters
dataSourcesOptional: DataSource[]

Since

2019.3

Last Update

2020.1 |
sendNotification
sendNotification(notification: NotificationOptions JSON): boolean

Sends a notification. Notifications can be messages and emails. Note: To send a notification, you need the "Runtime Notification" privilege. For more information about how to assign permissions and privileges, see the chapter "Permissions" in SAP Analytics Cloud Help.

Parameters
notification: NotificationOptions JSON

Returns

boolean

Since

2020.7 |
setActivePage
setActivePage(page: ApplicationPage | string | integer): void

Switch page.

Parameters
page: ApplicationPage | string | integer

Since

2023.3 |
setAutomaticBusyIndicatorEnabled
setAutomaticBusyIndicatorEnabled(enabled: boolean): void

Enables or disables the automatic busy indicator. If the automatic busy indicator is enabled, then it appears automatically when necessary.

Parameters
enabled: boolean

Since

2020.1 |
setCommentModeEnabled
setCommentModeEnabled(isEnabled: boolean): void

Enables or disables the comment mode.

Parameters
isEnabled: boolean

Since

2019.18 |
setCssClass
setCssClass(className: string): void

Sets the Cascading Style Sheet (CSS) class name of the canvas of the first page.

Parameters
className: string

Since

2020.20 |
setCurrentDateTime
setCurrentDateTime(currentDateTime: CurrentDateTime): void

Sets current date/time.

Parameters
currentDateTime: CurrentDateTime

Since

2023.13 |
setGlobalCssClass
setGlobalCssClass(className: string): void

Sets the global default Cascading Style Sheet (CSS) class name.

Parameters
className: string

Since

2021.2 |
setMessageTypesToShow
setMessageTypesToShow(messageTypes: ApplicationMessageType[]): void

Specifies which messages are shown, depending on their message type. By default, messages of all message types are shown. If you specify an empty array, then no message is shown.

Parameters
messageTypes: ApplicationMessageType[]

Since

2020.10 |
setPageVisible
setPageVisible(page: ApplicationPage | string | integer, visible: boolean): void

Set the page visible or not.

Parameters
page: ApplicationPage | string | integer
visible: boolean

Since

2023.3 |
setRefreshPaused
setRefreshPaused(dataSources: DataSource[], paused: boolean): void

Enables or disables the pause of the data refresh and at the same time updates the widgets associated with the data sources when the pause of data refresh is disabled.

Parameters
dataSources: DataSource[]
paused: boolean

Since

2021.2 |
setTheme
setTheme(themeId?: string): void

Applies a theme to the analytic application. The theme is specified by a theme ID or by selecting a theme from the Files repository. If no theme ID is specified, then the default theme is applied.

Parameters
themeIdOptional: string

Since

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

Shows the busy indicator.

Parameters
textOptional: string

Since

2020.1 |
showMessage
showMessage(messageType: ApplicationMessageType, message: string): void

Shows a message.

Parameters
messageType: ApplicationMessageType
message: string

Since

2020.10 |

Event Detail
onInitialization
onInitialization(): void<br>Called when the analytic application has finished loading.
onOrientationChange
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void

Called when the user changes the orientation of the mobile device.

Parameters
angle: DeviceOrientation
previousAngle: DeviceOrientation

Since

2020.13

Last Update

2020.15 |
onPostMessageReceived
onPostMessageReceived(message: string, origin: string): void

Called when the analytic application receives a message from the hosting page or an embedded page. Note: Always check the origin when receiving a message. A malicious site can change the location of the window and intercept the data you sent using the post message without your knowledge.

Parameters
message: string
origin: string
onResize
onResize(): void<br>Called when the user resizes the browser window. Note: This method is called in intervals of 500 milliseconds while the window is resized.<br>Since<br>2019.14
onShake
onShake(): void<br>Called when the user shakes the mobile device. Note: This method is called every two seconds during shaking.<br>Since<br>2020.13

Type Library standard

C

<a name="applicationinfo"></a>

ApplicationInfo

Since

2020.9

Property Summary
Name and Description
description: string
id: string
name: string

Property Detail
description
description: string
id
id: string
name
name: string

Type Library standard

E

<a name="applicationmessagetype"></a>

ApplicationMessageType

Since

2020.10

Property Summary
Name and Description
static Error: ApplicationMessageType<br>Error message
static Info: ApplicationMessageType<br>Information message
static Success: ApplicationMessageType<br>Success message
static Warning: ApplicationMessageType<br>Warning message

Property Detail
Error
staticError: ApplicationMessageType<br>Error message
Info
staticInfo: ApplicationMessageType<br>Information message
Success
staticSuccess: ApplicationMessageType<br>Success message
Warning
staticWarning: ApplicationMessageType<br>Warning message

Type Library standard

E

<a name="applicationmode"></a>

ApplicationMode

Since

2020.7

Property Summary
Name and Description
static Embed: ApplicationMode<br>The analytic application is displayed in embed mode.
static Present: ApplicationMode<br>The analytic application is displayed in present mode.
static View: ApplicationMode<br>The analytic application is displayed in view mode.

Property Detail
Embed
staticEmbed: ApplicationMode<br>The analytic application is displayed in embed mode.
Present
staticPresent: ApplicationMode<br>The analytic application is displayed in present mode.
View
staticView: ApplicationMode<br>The analytic application is displayed in view mode.

C

<a name="applicationpage"></a>

ApplicationPage

Since

2022.5

Last Update

2024.14

Method Summary
Name and Description
getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the page.
getInnerHeight(): LayoutValue<br>If the page size is fixed, then the height of the page is returned.
getInnerWidth(): LayoutValue<br>If the page size is fixed, then the width of the page is returned.
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type><br>Returns an array of widgets described by the widget search options.
moveWidget(widget: Widget): void<br>Moves the widget into the page.
refreshData(dataSources?: DataSource[]): void<br>Triggers a data refresh and updates the widgets associated with the refreshed data sources.
setCssClass(className: string): void<br>Sets the Cascading Style Sheet (CSS) class name of the page.
setRefreshPaused(dataSources: DataSource[], paused: boolean): void<br>Enables or disables the pausing of the data refresh and updates the widgets associated with the data sources when their pausing of the data refresh is disabled.

Event Summary
Name and Description
onActive(): void<br>Called when the analytic application page is set to active.
onInitialization(): void<br>Called when the analytic application page has finished loading.
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void<br>Called when the user changes the orientation of the mobile device.
onPostMessageReceived(message: string, origin: string): void<br>Called when the analytic application receives a message from the hosting page or an embedded page.
onResize(): void<br>Called when the user resizes the browser window.
onShake(): void<br>Called when the user shakes the mobile device.
onStoryPopupClose(origin: string): void<br>Called after a Story Popup is Closed.

Method Detail
getCssClass
getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the page.<br>Returns<br>string<br>Since<br>2022.6
getInnerHeight
getInnerHeight(): LayoutValue<br>If the page size is fixed, then the height of the page is returned. If the page size is dynamic, then the height of the viewport (the visible area of the window) is returned.<br>Returns<br>LayoutValue<br>Since<br>2022.6
getInnerWidth
getInnerWidth(): LayoutValue<br>If the page size is fixed, then the width of the page is returned. If the page size is dynamic, then the width of the viewport (the visible area of the window) is returned.<br>Returns<br>LayoutValue<br>Since<br>2022.6
getWidgets
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>

Returns an array of widgets described by the widget search options.

Parameters
widgetSearchOptions: WidgetSearchOptions

Returns

<type of type>

Since

2022.6 |
moveWidget
moveWidget(widget: Widget): void

Moves the widget into the page.

Parameters
widget: Widget

Since

2022.6 |
refreshData
refreshData(dataSources?: DataSource[]): void

Triggers a data refresh and updates the widgets associated with the refreshed data sources. If no data sources are specified, then all are refreshed. If data sources are specified, then only those are refreshed. Note: When specifying data sources, then only those associated with charts or tables are refreshed.

Parameters
dataSourcesOptional: DataSource[]

Since

2022.8 |
setCssClass
setCssClass(className: string): void

Sets the Cascading Style Sheet (CSS) class name of the page.

Parameters
className: string

Since

2022.6 |
setRefreshPaused
setRefreshPaused(dataSources: DataSource[], paused: boolean): void

Enables or disables the pausing of the data refresh and updates the widgets associated with the data sources when their pausing of the data refresh is disabled.

Parameters
dataSources: DataSource[]
paused: boolean

Since

2022.8 |

Event Detail
onActive
onActive(): void<br>Called when the analytic application page is set to active.<br>Since<br>2023.3
onInitialization
onInitialization(): void<br>Called when the analytic application page has finished loading.<br>Since<br>2023.3
onOrientationChange
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void

Called when the user changes the orientation of the mobile device.

Parameters
angle: DeviceOrientation
previousAngle: DeviceOrientation

Since

2023.3 |
onPostMessageReceived
onPostMessageReceived(message: string, origin: string): void

Called when the analytic application receives a message from the hosting page or an embedded page. Note: Always check the origin when receiving a message. A malicious site can change the location of the window and intercept the data you sent using the post message without your knowledge.

Parameters
message: string
origin: string

Since

2023.3 |
onResize
onResize(): void<br>Called when the user resizes the browser window. Note: This method is called in intervals of 500 milliseconds while the window is resized.<br>Since<br>2023.3
onShake
onShake(): void<br>Called when the user shakes the mobile device. Note: This method is called every two seconds during shaking.<br>Since<br>2023.3
onStoryPopupClose
onStoryPopupClose(origin: string): void

Called after a Story Popup is Closed.

Parameters
origin: string

Since

2024.14 |

Type Library standard

O

Array

The JavaScript Array global object is a constructor for arrays, which are high-level, list-like objects.

Last Update

2020.8

Property Summary
Name and Description
length: integer<br>An unsigned, 32-bit integer that specifies the number of elements in an array.

Method Summary
Name and Description
static isArray(value: <any type>): boolean<br>Returns true if an object is an array and false if it isn't an array.
concat(other: <this array's type>): <this array's type><br>Returns a new array comprised of this array joined with one or more other arrays and/or values.
copyWithin(target: integer, begin: integer, end?: integer): <this array's type><br>Copies a sequence of array elements within the array to the position starting at index position target.
fill(newelt: <this array's element type>, begin?: integer, end?: integer): <this array's type><br>Fills all elements of an array at index positions begin to end (end isn't included) with a value.
includes(elt: <this array's element type>): boolean<br>Returns whether an array includes a certain element, returning true if the element is included or false if the element isn't included.
indexOf(elt: <this array's element type>, from?: integer): integer<br>Returns the first index position at which a given element is found in the array, or -1 if it isn't present.
join(separator?: string): string<br>Joins all elements of an array into a string.
keys(): <array iterator traversing this array's integer indices><br>Returns a new Array Iterator that contains the keys for each index position in the array.
lastIndexOf(elt: <this array's element type>, from?: integer): integer<br>Returns the last index position at which a given element is found in the array, or -1 if it isn't present.
pop(): <this array's element type><br>Removes the last element from an array and returns that element.
push(newelt: <this array's element type>): integer<br>Appends one element and returns the new length of the array.
reverse(): void<br>Reverses an array in place.
shift(): <this array's element type><br>Removes the first element from an array and returns that element.
slice(begin?: integer, end?: integer): <this array's type><br>Returns a shallow copy of a portion of an array from index positions begin to end (end isn't included).
sort(): void<br>Sorts the elements of an array in place and returns the array.
splice(pos: integer, amount?: integer, item?: <this array's element type>): <this array's type><br>Changes the content of an array, adding new elements while removing old elements.
unshift(newelt: <this array's element type>): integer<br>Adds one or more elements to the beginning of an array and returns the new length of the array.
values(): <array iterator traversing this array's values><br>Returns a new Array Iterator object that contains the values for each index position in the array.

Property Detail
length
length: integer<br>An unsigned, 32-bit integer that specifies the number of elements in an array.

Method Detail
isArray
staticisArray(value: <any type>): boolean

Returns true if an object is an array and false if it isn't an array.

Parameters
value: <any type>

Returns

boolean |
concat
concat(other: <this array's type>): <this array's type>

Returns a new array comprised of this array joined with one or more other arrays and/or values.

Parameters
other: <this array's type>

Returns

<this array's type> |
copyWithin
copyWithin(target: integer, begin: integer, end?: integer): <this array's type>

Copies a sequence of array elements within the array to the position starting at index position target. The copy is taken from the index positions begin to end (end isn't included).

Parameters
target: integer
begin: integer
endOptional: integer

Returns

<this array's type> |
fill
fill(newelt: <this array's element type>, begin?: integer, end?: integer): <this array's type>

Fills all elements of an array at index positions begin to end (end isn't included) with a value.

Parameters
newelt: <this array's element type>
beginOptional: integer
endOptional: integer

Returns

<this array's type> |
includes
includes(elt: <this array's element type>): boolean

Returns whether an array includes a certain element, returning true if the element is included or false if the element isn't included.

Parameters
elt: <this array's element type>

Returns

boolean |
indexOf
indexOf(elt: <this array's element type>, from?: integer): integer

Returns the first index position at which a given element is found in the array, or -1 if it isn't present. The array is searched starting at index position from.

Parameters
elt: <this array's element type>
fromOptional: integer

Returns

integer

Last Update

2020.6 |
join
join(separator?: string): string

Joins all elements of an array into a string.

Parameters
separatorOptional: string

Returns

string |
keys
keys(): <array iterator traversing this array's integer indices><br>Returns a new Array Iterator that contains the keys for each index position in the array.<br>Returns<br><array iterator traversing this array's integer indices>
lastIndexOf
lastIndexOf(elt: <this array's element type>, from?: integer): integer

Returns the last index position at which a given element is found in the array, or -1 if it isn't present. The array is searched backwards, starting at index position from.

Parameters
elt: <this array's element type>
fromOptional: integer

Returns

integer

Last Update

2020.6 |
pop
pop(): <this array's element type><br>Removes the last element from an array and returns that element.<br>Returns<br><this array's element type>
push
push(newelt: <this array's element type>): integer

Appends one element and returns the new length of the array.

Parameters
newelt: <this array's element type>

Returns

integer |
reverse
reverse(): void<br>Reverses an array in place. The first array element becomes the last and the last array element becomes the first.
shift
shift(): <this array's element type><br>Removes the first element from an array and returns that element.<br>Returns<br><this array's element type>
slice
slice(begin?: integer, end?: integer): <this array's type>

Returns a shallow copy of a portion of an array from index positions begin to end (end isn't included).

Parameters
beginOptional: integer
endOptional: integer

Returns

<this array's type> |
sort
sort(): void<br>Sorts the elements of an array in place and returns the array.
splice
splice(pos: integer, amount?: integer, item?: <this array's element type>): <this array's type>

Changes the content of an array, adding new elements while removing old elements.

Parameters
pos: integer
amountOptional: integer
itemOptional: <this array's element type>

Returns

<this array's type>

Last Update

2020.8 |
unshift
unshift(newelt: <this array's element type>): integer

Adds one or more elements to the beginning of an array and returns the new length of the array.

Parameters
newelt: <this array's element type>

Returns

integer |
values
values(): <array iterator traversing this array's values><br>Returns a new Array Iterator object that contains the values for each index position in the array.<br>Returns<br><array iterator traversing this array's values>

Type Library standard

C

<a name="pagebook"></a>

PageBook

extends Widget

Since

2020.12

Method Summary

| |
| --- |
| Name and Description |
| getPage(pageKey: string): PageBookPage<br>Returns a page of the page book. |
| getSelectedKey(): string<br>Returns the key of the selected page of the page book. |
| hideBusyIndicator(): void<br>Hides the busy indicator. |
| moveWidget(pageKey: string, widget: Widget): void<br>Moves the widget into the specified page of the page book. |
| setSelectedKey(pageKey: string): void<br>Selects a page. |
| showBusyIndicator(text?: string): void<br>Shows the busy indicator. |

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

Event Summary

| |
| --- |
| Name and Description |
| onSelect(): void<br>Called when the user selects a page. |

Method Detail

| | | |
| --- | --- | --- |
| getPage |
| getPage(pageKey: string): PageBookPage

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

Parameters

| | | |
| --- | --- | --- |
| pageKey: | string | |

Returns

PageBookPage |

| |
| --- |
| getSelectedKey |
| getSelectedKey(): string<br>Returns the key of the selected page of the page book.<br>Returns<br>string |

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

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

Moves the widget into the specified page of the page book.

Parameters

| | | |
| --- | --- | --- |
| pageKey: | string | |
| widget: | Widget | | |

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

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

Parameters

| | | |
| --- | --- | --- |
| pageKey: | string | | |

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

Shows the busy indicator.

Parameters

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

Event Detail

| |
| --- |
| onSelect |
| onSelect(): void<br>Called when the user selects a page. |

Type Library
containers

C
\

<a name="pagebookpage"></a>

PageBookPage

Since

2020.12

Method Summary

| |
| --- |
| Name and Description |
| getKey(): string<br>Returns the key of the page. |
| isVisible(): boolean<br>Returns whether the page is visible. |
| setVisible(visible: boolean): void<br>Shows or hides the page. |

Method Detail

| |
| --- |
| getKey |
| getKey(): string<br>Returns the key of the page.<br>Returns<br>string |

| |
| --- |
| isVisible |
| isVisible(): boolean<br>Returns whether the page is visible.<br>Returns<br>boolean |

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

Shows or hides the page.

Parameters

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

Type Library
exportpdf

E
\

<a name="panel"></a>

Panel

extends Widget

Since

2019.14

Last Update

2020.7

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.<br>Since<br>2020.1 |

| | | |
| --- | --- | --- |
| moveWidget |
| moveWidget(widget: Widget): void

Moves the widget into the panel.

Parameters

| | | |
| --- | --- | --- |
| widget: | Widget | |

Since

2020.7 |

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

Shows the busy indicator.

Parameters

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

Since

2020.1 |

Type Library
datasource

E
\

<a name="popup"></a>

Popup

Last Update

2024.25

Method Summary

| |
| --- |
| Name and Description |
| close(): void<br>Closes the popup. |
| getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the popup. |
| getTitle(): string<br>Returns the title of the popup. |
| hideBusyIndicator(): void<br>Hides the busy indicator. |
| isButtonEnabled(buttonId: string): boolean<br>Returns whether a specific button in the footer of the popup is enabled. |
| isButtonVisible(buttonId: string): boolean<br>Returns whether a specific button in the footer of the popup is visible. |
| open(): void<br>Opens the popup. |
| setButtonEnabled(buttonId: string, enabled: boolean): void<br>Enables or disables a specific button in the footer of the popup. |
| setButtonVisible(buttonId: string, visible: boolean): void<br>Shows or hides a specific button in the footer of the popup. |
| setCssClass(className: string): void<br>Sets the Cascading Style Sheet (CSS) class name of the popup. |
| setSize(size: PopupSizeOptions): void<br>Sets the popup size. |
| setTitle(title: string): void<br>Sets the title of the popup. |
| showBusyIndicator(text?: string): void<br>Shows the busy indicator. |

Event Summary

| |
| --- |
| Name and Description |
| onButtonClick(buttonId: string): void<br>Called when the user clicks any button in the footer of the popup. |
| onResize(width: number, height: number): void<br>Called when the popup is resized. |

Method Detail

| |
| --- |
| close |
| close(): void<br>Closes the popup. |

| |
| --- |
| getCssClass |
| getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the popup.<br>Returns<br>string<br>Since<br>2020.20 |

| |
| --- |
| getTitle |
| getTitle(): string<br>Returns the title of the popup.<br>Returns<br>string |

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

| | | |
| --- | --- | --- |
| isButtonEnabled |
| isButtonEnabled(buttonId: string): boolean

Returns whether a specific button in the footer of the popup is enabled.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |

Returns

boolean |

| | | |
| --- | --- | --- |
| isButtonVisible |
| isButtonVisible(buttonId: string): boolean

Returns whether a specific button in the footer of the popup is visible.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |

Returns

boolean |

| |
| --- |
| open |
| open(): void<br>Opens the popup. |

| | | |
| --- | --- | --- |
| setButtonEnabled |
| setButtonEnabled(buttonId: string, enabled: boolean): void

Enables or disables a specific button in the footer of the popup.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |
| enabled: | boolean | |

Last Update

2018.22 |

| | | |
| --- | --- | --- |
| setButtonVisible |
| setButtonVisible(buttonId: string, visible: boolean): void

Shows or hides a specific button in the footer of the popup.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |
| visible: | boolean | |

Last Update

2018.22 |

| | | |
| --- | --- | --- |
| setCssClass |
| setCssClass(className: string): void

Sets the Cascading Style Sheet (CSS) class name of the popup.

Parameters

| | | |
| --- | --- | --- |
| className: | string | |

Since

2020.20 |

| | | |
| --- | --- | --- |
| setSize |
| setSize(size: PopupSizeOptions): void

Sets the popup size.

Parameters

| | | |
| --- | --- | --- |
| size: | PopupSizeOptions | |

Since

2024.25 |

| | | |
| --- | --- | --- |
| setTitle |
| setTitle(title: string): void

Sets the title of the popup.

Parameters

| | | |
| --- | --- | --- |
| title: | string | | |

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

Shows the busy indicator.

Parameters

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

Since

2020.1 |

Event Detail

| | | |
| --- | --- | --- |
| onButtonClick |
| onButtonClick(buttonId: string): void

Called when the user clicks any button in the footer of the popup.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |

Since

2018.22 |

| | | |
| --- | --- | --- |
| onResize |
| onResize(width: number, height: number): void

Called when the popup is resized.

Parameters

| | | |
| --- | --- | --- |
| width: | number | |
| height: | number | |

Since

2024.25 |

C
\

<a name="popupsizeoptions"></a>

PopupSizeOptions

Since

2024.25

Property Summary

| |
| --- |
| Name and Description |
| static height: integer<br>Height |
| static heightUnit: PopupSizeUnit<br>Height Unit |
| static width: integer<br>Width |
| static widthUnit: PopupSizeUnit<br>Width Unit |

Property Detail

| |
| --- |
| height |
| staticheight: integer<br>Height |

| |
| --- |
| heightUnit |
| staticheightUnit: PopupSizeUnit<br>Height Unit |

| |
| --- |
| width |
| staticwidth: integer<br>Width |

| |
| --- |
| widthUnit |
| staticwidthUnit: PopupSizeUnit<br>Width Unit |

E
\

<a name="popupsizeunit"></a>

PopupSizeUnit

Since

2024.25

Property Summary

| |
| --- |
| Name and Description |
| static Percent: PopupSizeUnit |
| static Pixel: PopupSizeUnit |

Property Detail

| |
| --- |
| Percent |
| staticPercent: PopupSizeUnit |

| |
| --- |
| Pixel |
| staticPixel: PopupSizeUnit |

Type Library
standard

E
\

<a name="storypopup"></a>

StoryPopup

Since

2024.14

Last Update

2024.25

Method Summary

| |
| --- |
| Name and Description |
| close(): void<br>Closes the popup. |
| getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the popup. |
| getTitle(): string<br>Returns the title of the popup. |
| hideBusyIndicator(): void<br>Hides the busy indicator. |
| isButtonEnabled(buttonId: string): boolean<br>Returns whether a specific button in the footer of the popup is enabled. |
| isButtonVisible(buttonId: string): boolean<br>Returns whether a specific button in the footer of the popup is visible. |
| open(): void<br>Opens the popup. |
| setButtonEnabled(buttonId: string, enabled: boolean): void<br>Enables or disables a specific button in the footer of the popup. |
| setButtonVisible(buttonId: string, visible: boolean): void<br>Shows or hides a specific button in the footer of the popup. |
| setCssClass(className: string): void<br>Sets the Cascading Style Sheet (CSS) class name of the popup. |
| setSize(size: CrossPagePopupSizeOptions): void<br>Sets the popup size. |
| setTitle(title: string): void<br>Sets the title of the popup. |
| showBusyIndicator(text?: string): void<br>Shows the busy indicator. |

Event Summary

| |
| --- |
| Name and Description |
| onButtonClick(buttonId: string): void<br>Called when the user clicks any button in the footer of the popup. |
| onOpen(origin: string): void<br>Called when the Story Popup is open. |
| onResize(width: number, height: number): void<br>Called when the popup is resized. |

Method Detail

| |
| --- |
| close |
| close(): void<br>Closes the popup. |

| |
| --- |
| getCssClass |
| getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the popup.<br>Returns<br>string |

| |
| --- |
| getTitle |
| getTitle(): string<br>Returns the title of the popup.<br>Returns<br>string |

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

| | | |
| --- | --- | --- |
| isButtonEnabled |
| isButtonEnabled(buttonId: string): boolean

Returns whether a specific button in the footer of the popup is enabled.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |

Returns

boolean |

| | | |
| --- | --- | --- |
| isButtonVisible |
| isButtonVisible(buttonId: string): boolean

Returns whether a specific button in the footer of the popup is visible.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |

Returns

boolean |

| |
| --- |
| open |
| open(): void<br>Opens the popup. |

| | | |
| --- | --- | --- |
| setButtonEnabled |
| setButtonEnabled(buttonId: string, enabled: boolean): void

Enables or disables a specific button in the footer of the popup.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |
| enabled: | boolean | | |

| | | |
| --- | --- | --- |
| setButtonVisible |
| setButtonVisible(buttonId: string, visible: boolean): void

Shows or hides a specific button in the footer of the popup.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | |
| visible: | boolean | | |

| | | |
| --- | --- | --- |
| setCssClass |
| setCssClass(className: string): void

Sets the Cascading Style Sheet (CSS) class name of the popup.

Parameters

| | | |
| --- | --- | --- |
| className: | string | | |

| | | |
| --- | --- | --- |
| setSize |
| setSize(size: CrossPagePopupSizeOptions): void

Sets the popup size.

Parameters

| | | |
| --- | --- | --- |
| size: | CrossPagePopupSizeOptions | |

Since

2024.25 |

| | | |
| --- | --- | --- |
| setTitle |
| setTitle(title: string): void

Sets the title of the popup.

Parameters

| | | |
| --- | --- | --- |
| title: | string | | |

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

Shows the busy indicator.

Parameters

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

Event Detail

| | | |
| --- | --- | --- |
| onButtonClick |
| onButtonClick(buttonId: string): void

Called when the user clicks any button in the footer of the popup.

Parameters

| | | |
| --- | --- | --- |
| buttonId: | string | | |

| | | |
| --- | --- | --- |
| onOpen |
| onOpen(origin: string): void

Called when the Story Popup is open.

Parameters

| | | |
| --- | --- | --- |
| origin: | string | | |

| | | |
| --- | --- | --- |
| onResize |
| onResize(width: number, height: number): void

Called when the popup is resized.

Parameters

| | | |
| --- | --- | --- |
| width: | number | |
| height: | number | |

Since

2024.25 |

Type Library
standard

O

String

A string represents a sequence of characters.

Last Update

2020.6

Property Summary

| |
| --- |
| Name and Description |
| length: integer<br>Represents the length of a string. |

Method Summary

| |
| --- |
| Name and Description |
| charAt(index: integer): string<br>Returns the specified character from a string. |
| charCodeAt(index: integer): integer<br>Returns the numeric Unicode value of the character at the given index (except for Unicode codepoints > 0x10000). |
| codePointAt(pos: integer): integer<br>Returns a non-negative integer that is the UTF-16 encoded code point value. |
| concat(other: string): string<br>Combines the text of two strings and returns a new string. |
| endsWith(searchString: string, length?: integer): boolean<br>Returns whether a string ends with the characters of another string. |
| includes(searchString: string, position?: integer): boolean<br>Returns whether one string may be found within another string. |
| indexOf(searchValue: string, fromIndex?: integer): integer<br>Returns the index within the calling string of the first occurrence of the specified value, starting the search at fromIndex, or -1 if the value isn't found. |
| lastIndexOf(searchValue: string, fromIndex?: integer): integer<br>Returns the index within the calling string of the last occurrence of the specified value, or -1 if the value isn't found. |
| localeCompare(compareString: string): integer<br>Returns a number indicating whether a reference string comes before or after or is the same as the given string in sort order. |
| normalize(form: string): string<br>Returns the Unicode Normalization Form of a given string (if the value isn't a string, it will be converted to one first). |
| repeat(count: integer): string<br>Constructs and returns a new string which contains the specified number of copies of the string on which it was called, concatenated together. |
| replace(pattern: string, replacement: string): string<br>Returns a new string with some or all matches of a pattern replaced by a replacement. |
| slice(beginIndex: integer, endIndex?: integer): string<br>Extracts a section of a string and returns a new string. |
| split(separator?: string, limit?: integer): string[]<br>Splits a string into an array of strings by separating the string into substrings. |
| startsWith(searchString: string, position?: integer): boolean<br>Returns whether a string begins with the characters of another string. |
| substr(start: integer, length?: integer): string<br>Returns the characters in a string beginning at the specified location through the specified number of characters. |
| substring(indexStart: integer, indexEnd?: integer): string<br>Returns a subset of a string between one index and another, or through the end of the string. |
| toLocaleLowerCase(): string<br>Returns the calling string value converted to lowercase, according to any locale-specific case mappings. |
| toLocaleUpperCase(): string<br>Returns the calling string value converted to uppercase, according to any locale-specific case mappings. |
| toLowerCase(): string<br>Returns the calling string value converted to lowercase. |
| toUpperCase(): string<br>Returns the calling string value converted to uppercase. |
| trim(): string<br>Removes whitespace from both ends of the string. |

Property Detail

| |
| --- |
| length |
| length: integer<br>Represents the length of a string.<br>Last Update<br>2020.6 |

Method Detail

| | | |
| --- | --- | --- |
| charAt |
| charAt(index: integer): string

Returns the specified character from a string.

Parameters

| | | |
| --- | --- | --- |
| index: | integer | |

Returns

string

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| charCodeAt |
| charCodeAt(index: integer): integer

Returns the numeric Unicode value of the character at the given index (except for Unicode codepoints > 0x10000).

Parameters

| | | |
| --- | --- | --- |
| index: | integer | |

Returns

integer

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| codePointAt |
| codePointAt(pos: integer): integer

Returns a non-negative integer that is the UTF-16 encoded code point value.

Parameters

| | | |
| --- | --- | --- |
| pos: | integer | |

Returns

integer

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| concat |
| concat(other: string): string

Combines the text of two strings and returns a new string.

Parameters

| | | |
| --- | --- | --- |
| other: | string | |

Returns

string |

| | | |
| --- | --- | --- |
| endsWith |
| endsWith(searchString: string, length?: integer): boolean

Returns whether a string ends with the characters of another string.

Parameters

| | | |
| --- | --- | --- |
| searchString: | string | |
| lengthOptional: | integer | |

Returns

boolean

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| includes |
| includes(searchString: string, position?: integer): boolean

Returns whether one string may be found within another string.

Parameters

| | | |
| --- | --- | --- |
| searchString: | string | |
| positionOptional: | integer | |

Returns

boolean

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| indexOf |
| indexOf(searchValue: string, fromIndex?: integer): integer

Returns the index within the calling string of the first occurrence of the specified value, starting the search at fromIndex, or -1 if the value isn't found.

Parameters

| | | |
| --- | --- | --- |
| searchValue: | string | |
| fromIndexOptional: | integer | |

Returns

integer

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| lastIndexOf |
| lastIndexOf(searchValue: string, fromIndex?: integer): integer

Returns the index within the calling string of the last occurrence of the specified value, or -1 if the value isn't found. The calling string is searched backward, starting at fromIndex.

Parameters

| | | |
| --- | --- | --- |
| searchValue: | string | |
| fromIndexOptional: | integer | |

Returns

integer

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| localeCompare |
| localeCompare(compareString: string): integer

Returns a number indicating whether a reference string comes before or after or is the same as the given string in sort order.

Parameters

| | | |
| --- | --- | --- |
| compareString: | string | |

Returns

integer

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| normalize |
| normalize(form: string): string

Returns the Unicode Normalization Form of a given string (if the value isn't a string, it will be converted to one first).

Parameters

| | | |
| --- | --- | --- |
| form: | string | |

Returns

string |

| | | |
| --- | --- | --- |
| repeat |
| repeat(count: integer): string

Constructs and returns a new string which contains the specified number of copies of the string on which it was called, concatenated together.

Parameters

| | | |
| --- | --- | --- |
| count: | integer | |

Returns

string

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| replace |
| replace(pattern: string, replacement: string): string

Returns a new string with some or all matches of a pattern replaced by a replacement. The pattern can be a string, and the replacement can be a string for each match.

Parameters

| | | |
| --- | --- | --- |
| pattern: | string | |
| replacement: | string | |

Returns

string |

| | | |
| --- | --- | --- |
| slice |
| slice(beginIndex: integer, endIndex?: integer): string

Extracts a section of a string and returns a new string.

Parameters

| | | |
| --- | --- | --- |
| beginIndex: | integer | |
| endIndexOptional: | integer | |

Returns

string

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| split |
| split(separator?: string, limit?: integer): string[]

Splits a string into an array of strings by separating the string into substrings.

Parameters

| | | |
| --- | --- | --- |
| separatorOptional: | string | |
| limitOptional: | integer | |

Returns

string[]

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| startsWith |
| startsWith(searchString: string, position?: integer): boolean

Returns whether a string begins with the characters of another string.

Parameters

| | | |
| --- | --- | --- |
| searchString: | string | |
| positionOptional: | integer | |

Returns

boolean

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| substr |
| substr(start: integer, length?: integer): string

Returns the characters in a string beginning at the specified location through the specified number of characters.

Parameters

| | | |
| --- | --- | --- |
| start: | integer | |
| lengthOptional: | integer | |

Returns

string

Last Update

2020.6 |

| | | |
| --- | --- | --- |
| substring |
| substring(indexStart: integer, indexEnd?: integer): string

Returns a subset of a string between one index and another, or through the end of the string.

Parameters

| | | |
| --- | --- | --- |
| indexStart: | integer | |
| indexEndOptional: | integer | |

Returns

string

Last Update

2020.6 |

| |
| --- |
| toLocaleLowerCase |
| toLocaleLowerCase(): string<br>Returns the calling string value converted to lowercase, according to any locale-specific case mappings.<br>Returns<br>string |

| |
| --- |
| toLocaleUpperCase |
| toLocaleUpperCase(): string<br>Returns the calling string value converted to uppercase, according to any locale-specific case mappings.<br>Returns<br>string |

| |
| --- |
| toLowerCase |
| toLowerCase(): string<br>Returns the calling string value converted to lowercase.<br>Returns<br>string |

| |
| --- |
| toUpperCase |
| toUpperCase(): string<br>Returns the calling string value converted to uppercase.<br>Returns<br>string |

| |
| --- |
| trim |
| trim(): string<br>Removes whitespace from both ends of the string.<br>Returns<br>string |

Type Library
standard

C
\

<a name="widget"></a>

Widget

is abstract

Direct Subclasses

BpcPlanningSequence, Button, Chart, CheckboxGroup, Commenting, Composite, DataActionTrigger, Dropdown, FileUploadTrigger, FilterLine, FlowPanel, GeoMap, Image, InputControl, InputField, ListBox, MultiActionTrigger, PageBook, Panel, RVisualization, RadioButtonGroup, RangeSlider, RssReader, Shape, Slider, Switch, TabStrip, Table, Text, TextArea, ValueDriverTree, WebPage

Last Update

2020.20

Method Summary

| |
| --- |
| Name and Description |
| getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the component. |
| getLayout(): Layout<br>Returns the layout of the widget. |
| isVisible(): boolean<br>Returns whether the widget is visible. |
| setCssClass(className: string): void<br>Sets the Cascading Style Sheet (CSS) class name of the component. |
| setVisible(visible: boolean): void<br>Shows or hides the widget. |

Method Detail

| |
| --- |
| getCssClass |
| getCssClass(): string<br>Returns the Cascading Style Sheet (CSS) class name of the component.<br>Returns<br>string<br>Since<br>2020.20 |

| |
| --- |
| getLayout |
| getLayout(): Layout<br>Returns the layout of the widget.<br>Returns<br>Layout<br>Since<br>2019.14 |

| |
| --- |
| isVisible |
| isVisible(): boolean<br>Returns whether the widget is visible.<br>Returns<br>boolean |

| | | |
| --- | --- | --- |
| setCssClass |
| setCssClass(className: string): void

Sets the Cascading Style Sheet (CSS) class name of the component.

Parameters

| | | |
| --- | --- | --- |
| className: | string | |

Since

2020.20 |

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

Shows or hides the widget.

Parameters

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

Type Library
standard

C
\

<a name="widgetsearchoptions"></a>

WidgetSearchOptions

Since

2021.23

Property Summary

| |
| --- |
| Name and Description |
| static searchPattern: string<br>Part of the name of the widgets to return. |
| static type: WidgetType<br>Type of the widgets to return |

Property Detail

| |
| --- |
| searchPattern |
| staticsearchPattern: string<br>Part of the name of the widgets to return. The search pattern is case-sensitive, for example, the search patterns "SalesChart" and "saleschart" return different results. |

| |
| --- |
| type |
| statictype: WidgetType<br>Type of the widgets to return |

Type Library
standard

E
\

<a name="widgettype"></a>

WidgetType

Since

2021.23

Optimized Story Experience API Reference Guide

With SAP Analytics Cloud you can create interactive and highly custom-defined stories.
To enable interactivity, you can write scripts, which are executed when the viewer performs
an action in your story. For example, you can place the Button widget in the story and
assign a script to the Button’s onClick event.


Scripts consist of one or more statements written in a JavaScript-based language, following
a specific syntax. To write scripts in your story, you can use the script editor.


All objects, functions, properties, methods and events available in such scripts specific to optimized story experience are listed in this API reference. For those specific to analytics designer, refer to Analytics Designer API Reference Guide.

<a name="tab"></a>

Tab

Since

2019.14

Last Update

2020.6

Method Summary

| |
| --- |
| Name and Description |
| getKey(): string<br>Returns the key of the tab. |
| getText(): string<br>Returns the text displayed on the tab. |
| isVisible(): boolean<br>Returns whether the tab is visible. |
| setText(text: string): void<br>Sets the text displayed on the tab. |
| setVisible(visible: boolean): void<br>Shows or hides the tab. |

Method Detail

| |
| --- |
| getKey |
| getKey(): string<br>Returns the key of the tab.<br>Returns<br>string |

| |
| --- |
| getText |
| getText(): string<br>Returns the text displayed on the tab.<br>Returns<br>string |

| |
| --- |
| isVisible |
| isVisible(): boolean<br>Returns whether the tab is visible.<br>Returns<br>boolean<br>Since<br>2020.6 |

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

Sets the text displayed on the tab.

Parameters

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

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

Shows or hides the tab.

Parameters

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

Since

2020.6 |

Type Library
table2
\

Source: SKILL.md on GitHub

Third-party checks

1 alert16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    The skill is a comprehensive reference and template collection for SAP Analytics Cloud (SAC) scripting. It provides secure instructions for setting up an associated Model Context Protocol (MCP) server, including commit pinning and security flags during installation. It also incorporates multiple security best practices for developers, such as origin validation for iframe communication.

  • Socket16d

    1 alert: gptAnomaly

  • Snyk16d

    Risk: MEDIUM · 1 issue

  • Runlayer6mo

    32/61 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 620a19a. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 weeks ago.

Activeupdated 2 months ago

Capability

Other metadata
metadata
{
  "maintainer": "Eduard Jiglau",
  "maintainer_email": "hello@sap-ai-skills.com",
  "website": "https://sap-ai-skills.com",
  "version": "2.4.1",
  "last_verified": "2026-06-11",
  "sac_version": "Q2 2026 (2026.8)",
  "api_reference_version": "2025.20 (OSE Q2 2026)",
  "documentation_source": "https://help.sap.com/docs/SAP_ANALYTICS_CLOUD",
  "reference_files": 66,
  "template_patterns": 56,
  "agents": 4,
  "commands": 4,
  "status": "docs_audited_runtime_pending",
  "known_issues": [
    "Live SAC story/runtime checks require tenant evidence before claiming production validation."
  ]
}

README badge

README badge for secondsky/sap-skills/sap-sac-scripting