|
Type Libraries
|
C
C
E
C
C
C
C
C
C
C
C
C
C
C
O
F
O
O
C
C
O
O
O
C
E
E
C
E
C
C
C
C
C
C
C
C
|
Type Libraries
|
| Name and Description |
|
static DefaultTheme: string
Represents the default theme. |
|
static FlatHierarchy: string
Represents the flat hierarchy. |
|
static MeasureDimension: string
Represents the measure dimension. |
|
static NullMember: string
Represents the NULL member of a dimension. |
|
static TotalsMember: string
Represents the Totals member of a dimension. |
| DefaultTheme |
|
static DefaultTheme: string
Represents the default theme.
Since
2020.13
|
| FlatHierarchy |
| static FlatHierarchy: string Represents the flat hierarchy. |
| MeasureDimension |
| static MeasureDimension: string Represents the measure dimension. |
| NullMember |
|
static NullMember: string
Represents the NULL member of a dimension. Such a member can typically be found in SAP HANA models as the result of joining database tables.
Since
2020.11
|
| TotalsMember |
|
static TotalsMember: string
Represents the Totals member of a dimension. To take effect, enable the display of totals for the dimension.
Since
2020.11
|
| Name and Description |
|
getActivePage(): ApplicationPage
Get the active page. |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the canvas of the first page. |
|
getFileDataSource(modelId: string): FileDataSource
Returns the data source of related modelId. |
|
getGlobalCssClass(): string
Returns the global default Cascading Style Sheet (CSS) class name. |
|
getInfo(): ApplicationInfo
Returns information about the analytic application. |
|
getInnerHeight(): LayoutValue
Get InnerHeight of first page. |
|
getInnerWidth(): LayoutValue
Get InnerWidth of first page. |
|
getMode(): ApplicationMode
Returns the mode in which the analytic application is displayed. |
|
getRolesInfo(): string[]
Returns role information about the current user. |
|
getTeamsInfo(): TeamInfo[]
Returns team information about the current user. |
|
getTheme(): string
Returns the theme ID of the analytic application. |
|
getUserInfo(): UserInfo
Returns information about the current user. |
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
isCommentModeEnabled(): boolean
Returns whether the comment mode is enabled. |
|
isMobile(): boolean
Returns whether the analytic application is in mobile mode. |
|
moveWidget(widget: Widget): void
Moves the widget into the first page canvas. |
|
openShareApplicationDialog(): void
Opens the Share Application dialog for the currently opened analytic application. |
|
postMessage(receiver: PostMessageReceiver, message: string, targetOrigin: string): void
Posts a message to the parent window or the top-level window. |
|
refreshData(dataSources?: DataSource[]): void
Triggers data refresh. |
|
sendNotification(notification: NotificationOptions JSON): boolean
Sends a notification. |
|
setActivePage(page: ApplicationPage | string | integer): void
Switch page. |
|
setAutomaticBusyIndicatorEnabled(enabled: boolean): void
Enables or disables the automatic busy indicator. |
|
setCommentModeEnabled(isEnabled: boolean): void
Enables or disables the comment mode. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the canvas of the first page. |
|
setCurrentDateTime(currentDateTime: CurrentDateTime): void
Sets current date/time. |
|
setGlobalCssClass(className: string): void
Sets the global default Cascading Style Sheet (CSS) class name. |
|
setMessageTypesToShow(messageTypes: ApplicationMessageType[]): void
Specifies which messages are shown, depending on their message type. |
|
setPageVisible(page: ApplicationPage | string | integer, visible: boolean): void
Set the page visible or not. |
|
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. |
|
setTheme(themeId?: string): void
Applies a theme to the analytic application. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
|
showMessage(messageType: ApplicationMessageType, message: string): void
Shows a message. |
| Name and Description |
|
onInitialization(): void Called when the analytic application has finished loading. |
|
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void Called when the user changes the orientation of the mobile device. |
|
onPostMessageReceived(message: string, origin: string): void Called when the analytic application receives a message from the hosting page or an embedded page. |
|
onResize(): void Called when the user resizes the browser window. |
|
onShake(): void Called when the user shakes the mobile device. |
| getActivePage |
|
getActivePage(): ApplicationPage
Get the active page.
Returns
ApplicationPage
Since
2023.3
|
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the canvas of the first page.
Returns
string
Since
2020.20
|
| getFileDataSource | |||
|
getFileDataSource(modelId: string): FileDataSource
Returns the data source of related modelId.
Parameters
Returns
FileDataSource
Since
2023.13
|
| getGlobalCssClass |
|
getGlobalCssClass(): string
Returns the global default Cascading Style Sheet (CSS) class name.
Returns
string
Since
2021.2
|
| getInfo |
|
getInfo(): ApplicationInfo
Returns information about the analytic application.
Returns
ApplicationInfo
Since
2020.9
|
| getInnerHeight |
|
getInnerHeight(): LayoutValue
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.
Returns
LayoutValue
Since
2019.14
|
| getInnerWidth |
|
getInnerWidth(): LayoutValue
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.
Returns
LayoutValue
Since
2019.14
|
| getMode |
|
getMode(): ApplicationMode
Returns the mode in which the analytic application is displayed.
Returns
ApplicationMode
Since
2020.11
|
| getRolesInfo |
|
getRolesInfo(): string[]
Returns role information about the current user.
Returns
string[]
Since
2023.13
|
| getTeamsInfo |
|
getTeamsInfo(): TeamInfo[]
Returns team information about the current user.
Returns
TeamInfo[]
Since
2023.13
|
| getTheme |
|
getTheme(): string
Returns the theme ID of the analytic application. If the default theme has been applied, then the value represented by Alias.DefaultTheme is returned.
Returns
string
Since
2020.13
|
| getUserInfo |
|
getUserInfo(): UserInfo
Returns information about the current user.
Returns
UserInfo
Since
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
Returns
<type of type>
Since
2021.23
|
| hideBusyIndicator |
|
hideBusyIndicator(): void
Hides the busy indicator.
Since
2020.1
|
| isCommentModeEnabled |
|
isCommentModeEnabled(): boolean
Returns whether the comment mode is enabled.
Returns
boolean
Since
2019.18
|
| isMobile |
|
isMobile(): boolean
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.
Returns
boolean
Since
2020.3
|
| moveWidget | |||
|
moveWidget(widget: Widget): void
Moves the widget into the first page canvas.
Parameters
Since
2020.7
|
| openShareApplicationDialog |
|
openShareApplicationDialog(): void
Opens the Share Application dialog for the currently opened analytic application.
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| postMessage | |||||||||
|
postMessage(receiver: PostMessageReceiver, message: string, targetOrigin: string): void
Posts a message to the parent window or the top-level window.
Parameters
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
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
Returns
boolean
Since
2020.7
|
| setActivePage | |||
|
setActivePage(page: ApplicationPage | string | integer): void
Switch page.
Parameters
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
Since
2020.1
|
| setCommentModeEnabled | |||
|
setCommentModeEnabled(isEnabled: boolean): void
Enables or disables the comment mode.
Parameters
Since
2019.18
|
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the canvas of the first page.
Parameters
Since
2020.20
|
| setCurrentDateTime | |||
|
setCurrentDateTime(currentDateTime: CurrentDateTime): void
Sets current date/time.
Parameters
Since
2023.13
|
| setGlobalCssClass | |||
|
setGlobalCssClass(className: string): void
Sets the global default Cascading Style Sheet (CSS) class name.
Parameters
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
Since
2020.10
|
| setPageVisible | ||||||
|
setPageVisible(page: ApplicationPage | string | integer, visible: boolean): void
Set the page visible or not.
Parameters
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
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
Since
2019.22
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
Since
2020.1
|
| showMessage | ||||||
|
showMessage(messageType: ApplicationMessageType, message: string): void
Shows a message.
Parameters
Since
2020.10
|
| onInitialization |
| onInitialization(): void 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
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
|
| onResize |
|
onResize(): void
Called when the user resizes the browser window. Note: This method is called in intervals of 500 milliseconds while the window is resized.
Since
2019.14
|
| onShake |
|
onShake(): void
Called when the user shakes the mobile device. Note: This method is called every two seconds during shaking.
Since
2020.13
|
| Name and Description |
| description: string |
| id: string |
| name: string |
| Name and Description |
|
static Error: ApplicationMessageType
Error message |
|
static Info: ApplicationMessageType
Information message |
|
static Success: ApplicationMessageType
Success message |
|
static Warning: ApplicationMessageType
Warning message |
| Error |
| static Error: ApplicationMessageType Error message |
| Info |
| static Info: ApplicationMessageType Information message |
| Success |
| static Success: ApplicationMessageType Success message |
| Warning |
| static Warning: ApplicationMessageType Warning message |
| Name and Description |
|
static Embed: ApplicationMode
The analytic application is displayed in embed mode. |
|
static Present: ApplicationMode
The analytic application is displayed in present mode. |
|
static View: ApplicationMode
The analytic application is displayed in view mode. |
| Embed |
| static Embed: ApplicationMode The analytic application is displayed in embed mode. |
| Present |
| static Present: ApplicationMode The analytic application is displayed in present mode. |
| View |
| static View: ApplicationMode The analytic application is displayed in view mode. |
| Name and Description |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the page. |
|
getInnerHeight(): LayoutValue
If the page size is fixed, then the height of the page is returned. |
|
getInnerWidth(): LayoutValue
If the page size is fixed, then the width of the page is returned. |
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options. |
|
moveWidget(widget: Widget): void
Moves the widget into the page. |
|
refreshData(dataSources?: DataSource[]): void
Triggers a data refresh and updates the widgets associated with the refreshed data sources. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the page. |
|
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. |
| Name and Description |
|
onActive(): void Called when the analytic application page is set to active. |
|
onInitialization(): void Called when the analytic application page has finished loading. |
|
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void Called when the user changes the orientation of the mobile device. |
|
onPostMessageReceived(message: string, origin: string): void Called when the analytic application receives a message from the hosting page or an embedded page. |
|
onResize(): void Called when the user resizes the browser window. |
|
onShake(): void Called when the user shakes the mobile device. |
|
onStoryPopupClose(origin: string): void Called after a Story Popup is Closed. |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the page.
Returns
string
Since
2022.6
|
| getInnerHeight |
|
getInnerHeight(): LayoutValue
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.
Returns
LayoutValue
Since
2022.6
|
| getInnerWidth |
|
getInnerWidth(): LayoutValue
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.
Returns
LayoutValue
Since
2022.6
|
| getWidgets | |||
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options.
Parameters
Returns
<type of type>
Since
2022.6
|
| moveWidget | |||
|
moveWidget(widget: Widget): void
Moves the widget into the page.
Parameters
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
Since
2022.8
|
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the page.
Parameters
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
Since
2022.8
|
| onActive |
|
onActive(): void
Called when the analytic application page is set to active.
Since
2023.3
|
| onInitialization |
|
onInitialization(): void
Called when the analytic application page has finished loading.
Since
2023.3
|
| onOrientationChange | ||||||
|
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void
Called when the user changes the orientation of the mobile device.
Parameters
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
Since
2023.3
|
| onResize |
|
onResize(): void
Called when the user resizes the browser window. Note: This method is called in intervals of 500 milliseconds while the window is resized.
Since
2023.3
|
| onShake |
|
onShake(): void
Called when the user shakes the mobile device. Note: This method is called every two seconds during shaking.
Since
2023.3
|
| onStoryPopupClose | |||
|
onStoryPopupClose(origin: string): void
Called after a Story Popup is Closed.
Parameters
Since
2024.14
|
| Name and Description |
|
length: integer
An unsigned, 32-bit integer that specifies the number of elements in an array. |
| Name and Description |
|
static isArray(value: <any type>): boolean
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>
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>
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>
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
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
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
Joins all elements of an array into a string. |
|
keys(): <array iterator traversing this array's integer indices>
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
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>
Removes the last element from an array and returns that element. |
|
push(newelt: <this array's element type>): integer
Appends one element and returns the new length of the array. |
|
reverse(): void
Reverses an array in place. |
|
shift(): <this array's element type>
Removes the first element from an array and returns that element. |
|
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). |
|
sort(): void
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>
Changes the content of an array, adding new elements while removing old elements. |
|
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. |
|
values(): <array iterator traversing this array's values>
Returns a new Array Iterator object that contains the values for each index position in the array. |
| length |
| length: integer An unsigned, 32-bit integer that specifies the number of elements in an array. |
| isArray | |||
|
static isArray(value: <any type>): boolean
Returns true if an object is an array and false if it isn't an array.
Parameters
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
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
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
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
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
Returns
integer
Last Update
2020.6
|
| join | |||
|
join(separator?: string): string
Joins all elements of an array into a string.
Parameters
Returns
string |
| keys |
|
keys(): <array iterator traversing this array's integer indices>
Returns a new Array Iterator that contains the keys for each index position in the array.
Returns
<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
Returns
integer
Last Update
2020.6
|
| pop |
|
pop(): <this array's element type>
Removes the last element from an array and returns that element.
Returns
<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
Returns
integer |
| reverse |
| reverse(): void 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>
Removes the first element from an array and returns that element.
Returns
<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
Returns
<this array's type> |
| sort |
| sort(): void 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
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
Returns
integer |
| values |
|
values(): <array iterator traversing this array's values>
Returns a new Array Iterator object that contains the values for each index position in the array.
Returns
<array iterator traversing this array's values> |
| Name and Description |
|
getProperties(): BackendConditionProperties
Returns properties of the BEx condition. |
|
isSelected(): boolean
Returns whether the BEx condition is applied to the current chart. |
|
setSelected(selected: boolean): void
Selects or deselects the BEx condition, and applies to the current chart. |
| getProperties |
|
getProperties(): BackendConditionProperties
Returns properties of the BEx condition.
Returns
BackendConditionProperties |
| isSelected |
|
isSelected(): boolean
Returns whether the BEx condition is applied to the current chart.
Returns
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
|
| Name and Description |
| description: string |
| id: string |
| Name and Description |
|
setDimensionFilter(dimension: string | DimensionInfo JSON, members: string | string[] | MemberInfo JSON | MemberInfo[] JSON | RangeFilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. |
| setDimensionFilter | ||||||
|
setDimensionFilter(dimension: string | DimensionInfo JSON, members: string | string[] | MemberInfo JSON | MemberInfo[] JSON | RangeFilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. The filter will be used in batch export. Only dimension member and range filter is supported.
Parameters
Last Update
2024.17
|
| Name and Description |
| displayName: string |
| id: string |
|
isDefault: boolean
Specifies whether the bookmark is the default bookmark. |
|
isGlobal: boolean
Specifies whether the bookmark is visible globally. |
| name: string |
|
properties: BookmarkProperties JSON
Additional properties of the bookmark, for example, {"property1": "value1", "property2": "value2"} |
| version: integer |
| displayName |
|
displayName: string
Since
2019.16
|
| id |
| id: string |
| isDefault |
|
isDefault: boolean
Specifies whether the bookmark is the default bookmark.
Since
2021.11
|
| isGlobal |
| isGlobal: boolean Specifies whether the bookmark is visible globally. |
| name |
| name: string |
| properties |
|
properties: BookmarkProperties JSON
Additional properties of the bookmark, for example, {"property1": "value1", "property2": "value2"}
Since
2021.11
|
| version |
| version: integer |
| Name and Description |
|
isDefault: boolean
Specifies whether the bookmark is the default bookmark. |
|
isGlobal: boolean
Specifies whether the bookmark is visible globally. |
|
isKeepLastDynamicVariableValue: boolean
Specifies whether the bookmark should apply last value of dynamic variable. |
|
name: string
Bookmark name |
|
properties: BookmarkProperties JSON
Additional properties of the bookmark, for example, {"property1": "value1", "property2": "value2"} |
|
startPageId: string
Specifies start page id. |
| isDefault |
| isDefault: boolean Specifies whether the bookmark is the default bookmark. |
| isGlobal |
| isGlobal: boolean Specifies whether the bookmark is visible globally. |
| isKeepLastDynamicVariableValue |
|
isKeepLastDynamicVariableValue: boolean
Specifies whether the bookmark should apply last value of dynamic variable.
Since
2022.7
|
| name |
| name: string Bookmark name |
| properties |
| properties: BookmarkProperties JSON Additional properties of the bookmark, for example, {"property1": "value1", "property2": "value2"} |
| startPageId |
|
startPageId: string
Specifies start page id.
Since
2024.19
|
| Name and Description |
|
apply(bookmark: string | BookmarkInfo): boolean
Applies the bookmark to the current analytic application. |
|
deleteBookmark(bookmark: string | BookmarkInfo): boolean
Deletes a bookmark of the analytic application. |
|
getAll(): BookmarkInfo[]
Returns all valid bookmarks of the analytic application. |
|
getAppliedBookmark(): BookmarkInfo
Returns the bookmark that was applied to the analytic application. |
|
getVersion(): integer
Returns the current bookmark version of the analytic application. |
|
isSameAsApplicationState(bookmark: string | BookmarkInfo): boolean
Returns whether the current state of the analytic application is the same as the state stored in a bookmark. |
|
openShareBookmarkDialog(bookmarkId: string): void
Opens the Share Bookmark dialog for a bookmark. |
|
save(bookmarkName: string, isGlobal: boolean, overwrite?: boolean): BookmarkInfo
Deprecated This method is deprecated, use saveBookmark() instead. |
|
saveBookmark(bookmarkSaveInfo: BookmarkSaveInfo JSON, overwrite?: boolean): BookmarkInfo
Saves a bookmark based on the current state of the analytic application. |
| apply | |||
|
apply(bookmark: string | BookmarkInfo): boolean
Applies the bookmark to the current analytic application. If the bookmark is accessible to the current user, then true is returned, and false if it isn't.
Parameters
Returns
boolean
Since
2020.7
|
| deleteBookmark | |||
|
deleteBookmark(bookmark: string | BookmarkInfo): boolean
Deletes a bookmark of the analytic application.
Parameters
Returns
boolean |
| getAll |
|
getAll(): BookmarkInfo[]
Returns all valid bookmarks of the analytic application.
Returns
BookmarkInfo[] |
| getAppliedBookmark |
|
getAppliedBookmark(): BookmarkInfo
Returns the bookmark that was applied to the analytic application.
Returns
BookmarkInfo |
| getVersion |
|
getVersion(): integer
Returns the current bookmark version of the analytic application.
Returns
integer |
| isSameAsApplicationState | |||
|
isSameAsApplicationState(bookmark: string | BookmarkInfo): boolean
Returns whether the current state of the analytic application is the same as the state stored in a bookmark.
Parameters
Returns
boolean
Since
2019.23
|
| openShareBookmarkDialog | |||
|
openShareBookmarkDialog(bookmarkId: string): void
Opens the Share Bookmark dialog for a bookmark.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| save | |||||||||
|
save(bookmarkName: string, isGlobal: boolean, overwrite?: boolean): BookmarkInfo
Deprecated This method is deprecated, use saveBookmark() instead.
Parameters
Returns
BookmarkInfo
Deprecated
2021.11
|
| saveBookmark | ||||||
|
saveBookmark(bookmarkSaveInfo: BookmarkSaveInfo JSON, overwrite?: boolean): BookmarkInfo
Saves a bookmark based on the current state of the analytic application. The bookmark save info specifies by default that the bookmark is neither globally visible nor a default bookmark. Optionally, you can specify whether to overwrite a bookmark with the same name (default: false).
Parameters
Returns
BookmarkInfo
Since
2021.11
|
| Name and Description |
|
execute(): BpcPlanningSequenceExecutionResponse
Executes the BPC planning sequence. |
|
getBpcPlanningSequenceDataSource(): BpcPlanningSequenceDataSource
Returns the data source of the BPC Planning Sequence. |
|
openPromptDialog(): void
Opens the Prompt dialog for the BPC planning sequence. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onBeforeExecute(): boolean Called when the user clicks the BPC planning sequence starter. |
| execute |
|
execute(): BpcPlanningSequenceExecutionResponse
Executes the BPC planning sequence.
Returns
BpcPlanningSequenceExecutionResponse
Mobile Support
Not supported on mobile devices.
Since
2022.14
|
| getBpcPlanningSequenceDataSource |
|
getBpcPlanningSequenceDataSource(): BpcPlanningSequenceDataSource
Returns the data source of the BPC Planning Sequence.
Returns
BpcPlanningSequenceDataSource
Mobile Support
Not supported on mobile devices.
Since
2022.14
|
| openPromptDialog |
|
openPromptDialog(): void
Opens the Prompt dialog for the BPC planning sequence. This method returns after user closes the Prompt dialog.
Mobile Support
Not supported on mobile devices.
Since
2022.14
|
| onBeforeExecute |
|
onBeforeExecute(): boolean
Called when the user clicks the BPC planning sequence starter. If this method returns true or returns no value, then the BPC planning sequence is executed. If this method returns false, then the BPC planning sequence is ignored.
Returns
boolean Default value: true
Since
2020.4
|
| Name and Description |
|
copyVariableValueFrom(sourceDataSource: BpcPlanningSequenceDataSource, variable?: string | string[] | BpcPlanningSequenceVariableInfo | BpcPlanningSequenceVariableInfo[]): void
Copies the value of a variable. |
|
getVariables(): BpcPlanningSequenceVariableInfo[]
Returns all variables of the data source. |
|
getVariableValues(variable: string | BpcPlanningSequenceVariableInfo): VariableValue[]
Returns the values of the variable. |
|
removeVariableValue(variable: string | BpcPlanningSequenceVariableInfo): void
Removes the value of the variable. |
|
setVariableValue(variable: string | BpcPlanningSequenceVariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. |
| copyVariableValueFrom | ||||||
|
copyVariableValueFrom(sourceDataSource: BpcPlanningSequenceDataSource, variable?: string | string[] | BpcPlanningSequenceVariableInfo | BpcPlanningSequenceVariableInfo[]): void
Copies the value of a variable. If no variable is specified, then all variable values of the data source are copied. If you copy an empty variable value to a mandatory variable, then copying this variable is ignored.
Parameters
Last Update
2022.16
|
| getVariableValues | |||
|
getVariableValues(variable: string | BpcPlanningSequenceVariableInfo): VariableValue[]
Returns the values of the variable. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function. Note: This method may return outdated values with SAP BW dynamic filter variables.
Parameters
Returns
VariableValue[]
Last Update
2022.16
|
| getVariables |
|
getVariables(): BpcPlanningSequenceVariableInfo[]
Returns all variables of the data source.
Returns
BpcPlanningSequenceVariableInfo[]
Last Update
2022.16
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | BpcPlanningSequenceVariableInfo): void
Removes the value of the variable. By default, this removes the variable value of the variable for the data source on the application. If you remove a variable value from a mandatory variable, then this operation is ignored.
Parameters
Last Update
2022.16
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | BpcPlanningSequenceVariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set an empty variable value to a mandatory variable, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.
Parameters
Last Update
2022.16
|
| Name and Description |
|
status: BpcPlanningSequenceExecutionResponseStatus
The execution is successful or not |
| status |
| status: BpcPlanningSequenceExecutionResponseStatus The execution is successful or not |
| Name and Description |
|
static Error: BpcPlanningSequenceExecutionResponseStatus
Execution ended with errors. |
|
static Success: BpcPlanningSequenceExecutionResponseStatus
Execution ended successfully. |
| Error |
| static Error: BpcPlanningSequenceExecutionResponseStatus Execution ended with errors. |
| Success |
| static Success: BpcPlanningSequenceExecutionResponseStatus Execution ended successfully. |
| Name and Description |
| description: string |
| id: string |
| isInputEnabled: boolean |
| Name and Description |
|
getText(): string
Returns the text of the button. |
|
getTooltip(): string
Returns the tooltip text of the button. |
|
isEnabled(): boolean
Returns whether the button is enabled. |
|
setEnabled(value: boolean): void
Enables or disables the button. |
|
setText(value: string): void
Sets the text of the button. |
|
setTooltip(value: string): void
Sets the tooltip text of the button. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the button. |
|
onLongPress(): void Called when the user presses and holds the button. |
| getText |
|
getText(): string
Returns the text of the button. If no text is present, then undefined is returned.
Returns
string |
| getTooltip |
|
getTooltip(): string
Returns the tooltip text of the button. If no tooltip text is present, then undefined is returned.
Returns
string |
| isEnabled |
|
isEnabled(): boolean
Returns whether the button is enabled.
Returns
boolean
Since
2024.18
|
| setEnabled | |||
|
setEnabled(value: boolean): void
Enables or disables the button.
Parameters
Since
2024.18
|
| setText | |||
|
setText(value: string): void
Sets the text of the button.
Parameters
|
| setTooltip | |||
|
setTooltip(value: string): void
Sets the tooltip text of the button.
Parameters
|
| Name and Description |
|
addReviewer(reviewer: string, level: number): boolean
Adds the reviewer to the specified review level of the calendar event. |
|
approve(): boolean
Approves the calendar task. |
|
canUserApprove(): boolean
Returns whether the current user can approve the task. |
|
canUserDecline(): boolean
Returns whether the current user can decline the task. |
|
canUserReject(): boolean
Returns whether the current user can reject the task. |
|
canUserSubmit(): boolean
Returns whether the current user can submit the task. |
|
decline(): boolean
Declines the calendar task. |
|
reject(): boolean
Rejects the calendar task. |
|
removeReviewer(reviewer: string): boolean
Removes the reviewer from the calendar event. |
|
submit(): boolean
Submits the calendar task. |
| addReviewer | ||||||
|
addReviewer(reviewer: string, level: number): boolean
Adds the reviewer to the specified review level of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean
Since
2024.3
|
| approve |
|
approve(): boolean
Approves the calendar task. Requires the user role "Reviewer". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| canUserApprove |
|
canUserApprove(): boolean
Returns whether the current user can approve the task. A task can be approved if the reviewer has their turn in the reviewer round and the status is "In Progress" or "Open".
Returns
boolean
Since
2021.19
|
| canUserDecline |
|
canUserDecline(): boolean
Returns whether the current user can decline the task. A task can be declined if the assignee / reviewer can still work on their task and the task isn't final yet.
Returns
boolean
Since
2021.19
|
| canUserReject |
|
canUserReject(): boolean
Returns whether the current user can reject the task. A task can be rejected if the reviewer has their turn in the reviewer round and the status is "In Progress" or "Open".
Returns
boolean
Since
2021.19
|
| canUserSubmit |
|
canUserSubmit(): boolean
Returns whether the current user can submit the task. A task can be submitted if the assignee has their turn and the status is "In Progress" or "Open".
Returns
boolean
Since
2021.19
|
| decline |
|
decline(): boolean
Declines the calendar task. Requires the user role "Assignee" or "Reviewer". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| reject |
|
reject(): boolean
Rejects the calendar task. Requires the user role "Reviewer". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| removeReviewer | |||
|
removeReviewer(reviewer: string): boolean
Removes the reviewer from the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean
Since
2024.3
|
| submit |
|
submit(): boolean
Submits the calendar task. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| Name and Description |
|
autoActivate: boolean
Specifies whether the task should automatically be activated when the start date is reached. |
| Name and Description |
|
assignees: string[]
Assignees of the calendar task |
|
contextFilters: CalendarContextFilter[] JSON
Context filters of the calendar task |
|
dependencies: CalendarDependencies JSON
Dependencies of the calendar task |
|
description: string
Description of the calendar task |
|
dueDate: Date
Deprecated This property is deprecated, use "endDate" instead. |
|
endDate: Date
End date of the calendar task (formerly known as due date) |
|
name: string
Name of the calendar task |
|
owners: string[]
Owners of the calendar task |
|
parentId: string
ID of the parent process of the calendar task |
|
reminders: CalendarReminder[] JSON
Reminders of the calendar task |
|
reviewers: CalendarCompositeTaskReviewersProperties
Reviewers of the calendar task |
|
startDate: Date
Start date of the calendar task |
|
workFiles: CalendarTaskWorkFile[] JSON
Work files of the calendar task |
| assignees |
| assignees: string[] Assignees of the calendar task |
| contextFilters |
|
contextFilters: CalendarContextFilter[] JSON
Context filters of the calendar task
Since
2024.3
|
| dependencies |
|
dependencies: CalendarDependencies JSON
Dependencies of the calendar task
Since
2024.3
|
| description |
| description: string Description of the calendar task |
| dueDate |
|
dueDate: Date
Deprecated This property is deprecated, use "endDate" instead. Due date of the calendar task
Deprecated
2023.19
|
| endDate |
|
endDate: Date
End date of the calendar task (formerly known as due date)
Since
2023.19
|
| name |
| name: string Name of the calendar task |
| owners |
|
owners: string[]
Owners of the calendar task
Since
2024.3
|
| parentId |
|
parentId: string
ID of the parent process of the calendar task
Since
2024.3
|
| reminders |
|
reminders: CalendarReminder[] JSON
Reminders of the calendar task
Since
2024.3
|
| reviewers |
| reviewers: CalendarCompositeTaskReviewersProperties Reviewers of the calendar task |
| startDate |
| startDate: Date Start date of the calendar task |
| workFiles |
| workFiles: CalendarTaskWorkFile[] JSON Work files of the calendar task |
| Name and Description |
|
hierarchy: HierarchyInfo JSON
Hierarchy of the context filter |
|
members: MemberInfo[] JSON
Members of the context filter |
| hierarchy |
| hierarchy: HierarchyInfo JSON Hierarchy of the context filter |
| members |
| members: MemberInfo[] JSON Members of the context filter |
| Name and Description |
|
dependentOnIds: string[]
IDs of events this event is dependent on. |
|
triggerStatuses: CalendarTaskStatus[]
Statuses of the predecessors on which this event is initiated |
| dependentOnIds |
| dependentOnIds: string[] IDs of events this event is dependent on. All predecessors need to have no or the same parent process as this event. |
| triggerStatuses |
| triggerStatuses: CalendarTaskStatus[] Statuses of the predecessors on which this event is initiated |
| Name and Description |
|
activate(): boolean
Activates a task. |
|
addAssignee(assignee: string): boolean
Adds the assignee to the calendar event. |
|
addContextFilter(contextFilter: CalendarContextFilter JSON): boolean
Adds the context filter to the calendar event. |
|
addOwner(owner: string): boolean
Adds the owner to the calendar event. |
|
addReminder(reminder: CalendarReminder JSON): boolean
Adds the reminder to the calendar event. |
|
canUserReopen(): boolean
Returns whether the current user can reopen the event. |
|
getContextFilters(): CalendarContextFilter[]
Returns the contexts of the calendar event. |
|
getDependencies(): CalendarDependencies
Returns the dependencies of the calendar event. |
|
getDescription(): string
Returns the description of the calendar task. |
|
getDueDate(): Date
Deprecated This method is deprecated, use "getEndDate()" instead. |
|
getEndDate(): Date
Returns the end date of the calendar task (formerly known as due date). |
|
getId(): string
Returns the ID of the calendar task. |
|
getName(): string
Returns the name of the calendar task. |
|
getOwners(): string[]
Returns the owners of the calendar event. |
|
getParentId(): string
Returns the ID of the parent process of the calendar event. |
|
getProgress(): integer
Returns the progress of the calendar task. |
|
getReminders(): CalendarReminder[]
Returns the reminders of the calendar event. |
|
getStartDate(): Date
Returns the start date of the calendar task. |
|
getStatus(): CalendarTaskStatus
Returns the status of the calendar task. |
|
getType(): CalendarTaskType
Returns the type of the calendar task. |
|
hasUserRole(calendarRoleType: CalendarTaskUserRoleType): boolean
Returns whether the current user has the specified role of the calendar task. |
|
removeAssignee(assignee: string): boolean
Removes the assignee from the calendar event. |
|
removeContextFilter(contextFilter: CalendarContextFilter JSON): boolean
Removes the context filter from the calendar event. |
|
removeOwner(owner: string): boolean
Removes the owner from the calendar event. |
|
removeReminder(reminder: CalendarReminder JSON): boolean
Removes the reminder from the calendar event. |
|
reopen(includingChildren?: boolean): boolean
Reopens an event. |
|
sendImmediateReminder(message?: string): boolean
Sends an immediate reminder with an optional message. |
|
setDependencies(dependencies: CalendarDependencies JSON): boolean
Sets the dependencies of the calendar event. |
|
setDescription(description: string): boolean
Sets the description of the calendar event. |
|
setEndDate(endDate: Date): boolean
Sets the end date of the calendar event. |
|
setName(name: string): boolean
Sets the name of the calendar event. |
|
setParentId(parentId: string): boolean
Sets the ID of the parent process of the calendar event. |
|
setProgress(progress: integer): boolean
Sets the progress of the calendar event. |
|
setStartDate(startDate: Date): boolean
Sets the start date of the calendar event. |
| activate |
|
activate(): boolean
Activates a task. If this operation was successful, then true is returned, and false if it wasn't. The notify option is deprecated and no longer has an effect.
Returns
boolean
Last Update
2024.19
|
| addAssignee | |||
|
addAssignee(assignee: string): boolean
Adds the assignee to the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| addContextFilter | |||
|
addContextFilter(contextFilter: CalendarContextFilter JSON): boolean
Adds the context filter to the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| addOwner | |||
|
addOwner(owner: string): boolean
Adds the owner to the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| addReminder | |||
|
addReminder(reminder: CalendarReminder JSON): boolean
Adds the reminder to the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| canUserReopen |
|
canUserReopen(): boolean
Returns whether the current user can reopen the event. An event can be reopened if the event has a final status and the user is an owner of this event.
Returns
boolean |
| getContextFilters |
|
getContextFilters(): CalendarContextFilter[]
Returns the contexts of the calendar event.
Returns
CalendarContextFilter[] |
| getDependencies |
|
getDependencies(): CalendarDependencies
Returns the dependencies of the calendar event.
Returns
CalendarDependencies |
| getDescription |
|
getDescription(): string
Returns the description of the calendar task.
Returns
string |
| getDueDate |
|
getDueDate(): Date
Deprecated This method is deprecated, use "getEndDate()" instead. Returns the due date of the calendar task.
Returns
Date
Deprecated
2024.3
|
| getEndDate |
|
getEndDate(): Date
Returns the end date of the calendar task (formerly known as due date).
Returns
Date |
| getId |
|
getId(): string
Returns the ID of the calendar task.
Returns
string |
| getName |
|
getName(): string
Returns the name of the calendar task.
Returns
string |
| getOwners |
|
getOwners(): string[]
Returns the owners of the calendar event.
Returns
string[] |
| getParentId |
|
getParentId(): string
Returns the ID of the parent process of the calendar event.
Returns
string |
| getProgress |
|
getProgress(): integer
Returns the progress of the calendar task. The progress is specified as an integer between 0 and 100.
Returns
integer |
| getReminders |
|
getReminders(): CalendarReminder[]
Returns the reminders of the calendar event.
Returns
CalendarReminder[] |
| getStartDate |
|
getStartDate(): Date
Returns the start date of the calendar task.
Returns
Date |
| getStatus |
|
getStatus(): CalendarTaskStatus
Returns the status of the calendar task.
Returns
CalendarTaskStatus |
| getType |
|
getType(): CalendarTaskType
Returns the type of the calendar task.
Returns
CalendarTaskType |
| hasUserRole | |||
|
hasUserRole(calendarRoleType: CalendarTaskUserRoleType): boolean
Returns whether the current user has the specified role of the calendar task.
Parameters
Returns
boolean |
| removeAssignee | |||
|
removeAssignee(assignee: string): boolean
Removes the assignee from the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| removeContextFilter | |||
|
removeContextFilter(contextFilter: CalendarContextFilter JSON): boolean
Removes the context filter from the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| removeOwner | |||
|
removeOwner(owner: string): boolean
Removes the owner from the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| removeReminder | |||
|
removeReminder(reminder: CalendarReminder JSON): boolean
Removes the reminder from the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| reopen | |||
|
reopen(includingChildren?: boolean): boolean
Reopens an event. Optionally, for processes all child events can be included to reopen.
Parameters
Returns
boolean |
| sendImmediateReminder | |||
|
sendImmediateReminder(message?: string): boolean
Sends an immediate reminder with an optional message. All involved people will directly receive a notification.
Parameters
Returns
boolean |
| setDependencies | |||
|
setDependencies(dependencies: CalendarDependencies JSON): boolean
Sets the dependencies of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| setDescription | |||
|
setDescription(description: string): boolean
Sets the description of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| setEndDate | |||
|
setEndDate(endDate: Date): boolean
Sets the end date of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| setName | |||
|
setName(name: string): boolean
Sets the name of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| setParentId | |||
|
setParentId(parentId: string): boolean
Sets the ID of the parent process of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| setProgress | |||
|
setProgress(progress: integer): boolean
Sets the progress of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| setStartDate | |||
|
setStartDate(startDate: Date): boolean
Sets the start date of the calendar event. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| Name and Description |
|
autoActivate: boolean
Specifies whether the event should automatically be activated when the start date is reached. |
| Name and Description |
|
canUserDecline(): boolean
Returns whether the current user can decline the task. |
|
canUserSubmit(): boolean
Returns whether the current user can submit the task. |
|
decline(): boolean
Declines the calendar task. |
|
submit(): boolean
Submits the calendar task. |
| canUserDecline |
|
canUserDecline(): boolean
Returns whether the current user can decline the task. A task can be declined if the assignee can still work on their task and the task isn't final yet.
Returns
boolean
Since
2021.19
|
| canUserSubmit |
|
canUserSubmit(): boolean
Returns whether the current user can submit the task. A task can be submitted if the assignee has their turn and the status is "In Progress" or "Open".
Returns
boolean
Since
2021.19
|
| decline |
|
decline(): boolean
Declines the calendar task. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| submit |
|
submit(): boolean
Submits the calendar task. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| Name and Description |
|
assignees: string[]
Assignees of the calendar task |
|
contextFilters: CalendarContextFilter[] JSON
Context filters of the calendar task |
|
dependencies: CalendarDependencies JSON
Dependencies of the calendar task |
|
description: string
Description of the calendar task |
|
endDate: Date
End date of the calendar task (formerly known as due date) |
|
name: string
Name of the calendar task |
|
owners: string[]
Owners of the calendar task |
|
parentId: string
ID of the parent process of the calendar task |
|
reminders: CalendarReminder[] JSON
Reminders of the calendar task |
|
startDate: Date
Start date of the calendar task |
|
workFiles: CalendarTaskWorkFile[] JSON
Work files of the calendar task |
| assignees |
| assignees: string[] Assignees of the calendar task |
| contextFilters |
| contextFilters: CalendarContextFilter[] JSON Context filters of the calendar task |
| dependencies |
| dependencies: CalendarDependencies JSON Dependencies of the calendar task |
| description |
| description: string Description of the calendar task |
| endDate |
| endDate: Date End date of the calendar task (formerly known as due date) |
| name |
| name: string Name of the calendar task |
| owners |
| owners: string[] Owners of the calendar task |
| parentId |
| parentId: string ID of the parent process of the calendar task |
| reminders |
| reminders: CalendarReminder[] JSON Reminders of the calendar task |
| startDate |
| startDate: Date Start date of the calendar task |
| workFiles |
| workFiles: CalendarTaskWorkFile[] JSON Work files of the calendar task |
| Name and Description |
|
createCompositeTask(taskProperties: CalendarCompositeTaskCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON | CalendarCompositeTaskCreateOptions JSON): CalendarCompositeTask
Deprecated This method is deprecated, use "createGeneralTask" and "createReviewTask" instead. |
|
createGeneralTask(taskProperties: CalendarGeneralTaskCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON): CalendarGeneralTask
Creates a general task specified by the task properties and the create options. |
|
createProcess(processProperties: CalendarProcessCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON): CalendarProcess
Creates a process specified by the process properties and the create options. |
|
createProcessFromTemplate(templateId: string, processFromTemplateProperties: CalendarProcessFromTemplateCreateProperties JSON): CalendarProcess
Creates a process from template specified by the template id, process properties and the create options. |
|
createReviewTask(taskProperties: CalendarReviewTaskCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON): CalendarReviewTask
Creates a review task specified by the task properties and the create options. |
|
getCalendarEventById(eventId: string): CalendarEvent
Returns the calendar event specified by the event ID. |
|
getCalendarTaskById(taskId: string): CalendarEvent
Deprecated This method is deprecated, use "getCalendarEventById" instead. |
|
getCurrentEvent(): CalendarEvent
Returns the calendar event with which the analytic application or story was started. |
|
getCurrentTask(): CalendarEvent
Deprecated This method is deprecated, use "getCurrentEvent" instead. |
|
getRelatedEventIds(): string[]
Returns an array of IDs of the events where the analytic application or story is a work file. |
|
getRelatedTaskIds(): string[]
Deprecated This method is deprecated, use "getRelatedEventIds" instead. |
| createCompositeTask | ||||||
|
createCompositeTask(taskProperties: CalendarCompositeTaskCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON | CalendarCompositeTaskCreateOptions JSON): CalendarCompositeTask
Deprecated This method is deprecated, use "createGeneralTask" and "createReviewTask" instead. Creates a composite task specified by the task properties and the create options. If this operation was successful, then the composite task is returned, and undefined if it wasn't.
Parameters
Returns
CalendarCompositeTask
Since
2021.13
Last Update
2024.3
Deprecated
2024.17
|
| createGeneralTask | ||||||
|
createGeneralTask(taskProperties: CalendarGeneralTaskCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON): CalendarGeneralTask
Creates a general task specified by the task properties and the create options. If this operation was successful, then the general task is returned, and undefined if it wasn't.
Parameters
Returns
CalendarGeneralTask
Since
2024.17
|
| createProcess | ||||||
|
createProcess(processProperties: CalendarProcessCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON): CalendarProcess
Creates a process specified by the process properties and the create options. If this operation was successful, then the process is returned, and undefined if it wasn't.
Parameters
Returns
CalendarProcess
Since
2024.3
|
| createProcessFromTemplate | ||||||
|
createProcessFromTemplate(templateId: string, processFromTemplateProperties: CalendarProcessFromTemplateCreateProperties JSON): CalendarProcess
Creates a process from template specified by the template id, process properties and the create options. If this operation was successful, then the process is returned, and undefined if it wasn't.
Parameters
Returns
CalendarProcess
Since
2024.17
|
| createReviewTask | ||||||
|
createReviewTask(taskProperties: CalendarReviewTaskCreateProperties JSON, createOptions?: CalendarEventCreateOptions JSON): CalendarReviewTask
Creates a review task specified by the task properties and the create options. If this operation was successful, then the review task is returned, and undefined if it wasn't.
Parameters
Returns
CalendarReviewTask
Since
2024.17
|
| getCalendarEventById | |||
|
getCalendarEventById(eventId: string): CalendarEvent
Returns the calendar event specified by the event ID. If no calendar event was found, then undefined is returned.
Parameters
Returns
CalendarEvent
Since
2024.3
|
| getCalendarTaskById | |||
|
getCalendarTaskById(taskId: string): CalendarEvent
Deprecated This method is deprecated, use "getCalendarEventById" instead. Returns the calendar task specified by the task ID. If no calendar task was found, then undefined is returned.
Parameters
Returns
CalendarEvent
Since
2021.13
Last Update
2024.3
Deprecated
2024.3
|
| getCurrentEvent |
|
getCurrentEvent(): CalendarEvent
Returns the calendar event with which the analytic application or story was started. If the analytic application or story isn't associated with a calendar event, then undefined is returned.
Returns
CalendarEvent
Since
2024.3
|
| getCurrentTask |
|
getCurrentTask(): CalendarEvent
Deprecated This method is deprecated, use "getCurrentEvent" instead. Returns the calendar task with which the analytic application or story was started. If the analytic application or story isn't associated with a calendar task, then undefined is returned.
Returns
CalendarEvent
Last Update
2024.3
Deprecated
2024.3
|
| getRelatedEventIds |
|
getRelatedEventIds(): string[]
Returns an array of IDs of the events where the analytic application or story is a work file. Recurring events are excluded from the result.
Returns
string[]
Since
2024.3
|
| getRelatedTaskIds |
|
getRelatedTaskIds(): string[]
Deprecated This method is deprecated, use "getRelatedEventIds" instead. Returns an array of task IDs for which the analytic application or story is a work file. Recurring composite tasks are excluded from the result.
Returns
string[]
Since
2021.13
Deprecated
2024.3
|
| Name and Description |
|
canUserDecline(): boolean
Returns whether the current user can decline the process. |
|
canUserSubmit(): boolean
Returns whether the current user can submit the process. |
|
decline(): boolean
Declines the calendar process. |
|
getChildren(): string[]
Returns an array of children IDs of the selected process. |
|
submit(): boolean
Submits the calendar process. |
| canUserDecline |
|
canUserDecline(): boolean
Returns whether the current user can decline the process. A process can be declined if the assignee can still work on their process and the process isn't final yet.
Returns
boolean |
| canUserSubmit |
|
canUserSubmit(): boolean
Returns whether the current user can submit the process. A process can be submitted if the assignee has their turn and the status is "In Progress" or "Open".
Returns
boolean |
| decline |
|
decline(): boolean
Declines the calendar process. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| getChildren |
|
getChildren(): string[]
Returns an array of children IDs of the selected process.
Returns
string[] |
| submit |
|
submit(): boolean
Submits the calendar process. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| Name and Description |
|
assignees: string[]
Assignees of the calendar process |
|
contextFilters: CalendarContextFilter[] JSON
Context filters of the calendar process |
|
dependencies: CalendarDependencies JSON
Dependencies of the calendar process |
|
description: string
Description of the calendar process |
|
endDate: Date
End date of the calendar process |
|
name: string
Name of the calendar process |
|
owners: string[]
Owners of the calendar process |
|
parentId: string
ID of the parent process of the calendar process |
|
reminders: CalendarReminder[] JSON
Reminders of the calendar process |
|
startDate: Date
Start date of the calendar process |
|
workFiles: CalendarTaskWorkFile[] JSON
Work files of the calendar process |
| assignees |
| assignees: string[] Assignees of the calendar process |
| contextFilters |
| contextFilters: CalendarContextFilter[] JSON Context filters of the calendar process |
| dependencies |
| dependencies: CalendarDependencies JSON Dependencies of the calendar process |
| description |
| description: string Description of the calendar process |
| endDate |
| endDate: Date End date of the calendar process |
| name |
| name: string Name of the calendar process |
| owners |
| owners: string[] Owners of the calendar process |
| parentId |
| parentId: string ID of the parent process of the calendar process |
| reminders |
| reminders: CalendarReminder[] JSON Reminders of the calendar process |
| startDate |
| startDate: Date Start date of the calendar process |
| workFiles |
| workFiles: CalendarTaskWorkFile[] JSON Work files of the calendar process |
| Name and Description |
|
dependencies: CalendarDependencies JSON
Dependencies of the calendar process |
|
endDate: Date
End date of the calendar process |
|
parentId: string
ID of the parent process of the calendar process |
|
prefix: string
Prefix of the generated events |
|
startDate: Date
Start date of the calendar process |
|
suffix: string
Suffix of the generated events |
|
useTypeBasedNames: boolean
Specifies whether the event names should be based on the event type or on the template name. |
| dependencies |
| dependencies: CalendarDependencies JSON Dependencies of the calendar process |
| endDate |
| endDate: Date End date of the calendar process |
| parentId |
| parentId: string ID of the parent process of the calendar process |
| prefix |
| prefix: string Prefix of the generated events |
| startDate |
| startDate: Date Start date of the calendar process |
| suffix |
| suffix: string Suffix of the generated events |
| useTypeBasedNames |
| useTypeBasedNames: boolean Specifies whether the event names should be based on the event type or on the template name. |
| Name and Description |
|
measure: CalendarReminderMeasureType
Measure of the reminder |
|
number: number
Number of the reminder to specify the amount of time. |
|
reference: CalendarReminderReferenceType
Reference of the reminder. |
| measure |
| measure: CalendarReminderMeasureType Measure of the reminder |
| number |
| number: number Number of the reminder to specify the amount of time. Half time reminders don't require this property. |
| reference |
| reference: CalendarReminderReferenceType Reference of the reminder. Half time reminders don't require this property. |
| Name and Description |
|
static Day: CalendarReminderMeasureType
The reminder is sent the specified days before the start or end of the event. |
|
static HalfTime: CalendarReminderMeasureType
The reminder is sent at the half of the event time. |
|
static Hour: CalendarReminderMeasureType
The reminder is sent the specified hours before the start or end of the event. |
|
static Minute: CalendarReminderMeasureType
The reminder is sent the specified minutes before the start or end of the event. |
| Day |
| static Day: CalendarReminderMeasureType The reminder is sent the specified days before the start or end of the event. |
| HalfTime |
| static HalfTime: CalendarReminderMeasureType The reminder is sent at the half of the event time. |
| Hour |
| static Hour: CalendarReminderMeasureType The reminder is sent the specified hours before the start or end of the event. |
| Minute |
| static Minute: CalendarReminderMeasureType The reminder is sent the specified minutes before the start or end of the event. |
| Name and Description |
|
static End: CalendarReminderReferenceType
The reminder is based on the end date. |
|
static Start: CalendarReminderReferenceType
The reminder is based on the start date. |
| End |
| static End: CalendarReminderReferenceType The reminder is based on the end date. |
| Start |
| static Start: CalendarReminderReferenceType The reminder is based on the start date. |
| Name and Description |
|
approve(): boolean
Approves the calendar task. |
|
canUserApprove(): boolean
Returns whether the current user can approve the task. |
|
canUserReject(): boolean
Returns whether the current user can reject the task. |
|
reject(): boolean
Rejects the calendar task. |
| approve |
|
approve(): boolean
Approves the calendar task. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| canUserApprove |
|
canUserApprove(): boolean
Returns whether the current user can approve the task. A task can be approved if the reviewer has their turn in the reviewer round and the status is "In Progress" or "Open".
Returns
boolean
Since
2021.19
|
| canUserReject |
|
canUserReject(): boolean
Returns whether the current user can reject the task. A task can be rejected if the reviewer has their turn in the reviewer round and the status is "In Progress" or "Open".
Returns
boolean
Since
2021.19
|
| reject |
|
reject(): boolean
Rejects the calendar task. Requires the user role "Assignee". If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| Name and Description |
|
assignees: string[]
Assignees of the calendar task |
|
contextFilters: CalendarContextFilter[] JSON
Context filters of the calendar task |
|
dependencies: CalendarDependencies JSON
Dependencies of the calendar task |
|
description: string
Description of the calendar task |
|
endDate: Date
End date of the calendar task (formerly known as due date) |
|
name: string
Name of the calendar task |
|
owners: string[]
Owners of the calendar task |
|
parentId: string
ID of the parent process of the calendar task |
|
reminders: CalendarReminder[] JSON
Reminders of the calendar task |
|
workFiles: CalendarTaskWorkFile[] JSON
Work files of the calendar task |
| assignees |
| assignees: string[] Assignees of the calendar task |
| contextFilters |
| contextFilters: CalendarContextFilter[] JSON Context filters of the calendar task |
| dependencies |
| dependencies: CalendarDependencies JSON Dependencies of the calendar task |
| description |
| description: string Description of the calendar task |
| endDate |
| endDate: Date End date of the calendar task (formerly known as due date) |
| name |
| name: string Name of the calendar task |
| owners |
| owners: string[] Owners of the calendar task |
| parentId |
| parentId: string ID of the parent process of the calendar task |
| reminders |
| reminders: CalendarReminder[] JSON Reminders of the calendar task |
| workFiles |
| workFiles: CalendarTaskWorkFile[] JSON Work files of the calendar task |
| Name and Description |
|
static Canceled: CalendarTaskStatus
The calendar task is in status "Canceled". |
|
static Failed: CalendarTaskStatus
The calendar task is in status "Failed". |
|
static Inactive: CalendarTaskStatus
The calendar task is in status "Inactive". |
|
static InProgress: CalendarTaskStatus
The calendar task is in status "In Progress". |
|
static NoAssignee: CalendarTaskStatus
The calendar task is in status "No Assignee". |
|
static OnHold: CalendarTaskStatus
The calendar task is in status "On Hold". |
|
static Open: CalendarTaskStatus
The calendar task is in status "Open". |
|
static PartiallySuccessful: CalendarTaskStatus
The calendar task is in status "Partially Successful". |
|
static Successful: CalendarTaskStatus
The calendar task is in status "Successful". |
| Canceled |
| static Canceled: CalendarTaskStatus The calendar task is in status "Canceled". |
| Failed |
|
static Failed: CalendarTaskStatus
The calendar task is in status "Failed".
Since
2024.14
|
| Inactive |
|
static Inactive: CalendarTaskStatus
The calendar task is in status "Inactive".
Since
2021.13
|
| InProgress |
| static InProgress: CalendarTaskStatus The calendar task is in status "In Progress". |
| NoAssignee |
|
static NoAssignee: CalendarTaskStatus
The calendar task is in status "No Assignee".
Since
2021.13
|
| OnHold |
| static OnHold: CalendarTaskStatus The calendar task is in status "On Hold". |
| Open |
| static Open: CalendarTaskStatus The calendar task is in status "Open". |
| PartiallySuccessful |
|
static PartiallySuccessful: CalendarTaskStatus
The calendar task is in status "Partially Successful".
Since
2024.14
|
| Successful |
|
static Successful: CalendarTaskStatus
The calendar task is in status "Successful".
Since
2023.3
|
| Name and Description |
|
static CompositeTask: CalendarTaskType
Composite task |
|
static GeneralTask: CalendarTaskType
General task |
|
static Process: CalendarTaskType
Process |
|
static ReviewTask: CalendarTaskType
Review task |
| CompositeTask |
| static CompositeTask: CalendarTaskType Composite task |
| GeneralTask |
| static GeneralTask: CalendarTaskType General task |
| Process |
|
static Process: CalendarTaskType
Process
Since
2024.3
|
| ReviewTask |
| static ReviewTask: CalendarTaskType Review task |
| Name and Description |
|
static Assignee: CalendarTaskUserRoleType
The person who processes the calendar task |
|
static Owner: CalendarTaskUserRoleType
The person who created the calendar task |
|
static Reviewer: CalendarTaskUserRoleType
The person who supervises the work of the assignee |
| Assignee |
| static Assignee: CalendarTaskUserRoleType The person who processes the calendar task |
| Owner |
| static Owner: CalendarTaskUserRoleType The person who created the calendar task |
| Reviewer |
| static Reviewer: CalendarTaskUserRoleType The person who supervises the work of the assignee |
| Name and Description |
|
id: string
ID of the work file |
|
type: CalendarTaskWorkFileType
Type of the work file |
| id |
| id: string ID of the work file |
| type |
| type: CalendarTaskWorkFileType Type of the work file |
| Name and Description |
|
static AnalyticApplication: CalendarTaskWorkFileType
The work file is an analytic application. |
|
static Story: CalendarTaskWorkFileType
The work file is a story. |
| AnalyticApplication |
| static AnalyticApplication: CalendarTaskWorkFileType The work file is an analytic application. |
| Story |
| static Story: CalendarTaskWorkFileType The work file is a story. |
| Name and Description |
|
day: integer
day |
|
granularity: CalendarTimeGranularity
granularity |
|
halfYear: integer
halfYear |
|
month: integer
month |
|
quarter: integer
quarter |
|
week: integer
week |
|
year: integer
year |
| day |
| day: integer day |
| granularity |
| granularity: CalendarTimeGranularity granularity |
| halfYear |
| halfYear: integer halfYear |
| month |
| month: integer month |
| quarter |
| quarter: integer quarter |
| week |
| week: integer week |
| year |
| year: integer year |
| Name and Description |
|
static Day: CalendarTimeGranularity
days |
|
static HalfYear: CalendarTimeGranularity
halfYears |
|
static Month: CalendarTimeGranularity
months |
|
static Quarter: CalendarTimeGranularity
quarters |
|
static Week: CalendarTimeGranularity
weeks |
|
static Year: CalendarTimeGranularity
years |
| Day |
| static Day: CalendarTimeGranularity days |
| HalfYear |
| static HalfYear: CalendarTimeGranularity halfYears |
| Month |
| static Month: CalendarTimeGranularity months |
| Quarter |
| static Quarter: CalendarTimeGranularity quarters |
| Week |
| static Week: CalendarTimeGranularity weeks |
| Year |
| static Year: CalendarTimeGranularity years |
| Name and Description |
|
cast(type: Type, arg: <any type>): <type of type>
Cast an object to the specified type. |
| cast | ||||||
|
cast(type: Type, arg: <any type>): <type of type>
Cast an object to the specified type. For example, you can cast a variable filterValue of type FilterValue to the FilterValue subtype SingleFilterValue to access the SingleFilterValue's value property (note the check whether the object is of the correct target type before the cast operation): if (filterValue.type === FilterValueType.Single) { var singleFilter = cast(Type.SingleFilterValue, filterValue); console.log(singleFilter.value); }.
Parameters
Returns
<type of type> |
| Name and Description |
|
addDimension(dimension: string | DimensionInfo JSON, feed: Feed, position?: integer): void
Adds the dimension to the feed, at the specified position. |
|
addMeasure(measure: string | MeasureInfo JSON, feed: Feed, position?: integer): void
Deprecated This method is deprecated, use addMember() instead. |
|
addMember(feed: Feed, structureMember: string | MeasureInfo JSON | MemberInfo JSON, position?: integer): void
Adds the structure member to the feed, at the specified position. |
|
getDataChangeInsights(): ChartDataChangeInsights
Returns the Data Change Insights of the chart. |
|
getDataSource(): DataSource
Returns the data source of the chart. |
|
getDimensions(feed: Feed): string[]
Returns the dimensions of the feed. |
|
getEffectiveAxisScale(feed: Feed): ChartAxisScaleEffective
Returns effective scale's min/max of chart |
|
getForecast(): Forecast
Returns the forecast of the chart. |
|
getMeasures(feed: Feed): string[]
Deprecated This method is deprecated, use getMembers() instead. |
|
getMembers(feed: Feed): string[]
Returns the structure members of the feed. |
|
getNumberFormat(): ChartNumberFormat
Returns the chart number format. |
|
getSelections(): Selection[]
Returns the selections of the chart. |
|
getSmartGrouping(): SmartGrouping
Returns the Smart Grouping of the chart. |
|
isEnabled(): boolean
Returns whether the user interaction with the chart is enabled. |
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the chart. |
|
openInNewStory(): void
Creates a new story with this widget. |
|
openSelectModelDialog(): void
Opens the select model dialog. |
|
rankBy(rankOptions: ChartRankOptions JSON): void
(Only available in optimized view mode) Creates a Top N filter to show a specified number of the lowest or highest ranked members. |
|
removeDimension(dimension: string | DimensionInfo JSON, feed: Feed): void
Removes the dimension from the feed. |
|
removeMeasure(measure: string | MeasureInfo JSON, feed: Feed): void
Deprecated This method is deprecated, use removeMember() instead. |
|
removeMember(feed: Feed, member: string | MeasureInfo JSON | MemberInfo JSON): void
Removes the structure member from the feed. |
|
removeRanking(): void
(Only available in optimized view mode) Clears ranking and shows all the members with sort order retained, if applicable. |
|
removeSorting(): void
(Only available in optimized view mode) Clears sorting and shows the members in default order. |
|
setAxisScale(feed: Feed, axisScale: ChartAxisScale JSON): void
Specifies the axis scale of chart. |
|
setBreakGroupingEnabled(enabled: boolean): void
(Only available in optimized view mode) Enables or disables Break Grouping when sorting. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the chart. |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
|
setQuickActionsVisibility(quickActionsVisibility: ChartQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility. |
|
sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void
(Only available in optimized view mode) Sorts dimension members in a chart. |
|
sortByValue(structureMember: string | MemberInfo JSON | MeasureInfo JSON, sortOrder: SortOrder, secondaryStructureMember?: string | MemberInfo JSON | MeasureInfo JSON): void
(Only available in optimized view mode) Sorts measure values in a chart. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onResultChanged(): void Called when the result set displayed by the chart changes. |
|
onSelect(): void Called when the user makes a selection within the chart. |
| addDimension | |||||||||
|
addDimension(dimension: string | DimensionInfo JSON, feed: Feed, position?: integer): void
Adds the dimension to the feed, at the specified position. If no position is specified, then the dimension is added at the end of the feed.
Parameters
Last Update
2019.7
|
| addMeasure | |||||||||
|
addMeasure(measure: string | MeasureInfo JSON, feed: Feed, position?: integer): void
Deprecated This method is deprecated, use addMember() instead. Adds the measure to the feed, at the specified position. If no position is specified, then the measure is added at the end of the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.Color and Feed.bubbleWidth.
Parameters
Last Update
2019.7
Deprecated
2021.6
|
| addMember | |||||||||
|
addMember(feed: Feed, structureMember: string | MeasureInfo JSON | MemberInfo JSON, position?: integer): void
Adds the structure member to the feed, at the specified position. If no position is specified, then the member is added at the end of the feed. Specify for the structure member either a measure member for a model with measures only or an account member for a model with accounts. When the structure member is a measure, it can be only added to Feed.ValueAxis, Feed.ValueAxis2, Feed.TooltipValueAxis, Feed.Color and Feed.bubbleWidth.
Parameters
Since
2021.6
|
| getDataChangeInsights |
|
getDataChangeInsights(): ChartDataChangeInsights
Returns the Data Change Insights of the chart.
Returns
ChartDataChangeInsights
Since
2021.5
|
| getDataSource |
|
getDataSource(): DataSource
Returns the data source of the chart.
Returns
DataSource |
| getDimensions | |||
|
getDimensions(feed: Feed): string[]
Returns the dimensions of the feed.
Parameters
Returns
string[]
Since
2019.1
Last Update
2019.7
|
| getEffectiveAxisScale | |||
|
getEffectiveAxisScale(feed: Feed): ChartAxisScaleEffective
Returns effective scale's min/max of chart
Parameters
Returns
ChartAxisScaleEffective
Since
2022.7
|
| getForecast |
|
getForecast(): Forecast
Returns the forecast of the chart.
Returns
Forecast
Mobile Support
Not supported on mobile devices.
|
| getMeasures | |||
|
getMeasures(feed: Feed): string[]
Deprecated This method is deprecated, use getMembers() instead. Returns the measures of the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures.
Parameters
Returns
string[]
Since
2019.1
Last Update
2019.7
Deprecated
2021.6
|
| getMembers | |||
|
getMembers(feed: Feed): string[]
Returns the structure members of the feed. The structure members are either measure members from a model with measures only or account members from a model with accounts.
Parameters
Returns
string[]
Since
2021.6
|
| getNumberFormat |
|
getNumberFormat(): ChartNumberFormat
Returns the chart number format.
Returns
ChartNumberFormat
Since
2020.11
|
| getSelections |
|
getSelections(): Selection[]
Returns the selections of the chart. You can use the elements of the returned array with DataSource.getData() to get the value of a cell. See also the documentation of Selection.
Returns
Selection[]
Since
2019.7
|
| getSmartGrouping |
|
getSmartGrouping(): SmartGrouping
Returns the Smart Grouping of the chart.
Returns
SmartGrouping
Mobile Support
Not supported on mobile devices.
|
| isEnabled |
|
isEnabled(): boolean
Returns whether the user interaction with the chart is enabled.
Returns
boolean
Since
2020.20
|
| openDataAnalyzer | |||
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the chart.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2024.25
|
| openInNewStory |
|
openInNewStory(): void
Creates a new story with this widget.
Mobile Support
Not supported on mobile devices.
Since
2021.3
|
| openSelectModelDialog |
|
openSelectModelDialog(): void
Opens the select model dialog. Selecting a model replaces the model of the chart.
Since
2024.24
|
| rankBy | |||
|
rankBy(rankOptions: ChartRankOptions JSON): void
(Only available in optimized view mode) Creates a Top N filter to show a specified number of the lowest or highest ranked members. Note that it is not supported in charts with Structures.
Parameters
Since
2022.7
|
| removeDimension | ||||||
|
removeDimension(dimension: string | DimensionInfo JSON, feed: Feed): void
Removes the dimension from the feed.
Parameters
Last Update
2019.7
|
| removeMeasure | ||||||
|
removeMeasure(measure: string | MeasureInfo JSON, feed: Feed): void
Deprecated This method is deprecated, use removeMember() instead. Removes the measure from the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.Color and Feed.bubbleWidth.
Parameters
Last Update
2019.7
Deprecated
2021.6
|
| removeMember | ||||||
|
removeMember(feed: Feed, member: string | MeasureInfo JSON | MemberInfo JSON): void
Removes the structure member from the feed. Specify for the structure member either a measure member for a model with measures only or an account member for a model with accounts. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.TooltipValueAxis, Feed.Color and Feed.bubbleWidth.
Parameters
Since
2021.6
|
| removeRanking |
|
removeRanking(): void
(Only available in optimized view mode) Clears ranking and shows all the members with sort order retained, if applicable.
Since
2022.7
|
| removeSorting |
|
removeSorting(): void
(Only available in optimized view mode) Clears sorting and shows the members in default order.
Since
2022.7
|
| setAxisScale | ||||||
|
setAxisScale(feed: Feed, axisScale: ChartAxisScale JSON): void
Specifies the axis scale of chart.
Parameters
Since
2022.7
|
| setBreakGroupingEnabled | |||
|
setBreakGroupingEnabled(enabled: boolean): void
(Only available in optimized view mode) Enables or disables Break Grouping when sorting.
Parameters
Since
2022.7
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the chart.
Parameters
Since
2020.20
|
| setModel | |||
|
setModel(modelId: string): boolean
Sets the model and replaces the old one.
Parameters
Returns
boolean
Since
2024.24
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: ChartQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| sortByMember | ||||||
|
sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void
(Only available in optimized view mode) Sorts dimension members in a chart. You can specify the dimension that you want to sort and the sort order.
Parameters
Since
2022.7
|
| sortByValue | |||||||||
|
sortByValue(structureMember: string | MemberInfo JSON | MeasureInfo JSON, sortOrder: SortOrder, secondaryStructureMember?: string | MemberInfo JSON | MeasureInfo JSON): void
(Only available in optimized view mode) Sorts measure values in a chart. You can specify the measure that you want to sort, the sort order, and, optionally, a secondary structure member.
Parameters
Since
2022.7
|
| Name and Description |
|
dynamicAxisEnabled: boolean
let the system dynamically set the minimum and maximum values. |
|
max: string
max scale of chart |
|
min: string
min scale of chart |
| Name and Description |
|
max: number
effective max scale of chart |
|
min: number
effective min scale of chart |
|
tickInterval: number
tick interval of axis scale |
| Name and Description |
|
getSubscriptionLevel(): DataChangeInsightsSubscriptionLevel
Returns the subscription level. |
|
getSubscriptionRange(): DataChangeInsightsSubscriptionRange
Returns the subscription range settings. |
|
setSubscriptionLevel(subscriptionLevel: DataChangeInsightsSubscriptionLevel): void
Sets the subscription level. |
|
setSubscriptionRange(subscriptionRange: DataChangeInsightsSubscriptionRange JSON): void
Sets the subscription range settings. |
| getSubscriptionLevel |
|
getSubscriptionLevel(): DataChangeInsightsSubscriptionLevel
Returns the subscription level.
Returns
DataChangeInsightsSubscriptionLevel |
| getSubscriptionRange |
|
getSubscriptionRange(): DataChangeInsightsSubscriptionRange
Returns the subscription range settings.
Returns
DataChangeInsightsSubscriptionRange |
| setSubscriptionLevel | |||
|
setSubscriptionLevel(subscriptionLevel: DataChangeInsightsSubscriptionLevel): void
Sets the subscription level.
Parameters
|
| setSubscriptionRange | |||
|
setSubscriptionRange(subscriptionRange: DataChangeInsightsSubscriptionRange JSON): void
Sets the subscription range settings.
Parameters
|
| Name and Description |
|
setDecimalPlaces(decimalPlaces: integer, measures?: string[]): void
Specifies the number of decimal places for specific or all measures. |
|
setScaleFormat(scaleFormat: NumberFormatScaleFormat): void
Specifies the scale format of the chart. |
|
setScaleUnit(scaleUnit: NumberFormatScaleUnit, feed: Feed): void
Specifies the scale unit of the labels of the feed. |
|
setSignDisplay(signDisplay: NumberFormatSignDisplay, measures?: string[]): void
Specifies how signs are displayed for specific or all measures. |
| setDecimalPlaces | ||||||
|
setDecimalPlaces(decimalPlaces: integer, measures?: string[]): void
Specifies the number of decimal places for specific or all measures. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example. Note: Not supported for universal account models.
Parameters
|
| setScaleFormat | |||
|
setScaleFormat(scaleFormat: NumberFormatScaleFormat): void
Specifies the scale format of the chart. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example.
Parameters
|
| setScaleUnit | ||||||
|
setScaleUnit(scaleUnit: NumberFormatScaleUnit, feed: Feed): void
Specifies the scale unit of the labels of the feed. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example.
Parameters
|
| setSignDisplay | ||||||
|
setSignDisplay(signDisplay: NumberFormatSignDisplay, measures?: string[]): void
Specifies how signs are displayed for specific or all measures. Number format APIs only apply to measures on axes, Feed.ValueAxis and Feed.ValueAxis2. Tooltip measures Feed.TooltipValueAxis, aren’t supported, for example. Note: Not supported for universal account models.
Parameters
|
| Name and Description |
|
static addComment: boolean
Comment |
|
static addCompoundGrowthRate: boolean
CGR |
|
static breakAxis: boolean
Break Axis |
|
static chartDetail: boolean
Applied to Chart |
|
static compareTo: boolean
Compare To |
|
static dataChangeInsights: boolean
Data Change Insights |
|
static drill: boolean
Drill |
|
static expand: boolean
Expand |
|
static exporting: boolean
Export |
|
static filter: boolean
Filter/Exclude |
|
static forecast: boolean
Forecast |
|
static fullscreen: boolean
Fullscreen |
|
static openHyperlink: boolean
Open Hyperlinks |
|
static rank: boolean
Ranking |
|
static selectConversions: boolean
Select Conversions |
|
static showAsPercentage: boolean
Show as Percentage |
|
static sort: boolean
Sorting |
|
static titleExpandCollapse: boolean
Collapse/Expand Title |
|
static variables: boolean
variables |
|
static zoom: boolean
Zoom |
| addComment |
| static addComment: boolean Comment |
| addCompoundGrowthRate |
| static addCompoundGrowthRate: boolean CGR |
| breakAxis |
| static breakAxis: boolean Break Axis |
| chartDetail |
|
static chartDetail: boolean
Applied to Chart
Since
2023.2
|
| compareTo |
| static compareTo: boolean Compare To |
| dataChangeInsights |
| static dataChangeInsights: boolean Data Change Insights |
| drill |
| static drill: boolean Drill |
| expand |
| static expand: boolean Expand |
| exporting |
| static exporting: boolean Export |
| filter |
| static filter: boolean Filter/Exclude |
| forecast |
| static forecast: boolean Forecast |
| fullscreen |
| static fullscreen: boolean Fullscreen |
| openHyperlink |
| static openHyperlink: boolean Open Hyperlinks |
| rank |
| static rank: boolean Ranking |
| selectConversions |
| static selectConversions: boolean Select Conversions |
| showAsPercentage |
| static showAsPercentage: boolean Show as Percentage |
| sort |
| static sort: boolean Sorting |
| titleExpandCollapse |
|
static titleExpandCollapse: boolean
Collapse/Expand Title
Since
2023.2
|
| variables |
|
static variables: boolean
variables
Since
2024.24
|
| zoom |
| static zoom: boolean Zoom |
| Name and Description |
|
rankOrder: RankOrder
Order used for ranking. |
|
secondaryStructureMember: string
Secondary structure member used for ranking |
|
structureMember: string
Structure member used for ranking |
|
value: integer
Number of values to include in the ranking filter |
|
versionId: string
Version ID |
| rankOrder |
| rankOrder: RankOrder Order used for ranking. The values RankOrder.Top or RankOrder.Bottom, for example, correspond to a descending or an ascending order of ranking, respectively. |
| secondaryStructureMember |
| secondaryStructureMember: string Secondary structure member used for ranking |
| structureMember |
| structureMember: string Structure member used for ranking |
| value |
| value: integer Number of values to include in the ranking filter |
| versionId |
| versionId: string Version ID |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the checkbox group. |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the checkbox group. |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the checkbox group. |
|
removeAllItems(): void
Removes all items from the checkbox group. |
|
removeItem(key: string): void
Removes an item from the checkbox group. |
|
setSelectedKeys(keys: string[]): void
Selects items in the checkbox group. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user changes the selection of a checkbox in the checkbox group. |
| 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
|
| getSelectedKeys |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the checkbox group. If no items are selected, then an empty array is returned.
Returns
string[] |
| getSelectedTexts |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the checkbox group. If no items are selected, then an empty array is returned.
Returns
string[] |
| removeAllItems |
| removeAllItems(): void 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
|
| 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
|
| Name and Description |
| commentId: string |
| createdAt: string |
| createdBy: UserInfo |
| numberOfLikes: integer |
| text: string |
| commentId |
| commentId: string |
| createdAt |
| createdAt: string |
| createdBy |
| createdBy: UserInfo |
| numberOfLikes |
| numberOfLikes: integer |
| text |
| text: string |
| Name and Description |
|
getCommentingDataSource(): CommentingDataSource
Returns the data source of the commenting widget. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| getCommentingDataSource |
|
getCommentingDataSource(): CommentingDataSource
Returns the data source of the commenting widget.
Returns
CommentingDataSource
Since
2021.5
|
| Name and Description |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
setDimensionFilter(dimension: string | DimensionInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[]): void
Sets a filter on the dimension. |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| removeDimensionFilter | |||
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| setDimensionFilter | ||||||
|
setDimensionFilter(dimension: string | DimensionInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[]): void
Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or more members to be included in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter.
Parameters
|
| Name and Description |
|
static fireEvent(eventName: string): Event
Fires composite interface event. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| fireEvent | |||
|
static fireEvent(eventName: string): Event
Fires composite interface event.
Parameters
Returns
Event
Since
2023.21
|
| hideBusyIndicator |
|
hideBusyIndicator(): void
Hides the busy indicator.
Since
2023.21
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
Since
2023.21
|
| Name and Description |
|
static log(arg: any): void
Outputs a message to the Web Console. |
| Name and Description |
|
static numberToString(value: number): string
Returns a string representation of the number value. |
|
static stringToInteger(value: string): integer
Returns the integer value represented by the string. |
|
static stringToNumber(value: string): number
Returns the number value represented by the string. |
| numberToString | |||
|
static numberToString(value: number): string
Returns a string representation of the number value. If the value is undefined, then the string "undefined" is returned.
Parameters
Returns
string |
| stringToInteger | |||
|
static stringToInteger(value: string): integer
Returns the integer value represented by the string. If the string can't be parsed to a decimal integer, then NaN is returned.
Parameters
Returns
integer |
| stringToNumber | |||
|
static stringToNumber(value: string): number
Returns the number value represented by the string. If the string can't be parsed to a decimal number, then NaN is returned.
Parameters
Returns
number |
| Name and Description |
|
static height: integer
Height |
|
static heightUnit: PopupSizeUnit
Height Unit |
|
static width: integer
Width |
|
static widthUnit: PopupSizeUnit
Width Unit |
| height |
| static height: integer Height |
| heightUnit |
| static heightUnit: PopupSizeUnit Height Unit |
| width |
| static width: integer Width |
| widthUnit |
| static widthUnit: PopupSizeUnit Width Unit |
| Name and Description |
|
static createCalendarDateTime(calendartime: CalendarTime JSON): CurrentDateTime
Creates a calendar date/time with the specified calendarTime. |
|
static createFiscalDateTime(modelId: string, dimension: string | DimensionInfo JSON, fiscalTime: FiscalTime JSON): CurrentDateTime
Creates a fiscal date/time with the specified modelId, time-based dimension and fiscalTime. |
| createCalendarDateTime | |||
|
static createCalendarDateTime(calendartime: CalendarTime JSON): CurrentDateTime
Creates a calendar date/time with the specified calendarTime. See also the documentation of CalendarTime.
Parameters
Returns
CurrentDateTime |
| createFiscalDateTime | |||||||||
|
static createFiscalDateTime(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
Returns
CurrentDateTime |
| Name and Description |
|
execute(): DataActionExecutionResponse
Executes the data action as a blocking operation, which prevents the rest of the application script from running until the data action is complete. |
|
executeInBackground(executionName: string): DataActionBackgroundExecutionResponse
Executes the data action as a non-blocking operation. |
|
getExecutionProgress(executionId: string): DataActionExecutionResponseStatus
Returns status of given Data Action execution. |
|
getParameterValue(id: string): DataActionParameterValue
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[] | DataActionParameterValue JSON | number): void
Sets the value of the parameter. |
| Name and Description |
|
onExecutionStatusUpdate(status: DataActionExecutionResponseStatus, executionId: string, executionName: string): void Called when an asynchronous Data Action execution changes its status. |
| execute |
|
execute(): DataActionExecutionResponse
Executes the data action as a blocking operation, which prevents the rest of the application script from running until the data action is complete. It's best to use it only for data actions that take a short time to run.
Returns
DataActionExecutionResponse |
| executeInBackground | |||
|
executeInBackground(executionName: string): DataActionBackgroundExecutionResponse
Executes the data action as a non-blocking operation. A non-blocking operation doesn't block further execution while that operation is executed.
Parameters
Returns
DataActionBackgroundExecutionResponse
Since
2022.12
|
| getExecutionProgress | |||
|
getExecutionProgress(executionId: string): DataActionExecutionResponseStatus
Returns status of given Data Action execution.
Parameters
Returns
DataActionExecutionResponseStatus
Since
2024.4
|
| getParameterValue | |||
|
getParameterValue(id: string): DataActionParameterValue
Returns the value of the parameter.
Parameters
Returns
DataActionParameterValue |
| isAllMembersSelected | |||
|
isAllMembersSelected(id: string): boolean
Returns whether the parameter has the all member as value.
Parameters
Returns
boolean
Since
2023.20
|
| setAllMembersSelected | ||||||
|
setAllMembersSelected(id: string, hierarchy?: string): void
Sets the all member as parameter value.
Parameters
Since
2023.20
|
| setParameterValue | ||||||
|
setParameterValue(id: string, value: string | string[] | DataActionParameterValue JSON | number): void
Sets the value of the parameter.
Parameters
|
| onExecutionStatusUpdate | |||||||||
|
onExecutionStatusUpdate(status: DataActionExecutionResponseStatus, executionId: string, executionName: string): void
Called when an asynchronous Data Action execution changes its status.
Parameters
Since
2022.12
|
| Name and Description |
|
hierarchy: string
Hierarchy name |
| Inherited from DataActionParameterValue |
| type |
| Name and Description |
|
executionId: string
Generated execution ID. |
|
status: DataActionBackgroundExecutionResponseStatus
Execution status |
| executionId |
| executionId: string Generated execution ID. |
| status |
| status: DataActionBackgroundExecutionResponseStatus Execution status |
| Name and Description |
|
static Accepted: DataActionBackgroundExecutionResponseStatus
Execution is accepted. |
|
static Error: DataActionBackgroundExecutionResponseStatus
Execution ended with errors. |
| Accepted |
|
static Accepted: DataActionBackgroundExecutionResponseStatus
Execution is accepted.
Last Update
2022.15
|
| Error |
|
static Error: DataActionBackgroundExecutionResponseStatus
Execution ended with errors.
Last Update
2022.15
|
| Name and Description |
|
status: DataActionExecutionResponseStatus
Execution result status |
| Name and Description |
|
static Accepted: DataActionExecutionResponseStatus
Execution is accepted. |
|
static Canceled: DataActionExecutionResponseStatus
Execution has been canceled. |
|
static Error: DataActionExecutionResponseStatus
Execution ended with errors. |
|
static Queued: DataActionExecutionResponseStatus
Execution is queued. |
|
static Running: DataActionExecutionResponseStatus
Execution is running. |
|
static Success: DataActionExecutionResponseStatus
Execution ended successfully. |
| Accepted |
|
static Accepted: DataActionExecutionResponseStatus
Execution is accepted.
Since
2024.4
|
| Canceled |
|
static Canceled: DataActionExecutionResponseStatus
Execution has been canceled.
Since
2022.3
|
| Error |
| static Error: DataActionExecutionResponseStatus Execution ended with errors. |
| Queued |
|
static Queued: DataActionExecutionResponseStatus
Execution is queued.
Since
2022.16
|
| Running |
|
static Running: DataActionExecutionResponseStatus
Execution is running.
Since
2022.12
|
| Success |
| static Success: DataActionExecutionResponseStatus Execution ended successfully. |
| Name and Description |
|
members: string[]
Member IDs |
| Inherited from DataActionParameterValue |
| type |
| Name and Description |
|
value: number
Number value |
| Inherited from DataActionParameterValue |
| type |
| Name and Description |
|
type: DataActionParameterValueType
Type of the parameter value |
| Name and Description |
|
static All: DataActionParameterValueType
All member selection type |
|
static Member: DataActionParameterValueType
Member value type |
|
static Number: DataActionParameterValueType
Number value type |
|
static PlanningModelMember: DataActionParameterValueType
Planning Model Member value type |
| All |
|
static All: DataActionParameterValueType
All member selection type
Since
2023.20
|
| Member |
| static Member: DataActionParameterValueType Member value type |
| Number |
| static Number: DataActionParameterValueType Number value type |
| PlanningModelMember |
|
static PlanningModelMember: DataActionParameterValueType
Planning Model Member value type
Since
2024.20
|
| Name and Description |
|
hierarchy: string
Specific hierarchy which should be used for the given members. |
|
members: PlanningModelMember[] JSON
Planning Model Member |
| Inherited from DataActionParameterValue |
| type |
| hierarchy |
| hierarchy: string Specific hierarchy which should be used for the given members. If undefined, the fixed hierarchy of the parameter or the default hierarchy of the dimension will be used |
| members |
| members: PlanningModelMember[] JSON Planning Model Member |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onBeforeExecute(): boolean Called when the user clicks the data action starter. |
| onBeforeExecute |
|
onBeforeExecute(): boolean
Called when the user clicks the data action starter. If this method returns true or returns no value, then the data action is executed. If this method returns false, then the data action is ignored.
Returns
boolean Default value: true
Since
2020.4
|
| Name and Description |
|
addDimensionToFeed(feed: string, dimensionId: string, position?: integer): void
Adds a dimension to a feed. |
|
addMemberToFeed(feed: string, memberId: string, position?: integer): void
Adds a member to a feed. |
|
getDataSource(): DataSource
Returns the data source of the data-binding. |
|
getDimensions(feed: string): string[]
Returns all dimensions on the feed. |
|
getLinkedAnalysis(): LinkedAnalysis
linked ayalysis for custom widget. |
|
getMembers(feed: string): string[]
Returns all members on the feed. |
|
openSelectModelDialog(): void
Opens the select model dialog. |
|
removeDimension(dimensionId: string): void
Removes a dimension from the feed on which it is currently on. |
|
removeMember(memberId: string): void
Removes a member from the feed on which it is currently on. |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
| addDimensionToFeed | |||||||||
|
addDimensionToFeed(feed: string, dimensionId: string, position?: integer): void
Adds a dimension to a feed.
Parameters
|
| addMemberToFeed | |||||||||
|
addMemberToFeed(feed: string, memberId: string, position?: integer): void
Adds a member to a feed.
Parameters
|
| getDataSource |
|
getDataSource(): DataSource
Returns the data source of the data-binding. If the data-binding has no data source, then undefined is returned.
Returns
DataSource |
| getDimensions | |||
|
getDimensions(feed: string): string[]
Returns all dimensions on the feed.
Parameters
Returns
string[] |
| getLinkedAnalysis |
|
getLinkedAnalysis(): LinkedAnalysis
linked ayalysis for custom widget.
Returns
LinkedAnalysis
Since
2023.15
|
| getMembers | |||
|
getMembers(feed: string): string[]
Returns all members on the feed.
Parameters
Returns
string[] |
| openSelectModelDialog |
| openSelectModelDialog(): void Opens the select model dialog. Selecting a model replaces the model and clears the query of the databinding. |
| removeDimension | |||
|
removeDimension(dimensionId: string): void
Removes a dimension from the feed on which it is currently on.
Parameters
|
| removeMember | |||
|
removeMember(memberId: string): void
Removes a member from the feed on which it is currently on.
Parameters
|
| setModel | |||
|
setModel(modelId: string): boolean
Sets the model and replaces the old one.
Parameters
Returns
boolean |
| Name and Description |
|
getDataBinding(dataBindingId?: string): DataBinding
Returns the databinding of the custom widget. |
| getDataBinding | |||
|
getDataBinding(dataBindingId?: string): DataBinding
Returns the databinding of the custom widget. If arugment is omitted, the first databinding defined in the contribution will be returned. If the customwidget has no databinding, then undefined is returned.
Parameters
Returns
DataBinding |
| Name and Description |
| formattedValue: string |
| rawValue: string |
| Name and Description |
| content: string |
| type: DataChangeInsightType |
| Name and Description |
|
compareApplicationStateWithSnapshot(target: Date, options?: DataChangeInsightsComparisonOptions JSON): DataChangeInsightsResult
Compares the current state of the analytic application with a Data Change Insights snapshot. |
|
compareSnapshots(source: Date, target: Date, options?: DataChangeInsightsComparisonOptions JSON): DataChangeInsightsResult
Compares two Data Change Insights snapshots by date. |
|
getVersion(): integer
Returns the Data Change Insights version of the analytic application. |
|
isRunBySnapshotGeneration(): boolean
Returns whether the Data Change Insights snapshot task is running. |
|
listRecentSnapshotDates(maximumNumber?: integer): Date[]
Returns a list of dates when a Data Change Insights snapshot was created from the analytic application. |
|
openSubscriptionDialog(): void
Opens the subscription dialog. |
|
saveSnapshot(): boolean
Saves a Data Change Insights snapshot. |
| compareApplicationStateWithSnapshot | ||||||
|
compareApplicationStateWithSnapshot(target: Date, options?: DataChangeInsightsComparisonOptions JSON): DataChangeInsightsResult
Compares the current state of the analytic application with a Data Change Insights snapshot.
Parameters
Returns
DataChangeInsightsResult |
| compareSnapshots | |||||||||
|
compareSnapshots(source: Date, target: Date, options?: DataChangeInsightsComparisonOptions JSON): DataChangeInsightsResult
Compares two Data Change Insights snapshots by date. Note: An analytic application can have only one Data Change Insights snapshot per day.
Parameters
Returns
DataChangeInsightsResult |
| getVersion |
|
getVersion(): integer
Returns the Data Change Insights version of the analytic application.
Returns
integer
Since
2021.5
|
| isRunBySnapshotGeneration |
|
isRunBySnapshotGeneration(): boolean
Returns whether the Data Change Insights snapshot task is running.
Returns
boolean |
| listRecentSnapshotDates | |||
|
listRecentSnapshotDates(maximumNumber?: integer): Date[]
Returns a list of dates when a Data Change Insights snapshot was created from the analytic application. Optionally, you can specify the maximum number of returned dates (default: 10 for Local Tenant Storage, 100 for Data Repositories). The maximum number is limited to 10 for Local Tenant Storage, 100 for Data Repositories.
Parameters
Returns
Date[] |
| openSubscriptionDialog |
|
openSubscriptionDialog(): void
Opens the subscription dialog.
Mobile Support
Not supported on mobile devices.
Since
2021.5
|
| saveSnapshot |
|
saveSnapshot(): boolean
Saves a Data Change Insights snapshot. Only one snapshot is kept per analytic application per day. When you save more snapshots per analytic application per day, then the latest snapshot overwrites the previous snapshot.
Returns
boolean |
| Name and Description |
|
top: integer
Number of returned Data Change Insights. |
| Name and Description |
| insights: DataChangeInsight[] |
| status: DataChangeInsightsStatus |
| statusMessage: string |
| insights |
| insights: DataChangeInsight[] |
| status |
| status: DataChangeInsightsStatus |
| statusMessage |
| statusMessage: string |
| Name and Description |
|
static Error: DataChangeInsightsStatus
Error |
|
static Invalid: DataChangeInsightsStatus
Invalid |
|
static Ok: DataChangeInsightsStatus
Ok |
| Error |
| static Error: DataChangeInsightsStatus Error |
| Invalid |
| static Invalid: DataChangeInsightsStatus Invalid |
| Ok |
| static Ok: DataChangeInsightsStatus Ok |
| Name and Description |
|
static Subscribed: DataChangeInsightsSubscriptionLevel
Subscribed |
|
static SubscribedHighImportance: DataChangeInsightsSubscriptionLevel
Subscribed with high importance |
|
static Unsubscribed: DataChangeInsightsSubscriptionLevel
Unsubscribed |
| Subscribed |
| static Subscribed: DataChangeInsightsSubscriptionLevel Subscribed |
| SubscribedHighImportance |
| static SubscribedHighImportance: DataChangeInsightsSubscriptionLevel Subscribed with high importance |
| Unsubscribed |
| static Unsubscribed: DataChangeInsightsSubscriptionLevel Unsubscribed |
| Name and Description |
|
isAbsoluteValue: boolean
Specifies whether the subscription range defines an absolute value. |
|
isDeltaValue: boolean
Specifies whether the subscription range defines a delta value. |
|
isInclude: boolean
Specifies whether the subscription range is inclusive. |
|
isMaxOrEqual: boolean
Specifies whether the subscription range defines values less or equal to the maximum value. |
|
isMinOrEqual: boolean
Specifies whether the subscription range defines values greater or equal to the minimum value. |
|
max: number
Maximum value of the subscription range |
|
min: number
Minimum value of the subscription range |
|
structureDimension: string
Structure dimension of the subscription range |
|
structureDimensionMember: string
Structure dimension member of the subscription range |
| isAbsoluteValue |
| isAbsoluteValue: boolean Specifies whether the subscription range defines an absolute value. |
| isDeltaValue |
| isDeltaValue: boolean Specifies whether the subscription range defines a delta value. |
| isInclude |
| isInclude: boolean Specifies whether the subscription range is inclusive. |
| isMaxOrEqual |
| isMaxOrEqual: boolean Specifies whether the subscription range defines values less or equal to the maximum value. |
| isMinOrEqual |
| isMinOrEqual: boolean Specifies whether the subscription range defines values greater or equal to the minimum value. |
| max |
| max: number Maximum value of the subscription range |
| min |
| min: number Minimum value of the subscription range |
| structureDimension |
| structureDimension: string Structure dimension of the subscription range |
| structureDimensionMember |
| structureDimensionMember: string Structure dimension member of the subscription range |
| Name and Description |
|
static TopNMemberChange: DataChangeInsightType
Top N member change |
|
static ValueChange: DataChangeInsightType
Value change |
|
static ValueChangeOverReferenceLine: DataChangeInsightType
Value change over reference line |
|
static ValueChangeOverThreshold: DataChangeInsightType
Value change over threshold |
| TopNMemberChange |
| static TopNMemberChange: DataChangeInsightType Top N member change |
| ValueChange |
| static ValueChange: DataChangeInsightType Value change |
| ValueChangeOverReferenceLine |
| static ValueChangeOverReferenceLine: DataChangeInsightType Value change over reference line |
| ValueChangeOverThreshold |
| static ValueChangeOverThreshold: DataChangeInsightType Value change over threshold |
| Name and Description |
|
description: string
Member or measure description (optional) |
|
formattedValue: string
Formatted value (measures only) |
|
id: string
Member or measure ID |
|
parentId: string
Parent ID of member or measure (optional) |
|
properties: ResultMemberProperties
Properties of a dimension |
|
rawValue: string
Raw (unformatted) value (measures only) |
| description |
| description: string Member or measure description (optional) |
| formattedValue |
| formattedValue: string Formatted value (measures only) |
| id |
| id: string Member or measure ID |
| parentId |
| parentId: string Parent ID of member or measure (optional) |
| properties |
|
properties: ResultMemberProperties
Properties of a dimension
Since
2020.10
|
| rawValue |
| rawValue: string Raw (unformatted) value (measures only) |
| Name and Description |
|
getState(selection: Selection JSON): DataLockingState
Returns the data locking state of a data cell. |
|
setState(selection: Selection JSON, value: DataLockingState): boolean
Sets the data locking state of a data cell. |
| getState | |||
|
getState(selection: Selection JSON): DataLockingState
Returns the data locking state of a data cell. The data cell is specified by the selection.
Parameters
Returns
DataLockingState |
| setState | ||||||
|
setState(selection: Selection JSON, value: DataLockingState): boolean
Sets the data locking state of a data cell. The data cell is specified by the selection. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| Name and Description |
|
static Locked: DataLockingState
The value of a data cell can't be changed. |
|
static Mixed: DataLockingState
The data locking state can't be determined. |
|
static Open: DataLockingState
The value of a data cell can be changed by users who have the permission to enter values for the model. |
|
static Restricted: DataLockingState
The value of a data cell can be changed only by users who have effective ownership of the locks of the data cell. |
| Locked |
| static Locked: DataLockingState The value of a data cell can't be changed. |
| Mixed |
| static Mixed: DataLockingState The data locking state can't be determined. |
| Open |
| static Open: DataLockingState The value of a data cell can be changed by users who have the permission to enter values for the model. |
| Restricted |
| static Restricted: DataLockingState The value of a data cell can be changed only by users who have effective ownership of the locks of the data cell. |
| Name and Description |
|
collapseNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Collapses a hierarchy node. |
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. |
|
copyVariableValueFrom(sourceDataSource: DataSource, variable?: string | string[] | VariableInfo | VariableInfo[]): void
Copies the value of a variable. |
|
expandNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Expands a hierarchy node. |
|
getBackendCondition(backendConditionId: string): BackendCondition
Gets a BEx condition by its ID. |
|
getBackendConditions(): BackendCondition[]
Gets all BEx conditions. |
|
getComments(): DataSourceComments
Deprecated This method is deprecated, use Table.getComments() instead. |
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. |
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source. |
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension. |
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension. |
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. |
|
getInfo(): DataSourceInfo
Returns information about the data source. |
|
getMeasures(): MeasureInfo[]
Returns all measures of the data source. |
|
getMember(dimension: string | DimensionInfo JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. |
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension. |
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. |
|
getRefreshPaused(): PauseMode
Returns the pause mode of the data refresh. |
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. |
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. |
|
getVariables(): VariableInfo[]
Returns all variables of the data source. |
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable. |
|
isRefreshPaused(): boolean
Deprecated This method is deprecated, use getRefreshPaused() instead. |
|
isResultEmpty(): boolean
Returns whether the result of the data source query state is empty, that is, no data cells were returned. |
|
openPromptDialog(): void
Opens the Prompt dialog for the model used by this data source. |
|
refreshData(): void
Triggers data refresh and updates the widgets associated with the data source at the same time. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. |
|
setDimensionFilter(dimension: string | DimensionInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. |
|
setHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON): void
Sets the hierarchy on the dimension. |
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. |
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension. |
|
setRefreshPaused(paused: PauseMode | boolean): void
Sets the pause mode of the data refresh. |
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. |
| collapseNode | ||||||
|
collapseNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Collapses a hierarchy node. The dimension node specified by the selection is collapsed. For tables, only one dimension node is collapsed. The expansion state of its child nodes is restored when this dimension node is expanded again. For charts, all specified dimension nodes are collapsed, along with their child nodes. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.
Parameters
Since
2020.11
|
| copyDimensionFilterFrom | ||||||
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. If no dimensions are specified, then the filters of all matching dimensions are copied. Note: Only filters on dimensions with the same name and the same active hierarchy in both the source data source and this data source are copied. Note: Advanced Filters are not copied.
Parameters
Last Update
2019.7
|
| copyVariableValueFrom | ||||||
|
copyVariableValueFrom(sourceDataSource: DataSource, variable?: string | string[] | VariableInfo | VariableInfo[]): void
Copies the value of a variable. If no variable is specified, then all variable values of the data source are copied. If you copy an empty variable value to a mandatory variable, then copying this variable is ignored. If you copy a variable value to a data source of a widget that overrides variables and the variable is of type text, then copying this variable is ignored.
Parameters
Since
2020.3
|
| expandNode | ||||||
|
expandNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Expands a hierarchy node. Only one hierarchy dimension can be expanded. Every node on the hierarchy path is expanded as well. For tables, this operation is ignored if one of the dimension nodes on the hierarchy path doesn't exist. Invalid dimensions in the selection are ignored. For charts, all dimension nodes specified by the selection are expanded. If the selection doesn't specify dimension nodes of the specified dimension, then this operation is ignored. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.
Parameters
Since
2020.11
|
| getBackendCondition | |||
|
getBackendCondition(backendConditionId: string): BackendCondition
Gets a BEx condition by its ID. Note: Only supported for data sources associated with charts.
Parameters
Returns
BackendCondition
Since
2024.20
|
| getBackendConditions |
|
getBackendConditions(): BackendCondition[]
Gets all BEx conditions. Note: Only supported for data sources associated with charts.
Returns
BackendCondition[]
Since
2024.20
|
| getComments |
|
getComments(): DataSourceComments
Deprecated This method is deprecated, use Table.getComments() instead. Returns the comments of the data source. Note: Currently, this operation is only supported for data sources associated with tables. If the data source isn't associated with a table, then undefined is returned.
Returns
DataSourceComments
Since
2019.18
Deprecated
2022.20
|
| getData | |||
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. If no value is available for that selection, then undefined is returned. See also the documentation of Selection.
Parameters
Returns
DataCell
Last Update
2019.7
|
| getDataSelections | |||||||||
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a selection including all data cells is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
Selection[]
Since
2019.20
Last Update
2020.6
|
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[]
Since
2020.13
|
| getDimensionProperties | |||
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. Note: Currently, this operation is only supported for data sources associated with tables.
Parameters
Returns
DimensionPropertyInfo[]
Since
2020.7
|
| getDimensions |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source.
Returns
DimensionInfo[] |
| getHierarchies | |||
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension.
Parameters
Returns
HierarchyInfo[]
Last Update
2019.7
|
| getHierarchy | |||
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension.
Parameters
Returns
HierarchyInfo
Last Update
2019.7
|
| getHierarchyLevel | |||
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. This operation is only supported for data sources associated with tables, charts and optimized geo map bubble color. If the dimension is invalid or if the dimension doesn't have a hierarchy, then undefined is returned. Note: This operation isn't supported for data sources associated with charts on SAP BW models and undefined is returned. For non-active dimensions this operation is only supported for data sources associated with charts in optimized view mode.
Parameters
Returns
integer
Since
2020.11
|
| getInfo |
|
getInfo(): DataSourceInfo
Returns information about the data source.
Returns
DataSourceInfo
Since
2021.19
|
| getMeasures |
|
getMeasures(): MeasureInfo[]
Returns all measures of the data source.
Returns
MeasureInfo[]
Since
2019.1
|
| getMember | |||||||||
|
getMember(dimension: string | DimensionInfo JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. Note: The member ID of a member may differ depending on its dimension's hierarchy. For example, for a SAP BW system, the member ID of the same member may be "DE" for a flat presentation hierarchy and "!DE" for an actual hierarchy. Note: If the specified hierarchy doesn't exist, then undefined is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation), then undefined is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo
Since
2021.1
|
| getMemberDisplayMode | |||
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension.
Parameters
Returns
MemberDisplayMode
Since
2019.1
Last Update
2019.7
|
| getMembers | ||||||
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. If you specify a number, then at most this many members are returned (default: 200). If you specify members options, then you can control the returned set of members even finer. Note: If the hierarchy specified in the members options doesn't exist, then an empty array is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation) in the members options, then an empty array is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo[]
Last Update
2021.1
|
| getRefreshPaused |
|
getRefreshPaused(): PauseMode
Returns the pause mode of the data refresh. Note: This operation is only supported for data sources associated with charts or tables.
Returns
PauseMode
Since
2021.18
|
| getResultMember | ||||||
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. It is specified by a dimension and a selection.
Parameters
Returns
ResultMemberInfo
Since
2019.20
|
| getResultSet | |||||||||
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. The result sets are specified by selections. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a result set including all data is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
ResultSet[]
Since
2019.20
Last Update
2020.6
|
| getVariableValues | |||
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function. Note: This method may return outdated values with SAP BW dynamic filter variables. Use getDimensionFilters() instead if you are interested in their current values.
Parameters
Returns
VariableValue[]
Since
2020.13
|
| getVariables |
|
getVariables(): VariableInfo[]
Returns all variables of the data source.
Returns
VariableInfo[]
Since
2019.22
|
| isRefreshPaused |
|
isRefreshPaused(): boolean
Deprecated This method is deprecated, use getRefreshPaused() instead. Returns whether the data refresh is paused. If the pause mode of the data source is Auto, then false is returned.
Returns
boolean
Since
2020.20
Deprecated
2021.19
|
| isResultEmpty |
|
isResultEmpty(): boolean
Returns whether the result of the data source query state is empty, that is, no data cells were returned.
Returns
boolean |
| openPromptDialog |
| openPromptDialog(): void Opens the Prompt dialog for the model used by this data source. By default, this is the same as opening the Prompt dialog from the toolbar for the model used by this data source. If the widget is overriding the variables, then this is the same as opening the Prompt dialog from the widget directly. |
| refreshData |
|
refreshData(): void
Triggers data refresh and updates the widgets associated with the data source at the same time. Note: This operation is only supported for data sources associated with charts, tables or geo map layers. Otherwise, no data refresh is triggered.
Since
2020.1
|
| removeDimensionFilter | |||
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
Last Update
2019.7
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. By default, this removes the variable value of the variable for the data source on the application. If you remove the variable value of a variable for a data source of a widget that overrides variables, then this operation removes only the variable value for this widget. If you remove a variable value from a mandatory variable, then this operation is ignored. If you remove a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored.
Parameters
Since
2020.3
|
| setDimensionFilter | ||||||
|
setDimensionFilter(dimension: string | DimensionInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. If the dimension has a hierarchy, then the specified members need to be part of this hierarchy. If they belong to a different hierarchy, then set that hierarchy with DataSource.setHierarchy() first before calling DataSource.setDimensionFilter().
Parameters
Last Update
2020.7
|
| setHierarchy | ||||||
|
setHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON): void
Sets the hierarchy on the dimension. Note: Currently, this operation is ignored for measure structures. This operation is not supported for data sources associated with geo map layers.
Parameters
Last Update
2019.7
|
| setHierarchyLevel | ||||||
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. If the dimension or the hierarchy level of the dimension is invalid, then this operation is ignored. The default value of the level is defined by the dimension's default level. For data sources associated with charts, the level value is optional.
Parameters
Since
2020.11
|
| setMemberDisplayMode | ||||||
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension.
Parameters
Since
2019.1
Last Update
2019.7
|
| setRefreshPaused | |||
|
setRefreshPaused(paused: PauseMode | boolean): void
Sets the pause mode of the data refresh. The script is fully executed without waiting for all the widgets associated with the data source to be updated when their pause of data refresh is disabled. Note: This operation is only supported for data sources associated with charts or tables. For more information about the different modes, see the chapter "Use Pause Refresh Options and APIs" in SAP Analytics Cloud Help.
Parameters
Since
2020.20
Last Update
2021.18
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set the variable value of a variable for a data source of a widget that overrides variables, then this operation sets only the variable value for this widget. If you set an empty variable value to a mandatory variable, then this operation is ignored. If you set a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.
Parameters
Since
2019.22
Last Update
2021.17
|
| Name and Description |
|
addComment(selection: Selection JSON, value: string): CommentInfo
Adds a comment to data cells. |
|
addComments(selection: Selection JSON, value: string[]): CommentInfo[]
Adds multiple comments to data cells. |
|
getAllComments(selection: Selection JSON): CommentInfo[]
Returns all comments of data cells. |
|
getComment(commentId: string): CommentInfo
Returns a comment. |
|
removeAllComments(selection: Selection JSON): boolean
Removes all comments on data cells. |
|
removeComment(commentId: string): boolean
Removes a comment. |
|
setCommentLiked(commentId: string, isLiked: boolean): boolean
Switches the Like flag of a comment on or off. |
|
updateComment(commentId: string, value: string): CommentInfo
Updates a comment. |
| addComment | ||||||
|
addComment(selection: Selection JSON, value: string): CommentInfo
Adds a comment to data cells. The data cells are specified by the selection. If this operation was successful, then the comment is returned, and undefined if it wasn't.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
|
| addComments | ||||||
|
addComments(selection: Selection JSON, value: string[]): CommentInfo[]
Adds multiple comments to data cells. The data cells are specified by the selection. If this operation was successful, then the comments are returned, and undefined if it wasn't. Note: Not supported for SAP BW live data models.
Parameters
Returns
CommentInfo[]
Mobile Support
Not supported on mobile devices.
Since
2020.22
|
| getAllComments | |||
|
getAllComments(selection: Selection JSON): CommentInfo[]
Returns all comments of data cells. The data cells are specified by the selection. If no comments exist, then an empty array is returned. Note: For SAP BW live data models, returns the only comment of the latest version.
Parameters
Returns
CommentInfo[]
Mobile Support
Not supported on mobile devices.
|
| getComment | |||
|
getComment(commentId: string): CommentInfo
Returns a comment. The comment is specified by the comment ID. If the comment ID is invalid, then undefined is returned.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
|
| removeAllComments | |||
|
removeAllComments(selection: Selection JSON): boolean
Removes all comments on data cells. The data cells are specified by the selection. If this operation was successful, then true is returned, and false if it wasn't. Note: For SAP BW live data models, removes the only comment along with all history versions.
Parameters
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| removeComment | |||
|
removeComment(commentId: string): boolean
Removes a comment. The comment is specified by the comment ID. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| setCommentLiked | ||||||
|
setCommentLiked(commentId: string, isLiked: boolean): boolean
Switches the Like flag of a comment on or off. The comment is specified by the comment ID. If the comment ID is valid, then true is returned, and false if it isn't. Note: Not supported for SAP BW live data models.
Parameters
Returns
boolean
Mobile Support
Not supported on mobile devices.
Since
2019.21
|
| updateComment | ||||||
|
updateComment(commentId: string, value: string): CommentInfo
Updates a comment. The comment is specified by the comment ID. Returns the latest comment if this operation is successful, and undefined if it fails. Note: Only supported for SAP BW live data models.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
Since
2023.6
|
| Name and Description |
|
modelDescription: string
Description of the model |
|
modelId: string
ID of the model |
|
modelName: string
Name of the model |
|
sourceDescription: string
Description of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
|
sourceLastChangedBy: string
Name of the user who changed the SAP BW Query most recently (for SAP BW models) or undefined (for all other models) |
|
sourceLastRefreshedAt: Date
Date of the last data source refresh (for SAP BW models) or undefined (for all other models) |
|
sourceName: string
Name of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
| modelDescription |
| modelDescription: string Description of the model |
| modelId |
| modelId: string ID of the model |
| modelName |
| modelName: string Name of the model |
| sourceDescription |
| sourceDescription: string Description of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
| sourceLastChangedBy |
| sourceLastChangedBy: string Name of the user who changed the SAP BW Query most recently (for SAP BW models) or undefined (for all other models) |
| sourceLastRefreshedAt |
| sourceLastRefreshedAt: Date Date of the last data source refresh (for SAP BW models) or undefined (for all other models) |
| sourceName |
| sourceName: string Name of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
| Name and Description |
|
static Canceled: DataUploadExecutionResponseStatus
Execution has been canceled. |
|
static Error: DataUploadExecutionResponseStatus
Execution ended with errors. |
|
static Success: DataUploadExecutionResponseStatus
Execution ended successfully. |
|
static Warning: DataUploadExecutionResponseStatus
Execution ended with warning. |
| Canceled |
| static Canceled: DataUploadExecutionResponseStatus Execution has been canceled. |
| Error |
| static Error: DataUploadExecutionResponseStatus Execution ended with errors. |
| Success |
| static Success: DataUploadExecutionResponseStatus Execution ended successfully. |
| Warning |
| static Warning: DataUploadExecutionResponseStatus Execution ended with warning. |
| Name and Description |
|
static now(): integer
Returns the number of milliseconds elapsed since January 1, 1970, 00:00:00 UTC. |
|
static parse(source: string): integer
Parses a string representation of a date and returns the number of milliseconds since January 1, 1970, 00:00:00 UTC. |
|
static UTC(year: number, month: number, date: number, hour?: number, min?: number, sec?: number, ms?: number): integer
Returns the number of milliseconds in a date since January 1, 1970, 00:00:00 UTC. |
|
getDate(): integer
Returns the day of the month of the specified date according to local time (where 1 represents the first day of the month). |
|
getDay(): integer
Returns the day of the week of the specified date according to local time (where 0 represents Sunday). |
|
getFullYear(): integer
Returns the full year of the specified date according to local time. |
|
getHours(): integer
Returns the hour of the specified date according to local time. |
|
getMilliseconds(): number
Returns the milliseconds of the specified date according to local time. |
|
getMinutes(): integer
Returns the minutes of the specified date according to local time. |
|
getMonth(): integer
Returns the month of the specified date according to local time (where 0 represents the first month of the year). |
|
getSeconds(): integer
Returns the seconds of the specified date according to local time. |
|
getTime(): integer
Returns the numeric value corresponding to the time for the specified date according to universal time. |
|
getTimezoneOffset(): integer
Returns the time zone difference, in minutes, from the current locale to universal time. |
|
getUTCDate(): integer
Returns the day of the month of the specified date according to universal time (where 1 represents the first day of the month). |
|
getUTCDay(): integer
Returns the day of the week of the specified date according to universal time (where 0 represents Sunday). |
|
getUTCHours(): integer
Returns the hours of the specified date according to universal time. |
|
getUTCMilliseconds(): integer
Returns the milliseconds of the specified date according to universal time. |
|
getUTCMinutes(): integer
Returns the minutes of the specified date according to universal time. |
|
getUTCMonth(): integer
Returns the month of the specified date according to universal time (where 0 represents the first month of the year). |
|
getUTCSeconds(): integer
Returns the seconds of the specified date according to universal time. |
|
getYear(): integer
Returns the year of the specified date according to local time. |
|
setDate(day: number): integer
Sets the day of the month of a specified date according to local time (where 1 represents the first day of the month). |
|
setFullYear(year: number): integer
Sets the full year of a specified date according to local time. |
|
setHours(hour: number): integer
Sets the hours of a specified date according to local time. |
|
setMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to local time. |
|
setMinutes(min: number): integer
Sets the minutes of a specified date according to local time. |
|
setMonth(month: number): integer
Sets the month of a specified date according to local time (where 0 represents the first month of the year). |
|
setSeconds(sec: number): integer
Sets the seconds of a specified date according to local time. |
|
setTime(timeValue: integer): integer
Sets the date to the time represented by a number of milliseconds since January 1, 1970, 00:00:00 UTC. |
|
setUTCDate(day: number): integer
Sets the day of the month of a specified date according to universal time (where 1 represents the first day of the month). |
|
setUTCFullYear(year: number): integer
Sets the full year of a specified date according to universal time. |
|
setUTCHours(hour: number): integer
Sets the hour of a specified date according to universal time. |
|
setUTCMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to universal time. |
|
setUTCMinutes(min: number): integer
Sets the minutes of a specified date according to universal time. |
|
setUTCMonth(month: number): integer
Sets the month of a specified date according to universal time (where 0 represents the first month of the year). |
|
setUTCSeconds(sec: number): integer
Sets the seconds of a specified date according to universal time. |
|
toDateString(): string
Returns the "date" portion of a date in human readable form in American English. |
|
toISOString(): string
Converts a date to a string in ISO 8601 Extended Format. |
|
toJSON(): string
Returns a string (using toISOString()) representing the date's value. |
|
toLocaleDateString(): string
Converts a date to a string, returning the "date" portion using the operating system's locale conventions. |
|
toLocaleTimeString(): string
Converts a date to a string, returning the "time" portion using the operating system's locale conventions. |
|
toTimeString(): string
Returns the "time" portion of a date in human readable form in American English. |
|
toUTCString(): string
Converts a date to a string according to universal time. |
| UTC | |||||||||||||||||||||
|
static UTC(year: number, month: number, date: number, hour?: number, min?: number, sec?: number, ms?: number): integer
Returns the number of milliseconds in a date since January 1, 1970, 00:00:00 UTC.
Parameters
Returns
integer |
| now |
|
static now(): integer
Returns the number of milliseconds elapsed since January 1, 1970, 00:00:00 UTC.
Returns
integer |
| parse | |||
|
static parse(source: string): integer
Parses a string representation of a date and returns the number of milliseconds since January 1, 1970, 00:00:00 UTC.
Parameters
Returns
integer |
| getDate |
|
getDate(): integer
Returns the day of the month of the specified date according to local time (where 1 represents the first day of the month).
Returns
integer |
| getDay |
|
getDay(): integer
Returns the day of the week of the specified date according to local time (where 0 represents Sunday).
Returns
integer |
| getFullYear |
|
getFullYear(): integer
Returns the full year of the specified date according to local time.
Returns
integer |
| getHours |
|
getHours(): integer
Returns the hour of the specified date according to local time.
Returns
integer |
| getMilliseconds |
|
getMilliseconds(): number
Returns the milliseconds of the specified date according to local time.
Returns
number |
| getMinutes |
|
getMinutes(): integer
Returns the minutes of the specified date according to local time.
Returns
integer |
| getMonth |
|
getMonth(): integer
Returns the month of the specified date according to local time (where 0 represents the first month of the year).
Returns
integer |
| getSeconds |
|
getSeconds(): integer
Returns the seconds of the specified date according to local time.
Returns
integer |
| getTime |
|
getTime(): integer
Returns the numeric value corresponding to the time for the specified date according to universal time.
Returns
integer |
| getTimezoneOffset |
|
getTimezoneOffset(): integer
Returns the time zone difference, in minutes, from the current locale to universal time.
Returns
integer |
| getUTCDate |
|
getUTCDate(): integer
Returns the day of the month of the specified date according to universal time (where 1 represents the first day of the month).
Returns
integer |
| getUTCDay |
|
getUTCDay(): integer
Returns the day of the week of the specified date according to universal time (where 0 represents Sunday).
Returns
integer |
| getUTCHours |
|
getUTCHours(): integer
Returns the hours of the specified date according to universal time.
Returns
integer |
| getUTCMilliseconds |
|
getUTCMilliseconds(): integer
Returns the milliseconds of the specified date according to universal time.
Returns
integer |
| getUTCMinutes |
|
getUTCMinutes(): integer
Returns the minutes of the specified date according to universal time.
Returns
integer |
| getUTCMonth |
|
getUTCMonth(): integer
Returns the month of the specified date according to universal time (where 0 represents the first month of the year).
Returns
integer |
| getUTCSeconds |
|
getUTCSeconds(): integer
Returns the seconds of the specified date according to universal time.
Returns
integer |
| getYear |
|
getYear(): integer
Returns the year of the specified date according to local time.
Returns
integer |
| setDate | |||
|
setDate(day: number): integer
Sets the day of the month of a specified date according to local time (where 1 represents the first day of the month). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setFullYear | |||
|
setFullYear(year: number): integer
Sets the full year of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setHours | |||
|
setHours(hour: number): integer
Sets the hours of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setMilliseconds | |||
|
setMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setMinutes | |||
|
setMinutes(min: number): integer
Sets the minutes of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setMonth | |||
|
setMonth(month: number): integer
Sets the month of a specified date according to local time (where 0 represents the first month of the year). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setSeconds | |||
|
setSeconds(sec: number): integer
Sets the seconds of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setTime | |||
|
setTime(timeValue: integer): integer
Sets the date to the time represented by a number of milliseconds since January 1, 1970, 00:00:00 UTC.
Parameters
Returns
integer |
| setUTCDate | |||
|
setUTCDate(day: number): integer
Sets the day of the month of a specified date according to universal time (where 1 represents the first day of the month). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCFullYear | |||
|
setUTCFullYear(year: number): integer
Sets the full year of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCHours | |||
|
setUTCHours(hour: number): integer
Sets the hour of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCMilliseconds | |||
|
setUTCMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCMinutes | |||
|
setUTCMinutes(min: number): integer
Sets the minutes of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCMonth | |||
|
setUTCMonth(month: number): integer
Sets the month of a specified date according to universal time (where 0 represents the first month of the year). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCSeconds | |||
|
setUTCSeconds(sec: number): integer
Sets the seconds of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| toDateString |
|
toDateString(): string
Returns the "date" portion of a date in human readable form in American English.
Returns
string |
| toISOString |
|
toISOString(): string
Converts a date to a string in ISO 8601 Extended Format.
Returns
string |
| toJSON |
|
toJSON(): string
Returns a string (using toISOString()) representing the date's value.
Returns
string |
| toLocaleDateString |
|
toLocaleDateString(): string
Converts a date to a string, returning the "date" portion using the operating system's locale conventions.
Returns
string |
| toLocaleTimeString |
|
toLocaleTimeString(): string
Converts a date to a string, returning the "time" portion using the operating system's locale conventions.
Returns
string |
| toTimeString |
|
toTimeString(): string
Returns the "time" portion of a date in human readable form in American English.
Returns
string |
| toUTCString |
|
toUTCString(): string
Converts a date to a string according to universal time.
Returns
string |
| Name and Description |
|
static format(date: Date, pattern?: string): string
Returns a string representation of the date. |
| format | ||||||
|
static format(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
Returns
string
Since
2020.2
|
| Name and Description |
| static Angle0: DeviceOrientation |
| static Angle180: DeviceOrientation |
| static Angle90Clockwise: DeviceOrientation |
| static Angle90Counterclockwise: DeviceOrientation |
| Angle0 |
| static Angle0: DeviceOrientation |
| Angle180 |
| static Angle180: DeviceOrientation |
| Angle90Clockwise |
| static Angle90Clockwise: DeviceOrientation |
| Angle90Counterclockwise |
| static Angle90Counterclockwise: DeviceOrientation |
| Name and Description |
| description: string |
| id: string |
| modelId: string |
| Name and Description |
| description: string |
| id: string |
| Name and Description |
|
static Horizontal: Direction
Horizontal direction |
|
static Vertical: Direction
Vertical direction |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the dropdown. |
|
getSelectedKey(): string
Returns the key of the selected item in the dropdown. |
|
getSelectedText(): string
Returns the text of the selected item in the dropdown. |
|
removeAllItems(): void
Removes all items from the dropdown. |
|
removeItem(key: string): void
Removes an item from the dropdown. |
|
setSelectedKey(key: string): void
Selects an item in the dropdown. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user selects an item in the dropdown. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the dropdown. 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
|
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected item in the dropdown. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedText |
|
getSelectedText(): string
Returns the text of the selected item in the dropdown. If no item is selected, then undefined is returned.
Returns
string |
| removeAllItems |
| removeAllItems(): void Removes all items from the dropdown. |
| removeItem | |||
|
removeItem(key: string): void
Removes an item from the dropdown. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKey | |||
|
setSelectedKey(key: string): void
Selects an item in the dropdown. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| Name and Description |
|
exportReport(): void
Exports the included table to a CSV file. |
|
getFileName(): string
Returns the filename of the exported CSV file. |
|
getScope(): ExportScope
Returns the scope of the exported CSV file. |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported CSV file. |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported CSV file. |
|
isExportFormattedValues(): boolean
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
Returns whether hierarchy levels are exported in individual columns. |
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported CSV file. |
|
setDateIncluded(included: boolean): void
Includes or excludes the date info in appendix of the exported CSV file. |
|
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. |
|
setFileName(text: string): void
Sets the filename of the exported CSV file. |
|
setHierarchyLevelsInIndividualCells(separate: boolean): void
Specifies whether hierarchy levels are exported in individual columns. |
|
setScope(scope: ExportScope): void
Sets the scope of the exported CSV file. |
|
setWidget(table: Table): void
Sets the table of the exported CSV file. |
| exportReport |
|
exportReport(): void
Exports the included table to a CSV file.
Mobile Support
Not supported on mobile devices.
|
| getFileName |
|
getFileName(): string
Returns the filename of the exported CSV file.
Returns
string |
| getScope |
|
getScope(): ExportScope
Returns the scope of the exported CSV file.
Returns
ExportScope |
| isAppendixIncluded |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported CSV file.
Returns
boolean
Since
2024.25
|
| isDateIncluded |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported CSV file.
Returns
boolean
Since
2024.25
|
| isExportFormattedValues |
|
isExportFormattedValues(): boolean
Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
Returns
boolean |
| isHierarchyLevelsInIndividualCells |
|
isHierarchyLevelsInIndividualCells(): boolean
Returns whether hierarchy levels are exported in individual columns.
Returns
boolean |
| setAppendixIncluded | |||
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported CSV file.
Parameters
Since
2024.25
|
| setDateIncluded | |||
|
setDateIncluded(included: boolean): void
Includes or excludes the date info in appendix of the exported CSV file.
Parameters
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
|
| setFileName | |||
|
setFileName(text: string): void
Sets the filename of the exported CSV file.
Parameters
|
| setHierarchyLevelsInIndividualCells | |||
|
setHierarchyLevelsInIndividualCells(separate: boolean): void
Specifies whether hierarchy levels are exported in individual columns.
Parameters
|
| setScope | |||
|
setScope(scope: ExportScope): void
Sets the scope of the exported CSV file.
Parameters
|
| setWidget | |||
|
setWidget(table: Table): void
Sets the table of the exported CSV file.
Parameters
|
| Name and Description |
|
exportReport(): void
Exports the included tables to an XLSX file. |
|
getFileName(): string
Returns the filename of the exported XLSX file. |
|
getScope(): ExportScope
Returns the scope of the exported XLSX file. |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported XLSX file. |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported XLSX file. |
|
isExportFormattedValues(): boolean
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
Returns whether to indent hierarchical data labels (row headers). |
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported XLSX file. |
|
setDateIncluded(date: boolean): void
Includes or excludes the date info in appendix of the exported XLSX file. |
|
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. |
|
setFileName(text: string): void
Sets the filename of the exported XLSX file. |
|
setIndentedHierarchy(indentedHierarchy: boolean): void
Specifies whether to indent hierarchical data labels (row headers). |
|
setScope(scope: ExportScope): void
Sets the scope of the exported XLSX file. |
|
setWidget(table: Table | Table[]): void
Sets the tables of the exported XLSX file. |
| exportReport |
|
exportReport(): void
Exports the included tables to an XLSX file.
Mobile Support
Not supported on mobile devices.
|
| getFileName |
|
getFileName(): string
Returns the filename of the exported XLSX file.
Returns
string |
| getScope |
|
getScope(): ExportScope
Returns the scope of the exported XLSX file.
Returns
ExportScope
Since
2024.12
|
| isAppendixIncluded |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported XLSX file.
Returns
boolean |
| isDateIncluded |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported XLSX file.
Returns
boolean
Since
2024.25
|
| isExportFormattedValues |
|
isExportFormattedValues(): boolean
Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
Returns
boolean |
| isIndentedHierarchy |
|
isIndentedHierarchy(): boolean
Returns whether to indent hierarchical data labels (row headers).
Returns
boolean |
| setAppendixIncluded | |||
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported XLSX file.
Parameters
|
| setDateIncluded | |||
|
setDateIncluded(date: boolean): void
Includes or excludes the date info in appendix of the exported XLSX file.
Parameters
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
|
| setFileName | |||
|
setFileName(text: string): void
Sets the filename of the exported XLSX file.
Parameters
|
| setIndentedHierarchy | |||
|
setIndentedHierarchy(indentedHierarchy: boolean): void
Specifies whether to indent hierarchical data labels (row headers).
Parameters
|
| setScope | |||
|
setScope(scope: ExportScope): void
Sets the scope of the exported XLSX file.
Parameters
Since
2024.12
|
| setWidget | |||
|
setWidget(table: Table | Table[]): void
Sets the tables of the exported XLSX file.
Parameters
|
| Name and Description |
|
excludeComponent(component: Widget | Popup): void
Excludes a widget or a popup from the exported PDF file. |
|
exportReport(): void
Exports all included tables in full length (report) to a PDF file. |
|
exportView(): boolean
Exports the story to a PDF file. |
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId. |
|
getDateLocation(): PageDateLocation
Returns the location of the date in the exported PDF file. |
|
getFileName(): string
Returns the filename of the exported PDF file. |
|
getFooterText(): string
Returns the text shown in the page footer of the exported PDF file. |
|
getHeaderText(): string
Returns the text shown in the page header of the exported PDF file. |
|
getPageNumberLocation(): PageNumberLocation
Returns the location of the page number in the exported PDF file. |
|
getPageOrientation(): PageOrientation
Returns the page orientation of the exported PDF file. |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PDF. |
|
getPageSize(): PageSize
Returns the page size of the exported PDF file. |
|
includeComponent(component: Widget | Popup): void
Includes a widget or a popup in the exported PDF file. |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported PDF file. |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled. |
|
isCommentsVisible(): boolean
Returns whether the comments are visible in the exported PDF file. |
|
isExportInBackgroundEnabled(): boolean
Returns whether the export of the PDF file in the background is enabled. |
|
isFooterVisible(): boolean
Returns whether the page footer is visible in the exported PDF file. |
|
isHeaderVisible(): boolean
Returns whether the page header is visible in the exported PDF file. |
|
isReportIncluded(): boolean
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
Shows or hides the appendix in the exported PDF file. |
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export. |
|
setCommentsVisible(visible: boolean): void
Shows or hides the comments in the exported PDF file. |
|
setDateLocation(location: PageDateLocation): void
Sets the location of the date in the exported PDF file. |
|
setExportInBackgroundEnabled(isEnabled: boolean): void
Enables or disables the export of the PDF file in the background. |
|
setFileName(fileName: string): void
Sets the filename of the exported PDF file. |
|
setFooterText(text: string): void
Sets the text shown in the page footer of the exported PDF file. |
|
setFooterVisible(visible: boolean): void
Shows or hides the page footer in the exported PDF file. |
|
setHeaderText(text: string): void
Sets the text shown in the page header of the exported PDF file. |
|
setHeaderVisible(visible: boolean): void
Shows or hides the page header in the exported PDF file. |
|
setPageNumberLocation(location: PageNumberLocation): void
Sets the location of the page number in the exported PDF file. |
|
setPageOrientation(orientation: PageOrientation): void
Sets the page orientation of the exported PDF file. |
|
setPageRange(value: number[]): void
Sets the pages to be exported to PDF. |
|
setPageSize(size: PageSize): void
Sets the page size of the exported PDF file. |
|
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(). |
| excludeComponent | |||
|
excludeComponent(component: Widget | Popup): void
Excludes a widget or a popup from the exported PDF file.
Parameters
Since
2020.10
|
| exportReport |
|
exportReport(): void
Exports all included tables in full length (report) to a PDF file.
Mobile Support
Not supported on mobile devices.
Since
2020.16
|
| exportView |
|
exportView(): boolean
Exports the story to a PDF file.
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| getBatchExportDataSource | |||
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId.
Parameters
Returns
BatchExportDataSource
Since
2024.7
|
| getDateLocation |
|
getDateLocation(): PageDateLocation
Returns the location of the date in the exported PDF file.
Returns
PageDateLocation |
| getFileName |
|
getFileName(): string
Returns the filename of the exported PDF file.
Returns
string |
| getFooterText |
|
getFooterText(): string
Returns the text shown in the page footer of the exported PDF file.
Returns
string |
| getHeaderText |
|
getHeaderText(): string
Returns the text shown in the page header of the exported PDF file.
Returns
string |
| getPageNumberLocation |
|
getPageNumberLocation(): PageNumberLocation
Returns the location of the page number in the exported PDF file.
Returns
PageNumberLocation |
| getPageOrientation |
|
getPageOrientation(): PageOrientation
Returns the page orientation of the exported PDF file.
Returns
PageOrientation |
| getPageRange |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PDF.
Returns
number[]
Since
2023.3
|
| getPageSize |
|
getPageSize(): PageSize
Returns the page size of the exported PDF file.
Returns
PageSize |
| includeComponent | |||
|
includeComponent(component: Widget | Popup): void
Includes a widget or a popup in the exported PDF file.
Parameters
Since
2020.10
|
| isAppendixVisible |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported PDF file.
Returns
boolean |
| isBatchExportEnabled |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled.
Returns
boolean
Since
2024.7
|
| isCommentsVisible |
|
isCommentsVisible(): boolean
Returns whether the comments are visible in the exported PDF file.
Returns
boolean |
| isExportInBackgroundEnabled |
|
isExportInBackgroundEnabled(): boolean
Returns whether the export of the PDF file in the background is enabled.
Returns
boolean
Since
2019.23
|
| isFooterVisible |
|
isFooterVisible(): boolean
Returns whether the page footer is visible in the exported PDF file.
Returns
boolean |
| isHeaderVisible |
|
isHeaderVisible(): boolean
Returns whether the page header is visible in the exported PDF file.
Returns
boolean |
| isReportIncluded |
|
isReportIncluded(): boolean
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().
Returns
boolean
Since
2020.16
|
| setAppendixVisible | |||
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported PDF file.
Parameters
|
| setBatchExportEnabled | |||
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export.
Parameters
Since
2024.7
|
| setCommentsVisible | |||
|
setCommentsVisible(visible: boolean): void
Shows or hides the comments in the exported PDF file.
Parameters
|
| setDateLocation | |||
|
setDateLocation(location: PageDateLocation): void
Sets the location of the date in the exported PDF file.
Parameters
|
| setExportInBackgroundEnabled | |||
|
setExportInBackgroundEnabled(isEnabled: boolean): void
Enables or disables the export of the PDF file in the background.
Parameters
Since
2019.23
|
| setFileName | |||
|
setFileName(fileName: string): void
Sets the filename of the exported PDF file.
Parameters
|
| setFooterText | |||
|
setFooterText(text: string): void
Sets the text shown in the page footer of the exported PDF file.
Parameters
|
| setFooterVisible | |||
|
setFooterVisible(visible: boolean): void
Shows or hides the page footer in the exported PDF file.
Parameters
|
| setHeaderText | |||
|
setHeaderText(text: string): void
Sets the text shown in the page header of the exported PDF file.
Parameters
|
| setHeaderVisible | |||
|
setHeaderVisible(visible: boolean): void
Shows or hides the page header in the exported PDF file.
Parameters
|
| setPageNumberLocation | |||
|
setPageNumberLocation(location: PageNumberLocation): void
Sets the location of the page number in the exported PDF file.
Parameters
|
| setPageOrientation | |||
|
setPageOrientation(orientation: PageOrientation): void
Sets the page orientation of the exported PDF file.
Parameters
|
| 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
Since
2023.3
|
| setPageSize | |||
|
setPageSize(size: PageSize): void
Sets the page size of the exported PDF file.
Parameters
|
| 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
Since
2020.16
|
| Name and Description |
|
exportView(): boolean
Exports the story to a power point file. |
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId. |
|
getFileName(): string
Returns the filename of the exported power point file. |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PPTX. |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported power point file. |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled. |
|
isDateIncluded(): boolean
Returns whether date is included in the appendix of the exported power point file. |
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported power point file. |
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export. |
|
setDateIncluded(included: boolean): void
Includes or excludes date in the appendix of the exported power point file. |
|
setFileName(fileName: string): void
Sets the filename of the exported power point file. |
|
setPageRange(value: number[]): void
Sets the pages to be exported to PPTX. |
| exportView |
|
exportView(): boolean
Exports the story to a power point file.
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| getBatchExportDataSource | |||
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId.
Parameters
Returns
BatchExportDataSource
Since
2024.7
|
| getFileName |
|
getFileName(): string
Returns the filename of the exported power point file.
Returns
string |
| getPageRange |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PPTX.
Returns
number[] |
| isAppendixVisible |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported power point file.
Returns
boolean |
| isBatchExportEnabled |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled.
Returns
boolean
Since
2024.7
|
| isDateIncluded |
|
isDateIncluded(): boolean
Returns whether date is included in the appendix of the exported power point file.
Returns
boolean
Since
2024.25
|
| setAppendixVisible | |||
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported power point file.
Parameters
|
| setBatchExportEnabled | |||
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export.
Parameters
Since
2024.7
|
| setDateIncluded | |||
|
setDateIncluded(included: boolean): void
Includes or excludes date in the appendix of the exported power point file.
Parameters
Since
2024.25
|
| setFileName | |||
|
setFileName(fileName: string): void
Sets the filename of the exported power point file.
Parameters
|
| 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
|
| Name and Description |
|
static All: ExportScope
Export scope of "All" |
|
static PointOfView: ExportScope
Export scope of "Point of View" |
| All |
| static All: ExportScope Export scope of "All" |
| PointOfView |
| static PointOfView: ExportScope Export scope of "Point of View" |
| Name and Description |
|
static BubbleWidth: Feed
The "BubbleWidth" feed |
|
static CategoryAxis: Feed
The "CategoryAxis" feed |
|
static CategoryAxis2: Feed
The "CategoryAxis2" feed |
|
static Color: Feed
The "Color" feed |
|
static CrossCalculations: Feed
The "CrossCalculations" feed |
|
static DataContext: Feed
The "DataContext" feed |
|
static DataContext2: Feed
The "DataContext2" feed |
|
static Pattern: Feed
The "Pattern" feed |
|
static Pattern2: Feed
The "Pattern2" feed |
|
static Size: Feed
The "Size" feed |
|
static TimeAxis: Feed
The "TimeAxis" feed |
|
static Title: Feed
The "Title" feed |
|
static TooltipCategoryAxis: Feed
The "TooltipCategoryAxis" feed |
|
static TooltipValueAxis: Feed
The "TooltipValueAxis" feed |
|
static Trellis: Feed
The "Trellis" feed |
|
static ValueAxis: Feed
The "ValueAxis" feed |
|
static ValueAxis2: Feed
The "ValueAxis2" feed |
|
static Weight: Feed
The "Weight" feed |
| BubbleWidth |
| static BubbleWidth: Feed The "BubbleWidth" feed |
| CategoryAxis |
| static CategoryAxis: Feed The "CategoryAxis" feed |
| CategoryAxis2 |
| static CategoryAxis2: Feed The "CategoryAxis2" feed |
| Color |
| static Color: Feed The "Color" feed |
| CrossCalculations |
| static CrossCalculations: Feed The "CrossCalculations" feed |
| DataContext |
| static DataContext: Feed The "DataContext" feed |
| DataContext2 |
| static DataContext2: Feed The "DataContext2" feed |
| Pattern |
| static Pattern: Feed The "Pattern" feed |
| Pattern2 |
| static Pattern2: Feed The "Pattern2" feed |
| Size |
| static Size: Feed The "Size" feed |
| TimeAxis |
| static TimeAxis: Feed The "TimeAxis" feed |
| Title |
| static Title: Feed The "Title" feed |
| TooltipCategoryAxis |
| static TooltipCategoryAxis: Feed The "TooltipCategoryAxis" feed |
| TooltipValueAxis |
| static TooltipValueAxis: Feed The "TooltipValueAxis" feed |
| Trellis |
| static Trellis: Feed The "Trellis" feed |
| ValueAxis |
| static ValueAxis: Feed The "ValueAxis" feed |
| ValueAxis2 |
| static ValueAxis2: Feed The "ValueAxis2" feed |
| Weight |
|
static Weight: Feed
The "Weight" feed
Since
2019.10
|
| Name and Description |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable on the story. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable on the story. |
|
setDimensionFilterWithHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. |
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable on the story. |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| getVariableValues | |||
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable on the story. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function.
Parameters
Returns
VariableValue[] |
| removeDimensionFilter | |||
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable on the story. This removes the variable value of the variable for the data source on the story.
Parameters
|
| setDimensionFilterWithHierarchy | |||||||||
|
setDimensionFilterWithHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. The specified members need to be part of the hierarchy.
Parameters
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable on the story. If you set an empty variable value to a mandatory variable, then this operation is ignored. Note: The variable value will not be validated.
Parameters
|
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onAfterExecute(status: DataUploadExecutionResponseStatus): void Called when the Data Upload Starter execution ends. |
|
onBeforeExecute(): boolean Called when the user clicks the Data Upload Starter. |
| onAfterExecute | |||
|
onAfterExecute(status: DataUploadExecutionResponseStatus): void
Called when the Data Upload Starter execution ends.
Parameters
Last Update
2024.17
|
| onBeforeExecute |
|
onBeforeExecute(): boolean
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.
Returns
boolean Default value: true
|
| Name and Description |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
isVisible(): boolean
Returns whether FilterPanel is visible. |
|
setVisible(visible: boolean): void
Shows or hides FilterPanel. |
| Name and Description |
|
type: FilterValueType
Type of the filter value |
| Name and Description |
|
static Multiple: FilterValueType
An object representing multiple filter values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
|
static Range: FilterValueType
An object representing a range of filter values from dimension members, like: {<operator>: '<memberId>'}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
|
static Single: FilterValueType
An object representing a single filter value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Multiple |
| static Multiple: FilterValueType An object representing multiple filter values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
| Range |
| static Range: FilterValueType An object representing a range of filter values from dimension members, like: {<operator>: '<memberId>'}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
| Single |
| static Single: FilterValueType An object representing a single filter value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Name and Description |
|
fiscalDay: integer
fiscalDay |
|
fiscalQuarter: integer
fiscalQuarter |
|
fiscalYear: integer
fiscalYear |
|
granularity: FiscalTimeGranularity
granularity |
|
period: integer
period |
| fiscalDay |
| fiscalDay: integer fiscalDay |
| fiscalQuarter |
| fiscalQuarter: integer fiscalQuarter |
| fiscalYear |
| fiscalYear: integer fiscalYear |
| granularity |
| granularity: FiscalTimeGranularity granularity |
| period |
| period: integer period |
| Name and Description |
|
static FiscalDay: FiscalTimeGranularity
fiscal days |
|
static FiscalQuarter: FiscalTimeGranularity
fiscal quarters |
|
static FiscalYear: FiscalTimeGranularity
fiscal years |
|
static Period: FiscalTimeGranularity
fiscal periods |
| FiscalDay |
| static FiscalDay: FiscalTimeGranularity fiscal days |
| FiscalQuarter |
| static FiscalQuarter: FiscalTimeGranularity fiscal quarters |
| FiscalYear |
| static FiscalYear: FiscalTimeGranularity fiscal years |
| Period |
| static Period: FiscalTimeGranularity fiscal periods |
| Name and Description |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
moveWidget(widget: Widget): void
Moves the widget into the panel. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| hideBusyIndicator |
| hideBusyIndicator(): void Hides the busy indicator. |
| moveWidget | |||
|
moveWidget(widget: Widget): void
Moves the widget into the panel.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| Name and Description |
|
setNumberOfPeriods(number: integer): void
Sets the number of forecast periods. |
|
setType(forecastType: ForecastType): void
Sets the forecast type. |
| 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
|
| setType | |||
|
setType(forecastType: ForecastType): void
Sets the forecast type.
Parameters
|
| Name and Description |
|
static Auto: ForecastType
The forecast is performed on the available data. |
|
static None: ForecastType
No forecast is performed. |
|
static TripleExponentialSmoothing: ForecastType
The forecast is performed using the Triple Exponential Smoothing algorithm to account for seasonal changes as well as trends. |
| Auto |
| static Auto: ForecastType The forecast is performed on the available data. |
| None |
| static None: ForecastType No forecast is performed. |
| TripleExponentialSmoothing |
| static TripleExponentialSmoothing: ForecastType The forecast is performed using the Triple Exponential Smoothing algorithm to account for seasonal changes as well as trends. |
| Name and Description |
|
getLayer(index: integer): GeoMapLayer
Returns the layer. |
|
openInNewStory(): void
Creates a new story with this widget. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setQuickActionsVisibility(quickActionsVisibility: GeoMapQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| getLayer | |||
|
getLayer(index: integer): GeoMapLayer
Returns the layer. The layer is specified by an index.
Parameters
Returns
GeoMapLayer
Mobile Support
Not supported on mobile devices.
Since
2019.14
|
| openInNewStory |
|
openInNewStory(): void
Creates a new story with this widget.
Mobile Support
Not supported on mobile devices.
Since
2021.3
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: GeoMapQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| Name and Description |
|
getDataSource(): DataSource
(Only available in optimized view mode) Returns the data source of the layer. |
|
getSelections(): Selection[]
Returns the selections of the layer. |
|
isVisible(): boolean
Returns whether the layer is visible. |
|
setVisible(visible: boolean): void
Shows or hides the layer. |
| getDataSource |
|
getDataSource(): DataSource
(Only available in optimized view mode) Returns the data source of the layer.
Returns
DataSource
Since
2022.7
|
| getSelections |
|
getSelections(): Selection[]
Returns the selections of the layer. The API only works for the geo map bubble layer with a dimension as the bubble color. Otherwise, it returns an empty array. You can use the elements of the returned array with DataSource.getData() to get the value of a cell. See also the documentation of Selection.
Returns
Selection[]
Since
2023.7
|
| isVisible |
|
isVisible(): boolean
Returns whether the layer is visible.
Returns
boolean |
| setVisible | |||
|
setVisible(visible: boolean): void
Shows or hides the layer.
Parameters
|
| Name and Description |
|
static addComment: boolean
Comment |
|
static drill: boolean
Drill |
|
static filter: boolean
Filter/Exclude |
|
static fullscreen: boolean
Fullscreen |
|
static geomapDetail: boolean
Applied to Geomap |
|
static ranking: boolean
Ranking |
| addComment |
| static addComment: boolean Comment |
| drill |
| static drill: boolean Drill |
| filter |
| static filter: boolean Filter/Exclude |
| fullscreen |
| static fullscreen: boolean Fullscreen |
| geomapDetail |
|
static geomapDetail: boolean
Applied to Geomap
Since
2023.2
|
| ranking |
|
static ranking: boolean
Ranking
Since
2023.2
|
| Name and Description |
| description: string |
| id: string |
| Name and Description |
|
context: Selection JSON
Dimension the cell corresponds to, whose value is its dimension ID |
|
newValue: string
Cell value after change |
|
oldValue: string
Cell value before change |
| context |
| context: Selection JSON Dimension the cell corresponds to, whose value is its dimension ID |
| newValue |
| newValue: string Cell value after change |
| oldValue |
| oldValue: string Cell value before change |
| Name and Description |
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the image will navigate to when clicked. |
|
setImage(url: string): void
Sets the URL of the image. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the image. |
|
onLongPress(): void Called when the user presses and holds the image. |
| Name and Description |
|
getInputControlDataSource(): InputControlDataSource
Returns the data source of input control widget |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user changes the selections on the input control. |
| getInputControlDataSource |
|
getInputControlDataSource(): InputControlDataSource
Returns the data source of input control widget
Returns
InputControlDataSource
Since
2022.7
Last Update
2022.14
|
| onSelect |
|
onSelect(): void
Called when the user changes the selections on the input control. The onSelect event is only supported for dimension member input controls and calculation input controls, while not supported for other types, such as range filters and dimension input controls.
Since
2023.7
|
| Name and Description |
|
getActiveSelectedMembers(options?: integer): MemberInfo[]
Returns the active selected dimension members. |
|
getActiveSelectedMembersWithUnbooked(options?: integer): MemberInfo[]
Returns the active selected dimension members on the input control, including unbooked ones. |
|
isAllMembersSelected(): boolean
Returns whether all members have been selected on the input control. |
|
setAllMembersSelected(): void
Selects all members on the input control. |
|
setSelectedMembers(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control. |
|
setSelectedMembersWithUnbooked(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control, including unbooked ones. |
| getActiveSelectedMembers | |||
|
getActiveSelectedMembers(options?: integer): MemberInfo[]
Returns the active selected dimension members. You can define how many members are returned at most. By default it's 100 if not specified. Note: Not supported for input controls that display all available members including unbooked ones. Not supported for range filters and advanced filters. Not supported for members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting. Note: Please consider the performance impact when using this API. Always try to use it on input controls with low cardinality dimensions, or turn on cascading effect to narrow down the dimension members on input controls.
Parameters
Returns
MemberInfo[] |
| getActiveSelectedMembersWithUnbooked | |||
|
getActiveSelectedMembersWithUnbooked(options?: integer): MemberInfo[]
Returns the active selected dimension members on the input control, including unbooked ones. To use this API, ensure that the input control is either dimension member or calculation input control, and cascading effect off. Other types such as range filters aren't supported. Members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting aren’t supported. You can limit the number of returned members (by default 100). Be mindful of performance impacts on high cardinality dimensions.
Parameters
Returns
MemberInfo[]
Since
2024.1
|
| isAllMembersSelected |
|
isAllMembersSelected(): boolean
Returns whether all members have been selected on the input control. Note: Not supported for excluded members, range filters and advanced filters.
Returns
boolean
Since
2023.7
|
| setAllMembersSelected |
|
setAllMembersSelected(): void
Selects all members on the input control. Note: Not supported for excluded members, range filters and advanced filters.
Since
2023.7
|
| setSelectedMembers | |||
|
setSelectedMembers(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control. The dimension members should be from the selected members configured at design time. Note: Not supported for input controls that display all available members including unbooked ones. Not supported for range filters and advanced filters. Not supported for members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting.
Parameters
|
| setSelectedMembersWithUnbooked | |||
|
setSelectedMembersWithUnbooked(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control, including unbooked ones. To use this API, ensure that the input control is either dimension member or calculation input control, and cascading effect off. Other types such as range filters aren't supported. Members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting aren’t supported. The dimension members should be from the selected members configured at design time.
Parameters
Since
2024.1
|
| Name and Description |
|
getValue(): string
Returns the value of the input field. |
|
isEditable(): boolean
Returns whether the input field is editable. |
|
isEnabled(): boolean
Returns whether the input field is enabled. |
|
setEditable(editable: boolean): void
Enables or disables editing of the input field. |
|
setEnabled(enabled: boolean): void
Enables or disables the input field. |
|
setStyle(style: InputFieldStyle JSON): void
Applies the style to the input field. |
|
setValue(value: string): void
Sets the value of the input field. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the input field doesn't have the focus anymore, for example, after the user has entered text and pressed the "Enter" key. |
| getValue |
|
getValue(): string
Returns the value of the input field.
Returns
string |
| isEditable |
|
isEditable(): boolean
Returns whether the input field is editable.
Returns
boolean |
| isEnabled |
|
isEnabled(): boolean
Returns whether the input field is enabled.
Returns
boolean |
| setEditable | |||
|
setEditable(editable: boolean): void
Enables or disables editing of the input field.
Parameters
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the input field.
Parameters
|
| setStyle | |||
|
setStyle(style: InputFieldStyle JSON): void
Applies the style to the input field. You can also pass a JSON object for the style argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
Since
2020.9
|
| setValue | |||
|
setValue(value: string): void
Sets the value of the input field.
Parameters
|
| Name and Description |
|
backgroundColor: string
Background color of the input field |
|
borderColor: string
Border color of the input field |
|
color: string
Font color of the input field |
| Name and Description |
|
getBottom(): LayoutValue
Returns the bottom margin between the widget and the widget's parent container. |
|
getHeight(): LayoutValue
Returns the height of the widget. |
|
getLeft(): LayoutValue
Returns the left margin between the widget and the widget's parent container. |
|
getRight(): LayoutValue
Returns the right margin between the widget and the widget's parent container. |
|
getTop(): LayoutValue
Returns the top margin between the widget and the widget's parent container. |
|
getWidth(): LayoutValue
Returns the width of the widget. |
|
setBottom(value: LayoutValue | integer): void
Sets the bottom margin between the widget and the widget's parent container. |
|
setHeight(value: LayoutValue | integer): void
Sets the height of the widget. |
|
setLeft(value: LayoutValue | integer): void
Sets the left margin between the widget and the widget's parent container. |
|
setRight(value: LayoutValue | integer): void
Sets the right margin between the widget and the widget's parent container. |
|
setTop(value: LayoutValue | integer): void
Sets the top margin between the widget and the widget's parent container. |
|
setWidth(value: LayoutValue | integer): void
Sets the width of the widget. |
| getBottom |
|
getBottom(): LayoutValue
Returns the bottom margin between the widget and the widget's parent container.
Returns
LayoutValue
Since
2019.20
|
| getHeight |
|
getHeight(): LayoutValue
Returns the height of the widget.
Returns
LayoutValue |
| getLeft |
|
getLeft(): LayoutValue
Returns the left margin between the widget and the widget's parent container.
Returns
LayoutValue |
| getRight |
|
getRight(): LayoutValue
Returns the right margin between the widget and the widget's parent container.
Returns
LayoutValue
Since
2019.20
|
| getTop |
|
getTop(): LayoutValue
Returns the top margin between the widget and the widget's parent container.
Returns
LayoutValue |
| getWidth |
|
getWidth(): LayoutValue
Returns the width of the widget.
Returns
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
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
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
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
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
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
Last Update
2019.15
|
| Name and Description |
| static Auto: LayoutUnit |
| static Grid: LayoutUnit |
| static Percent: LayoutUnit |
| static Pixel: LayoutUnit |
| Auto |
|
static Auto: LayoutUnit
Since
2019.20
|
| Grid |
|
static Grid: LayoutUnit
Since
2023.8
|
| Percent |
|
static Percent: LayoutUnit
Since
2019.20
|
| Pixel |
| static Pixel: LayoutUnit |
| Name and Description |
| static Auto: LayoutValue |
| numberValue: number |
| unit: LayoutUnit |
| value: integer |
| Name and Description |
|
static create(value: number, unit: LayoutUnit): LayoutValue
Creates a Unit with a value and type. |
| Auto |
|
static Auto: LayoutValue
Since
2019.20
|
| numberValue |
|
numberValue: number
Since
2019.20
|
| unit |
|
unit: LayoutUnit
Since
2019.15
|
| value |
|
value: integer
Since
2019.15
|
| create | ||||||
|
static create(value: number, unit: LayoutUnit): LayoutValue
Creates a Unit with a value and type.
Parameters
Returns
LayoutValue
Last Update
2019.20
|
| Name and Description |
|
isDataPointSelectionEnabled(): boolean
Whether it supports filter on data point selection |
|
removeFilters(): void
Remove the filters on data point selection |
|
setFilters(selections: Selection JSON | Selection[] JSON): void
Set the filter on data point selection |
| isDataPointSelectionEnabled |
|
isDataPointSelectionEnabled(): boolean
Whether it supports filter on data point selection
Returns
boolean |
| removeFilters |
| removeFilters(): void Remove the filters on data point selection |
| setFilters | |||
|
setFilters(selections: Selection JSON | Selection[] JSON): void
Set the filter on data point selection
Parameters
|
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the list box. |
|
getSelectedKey(): string
Returns the key of the selected item in the list box. |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the list box. |
|
getSelectedText(): string
Returns the text of the selected item in the list box. |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the list box. |
|
removeAllItems(): void
Removes all items from the list box. |
|
removeItem(key: string): void
Removes an item from the list box. |
|
setSelectedKey(key: string): void
Selects an item in the list box. |
|
setSelectedKeys(keys: string[]): void
Selects items in the list box. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user selects an item in the list box. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the list box. 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
|
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected item in the list box. If the list box allows multiple selections, then the key of the first selected item is returned. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedKeys |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the list box. If no items are selected, then an empty array is returned.
Returns
string[] |
| getSelectedText |
|
getSelectedText(): string
Returns the text of the selected item in the list box. If the list box allows multiple selections, then the text of the first selected item is returned. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedTexts |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the list box. If no items are selected, then an empty array is returned.
Returns
string[] |
| removeAllItems |
| removeAllItems(): void Removes all items from the list box. |
| removeItem | |||
|
removeItem(key: string): void
Removes an item from the list box. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKey | |||
|
setSelectedKey(key: string): void
Selects an item in the list box. The item is specified by its key. If the key isn't present in the list box, then nothing is selected.
Parameters
|
| setSelectedKeys | |||
|
setSelectedKeys(keys: string[]): void
Selects items in the list box. The items are specified by their keys. If the list box allows only a single selection, then the first of the specified keys is selected that is present in the list box. If the keys aren't present in the list box, then nothing is selected.
Parameters
|
| Name and Description |
|
static E: number
Euler's constant and the base of natural logarithms, approximately 2.718. |
|
static LN10: number
Natural logarithm of 10, approximately 2.302. |
|
static LN2: number
Natural logarithm of 2, approximately 0.693. |
|
static LOG10E: number
Base 10 logarithm of E, approximately 0.434. |
|
static LOG2E: number
Base 2 logarithm of E, approximately 1.443. |
|
static PI: number
Ratio of the circumference of a circle to its diameter, approximately 3.14159. |
|
static SQRT1_2: number
Square root of 1/2; equivalently, 1 over the square root of 2, approximately 0.707. |
|
static SQRT2: number
Square root of 2, approximately 1.414. |
| Name and Description |
|
static abs(x: number): number
Returns the absolute value of a number. |
|
static acos(x: number): number
Returns the arccosine (in radians) of a number. |
|
static acosh(x: number): number
Returns the hyperbolic arccosine of a number. |
|
static asin(x: number): number
Returns the arcsine (in radians) of a number. |
|
static asinh(x: number): number
Returns the hyperbolic arcsine of a number. |
|
static atan(x: number): number
Returns the arctangent (in radians) of a number. |
|
static atan2(y: number, x: number): number
Returns the arctangent of the quotient y/x. |
|
static atanh(x: number): number
Returns the hyperbolic arctangent of a number. |
|
static cbrt(x: number): number
Returns the cube root of a number. |
|
static ceil(x: number): integer
Returns the smallest integer greater than or equal to a number. |
|
static clz32(x: number): integer
Returns the number of leading zero bits in the 32-bit binary representation of a number. |
|
static cos(x: number): number
Returns the cosine of a number. |
|
static cosh(x: number): number
Returns the hyperbolic cosine of a number. |
|
static exp(x: number): number
Returns E to the power of x, where E is Euler's constant, the base of the natural logarithm. |
|
static expm1(x: number): number
Returns exp(x) - 1. |
|
static floor(x: number): integer
Returns the largest integer less than or equal to a number. |
|
static fround(x: number): integer
Returns the nearest single precision float representation of a number. |
|
static hypot(value: number): number
Returns the square root of the sum of squares of its arguments. |
|
static imul(a: number, b: number): integer
Returns the result of a 32-bit integer multiplication. |
|
static log(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of a number. |
|
static log10(x: number): number
Returns the base 10 logarithm of a number. |
|
static log1p(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of 1 + x. |
|
static log2(x: number): number
Returns the base 2 logarithm of a number. |
|
static max(a: number, a: number): number
Returns the largest of zero or more numbers. |
|
static min(a: number, b: number): number
Returns the smallest of zero or more numbers. |
|
static pow(base: number, exponent: number): number
Returns base to the power of exponent, that is, base^exponent. |
|
static random(): number
Returns a floating-point pseudo-random number in the range [0, 1), that is, from 0 (inclusive) up to but not including 1 (exclusive). |
|
static round(x: number): integer
Returns the value of a number rounded to the nearest integer. |
|
static sign(x: number): integer
Returns the sign of a number, indicating whether the number is positive, negative, or zero. |
|
static sin(x: number): number
Returns the sine of a number. |
|
static sinh(x: number): number
Returns the hyperbolic sine of a number. |
|
static sqrt(x: number): number
Returns the square root of a number. |
|
static tan(x: number): number
Returns the tangent of a number. |
|
static tanh(x: number): number
Returns the hyperbolic tangent of a number. |
|
static trunc(x: number): integer
Returns the integer part of a number, removing any fractional digits. |
| E |
| static E: number Euler's constant and the base of natural logarithms, approximately 2.718. |
| LN10 |
| static LN10: number Natural logarithm of 10, approximately 2.302. |
| LN2 |
| static LN2: number Natural logarithm of 2, approximately 0.693. |
| LOG10E |
| static LOG10E: number Base 10 logarithm of E, approximately 0.434. |
| LOG2E |
| static LOG2E: number Base 2 logarithm of E, approximately 1.443. |
| PI |
| static PI: number Ratio of the circumference of a circle to its diameter, approximately 3.14159. |
| SQRT1_2 |
| static SQRT1_2: number Square root of 1/2; equivalently, 1 over the square root of 2, approximately 0.707. |
| SQRT2 |
| static SQRT2: number Square root of 2, approximately 1.414. |
| abs | |||
|
static abs(x: number): number
Returns the absolute value of a number.
Parameters
Returns
number |
| acos | |||
|
static acos(x: number): number
Returns the arccosine (in radians) of a number.
Parameters
Returns
number |
| acosh | |||
|
static acosh(x: number): number
Returns the hyperbolic arccosine of a number.
Parameters
Returns
number |
| asin | |||
|
static asin(x: number): number
Returns the arcsine (in radians) of a number.
Parameters
Returns
number |
| asinh | |||
|
static asinh(x: number): number
Returns the hyperbolic arcsine of a number.
Parameters
Returns
number |
| atan | |||
|
static atan(x: number): number
Returns the arctangent (in radians) of a number.
Parameters
Returns
number |
| atan2 | ||||||
|
static atan2(y: number, x: number): number
Returns the arctangent of the quotient y/x.
Parameters
Returns
number |
| atanh | |||
|
static atanh(x: number): number
Returns the hyperbolic arctangent of a number.
Parameters
Returns
number |
| cbrt | |||
|
static cbrt(x: number): number
Returns the cube root of a number.
Parameters
Returns
number |
| ceil | |||
|
static ceil(x: number): integer
Returns the smallest integer greater than or equal to a number.
Parameters
Returns
integer |
| clz32 | |||
|
static clz32(x: number): integer
Returns the number of leading zero bits in the 32-bit binary representation of a number.
Parameters
Returns
integer |
| cos | |||
|
static cos(x: number): number
Returns the cosine of a number.
Parameters
Returns
number |
| cosh | |||
|
static cosh(x: number): number
Returns the hyperbolic cosine of a number.
Parameters
Returns
number |
| exp | |||
|
static exp(x: number): number
Returns E to the power of x, where E is Euler's constant, the base of the natural logarithm.
Parameters
Returns
number |
| expm1 | |||
|
static expm1(x: number): number
Returns exp(x) - 1.
Parameters
Returns
number |
| floor | |||
|
static floor(x: number): integer
Returns the largest integer less than or equal to a number.
Parameters
Returns
integer |
| fround | |||
|
static fround(x: number): integer
Returns the nearest single precision float representation of a number.
Parameters
Returns
integer |
| hypot | |||
|
static hypot(value: number): number
Returns the square root of the sum of squares of its arguments.
Parameters
Returns
number |
| imul | ||||||
|
static imul(a: number, b: number): integer
Returns the result of a 32-bit integer multiplication.
Parameters
Returns
integer |
| log | |||
|
static log(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of a number.
Parameters
Returns
number |
| log10 | |||
|
static log10(x: number): number
Returns the base 10 logarithm of a number.
Parameters
Returns
number |
| log1p | |||
|
static log1p(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of 1 + x.
Parameters
Returns
number |
| log2 | |||
|
static log2(x: number): number
Returns the base 2 logarithm of a number.
Parameters
Returns
number |
| max | ||||||
|
static max(a: number, a: number): number
Returns the largest of zero or more numbers.
Parameters
Returns
number |
| min | ||||||
|
static min(a: number, b: number): number
Returns the smallest of zero or more numbers.
Parameters
Returns
number |
| pow | ||||||
|
static pow(base: number, exponent: number): number
Returns base to the power of exponent, that is, base^exponent.
Parameters
Returns
number |
| random |
|
static random(): number
Returns a floating-point pseudo-random number in the range [0, 1), that is, from 0 (inclusive) up to but not including 1 (exclusive).
Returns
number |
| round | |||
|
static round(x: number): integer
Returns the value of a number rounded to the nearest integer.
Parameters
Returns
integer |
| sign | |||
|
static sign(x: number): integer
Returns the sign of a number, indicating whether the number is positive, negative, or zero.
Parameters
Returns
integer |
| sin | |||
|
static sin(x: number): number
Returns the sine of a number.
Parameters
Returns
number |
| sinh | |||
|
static sinh(x: number): number
Returns the hyperbolic sine of a number.
Parameters
Returns
number |
| sqrt | |||
|
static sqrt(x: number): number
Returns the square root of a number.
Parameters
Returns
number |
| tan | |||
|
static tan(x: number): number
Returns the tangent of a number.
Parameters
Returns
number |
| tanh | |||
|
static tanh(x: number): number
Returns the hyperbolic tangent of a number.
Parameters
Returns
number |
| trunc | |||
|
static trunc(x: number): integer
Returns the integer part of a number, removing any fractional digits.
Parameters
Returns
integer |
| Name and Description |
| description: string |
| dimensionId: string |
| id: string |
| modelId: string |
| Name and Description |
|
static BookedValues: MemberAccessMode
Only members which have booked values |
|
static MasterData: MemberAccessMode
Full set of available members |
| BookedValues |
| static BookedValues: MemberAccessMode Only members which have booked values |
| MasterData |
| static MasterData: MemberAccessMode Full set of available members |
| 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. |
| Description |
| static Description: MemberDisplayMode Members are visualized using their description. |
| DisplayId |
| static DisplayId: MemberDisplayMode Members are visualized using their display ID. |
| DisplayIdAndDescription |
| static DisplayIdAndDescription: MemberDisplayMode Members are visualized using their display ID and description. |
| Name and Description |
| description: string |
| dimensionId: string |
| displayId: string |
| id: string |
| modelId: string |
| Name and Description |
|
accessMode: MemberAccessMode
Type of members to retrieve (default: MemberAccessMode.MasterData) |
|
hierarchyId: string
Hierarchy ID (default: currently active hierarchy) |
|
limit: integer
Maximum number of returned members, which must be zero or a positive number. |
| accessMode |
| accessMode: MemberAccessMode Type of members to retrieve (default: MemberAccessMode.MasterData) |
| hierarchyId |
| hierarchyId: string Hierarchy ID (default: currently active hierarchy) |
| limit |
| limit: integer Maximum number of returned members, which must be zero or a positive number. If the limit isn't specified or invalid, then the default value is used (default: 200). |
| 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. |
|
setParameterValue(id: string, value: string | string[] | MultiActionParameterValue JSON | number): void
Sets the value of the parameter. |
| Name and Description |
|
onExecutionStatusUpdate(status: MultiActionExecutionResponseStatus, executionId: string, executionName: string, message: string): void Called when an asynchronous Multi Action execution changes its status. |
| 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
Returns
MultiActionBackgroundExecutionResponse
Mobile Support
Not supported on mobile devices.
|
| getParameterValue | |||
|
getParameterValue(id: string): MultiActionParameterValue
Returns the value of the parameter.
Parameters
Returns
MultiActionParameterValue
Mobile Support
Not supported on mobile devices.
|
| setParameterValue | ||||||
|
setParameterValue(id: string, value: string | string[] | MultiActionParameterValue JSON | number): void
Sets the value of the parameter.
Parameters
Mobile Support
Not supported on mobile devices.
|
| onExecutionStatusUpdate | ||||||||||||
|
onExecutionStatusUpdate(status: MultiActionExecutionResponseStatus, executionId: string, executionName: string, message: string): void
Called when an asynchronous Multi Action execution changes its status.
Parameters
Last Update
2023.13
|
| Name and Description |
|
executionId: string
Generated execution ID. |
|
status: MultiActionBackgroundExecutionResponseStatus
Execution status |
| executionId |
| executionId: string Generated execution ID. |
| status |
| status: MultiActionBackgroundExecutionResponseStatus Execution status |
| Name and Description |
|
static Accepted: MultiActionBackgroundExecutionResponseStatus
Execution is accepted. |
|
static Error: MultiActionBackgroundExecutionResponseStatus
Execution ended with errors. |
| Accepted |
| static Accepted: MultiActionBackgroundExecutionResponseStatus Execution is accepted. |
| Error |
| static Error: MultiActionBackgroundExecutionResponseStatus Execution ended with errors. |
| Name and Description |
|
message: string
Execution result message |
|
status: MultiActionExecutionResponseStatus
Execution result status |
| message |
|
message: string
Execution result message
Since
2023.13
|
| status |
| status: MultiActionExecutionResponseStatus Execution result status |
| 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. |
| Error |
| static Error: MultiActionExecutionResponseStatus Execution ended with errors. |
| Running |
| static Running: MultiActionExecutionResponseStatus Execution is running. |
| Success |
| static Success: MultiActionExecutionResponseStatus Execution ended successfully. |
| Warning |
|
static Warning: MultiActionExecutionResponseStatus
Execution ended with warning.
Since
2023.6
|
| Name and Description |
|
members: string[]
Member IDs |
| Inherited from MultiActionParameterValue |
| type |
| Name and Description |
|
value: number
Number value |
| Inherited from MultiActionParameterValue |
| type |
| Name and Description |
|
type: MultiActionParameterValueType
Type of the parameter value |
| Name and Description |
|
static Member: MultiActionParameterValueType
Member value type |
|
static Number: MultiActionParameterValueType
Number value type |
| Member |
| static Member: MultiActionParameterValueType Member value type |
| Number |
| static Number: MultiActionParameterValueType Number value type |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onBeforeExecute(): boolean Called when the user clicks the multi action starter. |
| Name and Description |
|
descriptions: string[]
Multiple filter descriptions |
|
exclude: boolean
Indicates whether to exclude the filter values. |
|
values: string[]
Multiple filter values |
| Inherited from FilterValue |
| type |
| Name and Description |
|
exclude: boolean
Indicates whether to exclude the variable values. |
|
values: string[]
Multiple variable values |
| Inherited from VariableValue |
| type |
| Name and Description |
|
expanded: boolean
Indicates whether the navigation panel opens in expanded state. |
| Name and Description |
|
static createApplicationUrl(appId: string, parameters?: UrlParameter | UrlParameter[]): string
Creates an analytic application URL. |
|
static createStoryUrl(storyId: string, pageId: string, parameters?: UrlParameter | UrlParameter[]): string
Creates a story URL. |
|
static openApplication(appId: string, parameters?: UrlParameter | UrlParameter[], newTab?: boolean): void
Opens an analytic application. |
|
static openDataAnalyzer(connection?: string, dataSourceName?: string, parameters?: UrlParameter | UrlParameter[], newTab?: boolean): void
Opens the Data Analyzer. |
|
static openInsight(insightId: string, urlParameters?: UrlParameter | UrlParameter[]): void
Opens the Insight. |
|
static openStory(storyId: string, pageId: string, parameters?: UrlParameter | UrlParameter[], newTab?: boolean): void
Opens a story. |
|
static openUrl(url: string, newTab?: boolean): void
Opens a URL. |
| createApplicationUrl | ||||||
|
static createApplicationUrl(appId: string, parameters?: UrlParameter | UrlParameter[]): string
Creates an analytic application URL.
Parameters
Returns
string
Mobile Support
Not supported on mobile devices.
|
| createStoryUrl | |||||||||
|
static createStoryUrl(storyId: string, pageId: string, parameters?: UrlParameter | UrlParameter[]): string
Creates a story URL.
Parameters
Returns
string
Mobile Support
Not supported on mobile devices.
|
| openApplication | |||||||||
|
static openApplication(appId: string, parameters?: UrlParameter | UrlParameter[], newTab?: boolean): void
Opens an analytic application. Note: This operation is ignored when scheduling a publication.
Parameters
|
| openDataAnalyzer | ||||||||||||
|
static openDataAnalyzer(connection?: string, dataSourceName?: string, parameters?: UrlParameter | UrlParameter[], newTab?: boolean): void
Opens the Data Analyzer. Note: This operation is ignored when scheduling a publication.
Parameters
Since
2019.14
|
| openInsight | ||||||
|
static openInsight(insightId: string, urlParameters?: UrlParameter | UrlParameter[]): void
Opens the Insight. Note: This operation is ignored when scheduling a publication.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2024.25
|
| openStory | ||||||||||||
|
static openStory(storyId: string, pageId: string, parameters?: UrlParameter | UrlParameter[], newTab?: boolean): void
Opens a story. Note: This operation is ignored when scheduling a publication.
Parameters
|
| openUrl | ||||||
|
static openUrl(url: string, newTab?: boolean): void
Opens a URL. Note: This operation is ignored when scheduling a publication.
Parameters
|
| Name and Description |
|
content: string
Content of the notification |
|
isSendEmail: boolean
Indicates whether an email notification is sent to the receivers (default: false). |
|
isSendMobileNotification: boolean
Indicates whether a mobile notification is sent to the receivers (default: false). |
|
mode: ApplicationMode
Mode in which the analytic application is displayed when it is opened from the notification (default: Present) |
|
parameters: UrlParameter[]
URL parameters to be used when opening the analytic application |
|
receivers: string[]
Users to receive the notification. |
|
title: string
Title of the notification |
| content |
| content: string Content of the notification |
| isSendEmail |
| isSendEmail: boolean Indicates whether an email notification is sent to the receivers (default: false). |
| isSendMobileNotification |
|
isSendMobileNotification: boolean
Indicates whether a mobile notification is sent to the receivers (default: false).
Since
2020.17
|
| mode |
| mode: ApplicationMode Mode in which the analytic application is displayed when it is opened from the notification (default: Present) |
| parameters |
| parameters: UrlParameter[] URL parameters to be used when opening the analytic application |
| receivers |
| receivers: string[] Users to receive the notification. If no receivers are specified, then the receiver is the creator of the calendar task that runs the analytic application by the scheduling service. |
| title |
| title: string Title of the notification |
| Name and Description |
|
static EPSILON: number
Difference between 1 and the smallest value greater than 1 that can be represented as a Number. |
|
static MAX_SAFE_INTEGER: integer
Maximum safe integer in JavaScript (2^53 - 1). |
|
static MAX_VALUE: number
Maximum numeric value representable in JavaScript. |
|
static MIN_SAFE_INTEGER: integer
Minimum safe integer in JavaScript (-(2^53 - 1)). |
|
static MIN_VALUE: number
Smallest positive numeric value representable in JavaScript. |
|
static NEGATIVE_INFINITY: number
Negative Infinity value. |
|
static POSITIVE_INFINITY: number
Positive Infinity value. |
| Name and Description |
|
static isFinite(testValue: <any type>): boolean
Returns whether the value is a finite number. |
|
static isInteger(testValue: <any type>): boolean
Returns whether the value is an integer. |
|
static isNaN(testValue: <any type>): boolean
Returns whether the value is NaN and its type is a Number. |
|
static isSafeInteger(testValue: <any type>): boolean
Returns whether the value is a safe integer. |
|
static parseFloat(string: string): number
Parses a string and returns a floating-point number. |
|
static parseInt(string: string, radix?: number): integer
Parses a string and returns an integer of the specified radix or base. |
|
toExponential(significantDigits?: number): string
Returns a string representing the number in exponential notation. |
|
toFixed(significantDigits?: number): string
Returns a string representing the number in fixed-point notation. |
|
toPrecision(significantDigits?: number): string
Returns a string representing the number to the specified precision. |
|
toString(radix?: number): string
Returns a string representing the number in the (optionally) specified radix or base. |
| EPSILON |
| static EPSILON: number Difference between 1 and the smallest value greater than 1 that can be represented as a Number. |
| MAX_SAFE_INTEGER |
| static MAX_SAFE_INTEGER: integer Maximum safe integer in JavaScript (2^53 - 1). |
| MAX_VALUE |
| static MAX_VALUE: number Maximum numeric value representable in JavaScript. |
| MIN_SAFE_INTEGER |
| static MIN_SAFE_INTEGER: integer Minimum safe integer in JavaScript (-(2^53 - 1)). |
| MIN_VALUE |
| static MIN_VALUE: number Smallest positive numeric value representable in JavaScript. |
| NEGATIVE_INFINITY |
| static NEGATIVE_INFINITY: number Negative Infinity value. |
| POSITIVE_INFINITY |
| static POSITIVE_INFINITY: number Positive Infinity value. |
| isFinite | |||
|
static isFinite(testValue: <any type>): boolean
Returns whether the value is a finite number.
Parameters
Returns
boolean |
| isInteger | |||
|
static isInteger(testValue: <any type>): boolean
Returns whether the value is an integer.
Parameters
Returns
boolean |
| isNaN | |||
|
static isNaN(testValue: <any type>): boolean
Returns whether the value is NaN and its type is a Number.
Parameters
Returns
boolean |
| isSafeInteger | |||
|
static isSafeInteger(testValue: <any type>): boolean
Returns whether the value is a safe integer. A safe integer is an integer that can be exactly represented as an IEEE-754 double precision number and whose IEEE-754 representation can't be the result of rounding any other integer to fit the IEEE-754 representation.
Parameters
Returns
boolean |
| parseFloat | |||
|
static parseFloat(string: string): number
Parses a string and returns a floating-point number.
Parameters
Returns
number |
| parseInt | ||||||
|
static parseInt(string: string, radix?: number): integer
Parses a string and returns an integer of the specified radix or base.
Parameters
Returns
integer |
| toExponential | |||
|
toExponential(significantDigits?: number): string
Returns a string representing the number in exponential notation. It has one digit before the decimal point and is rounded to significantDigits digits after the decimal point.
Parameters
Returns
string |
| toFixed | |||
|
toFixed(significantDigits?: number): string
Returns a string representing the number in fixed-point notation. It is rounded to significantDigits digits after the decimal point.
Parameters
Returns
string |
| toPrecision | |||
|
toPrecision(significantDigits?: number): string
Returns a string representing the number to the specified precision. It is rounded to significantDigits digits after the decimal point.
Parameters
Returns
string |
| toString | |||
|
toString(radix?: number): string
Returns a string representing the number in the (optionally) specified radix or base.
Parameters
Returns
string |
| 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. |
| create |
|
static create(): NumberFormat
Creates a number format.
Returns
NumberFormat |
| format | |||
|
static format(value: number): string
Formats a number by applying the current user settings.
Parameters
Returns
string |
| format | |||
|
format(value: number): string
Formats a number by applying the settings of this number format.
Parameters
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
|
| 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
|
| setMaximumDecimalPlaces | |||
|
setMaximumDecimalPlaces(maximumDecimalPlaces: integer): void
Sets the maximum number of decimal places.
Parameters
|
| setMinimumDecimalPlaces | |||
|
setMinimumDecimalPlaces(minimumDecimalPlaces: integer): void
Sets the minimum number of decimal places.
Parameters
|
| setScalingFactor | |||
|
setScalingFactor(factor: number): void
Sets the scaling factor. If the scaling factor is 0 or 1, then the number isn't scaled.
Parameters
|
| setScalingText | |||
|
setScalingText(text: string): void
Sets the scaling text.
Parameters
|
| setSignDisplay | |||
|
setSignDisplay(mode: NumberFormatSignDisplay): void
Specifies how signs are displayed.
Parameters
|
| Name and Description |
| static Cells: NumberFormatDisplayUnit |
| static Column: NumberFormatDisplayUnit |
| static Default: NumberFormatDisplayUnit |
| static Row: NumberFormatDisplayUnit |
| Cells |
| static Cells: NumberFormatDisplayUnit |
| Column |
| static Column: NumberFormatDisplayUnit |
| Default |
| static Default: NumberFormatDisplayUnit |
| Row |
| static Row: NumberFormatDisplayUnit |
| Name and Description |
| static Default: NumberFormatScaleFormat |
| static Long: NumberFormatScaleFormat |
| static Short: NumberFormatScaleFormat |
| Default |
| static Default: NumberFormatScaleFormat |
| Long |
| static Long: NumberFormatScaleFormat |
| Short |
| static Short: NumberFormatScaleFormat |
| Name and Description |
| static AutoFormatted: NumberFormatScaleUnit |
| static Billion: NumberFormatScaleUnit |
| static Default: NumberFormatScaleUnit |
| static Million: NumberFormatScaleUnit |
| static Thousand: NumberFormatScaleUnit |
| static Unformatted: NumberFormatScaleUnit |
| AutoFormatted |
| static AutoFormatted: NumberFormatScaleUnit |
| Billion |
| static Billion: NumberFormatScaleUnit |
| Default |
| static Default: NumberFormatScaleUnit |
| Million |
| static Million: NumberFormatScaleUnit |
| Thousand |
| static Thousand: NumberFormatScaleUnit |
| Unformatted |
| static Unformatted: NumberFormatScaleUnit |
| 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 (-). |
| Default |
|
static Default: NumberFormatSignDisplay
A default format is applied to positive and negative numbers.
Since
2020.11
|
| MinusAsParentheses |
| static MinusAsParentheses: NumberFormatSignDisplay Negative numbers are nested in parentheses (()). |
| MinusAsPrefix |
| static MinusAsPrefix: NumberFormatSignDisplay Negative numbers are prefixed with a minus sign (-). |
| PlusMinusAsPrefix |
| static PlusMinusAsPrefix: NumberFormatSignDisplay Positive numbers are prefixed with a plus sign (+), negative numbers are prefixed with a minus sign (-). |
| Name and Description |
| code: string |
| details: ODataError[] |
| message: string |
| target: string |
| code |
| code: string |
| details |
| details: ODataError[] |
| message |
| message: string |
| target |
| target: string |
| Name and Description |
|
getPage(pageKey: string): PageBookPage
Returns a page of the page book. |
|
getSelectedKey(): string
Returns the key of the selected page of the page book. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
moveWidget(pageKey: string, widget: Widget): void
Moves the widget into the specified page of the page book. |
|
setSelectedKey(pageKey: string): void
Selects a page. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user selects a page. |
| 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
Returns
PageBookPage |
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected page of the page book.
Returns
string |
| hideBusyIndicator |
| hideBusyIndicator(): void Hides the busy indicator. |
| moveWidget | ||||||
|
moveWidget(pageKey: string, widget: Widget): void
Moves the widget into the specified page of the page book.
Parameters
|
| 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
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| Name and Description |
|
getKey(): string
Returns the key of the page. |
|
isVisible(): boolean
Returns whether the page is visible. |
|
setVisible(visible: boolean): void
Shows or hides the page. |
| Name and Description |
| static Appendix: PageDateLocation |
| static Header: PageDateLocation |
| static HeaderAndAppendix: PageDateLocation |
| static None: PageDateLocation |
| Appendix |
| static Appendix: PageDateLocation |
| Header |
| static Header: PageDateLocation |
| HeaderAndAppendix |
| static HeaderAndAppendix: PageDateLocation |
| None |
| static None: PageDateLocation |
| Name and Description |
| static Footer: PageNumberLocation |
| static Header: PageNumberLocation |
| static HeaderAndFooter: PageNumberLocation |
| static None: PageNumberLocation |
| Footer |
| static Footer: PageNumberLocation |
| Header |
| static Header: PageNumberLocation |
| HeaderAndFooter |
|
static HeaderAndFooter: PageNumberLocation
Since
2023.7
|
| None |
| static None: PageNumberLocation |
| Name and Description |
| static Landscape: PageOrientation |
| static Portrait: PageOrientation |
| Landscape |
| static Landscape: PageOrientation |
| Portrait |
| static Portrait: PageOrientation |
| Name and Description |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
moveWidget(widget: Widget): void
Moves the widget into the panel. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| hideBusyIndicator |
|
hideBusyIndicator(): void
Hides the busy indicator.
Since
2020.1
|
| moveWidget | |||
|
moveWidget(widget: Widget): void
Moves the widget into the panel.
Parameters
Since
2020.7
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
Since
2020.1
|
| 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. |
| Auto |
| static Auto: 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 |
| static Off: PauseMode Pause data refresh is turned off. |
| On |
| static On: PauseMode Pause data refresh is turned on. Any operations resulting in a data refresh are paused. |
| Name and Description |
|
getDataLocking(): DataLocking
Returns the Data Locking object of the table. |
|
getPlanningAreaInfo(): PlanningAreaInfo
Returns the Planning Area Info object that is initialized with the filters applied to the table. |
|
getPrivateVersion(versionId: string): PlanningPrivateVersion
Returns a private version associated with the data source. |
|
getPrivateVersions(): PlanningPrivateVersion[]
Returns all private versions associated with the data source. |
|
getPublicVersion(versionId: string): PlanningPublicVersion
Returns a public version associated with the data source. |
|
getPublicVersions(): PlanningPublicVersion[]
Returns all public versions associated with the data source. |
|
isEnabled(): boolean
Returns whether planning is enabled for the table. |
|
setEnabled(enabled: boolean): boolean
Enables or disables planning for the table. |
|
setUserInput(selectedData: Selection JSON, value: string): boolean
Sets a value to data cells. |
|
submitData(): boolean
Submits the data to the server. |
| getDataLocking |
|
getDataLocking(): DataLocking
Returns the Data Locking object of the table. If the data source associated with the table doesn't support data locking, then undefined is returned.
Returns
DataLocking
Since
2019.22
|
| getPlanningAreaInfo |
|
getPlanningAreaInfo(): PlanningAreaInfo
Returns the Planning Area Info object that is initialized with the filters applied to the table. If the data source associated with the table doesn't support planning, then undefined is returned.
Returns
PlanningAreaInfo
Since
2023.20
|
| getPrivateVersion | |||
|
getPrivateVersion(versionId: string): PlanningPrivateVersion
Returns a private version associated with the data source. If there is no private version with this version ID, then undefined is returned.
Parameters
Returns
PlanningPrivateVersion
Since
2019.4
|
| getPrivateVersions |
|
getPrivateVersions(): PlanningPrivateVersion[]
Returns all private versions associated with the data source.
Returns
PlanningPrivateVersion[]
Since
2019.4
|
| getPublicVersion | |||
|
getPublicVersion(versionId: string): PlanningPublicVersion
Returns a public version associated with the data source. If there is no public version with this version ID, then undefined is returned.
Parameters
Returns
PlanningPublicVersion
Since
2019.4
|
| getPublicVersions |
|
getPublicVersions(): PlanningPublicVersion[]
Returns all public versions associated with the data source.
Returns
PlanningPublicVersion[]
Since
2019.4
|
| isEnabled |
|
isEnabled(): boolean
Returns whether planning is enabled for the table.
Returns
boolean |
| setEnabled | |||
|
setEnabled(enabled: boolean): boolean
Enables or disables planning for the table. If this operation was successful, then true is returned (even if you try to enable planning for a table that is already planning-enabled), and false if it wasn't.
Parameters
Returns
boolean |
| setUserInput | ||||||
|
setUserInput(selectedData: Selection JSON, value: string): boolean
Sets a value to data cells. The data cells are specified by the selection. The selection references a visible data cell in the rows or columns of the table. If this operation was successful, then true is returned, and false if it wasn't. Note: If this operation wasn't successful, then one of the following could be the cause: The cell is either a fact cell, a calculation cell, or not input-enabled. Note: After calling setUserInput() it's best to immediately submit your input with Planning.submitData(). Otherwise, unexpected results may occur. For example, if other operations are performed in scripts or by user interaction that lead to a refresh of the planning table before submitting your input, then your input may be discarded. Note: When setting a value for a key figure of a BPC model, you can use digits, letters, and special characters in the value.
Parameters
Returns
boolean
Since
2019.10
|
| submitData |
|
submitData(): boolean
Submits the data to the server. If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean
Since
2019.10
|
| Name and Description |
|
changeFilter(dimension: string | DimensionInfo JSON, memberInfo: PlanningAreaMemberInfo JSON): PlanningAreaInfo
Sets a filter on the dimension. |
|
getFilters(): PlanningAreaFilter[]
Returns filters that define the planning area. |
|
removeFilter(dimension: string | DimensionInfo JSON): PlanningAreaInfo
Removes any filter that is set on the dimension. |
| changeFilter | ||||||
|
changeFilter(dimension: string | DimensionInfo JSON, memberInfo: PlanningAreaMemberInfo JSON): PlanningAreaInfo
Sets a filter on the dimension. Any existing filter on the dimension is overwritten.
Parameters
Returns
PlanningAreaInfo |
| getFilters |
|
getFilters(): PlanningAreaFilter[]
Returns filters that define the planning area. Filters on Version and Measure dimensions are ignored.
Returns
PlanningAreaFilter[] |
| removeFilter | |||
|
removeFilter(dimension: string | DimensionInfo JSON): PlanningAreaInfo
Removes any filter that is set on the dimension.
Parameters
Returns
PlanningAreaInfo |
| Name and Description |
|
static Actuals: PlanningCategory
Predefined "Actuals" category of the SAP Analytic Cloud planning model |
|
static Budget: PlanningCategory
Predefined "Budget" category of the SAP Analytic Cloud planning model |
|
static Forecast: PlanningCategory
Predefined "Forecast" category of the SAP Analytic Cloud planning model |
|
static Planning: PlanningCategory
Predefined "Planning" category of the SAP Analytic Cloud planning model |
|
static RollingForecast: PlanningCategory
Predefined "Rolling Forecast" category of the SAP Analytic Cloud planning model |
| Actuals |
|
static Actuals: PlanningCategory
Predefined "Actuals" category of the SAP Analytic Cloud planning model
Since
2019.7
|
| Budget |
| static Budget: PlanningCategory Predefined "Budget" category of the SAP Analytic Cloud planning model |
| Forecast |
| static Forecast: PlanningCategory Predefined "Forecast" category of the SAP Analytic Cloud planning model |
| Planning |
| static Planning: PlanningCategory Predefined "Planning" category of the SAP Analytic Cloud planning model |
| RollingForecast |
| static RollingForecast: PlanningCategory Predefined "Rolling Forecast" category of the SAP Analytic Cloud planning model |
| Name and Description |
|
static AllData: PlanningCopyOption
All data is included when copying a version. |
|
static CustomizedPlanningArea: PlanningCopyOption
Planning Area with customized filter is included when copying a version. |
|
static NoData: PlanningCopyOption
All data is excluded when copying a version. |
|
static PlanningArea: PlanningCopyOption
Deprecated This option is deprecated, Planning Area data is included when copying a version. |
|
static VisibleData: PlanningCopyOption
Visible data based on the table is included when copying a version. |
| AllData |
| static AllData: PlanningCopyOption All data is included when copying a version. |
| CustomizedPlanningArea |
|
static CustomizedPlanningArea: PlanningCopyOption
Planning Area with customized filter is included when copying a version.
Since
2023.20
|
| NoData |
| static NoData: PlanningCopyOption All data is excluded when copying a version. |
| PlanningArea |
|
static PlanningArea: PlanningCopyOption
Deprecated This option is deprecated, Planning Area data is included when copying a version.
Since
2021.19
Deprecated
2024.12
|
| VisibleData |
|
static VisibleData: PlanningCopyOption
Visible data based on the table is included when copying a version.
Since
2023.20
|
| Name and Description |
|
createMembers(dimensionId: string, members: PlanningModelMember JSON | PlanningModelMember[] JSON): boolean
Creates planning model members. |
|
deleteMembers(dimensionId: string, members: string | string[]): boolean
Deletes planning model members. |
|
getMember(dimensionId: string, memberId: string): PlanningModelMember
Returns a planning model member. |
|
getMembers(dimensionId: string, options?: PlanningModelMemberOptions JSON): PlanningModelMember[]
Returns planning model members. |
|
updateMembers(dimensionId: string, members: PlanningModelMember JSON | PlanningModelMember[] JSON): boolean
Updates planning model members. |
| createMembers | ||||||
|
createMembers(dimensionId: string, members: PlanningModelMember JSON | PlanningModelMember[] JSON): boolean
Creates planning model members. If this operation was successful, then true is returned, and false if it wasn't. Note: Currently, this operation supports only generic dimensions. Note: Call DataSource.refreshData() or Application.refreshData() after this operation, if you need the chart or table to reflect the created members in subsequent method calls operating on visible cells or elements of those widgets, for example, Planning.setUserInput(), DataSource.getData(), or DataSource.getPlanning().getState(). Note: Creating a member with the same member ID as an already existing member results in an error.
Parameters
Returns
boolean |
| deleteMembers | ||||||
|
deleteMembers(dimensionId: string, members: string | string[]): boolean
Deletes planning model members. If this operation was successful, then true is returned, and false if it wasn't. Note: Currently, this operation supports only generic dimensions. Note: Call DataSource.refreshData() or Application.refreshData() after this operation, if you need the chart or table to reflect the deleted members in subsequent method calls operating on visible cells or elements of those widgets, for example, Planning.setUserInput(), DataSource.getData(), or DataSource.getPlanning().getState().
Parameters
Returns
boolean |
| getMember | ||||||
|
getMember(dimensionId: string, memberId: string): PlanningModelMember
Returns a planning model member. Note: Currently, this operation supports only generic dimensions.
Parameters
Returns
PlanningModelMember |
| getMembers | ||||||
|
getMembers(dimensionId: string, options?: PlanningModelMemberOptions JSON): PlanningModelMember[]
Returns planning model members. Note: Currently, this operation supports only generic dimensions. Note: If you specify options, then you can control the returned set of members even finer, for example, the number of returned members (default: 200).
Parameters
Returns
PlanningModelMember[] |
| updateMembers | ||||||
|
updateMembers(dimensionId: string, members: PlanningModelMember JSON | PlanningModelMember[] JSON): boolean
Updates planning model members. If this operation was successful, then true is returned, and false if it wasn't. Note: Currently, this operation supports only generic dimensions. Note: Call DataSource.refreshData() or Application.refreshData() after this operation, if you need the chart or table to reflect the updated members in subsequent method calls operating on visible cells or elements of those widgets, for example, Planning.setUserInput(), DataSource.getData(), or DataSource.getPlanning().getState().
Parameters
Returns
boolean |
| Name and Description |
|
dataLockingOwners: PlanningModelMemberPrincipal[] JSON
Users and teams who own data locks on the planning model member |
|
description: string
Description of the planning model member |
|
hierarchies: PlanningModelMemberHierarchies
Hierarchies of the planning model member. |
|
id: string
ID of the planning model member |
|
properties: PlanningModelMemberProperties
Properties of the planning model member |
|
readers: PlanningModelMemberPrincipal[] JSON
Users and teams who can read the planning model member |
|
responsible: PlanningModelMemberPrincipal JSON
Responsible user for the planning model member |
|
writers: PlanningModelMemberPrincipal[] JSON
Users and teams who can update the planning model member |
| dataLockingOwners |
|
dataLockingOwners: PlanningModelMemberPrincipal[] JSON
Users and teams who own data locks on the planning model member
Since
2020.13
|
| description |
| description: string Description of the planning model member |
| hierarchies |
| hierarchies: PlanningModelMemberHierarchies Hierarchies of the planning model member. Here's an example of the structure of the hierarchies object, hierarchies: { MyHierarchyId: { parentId: "HCUST0001", previousSiblingId: "CUST0007" } }. In this example, "MyHierarchyId" represents the ID of the hierarchy in your model. |
| id |
| id: string ID of the planning model member |
| properties |
| properties: PlanningModelMemberProperties Properties of the planning model member |
| readers |
| readers: PlanningModelMemberPrincipal[] JSON Users and teams who can read the planning model member |
| responsible |
|
responsible: PlanningModelMemberPrincipal JSON
Responsible user for the planning model member
Since
2020.13
|
| writers |
| writers: PlanningModelMemberPrincipal[] JSON Users and teams who can update the planning model member |
| Name and Description |
|
parentId: string
Parent ID of a planning model member hierarchy |
|
previousSiblingId: string
Previous sibling ID of a planning model member hierarchy. |
| parentId |
| parentId: string Parent ID of a planning model member hierarchy |
| previousSiblingId |
| previousSiblingId: string Previous sibling ID of a planning model member hierarchy. The planning model member is inserted after the specified sibling. If previousSiblingId is an empty string (""), then the planning model member is inserted as the first sibling. If the property previousSiblingId is omitted, then the planning model member is appended as the last sibling. |
| Name and Description |
|
hierarchyId: string
Hierarchy ID |
|
limit: integer
Maximum number of returned members. |
|
offset: integer
Number of members to skip before starting to read members |
|
parentId: string
Parent ID |
| hierarchyId |
| hierarchyId: string Hierarchy ID |
| limit |
| limit: integer Maximum number of returned members. It must be zero or a positive number. If the limit isn't specified or invalid, then the default value is used (default: 200). |
| offset |
| offset: integer Number of members to skip before starting to read members |
| parentId |
| parentId: string Parent ID |
| Name and Description |
|
id: string
ID of a user or a team that has certain access to a planning model member |
|
type: UserType
Type of a user or a team who has certain access to a planning model member |
| id |
| id: string ID of a user or a team that has certain access to a planning model member |
| type |
| type: UserType Type of a user or a team who has certain access to a planning model member |
| Name and Description |
|
getOwnerId(): string
Returns the user ID of the user who created this private version. |
|
publish(targetVersion?: PlanningPublicVersion, updateChangedDataOnly?: boolean, publishOptions?: PrivateVersionPublishOptions JSON): boolean
Creates a public version from this private version. |
|
publishAs(newVersionName: string, versionCategory?: PlanningCategory): boolean
Creates a public version with the specified name from this private version. |
| Inherited from PlanningVersion |
| copy, deleteVersion, getDisplayId, getId |
| getOwnerId |
|
getOwnerId(): string
Returns the user ID of the user who created this private version.
Returns
string
Since
2019.8
|
| publish | |||||||||
|
publish(targetVersion?: PlanningPublicVersion, updateChangedDataOnly?: boolean, publishOptions?: PrivateVersionPublishOptions JSON): boolean
Creates a public version from this private version. If a public target version is specified, then updateChangedDataOnly specifies whether to update only data that was changed or to update all valid member combinations (default: false). If no public target version is specified, then the original public version is overwritten that was used when the private version was created. If the public target version is unrelated to the private version and updateChangedDataOnly is false, then the private version overwrites the public target version. If the public target version is unrelated to the private version and updateChangedDataOnly is true, then only the changed data is published to the public target version. If this operation was successful, then this private version is deleted.
Parameters
Returns
boolean
Last Update
2023.15
|
| publishAs | ||||||
|
publishAs(newVersionName: string, versionCategory?: PlanningCategory): boolean
Creates a public version with the specified name from this private version. If no category is specified, then the category of the private version is used for the new public version. If this operation was successful, then this private version is deleted.
Parameters
Returns
boolean |
| Name and Description |
|
static AllData: PlanningPublicEditOption
All data is included when starting edit version. |
|
static CustomizedPlanningArea: PlanningPublicEditOption
Planning Area with customized filter is included when starting edit version. |
|
static PlanningArea: PlanningPublicEditOption
Planning Area data is included when starting edit version. |
|
static TableContextWithPlanningArea: PlanningPublicEditOption
Table context with Planning Area is included when starting edit version. |
| AllData |
| static AllData: PlanningPublicEditOption All data is included when starting edit version. |
| CustomizedPlanningArea |
| static CustomizedPlanningArea: PlanningPublicEditOption Planning Area with customized filter is included when starting edit version. |
| PlanningArea |
| static PlanningArea: PlanningPublicEditOption Planning Area data is included when starting edit version. |
| TableContextWithPlanningArea |
| static TableContextWithPlanningArea: PlanningPublicEditOption Table context with Planning Area is included when starting edit version. |
| Name and Description |
|
isDirty(): boolean
Returns whether this version has been modified and can be published or reverted. |
|
publish(publishOptions?: PublicVersionPublishOptions JSON): boolean
Publishes the modifications applied by the user. |
|
revert(): boolean
Reverts the modifications applied by the user. |
|
startEditMode(planningPublicEditOption: PlanningPublicEditOption, planningAreaFilter?: PlanningAreaFilter[] JSON): boolean
Starts the edit mode for public version. |
| Inherited from PlanningVersion |
| copy, deleteVersion, getDisplayId, getId |
| isDirty |
|
isDirty(): boolean
Returns whether this version has been modified and can be published or reverted.
Returns
boolean |
| publish | |||
|
publish(publishOptions?: PublicVersionPublishOptions JSON): boolean
Publishes the modifications applied by the user. If this operation was successful, then true is returned, and false if it wasn't. Note: Before publishing, check with PlanningPublicVersion.isDirty() if there are modifications available that can be published. When there're conflicting changes, if the related parameter isn't specified, the user's changes overwrite the other ones.
Parameters
Returns
boolean
Last Update
2023.15
|
| revert |
|
revert(): boolean
Reverts the modifications applied by the user. If this operation was successful, then true is returned, and false if it wasn't. Note: Before reverting, check with PlanningPublicVersion.isDirty() if there are modifications available that can be reverted.
Returns
boolean |
| startEditMode | ||||||
|
startEditMode(planningPublicEditOption: PlanningPublicEditOption, planningAreaFilter?: PlanningAreaFilter[] JSON): boolean
Starts the edit mode for public version. If this operation was successful, then true is returned, and false if it wasn't. Note: Before starting edit mode, check with PlanningPublicVersion.isDirty() to false.
Parameters
Returns
boolean
Since
2024.12
|
| Name and Description |
|
copy(newVersionName: string, planningCopyOption: PlanningCopyOption, versionCategory?: PlanningCategory, planningAreaFilter?: PlanningAreaFilter[] JSON): boolean
Creates a private copy of this version. |
|
deleteVersion(): boolean
Deletes this version. |
|
getDisplayId(): string
Returns the display ID of this version. |
|
getId(): string
Returns the ID of this version. |
| copy | ||||||||||||
|
copy(newVersionName: string, planningCopyOption: PlanningCopyOption, versionCategory?: PlanningCategory, planningAreaFilter?: PlanningAreaFilter[] JSON): boolean
Creates a private copy of this version. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean
Since
2019.7
Last Update
2023.20
|
| deleteVersion |
|
deleteVersion(): boolean
Deletes this version. If this operation was successful, then true is returned, and false if it wasn't.
Returns
boolean |
| getDisplayId |
|
getDisplayId(): string
Returns the display ID of this version. You can use it, for example, to display the version in dropdowns or texts.
Returns
string
Since
2019.5
|
| getId |
|
getId(): string
Returns the ID of this version. You can use it, for example, when calling DataSource.getData().
Returns
string |
| Name and Description |
|
close(): void
Closes the popup. |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the popup. |
|
getTitle(): string
Returns the title of the popup. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
isButtonEnabled(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is enabled. |
|
isButtonVisible(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is visible. |
|
open(): void
Opens the popup. |
|
setButtonEnabled(buttonId: string, enabled: boolean): void
Enables or disables a specific button in the footer of the popup. |
|
setButtonVisible(buttonId: string, visible: boolean): void
Shows or hides a specific button in the footer of the popup. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the popup. |
|
setSize(size: PopupSizeOptions): void
Sets the popup size. |
|
setTitle(title: string): void
Sets the title of the popup. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Name and Description |
|
onButtonClick(buttonId: string): void Called when the user clicks any button in the footer of the popup. |
|
onResize(width: number, height: number): void Called when the popup is resized. |
| close |
| close(): void Closes the popup. |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the popup.
Returns
string
Since
2020.20
|
| getTitle |
|
getTitle(): string
Returns the title of the popup.
Returns
string |
| hideBusyIndicator |
|
hideBusyIndicator(): void
Hides the busy indicator.
Since
2020.1
|
| isButtonEnabled | |||
|
isButtonEnabled(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is enabled.
Parameters
Returns
boolean |
| isButtonVisible | |||
|
isButtonVisible(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is visible.
Parameters
Returns
boolean |
| open |
| open(): void Opens the popup. |
| setButtonEnabled | ||||||
|
setButtonEnabled(buttonId: string, enabled: boolean): void
Enables or disables a specific button in the footer of the popup.
Parameters
Last Update
2018.22
|
| setButtonVisible | ||||||
|
setButtonVisible(buttonId: string, visible: boolean): void
Shows or hides a specific button in the footer of the popup.
Parameters
Last Update
2018.22
|
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the popup.
Parameters
Since
2020.20
|
| setSize | |||
|
setSize(size: PopupSizeOptions): void
Sets the popup size.
Parameters
Since
2024.25
|
| setTitle | |||
|
setTitle(title: string): void
Sets the title of the popup.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
Since
2020.1
|
| onButtonClick | |||
|
onButtonClick(buttonId: string): void
Called when the user clicks any button in the footer of the popup.
Parameters
Since
2018.22
|
| onResize | ||||||
|
onResize(width: number, height: number): void
Called when the popup is resized.
Parameters
Since
2024.25
|
| Name and Description |
|
static height: integer
Height |
|
static heightUnit: PopupSizeUnit
Height Unit |
|
static width: integer
Width |
|
static widthUnit: PopupSizeUnit
Width Unit |
| height |
| static height: integer Height |
| heightUnit |
| static heightUnit: PopupSizeUnit Height Unit |
| width |
| static width: integer Width |
| widthUnit |
| static widthUnit: PopupSizeUnit Width Unit |
| Name and Description |
| static Percent: PopupSizeUnit |
| static Pixel: PopupSizeUnit |
| Name and Description |
| static Parent: PostMessageReceiver |
| static Top: PostMessageReceiver |
| 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. |
| PublishWithoutWarning |
| 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. |
| ShowWarning |
| static ShowWarning: PrivatePublishConflict Shows the warning dialog for the user to handle conflicting changes. |
| Name and Description |
|
privatePublishConflict: PrivatePublishConflict
Used for handling conflicting changes. |
| privatePublishConflict |
| privatePublishConflict: PrivatePublishConflict Used for handling conflicting changes. The values correspond to showing the conflict warning dialog, overwriting user's changes without showing the dialog respectively. |
| 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. |
| PublishWithoutWarning |
| 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. |
| RevertWithoutWarning |
| static RevertWithoutWarning: PublicPublishConflict Reverts the version without showing the conflict warning dialog. |
| ShowWarning |
| static ShowWarning: PublicPublishConflict Shows the warning dialog for the user to handle conflicting changes. |
| Name and Description |
|
publicPublishConflict: PublicPublishConflict
Used for handling conflicting changes. |
| publicPublishConflict |
| publicPublishConflict: PublicPublishConflict Used for handling conflicting changes. The values correspond to showing the conflict warning dialog, overwriting user's changes without showing the dialog, and reverting the version without showing the dialog respectively. |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the radio button group. |
|
getSelectedKey(): string
Returns the key of the selected item in the radio button group. |
|
getSelectedText(): string
Returns the text of the selected item in the radio button group. |
|
removeAllItems(): void
Removes all items from the radio button group. |
|
removeItem(key: string): void
Removes the item from the radio button group. |
|
setSelectedKey(key: string): void
Selects an item in the radio button group. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user changes the selection in the radio button group. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the radio button 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
|
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected item in the radio button group. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedText |
|
getSelectedText(): string
Returns the text of the selected item in the radio button group. If no item is selected, then undefined is returned.
Returns
string |
| removeAllItems |
| removeAllItems(): void Removes all items from the radio button group. |
| removeItem | |||
|
removeItem(key: string): void
Removes the item from the radio button group. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKey | |||
|
setSelectedKey(key: string): void
Selects an item in the radio button group. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| 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. |
| create | ||||||
|
static create(startValue: number, endValue: number): Range
Creates a range with a start and an end value.
Parameters
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
|
| setStartValue | |||
|
setStartValue(value: number): void
Sets the start value of the range.
Parameters
|
| Name and Description |
|
from: string
Start filter value of a range |
|
greater: string
Filter value specifying a range of filter values greater than this filter value |
|
greaterOrEqual: string
Filter value specifying a range of filter values greater or equal than this filter value |
|
less: string
Filter value specifying a range of filter values less than this filter value |
|
lessOrEqual: string
Filter value specifying a range of filter values less or equal than this filter value |
|
to: string
End filter value of a range |
| Inherited from FilterValue |
| type |
| from |
| from: string Start filter value of a range |
| greater |
| greater: string Filter value specifying a range of filter values greater than this filter value |
| greaterOrEqual |
| greaterOrEqual: string Filter value specifying a range of filter values greater or equal than this filter value |
| less |
| less: string Filter value specifying a range of filter values less than this filter value |
| lessOrEqual |
| lessOrEqual: string Filter value specifying a range of filter values less or equal than this filter value |
| to |
| to: string End filter value of a range |
| Name and Description |
|
getMaxValue(): number
Returns the maximum value of the range slider. |
|
getMinValue(): number
Returns the minimum value of the range slider. |
|
getRange(): Range
Returns the range of the range slider. |
|
setMaxValue(value: number): void
Sets the maximum value of the range slider. |
|
setMinValue(value: number): void
Sets the minimum value of the range slider. |
|
setRange(range: Range): void
Sets the range of the range slider. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the range slider doesn't have the focus anymore. |
| getMaxValue |
|
getMaxValue(): number
Returns the maximum value of the range slider.
Returns
number |
| getMinValue |
|
getMinValue(): number
Returns the minimum value of the range slider.
Returns
number |
| getRange |
|
getRange(): Range
Returns the range of the range slider.
Returns
Range |
| setMaxValue | |||
|
setMaxValue(value: number): void
Sets the maximum value of the range slider.
Parameters
|
| setMinValue | |||
|
setMinValue(value: number): void
Sets the minimum value of the range slider.
Parameters
|
| setRange | |||
|
setRange(range: Range): void
Sets the range of the range slider.
Parameters
|
| 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 |
| 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 |
| Name and Description |
|
getDataSource(): DataSource
Returns the data source of the data frame. |
| getDataSource |
|
getDataSource(): DataSource
Returns the data source of the data frame.
Returns
DataSource |
| Name and Description |
|
getNumber(key: string): number
Returns the number value of an R code variable. |
| Name and Description |
|
description: string
Member description |
|
id: string
Member ID |
|
parentId: string
Parent ID of member |
|
properties: ResultMemberProperties
Properties of a dimension |
| description |
| description: string Member description |
| id |
| id: string Member ID |
| parentId |
| parentId: string Parent ID of member |
| properties |
|
properties: ResultMemberProperties
Properties of a dimension
Since
2020.10
|
| 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. |
| 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
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
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
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
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
|
| 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
|
| 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
|
| 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
|
| Name and Description |
|
addFeed(title: string, url: string): void
Adds a new RSS feed to the RSS feeds. |
|
getAllFeeds(): RssFeedInfo[]
Returns all RSS feeds. |
|
getSelectedFeed(): RssFeedInfo
Returns the selected RSS feed. |
|
removeAllFeeds(): void
Removes all RSS feeds. |
|
removeFeed(url: string): void
Removes any RSS feed with this URL from the RSS feeds. |
|
setSelectedFeed(url: string): void
Selects the first RSS feed with this URL. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| addFeed | ||||||
|
addFeed(title: string, url: string): void
Adds a new RSS feed to the RSS feeds. If an RSS feed with the same title and URL is already present, then the new RSS feed is still added.
Parameters
|
| getAllFeeds |
|
getAllFeeds(): RssFeedInfo[]
Returns all RSS feeds.
Returns
RssFeedInfo[] |
| getSelectedFeed |
|
getSelectedFeed(): RssFeedInfo
Returns the selected RSS feed.
Returns
RssFeedInfo |
| removeAllFeeds |
| removeAllFeeds(): void Removes all RSS feeds. |
| removeFeed | |||
|
removeFeed(url: string): void
Removes any RSS feed with this URL from the RSS feeds. If an RSS feed is removed that is selected, then that RSS feed is removed, and the first RSS feed of the RSS feeds is selected. If there is no RSS feed with this URL, then this operation is ignored.
Parameters
|
| setSelectedFeed | |||
|
setSelectedFeed(url: string): void
Selects the first RSS feed with this URL. If there is no RSS feed with this URL, then this operation is ignored.
Parameters
|
| Name and Description |
|
getDataFrame(dataframeName: string): RDataFrame
Returns the data frame. |
|
getEnvironmentValues(): REnvironmentValues
Returns the environment values. |
|
getInputParameters(): RInputParameters
Returns the input parameters. |
|
getMessages(): string[]
Returns the console output. |
|
getStatus(): RVisualizationStatus
Returns the execution status of the R code. |
|
openInNewStory(): void
Creates a new story with this widget. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the R widget will navigate to. |
|
setQuickActionsVisibility(quickActionsVisibility: RVisualizationQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onResultChanged(): void Called when the result set in the R visualization changes. |
| getDataFrame | |||
|
getDataFrame(dataframeName: string): RDataFrame
Returns the data frame.
Parameters
Returns
RDataFrame
Mobile Support
Not supported on mobile devices.
|
| getEnvironmentValues |
|
getEnvironmentValues(): REnvironmentValues
Returns the environment values.
Returns
REnvironmentValues
Mobile Support
Not supported on mobile devices.
|
| getInputParameters |
|
getInputParameters(): RInputParameters
Returns the input parameters.
Returns
RInputParameters
Mobile Support
Not supported on mobile devices.
|
| getMessages |
|
getMessages(): string[]
Returns the console output.
Returns
string[]
Mobile Support
Not supported on mobile devices.
|
| getStatus |
|
getStatus(): RVisualizationStatus
Returns the execution status of the R code.
Returns
RVisualizationStatus
Mobile Support
Not supported on mobile devices.
|
| openInNewStory |
|
openInNewStory(): void
Creates a new story with this widget.
Mobile Support
Not supported on mobile devices.
Since
2021.3
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| setHyperlink | ||||||
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the R widget will navigate to.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2019.21
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: RVisualizationQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| Name and Description |
|
static addComment: boolean
Comment |
|
static fullscreen: boolean
Fullscreen |
|
static rDetail: boolean
Applied to R Visualization |
| Name and Description |
|
static Error: RVisualizationStatus
The R request failed to execute the R script. |
|
static Running: RVisualizationStatus
The R request is processed by the R server. |
|
static Success: RVisualizationStatus
The R request was executed successfully. |
| Error |
| static Error: RVisualizationStatus The R request failed to execute the R script. |
| Running |
| static Running: RVisualizationStatus The R request is processed by the R server. |
| Success |
| static Success: RVisualizationStatus The R request was executed successfully. |
| Name and Description |
|
static isRunBySchedulePublication(): boolean
Returns whether the analytic application is run by scheduling. |
|
static logMessage(messageType: SchedulingMessageType, messageText: string): void
Log a message in the scheduling status details. |
|
static openSubscriptionDialog(): void
Opens the scheduling subscription dialog. |
|
static publish(): boolean
Triggers the scheduling of an export in manual mode. |
| isRunBySchedulePublication |
|
static isRunBySchedulePublication(): boolean
Returns whether the analytic application is run by scheduling.
Returns
boolean |
| logMessage | ||||||
|
static logMessage(messageType: SchedulingMessageType, messageText: string): void
Log a message in the scheduling status details.
Parameters
Since
2020.17
|
| openSubscriptionDialog |
|
static openSubscriptionDialog(): void
Opens the scheduling subscription dialog.
Mobile Support
Not supported on mobile devices.
Since
2021.16
|
| publish |
|
static publish(): boolean
Triggers the scheduling of an export in manual mode.
Returns
boolean |
| Name and Description |
|
static Error: SchedulingMessageType
Error message |
|
static Info: SchedulingMessageType
Information message |
|
static Warning: SchedulingMessageType
Warning message |
| Error |
| static Error: SchedulingMessageType Error message |
| Info |
| static Info: SchedulingMessageType Information message |
| Warning |
| static Warning: SchedulingMessageType Warning message |
| Name and Description |
|
applySearchToChart(question: string, chart: Chart): boolean
Applies the Search to Insight result to a chart. |
| closeDialog(): void |
|
getVariables(modelId: string): VariableInfo[]
Returns the variable values stored in this Search to Insight component. |
| openDialog(question: string, mode: SearchToInsightDialogMode, cleanHistory?: boolean, autoSearch?: boolean): void |
|
setVariableValue(modelId: string, variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON): void
Stores a variable value in this Search to Insight component. |
| applySearchToChart | ||||||
|
applySearchToChart(question: string, chart: Chart): boolean
Applies the Search to Insight result to a chart. The chart also applies variable values set by earlier calls of SearchToInsight.setVariableValue().
Parameters
Returns
boolean
Since
2020.1
|
| closeDialog |
| closeDialog(): void |
| getVariables | |||
|
getVariables(modelId: string): VariableInfo[]
Returns the variable values stored in this Search to Insight component.
Parameters
Returns
VariableInfo[]
Since
2020.1
|
| openDialog | ||||||||||||
|
openDialog(question: string, mode: SearchToInsightDialogMode, cleanHistory?: boolean, autoSearch?: boolean): void
Parameters
Mobile Support
Not supported on mobile devices.
|
| setVariableValue | |||||||||
|
setVariableValue(modelId: string, variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON): void
Stores a variable value in this Search to Insight component. The variable value is applied to a chart when calling SearchToInsight.applySearchToChart().
Parameters
Since
2020.1
|
| Name and Description |
|
static Advanced: SearchToInsightDialogMode
Advanced Search to Insight dialog with model selection and suggestions |
|
static Simple: SearchToInsightDialogMode
Simple Search to Insight dialog |
| Advanced |
| static Advanced: SearchToInsightDialogMode Advanced Search to Insight dialog with model selection and suggestions |
| Simple |
| static Simple: SearchToInsightDialogMode Simple Search to Insight dialog |
| Name and Description |
|
loadDescriptions: boolean
Specifies whether to load the variable value descriptions for the Prompt dialog and for dynamic texts (default: true). |
| loadDescriptions |
| loadDescriptions: boolean Specifies whether to load the variable value descriptions for the Prompt dialog and for dynamic texts (default: true). If set to false, then this may improve the performance of the analytic application, however at the cost of displaying variable value IDs instead of variable value descriptions in the Prompt dialog and in dynamic texts. |
| Name and Description |
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the shape will navigate to. |
|
setStyle(style: ShapeStyle JSON): void
Applies the style to the shape. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the shape. |
|
onLongPress(): void Called when the user presses and holds the shape. |
| setHyperlink | ||||||
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the shape will navigate to.
Parameters
|
| setStyle | |||
|
setStyle(style: ShapeStyle JSON): void
Applies the style to the shape. You can also pass a JSON object for this argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
Since
2020.9
|
| Name and Description |
|
description: string
Filter description |
|
exclude: boolean
Indicates whether to exclude the filter value. |
|
value: string
Filter value |
| Inherited from FilterValue |
| type |
| Name and Description |
|
exclude: boolean
Indicates whether to exclude the variable value. |
|
value: string
Variable value |
| Inherited from VariableValue |
| type |
| Name and Description |
|
getMaxValue(): number
Returns the maximum value of the slider. |
|
getMinValue(): number
Returns the minimum value of the slider. |
|
getValue(): number
Returns the value of the slider. |
|
setMaxValue(value: number): void
Sets the maximum value of the slider. |
|
setMinValue(value: number): void
Sets the minimum value of the slider. |
|
setValue(value: number): void
Sets the value of the slider. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the slider doesn't have the focus anymore. |
| getMaxValue |
|
getMaxValue(): number
Returns the maximum value of the slider.
Returns
number |
| getMinValue |
|
getMinValue(): number
Returns the minimum value of the slider.
Returns
number |
| getValue |
|
getValue(): number
Returns the value of the slider.
Returns
number |
| setMaxValue | |||
|
setMaxValue(value: number): void
Sets the maximum value of the slider.
Parameters
|
| setMinValue | |||
|
setMinValue(value: number): void
Sets the minimum value of the slider.
Parameters
|
| setValue | |||
|
setValue(value: number): void
Sets the value of the slider.
Parameters
|
| 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. |
| setGroupLabel | |||
|
setGroupLabel(label: string): void
Sets the group prefix label.
Parameters
|
| 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
|
| setTooltipFeedsIncluded | |||
|
setTooltipFeedsIncluded(included: boolean): void
Includes or excludes the tooltip feeds.
Parameters
Since
2021.6
|
| setTooltipMeasureIncluded | |||
|
setTooltipMeasureIncluded(included: boolean): void
Deprecated This method is deprecated, use setTooltipFeedsIncluded() instead. Includes or excludes the tooltip measure.
Parameters
Deprecated
2021.6
|
| setVisible | |||
|
setVisible(visible: boolean): void
Enables or disables Smart Grouping.
Parameters
|
| Name and Description |
|
static Ascending: SortOrder
Ascending order of sorting (lowest to highest for a measure, earliest to latest for a time-based dimension, and alphabetically ascending for a non-time-based dimension) |
|
static Default: SortOrder
Default order of sorting |
|
static Descending: SortOrder
Descending order of sorting (highest to lowest for a measure, latest to earliest for a time-based dimension, and alphabetically descending for a non-time-based dimension) |
| Ascending |
| static Ascending: SortOrder Ascending order of sorting (lowest to highest for a measure, earliest to latest for a time-based dimension, and alphabetically ascending for a non-time-based dimension) |
| Default |
| static Default: SortOrder Default order of sorting |
| Descending |
| static Descending: SortOrder Descending order of sorting (highest to lowest for a measure, latest to earliest for a time-based dimension, and alphabetically descending for a non-time-based dimension) |
| Name and Description |
|
close(): void
Closes the popup. |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the popup. |
|
getTitle(): string
Returns the title of the popup. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
isButtonEnabled(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is enabled. |
|
isButtonVisible(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is visible. |
|
open(): void
Opens the popup. |
|
setButtonEnabled(buttonId: string, enabled: boolean): void
Enables or disables a specific button in the footer of the popup. |
|
setButtonVisible(buttonId: string, visible: boolean): void
Shows or hides a specific button in the footer of the popup. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the popup. |
|
setSize(size: CrossPagePopupSizeOptions): void
Sets the popup size. |
|
setTitle(title: string): void
Sets the title of the popup. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Name and Description |
|
onButtonClick(buttonId: string): void Called when the user clicks any button in the footer of the popup. |
|
onOpen(origin: string): void Called when the Story Popup is open. |
|
onResize(width: number, height: number): void Called when the popup is resized. |
| close |
| close(): void Closes the popup. |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the popup.
Returns
string |
| getTitle |
|
getTitle(): string
Returns the title of the popup.
Returns
string |
| hideBusyIndicator |
| hideBusyIndicator(): void Hides the busy indicator. |
| isButtonEnabled | |||
|
isButtonEnabled(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is enabled.
Parameters
Returns
boolean |
| isButtonVisible | |||
|
isButtonVisible(buttonId: string): boolean
Returns whether a specific button in the footer of the popup is visible.
Parameters
Returns
boolean |
| open |
| open(): void Opens the popup. |
| setButtonEnabled | ||||||
|
setButtonEnabled(buttonId: string, enabled: boolean): void
Enables or disables a specific button in the footer of the popup.
Parameters
|
| setButtonVisible | ||||||
|
setButtonVisible(buttonId: string, visible: boolean): void
Shows or hides a specific button in the footer of the popup.
Parameters
|
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the popup.
Parameters
|
| setSize | |||
|
setSize(size: CrossPagePopupSizeOptions): void
Sets the popup size.
Parameters
Since
2024.25
|
| setTitle | |||
|
setTitle(title: string): void
Sets the title of the popup.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| onButtonClick | |||
|
onButtonClick(buttonId: string): void
Called when the user clicks any button in the footer of the popup.
Parameters
|
| onOpen | |||
|
onOpen(origin: string): void
Called when the Story Popup is open.
Parameters
|
| onResize | ||||||
|
onResize(width: number, height: number): void
Called when the popup is resized.
Parameters
Since
2024.25
|
| Name and Description |
|
length: integer
Represents the length of a string. |
| Name and Description |
|
charAt(index: integer): string
Returns the specified character from a string. |
|
charCodeAt(index: integer): integer
Returns the numeric Unicode value of the character at the given index (except for Unicode codepoints > 0x10000). |
|
codePointAt(pos: integer): integer
Returns a non-negative integer that is the UTF-16 encoded code point value. |
|
concat(other: string): string
Combines the text of two strings and returns a new string. |
|
endsWith(searchString: string, length?: integer): boolean
Returns whether a string ends with the characters of another string. |
|
includes(searchString: string, position?: integer): boolean
Returns whether one string may be found within another string. |
|
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. |
|
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. |
|
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. |
|
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). |
|
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. |
|
replace(pattern: string, replacement: string): string
Returns a new string with some or all matches of a pattern replaced by a replacement. |
|
slice(beginIndex: integer, endIndex?: integer): string
Extracts a section of a string and returns a new string. |
|
split(separator?: string, limit?: integer): string[]
Splits a string into an array of strings by separating the string into substrings. |
|
startsWith(searchString: string, position?: integer): boolean
Returns whether a string begins with the characters of another string. |
|
substr(start: integer, length?: integer): string
Returns the characters in a string beginning at the specified location through the specified number of characters. |
|
substring(indexStart: integer, indexEnd?: integer): string
Returns a subset of a string between one index and another, or through the end of the string. |
|
toLocaleLowerCase(): string
Returns the calling string value converted to lowercase, according to any locale-specific case mappings. |
|
toLocaleUpperCase(): string
Returns the calling string value converted to uppercase, according to any locale-specific case mappings. |
|
toLowerCase(): string
Returns the calling string value converted to lowercase. |
|
toUpperCase(): string
Returns the calling string value converted to uppercase. |
|
trim(): string
Removes whitespace from both ends of the string. |
| charAt | |||
|
charAt(index: integer): string
Returns the specified character from a string.
Parameters
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
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
Returns
integer
Last Update
2020.6
|
| concat | |||
|
concat(other: string): string
Combines the text of two strings and returns a new string.
Parameters
Returns
string |
| endsWith | ||||||
|
endsWith(searchString: string, length?: integer): boolean
Returns whether a string ends with the characters of another string.
Parameters
Returns
boolean
Last Update
2020.6
|
| includes | ||||||
|
includes(searchString: string, position?: integer): boolean
Returns whether one string may be found within another string.
Parameters
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
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
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
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
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
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
Returns
string |
| slice | ||||||
|
slice(beginIndex: integer, endIndex?: integer): string
Extracts a section of a string and returns a new string.
Parameters
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
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
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
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
Returns
string
Last Update
2020.6
|
| toLocaleLowerCase |
|
toLocaleLowerCase(): string
Returns the calling string value converted to lowercase, according to any locale-specific case mappings.
Returns
string |
| toLocaleUpperCase |
|
toLocaleUpperCase(): string
Returns the calling string value converted to uppercase, according to any locale-specific case mappings.
Returns
string |
| toLowerCase |
|
toLowerCase(): string
Returns the calling string value converted to lowercase.
Returns
string |
| toUpperCase |
|
toUpperCase(): string
Returns the calling string value converted to uppercase.
Returns
string |
| trim |
|
trim(): string
Removes whitespace from both ends of the string.
Returns
string |
| Name and Description |
|
static replaceAll(value: string, searchFor: string, replaceWith: string): string
Replaces all occurrences of the searchFor string with the replaceWith string. |
| Name and Description |
|
isEnabled(): boolean
Returns whether the switch is enabled. |
|
isOn(): boolean
Returns whether the switch is turned on. |
|
setEnabled(enabled: boolean): void
Enables or disables the switch. |
|
setOn(on: boolean): void
Turns the switch on or off. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the switch has been turned on or off. |
| isEnabled |
|
isEnabled(): boolean
Returns whether the switch is enabled.
Returns
boolean |
| isOn |
|
isOn(): boolean
Returns whether the switch is turned on.
Returns
boolean
Since
2020.16
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the switch.
Parameters
|
| setOn | |||
|
setOn(on: boolean): void
Turns the switch on or off.
Parameters
Since
2020.16
|
| Name and Description |
|
getKey(): string
Returns the key of the tab. |
|
getText(): string
Returns the text displayed on the tab. |
|
isVisible(): boolean
Returns whether the tab is visible. |
|
setText(text: string): void
Sets the text displayed on the tab. |
|
setVisible(visible: boolean): void
Shows or hides the tab. |
| getKey |
|
getKey(): string
Returns the key of the tab.
Returns
string |
| getText |
|
getText(): string
Returns the text displayed on the tab.
Returns
string |
| isVisible |
|
isVisible(): boolean
Returns whether the tab is visible.
Returns
boolean
Since
2020.6
|
| setText | |||
|
setText(text: string): void
Sets the text displayed on the tab.
Parameters
|
| setVisible | |||
|
setVisible(visible: boolean): void
Shows or hides the tab.
Parameters
Since
2020.6
|
| Name and Description |
|
addDimensionToColumns(dimension: string | DimensionInfo JSON, position?: integer): void
Adds the dimension to the Columns axis, at the specified position. |
|
addDimensionToRows(dimension: string | DimensionInfo JSON, position?: integer): void
Adds the dimension to the Rows axis, at the specified position. |
|
closeNavigationPanel(): void
Closes the navigation panel. |
|
getActiveDimensionProperties(dimension: string | DimensionInfo JSON): string[]
Returns the IDs of the currently active properties of the dimension. |
|
getColumnCount(): integer
Returns the number of columns of the table. |
|
getComments(): TableComments
Returns the comments of the data source. |
|
getDataSource(): DataSource
Returns the data source of the table. |
|
getDimensionsOnColumns(): string[]
Returns the dimensions on the Columns axis. |
|
getDimensionsOnRows(): string[]
Returns the dimensions on the Rows axis. |
|
getNumberFormat(): TableNumberFormat
Returns the table number format. |
|
getPlanning(): Planning
Returns the Planning object of the table. |
|
getRowCount(): integer
Returns the number of rows of the table. |
|
getSelections(): Selection[]
Returns the selections of the table. |
|
isCompactDisplayEnabled(axis: TableAxis): boolean
Returns whether the compact display is enabled for the axis. |
|
isEnabled(): boolean
Returns whether the user interaction with the table is enabled. |
|
isZeroSuppressionEnabled(axis: TableAxis): boolean
Returns whether zero suppression is enabled for the axis. |
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the table. |
|
openInNewStory(): void
Creates a new story with this widget. |
|
openNavigationPanel(navigationPanelOptions?: NavigationPanelOptions JSON): void
Opens the navigation panel. |
|
openSelectModelDialog(): void
Opens the select model dialog. |
|
rankBy(rankOptions: TableRankOptions JSON): void
Creates a Top N filter to show a specified number of the lowest or highest ranked values. |
|
removeDimension(dimension: string | DimensionInfo JSON): void
Removes the dimension from whichever axis it is present on. |
|
removeRanking(): void
Clears ranking and shows all the members with sort order retained, if applicable. |
|
removeSorting(): void
Clears sorting and shows the members in default order. |
|
setActiveDimensionProperties(dimension: string | DimensionInfo JSON, properties: string[] | DimensionPropertyInfo[]): void
Sets the active properties of the dimension. |
|
setBreakGroupingEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables Break Grouping when sorting. |
|
setCompactDisplayEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables the compact display for the axis. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the table. |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
|
setQuickActionsVisibility(quickActionsVisibility: TableQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility. |
|
setZeroSuppressionEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables zero suppression for the axis. |
|
sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void
Sorts dimension members in a table. |
|
sortByValue(relatedDimensions: Selection JSON, sortOrder: SortOrder, direction: Direction): void
Sorts measure values in a table. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onAfterDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext JSON): void Called when the table data is changed via manual data entry, copy and paste, or submitData() API. |
|
onResultChanged(): void Called when the result set displayed by the table changes. |
|
onSelect(): void Called when the user makes a selection within the table. |
| addDimensionToColumns | ||||||
|
addDimensionToColumns(dimension: string | DimensionInfo JSON, position?: integer): void
Adds the dimension to the Columns axis, at the specified position. If no position is specified, then the dimension is added as the last dimension of the Columns axis.
Parameters
Last Update
2019.7
|
| addDimensionToRows | ||||||
|
addDimensionToRows(dimension: string | DimensionInfo JSON, position?: integer): void
Adds the dimension to the Rows axis, at the specified position. If no position is specified, then the dimension is added as the last dimension of the Rows axis.
Parameters
Last Update
2019.7
|
| closeNavigationPanel |
|
closeNavigationPanel(): void
Closes the navigation panel.
Since
2020.13
|
| getActiveDimensionProperties | |||
|
getActiveDimensionProperties(dimension: string | DimensionInfo JSON): string[]
Returns the IDs of the currently active properties of the dimension.
Parameters
Returns
string[]
Since
2020.7
|
| getColumnCount |
|
getColumnCount(): integer
Returns the number of columns of the table.
Returns
integer
Since
2019.20
Last Update
2020.6
|
| getComments |
|
getComments(): TableComments
Returns the comments of the data source. Note: Currently, this operation is only supported for data sources associated with tables. If the data source isn't associated with a table, then undefined is returned.
Returns
TableComments
Since
2022.20
|
| getDataSource |
|
getDataSource(): DataSource
Returns the data source of the table.
Returns
DataSource |
| getDimensionsOnColumns |
|
getDimensionsOnColumns(): string[]
Returns the dimensions on the Columns axis.
Returns
string[]
Since
2019.1
Last Update
2019.7
|
| getDimensionsOnRows |
|
getDimensionsOnRows(): string[]
Returns the dimensions on the Rows axis.
Returns
string[]
Since
2019.1
Last Update
2019.7
|
| getNumberFormat |
|
getNumberFormat(): TableNumberFormat
Returns the table number format.
Returns
TableNumberFormat
Since
2020.11
|
| getPlanning |
|
getPlanning(): Planning
Returns the Planning object of the table. If the data source associated with the table doesn't support planning, then undefined is returned.
Returns
Planning
Since
2019.3
|
| getRowCount |
|
getRowCount(): integer
Returns the number of rows of the table.
Returns
integer
Since
2019.20
Last Update
2020.6
|
| getSelections |
|
getSelections(): Selection[]
Returns the selections of the table. You can use elements of the returned array with DataSource.getData() to get the value of a cell. See also the documentation of Selection.
Returns
Selection[]
Since
2019.7
|
| isCompactDisplayEnabled | |||
|
isCompactDisplayEnabled(axis: TableAxis): boolean
Returns whether the compact display is enabled for the axis. Note: Compact display is only supported for SAP BW models.
Parameters
Returns
boolean
Since
2020.7
|
| isEnabled |
|
isEnabled(): boolean
Returns whether the user interaction with the table is enabled.
Returns
boolean
Since
2020.20
|
| isZeroSuppressionEnabled | |||
|
isZeroSuppressionEnabled(axis: TableAxis): boolean
Returns whether zero suppression is enabled for the axis. Note: Zero suppression is only supported for SAP BW models.
Parameters
Returns
boolean
Since
2020.7
|
| openDataAnalyzer | |||
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the table.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2024.25
|
| openInNewStory |
|
openInNewStory(): void
Creates a new story with this widget.
Mobile Support
Not supported on mobile devices.
Since
2021.3
|
| openNavigationPanel | |||
|
openNavigationPanel(navigationPanelOptions?: NavigationPanelOptions JSON): void
Opens the navigation panel. Note: This operation is ignored if the table is contained in a mobile application or a popup.
Parameters
Since
2020.13
|
| openSelectModelDialog |
|
openSelectModelDialog(): void
Opens the select model dialog. Selecting a model replaces the model of the table.
Since
2020.20
|
| rankBy | |||
|
rankBy(rankOptions: TableRankOptions JSON): void
Creates a Top N filter to show a specified number of the lowest or highest ranked values.
Parameters
Since
2021.19
|
| removeDimension | |||
|
removeDimension(dimension: string | DimensionInfo JSON): void
Removes the dimension from whichever axis it is present on. If the dimension is neither on the Rows nor Columns axis, then this operation is ignored.
Parameters
Last Update
2019.7
|
| removeRanking |
|
removeRanking(): void
Clears ranking and shows all the members with sort order retained, if applicable.
Since
2021.19
|
| removeSorting |
|
removeSorting(): void
Clears sorting and shows the members in default order.
Since
2021.19
|
| setActiveDimensionProperties | ||||||
|
setActiveDimensionProperties(dimension: string | DimensionInfo JSON, properties: string[] | DimensionPropertyInfo[]): void
Sets the active properties of the dimension.
Parameters
Since
2020.7
|
| setBreakGroupingEnabled | ||||||
|
setBreakGroupingEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables Break Grouping when sorting.
Parameters
Since
2021.19
|
| setCompactDisplayEnabled | ||||||
|
setCompactDisplayEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables the compact display for the axis. Note: Compact display is only supported for SAP BW models.
Parameters
Since
2020.7
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the table.
Parameters
Since
2020.20
|
| setModel | |||
|
setModel(modelId: string): boolean
Sets the model and replaces the old one.
Parameters
Returns
boolean
Since
2020.20
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: TableQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2021.11
|
| setZeroSuppressionEnabled | ||||||
|
setZeroSuppressionEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables zero suppression for the axis. Note: Zero suppression is only supported for SAP BW models.
Parameters
Since
2020.7
|
| sortByMember | ||||||
|
sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void
Sorts dimension members in a table. You can specify the dimension that you want to sort and the sort order. Note: Creating a custom order for members in a table isn't supported.
Parameters
Since
2021.19
|
| sortByValue | |||||||||
|
sortByValue(relatedDimensions: Selection JSON, sortOrder: SortOrder, direction: Direction): void
Sorts measure values in a table. You can specify the related dimensions, the sort order, and the sort direction in the table.
Parameters
Since
2021.19
|
| onAfterDataEntryProcess | ||||||
|
onAfterDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext JSON): void
Called when the table data is changed via manual data entry, copy and paste, or submitData() API.
Parameters
Since
2024.25
|
| onResultChanged |
| onResultChanged(): void Called when the result set displayed by the table changes. |
| onSelect |
| onSelect(): void Called when the user makes a selection within the table. |
| Name and Description |
|
addComment(selection: Selection JSON, value: string): CommentInfo
Adds a comment to data cells. |
|
addComments(selection: Selection JSON, value: string[]): CommentInfo[]
Adds multiple comments to data cells. |
|
getAllComments(selection: Selection JSON): CommentInfo[]
Returns all comments of data cells. |
|
getComment(commentId: string): CommentInfo
Returns a comment. |
|
getDimensionComment(selection: Selection JSON): CommentInfo
Returns the dimension comment of a data cell. |
|
removeAllComments(selection: Selection JSON): boolean
Removes all comments on data cells. |
|
removeComment(commentId: string): boolean
Removes a comment. |
|
removeDimensionComment(selection: Selection JSON): void
Removes the dimension comment of a data cell. |
|
setCommentLiked(commentId: string, isLiked: boolean): boolean
Switches the Like flag of a comment on or off. |
|
setDimensionComment(selection: Selection JSON, value: string): void
Sets the dimension comment of a data cell. |
|
updateComment(commentId: string, value: string): CommentInfo
Updates a comment. |
| addComment | ||||||
|
addComment(selection: Selection JSON, value: string): CommentInfo
Adds a comment to data cells. The data cells are specified by the selection. If this operation was successful, then the comment is returned, and undefined if it wasn't.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
|
| addComments | ||||||
|
addComments(selection: Selection JSON, value: string[]): CommentInfo[]
Adds multiple comments to data cells. The data cells are specified by the selection. If this operation was successful, then the comments are returned, and undefined if it wasn't. Note: Not supported for SAP BW live data models.
Parameters
Returns
CommentInfo[]
Mobile Support
Not supported on mobile devices.
|
| getAllComments | |||
|
getAllComments(selection: Selection JSON): CommentInfo[]
Returns all comments of data cells. The data cells are specified by the selection. If no comments exist, then an empty array is returned. Note: For SAP BW live data models, returns the only comment of the latest version.
Parameters
Returns
CommentInfo[]
Mobile Support
Not supported on mobile devices.
|
| getComment | |||
|
getComment(commentId: string): CommentInfo
Returns a comment. The comment is specified by the comment ID. If the comment ID is invalid, then undefined is returned.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
|
| getDimensionComment | |||
|
getDimensionComment(selection: Selection JSON): CommentInfo
Returns the dimension comment of a data cell. The data cell is specified by the selection. If no dimension comment exists, then undefined is returned.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
|
| removeAllComments | |||
|
removeAllComments(selection: Selection JSON): boolean
Removes all comments on data cells. The data cells are specified by the selection. If this operation was successful, then true is returned, and false if it wasn't. Note: For SAP BW live data models, removes the only comment along with all history versions.
Parameters
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| removeComment | |||
|
removeComment(commentId: string): boolean
Removes a comment. The comment is specified by the comment ID. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| removeDimensionComment | |||
|
removeDimensionComment(selection: Selection JSON): void
Removes the dimension comment of a data cell. The data cell is specified by the selection.
Parameters
Mobile Support
Not supported on mobile devices.
|
| setCommentLiked | ||||||
|
setCommentLiked(commentId: string, isLiked: boolean): boolean
Switches the Like flag of a comment on or off. The comment is specified by the comment ID. If the comment ID is valid, then true is returned, and false if it isn't. Note: Not supported for SAP BW live data models.
Parameters
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| setDimensionComment | ||||||
|
setDimensionComment(selection: Selection JSON, value: string): void
Sets the dimension comment of a data cell. The data cell is specified by the selection.
Parameters
Mobile Support
Not supported on mobile devices.
|
| updateComment | ||||||
|
updateComment(commentId: string, value: string): CommentInfo
Updates a comment. The comment is specified by the comment ID. Returns the latest comment if this operation is successful, and undefined if it fails. Note: Only supported for SAP BW live data models.
Parameters
Returns
CommentInfo
Mobile Support
Not supported on mobile devices.
Since
2023.6
|
| Name and Description |
|
setDecimalPlaces(decimalPlaces: integer, measures?: string[]): void
Specifies the number of decimal places for specific or all measures. |
|
setDisplayUnit(displayUnit: NumberFormatDisplayUnit): void
Specifies where the units or currencies of the measures are displayed. |
|
setScaleFormat(scaleFormat: NumberFormatScaleFormat): void
Specifies the scale format of the table. |
|
setScaleUnit(scaleUnit: NumberFormatScaleUnit, measures?: string[]): void
Specifies the scale unit for specific or all measures. |
|
setSignDisplay(signDisplay: NumberFormatSignDisplay, measures?: string[]): void
Specifies how signs are displayed for specific or all measures. |
| setDecimalPlaces | ||||||
|
setDecimalPlaces(decimalPlaces: integer, measures?: string[]): void
Specifies the number of decimal places for specific or all measures.
Parameters
|
| setDisplayUnit | |||
|
setDisplayUnit(displayUnit: NumberFormatDisplayUnit): void
Specifies where the units or currencies of the measures are displayed.
Parameters
|
| setScaleFormat | |||
|
setScaleFormat(scaleFormat: NumberFormatScaleFormat): void
Specifies the scale format of the table.
Parameters
|
| setScaleUnit | ||||||
|
setScaleUnit(scaleUnit: NumberFormatScaleUnit, measures?: string[]): void
Specifies the scale unit for specific or all measures.
Parameters
|
| setSignDisplay | ||||||
|
setSignDisplay(signDisplay: NumberFormatSignDisplay, measures?: string[]): void
Specifies how signs are displayed for specific or all measures.
Parameters
|
| Name and Description |
|
static addClientCalculation: boolean
Add Calculation |
|
static addClientRowColumn: boolean
Add/Remove Row/Column |
|
static addComment: boolean
Comment |
|
static addMember: boolean
Add Member |
|
static conditions: boolean
Conditions |
|
static dataLocks: boolean
Data Locks |
|
static displayOptions: boolean
Display Options |
|
static distributeValue: boolean
Distribute Value |
|
static drill: boolean
Drill |
|
static exporting: boolean
Export |
|
static filter: boolean
Filter/Exclude |
|
static freeze: boolean
Freeze |
|
static fullscreen: boolean
Fullscreen |
|
static gotoHyperLink: boolean
Go To HyperLink |
|
static lockCell: boolean
Lock Cell |
|
static massDataEntry: boolean
Mass Data Entry |
|
static publish: boolean
Publish |
|
static rank: boolean
Ranking |
|
static removeCellReference: boolean
Remove Reference |
|
static revert: boolean
Revert |
|
static selectConversions: boolean
Select Conversions |
|
static selectHierarchy: boolean
Select Hierarchy |
|
static showHide: boolean
Show/Hide |
|
static sort: boolean
Sorting |
|
static swapAxis: boolean
Swap Axis |
|
static tableDetail: boolean
Applied to Table |
|
static undoRedoDataChange: boolean
Undo/Redo Data Entry |
|
static valueLockManagement: boolean
Value Lock |
|
static version: boolean
Version |
|
static versionHistory: boolean
History |
| addClientCalculation |
| static addClientCalculation: boolean Add Calculation |
| addClientRowColumn |
| static addClientRowColumn: boolean Add/Remove Row/Column |
| addComment |
| static addComment: boolean Comment |
| addMember |
| static addMember: boolean Add Member |
| conditions |
|
static conditions: boolean
Conditions
Since
2021.18
|
| dataLocks |
| static dataLocks: boolean Data Locks |
| displayOptions |
| static displayOptions: boolean Display Options |
| distributeValue |
| static distributeValue: boolean Distribute Value |
| drill |
| static drill: boolean Drill |
| exporting |
| static exporting: boolean Export |
| filter |
| static filter: boolean Filter/Exclude |
| freeze |
| static freeze: boolean Freeze |
| fullscreen |
| static fullscreen: boolean Fullscreen |
| gotoHyperLink |
|
static gotoHyperLink: boolean
Go To HyperLink
Since
2023.3
|
| lockCell |
| static lockCell: boolean Lock Cell |
| massDataEntry |
| static massDataEntry: boolean Mass Data Entry |
| publish |
| static publish: boolean Publish |
| rank |
| static rank: boolean Ranking |
| removeCellReference |
|
static removeCellReference: boolean
Remove Reference
Since
2023.3
|
| revert |
| static revert: boolean Revert |
| selectConversions |
| static selectConversions: boolean Select Conversions |
| selectHierarchy |
| static selectHierarchy: boolean Select Hierarchy |
| showHide |
| static showHide: boolean Show/Hide |
| sort |
| static sort: boolean Sorting |
| swapAxis |
| static swapAxis: boolean Swap Axis |
| tableDetail |
|
static tableDetail: boolean
Applied to Table
Since
2023.3
|
| undoRedoDataChange |
| static undoRedoDataChange: boolean Undo/Redo Data Entry |
| valueLockManagement |
| static valueLockManagement: boolean Value Lock |
| version |
| static version: boolean Version |
| versionHistory |
| static versionHistory: boolean History |
| Name and Description |
|
applyToEachDimension: boolean
Shows the top values for each dimension instead of for the group of dimensions. |
|
direction: Direction
Direction of sorting in the table. |
|
rankOrder: RankOrder
Order used for ranking. |
|
relatedDimensions: Selection JSON
Related dimension used for ranking |
|
value: integer
Number of values to include in the ranking filter |
| applyToEachDimension |
| applyToEachDimension: boolean Shows the top values for each dimension instead of for the group of dimensions. If you have a hierarchical measure in your table, then this option is enabled and can't be disabled. |
| direction |
| direction: Direction Direction of sorting in the table. The values Direction.Vertical or Direction.Horizontal correspond to a vertical or horizontal sort direction in the table, respectively. |
| rankOrder |
| rankOrder: RankOrder Order used for ranking. The values RankOrder.Top or RankOrder.Bottom, for example, correspond to a descending or an ascending order of ranking, respectively. |
| relatedDimensions |
| relatedDimensions: Selection JSON Related dimension used for ranking |
| value |
| value: integer Number of values to include in the ranking filter |
| 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 |
| Name and Description |
|
onSelect(): void Called when the user selects a tab. |
| 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
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
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
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
Since
2020.1
|
| Name and Description |
| description: string |
| name: string |
| Name and Description |
|
applyText(text: string): void
Replaces the text of the first formatted section of the Text widget. |
|
getPlainText(): string
Returns the text of the Text widget, with no formatting or markup information. |
|
setStyle(textStyle: TextStyle JSON): void
Applies the style to the text. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the text. |
| applyText | |||
|
applyText(text: string): void
Replaces the text of the first formatted section of the Text widget. If multiple text styles are present within the contents, then only the text with the first configured style is replaced. If only one text style is present, then the entire text is replaced.
Parameters
|
| getPlainText |
|
getPlainText(): string
Returns the text of the Text widget, with no formatting or markup information.
Returns
string |
| setStyle | |||
|
setStyle(textStyle: TextStyle JSON): void
Applies the style to the text. You can also pass a JSON object for this argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
Since
2020.9
|
| Name and Description |
|
getValue(): string
Returns the value of the text area. |
|
isEditable(): boolean
Returns whether the text area is editable. |
|
isEnabled(): boolean
Returns whether the text area is enabled. |
|
setEditable(editable: boolean): void
Enables or disables editing of the text area. |
|
setEnabled(enabled: boolean): void
Enables or disables the text area. |
|
setStyle(style: TextAreaStyle JSON): void
Applies the style to the text area. |
|
setValue(value: string): void
Sets the value of the text area. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the text area doesn't have the focus anymore, for example, after the user has entered text and pressed the "Enter" key. |
| getValue |
|
getValue(): string
Returns the value of the text area.
Returns
string |
| isEditable |
|
isEditable(): boolean
Returns whether the text area is editable.
Returns
boolean |
| isEnabled |
|
isEnabled(): boolean
Returns whether the text area is enabled.
Returns
boolean |
| setEditable | |||
|
setEditable(editable: boolean): void
Enables or disables editing of the text area.
Parameters
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the text area.
Parameters
|
| setStyle | |||
|
setStyle(style: TextAreaStyle JSON): void
Applies the style to the text area. You can also pass a JSON object for this argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
Since
2020.9
|
| setValue | |||
|
setValue(value: string): void
Sets the value of the text area.
Parameters
|
| Name and Description |
|
backgroundColor: string
Background color of the text area |
|
borderColor: string
Border color of the text area |
|
color: string
Font color of the text area |
| Name and Description |
|
getText(textId: string): string
fetch the string corresponding to the textId. |
| Name and Description |
|
backgroundColor: string
Background color of the text |
|
color: string
Font color of the text |
| Name and Description |
|
isRunning(): boolean
Returns whether the timer is running. |
|
start(delayInSeconds: number): void
Starts the timer. |
|
stop(): void
Stops the timer. |
| Name and Description |
|
onTimeout(): void Called when the set timespan of the timer has elapsed. |
| Name and Description |
|
static create(granularity: TimeRangeGranularity, start: Date, end: Date): TimeRange
Creates a time range with the specified granularity, start date, and end date. |
|
static createMonthRange(startYear: integer, startMonth: integer, endYear: integer, endMonth: integer): TimeRange
Creates a time range with the specified start and end years and months. |
|
static createWeekRange(startYear: integer, startWeek: integer, endYear: integer, endWeek: integer): TimeRange
Creates a time range with the specified start and end years and weeks. |
|
static createYearRange(start: integer, end: integer): TimeRange
Creates a time range with the specified start year and end year. |
| create | |||||||||
|
static create(granularity: TimeRangeGranularity, start: Date, end: Date): TimeRange
Creates a time range with the specified granularity, start date, and end date.
Parameters
Returns
TimeRange |
| createMonthRange | ||||||||||||
|
static createMonthRange(startYear: integer, startMonth: integer, endYear: integer, endMonth: integer): TimeRange
Creates a time range with the specified start and end years and months.
Parameters
Returns
TimeRange |
| createWeekRange | ||||||||||||
|
static createWeekRange(startYear: integer, startWeek: integer, endYear: integer, endWeek: integer): TimeRange
Creates a time range with the specified start and end years and weeks.
Parameters
Returns
TimeRange |
| createYearRange | ||||||
|
static createYearRange(start: integer, end: integer): TimeRange
Creates a time range with the specified start year and end year.
Parameters
Returns
TimeRange |
| Name and Description |
|
static Day: TimeRangeGranularity
A range of days |
|
static HalfYear: TimeRangeGranularity
A range of half-years |
|
static Hour: TimeRangeGranularity
A range of hours |
|
static Millisecond: TimeRangeGranularity
A range of milliseconds |
|
static Minute: TimeRangeGranularity
A range of minutes |
|
static Month: TimeRangeGranularity
A range of months |
|
static Quarter: TimeRangeGranularity
A range of quarters |
|
static Second: TimeRangeGranularity
A range of seconds |
|
static Year: TimeRangeGranularity
A range of years |
| Day |
| static Day: TimeRangeGranularity A range of days |
| HalfYear |
| static HalfYear: TimeRangeGranularity A range of half-years |
| Hour |
| static Hour: TimeRangeGranularity A range of hours |
| Millisecond |
| static Millisecond: TimeRangeGranularity A range of milliseconds |
| Minute |
| static Minute: TimeRangeGranularity A range of minutes |
| Month |
| static Month: TimeRangeGranularity A range of months |
| Quarter |
| static Quarter: TimeRangeGranularity A range of quarters |
| Second |
| static Second: TimeRangeGranularity A range of seconds |
| Year |
| static Year: TimeRangeGranularity A range of years |
| Name and Description |
|
static create(parameterName: string, parameterValueNotEncoded: string): UrlParameter
Creates a URL parameter. |
| create | ||||||
|
static create(parameterName: string, parameterValueNotEncoded: string): UrlParameter
Creates a URL parameter.
Parameters
Returns
UrlParameter |
| Name and Description |
| displayName: string |
| id: string |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
| description: string |
| id: string |
| isInputEnabled: boolean |
| modelId: string |
| Name and Description |
|
type: VariableValueType
Type of the variable value |
| 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} |
| Multiple |
| static Multiple: VariableValueType An object representing multiple variable values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
| Range |
| 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". |
| Single |
| static Single: VariableValueType An object representing a single variable value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Name and Description |
|
postMessage(message: string, targetOrigin?: string): void
Posts a message to a web page. |
|
setAddress(address: string): void
Sets the address that the web page will navigate to. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| postMessage | ||||||
|
postMessage(message: string, targetOrigin?: string): void
Posts a message to a web page.
Parameters
Since
2018.22
|
| setAddress | |||
|
setAddress(address: string): void
Sets the address that the web page will navigate to.
Parameters
|
| Name and Description |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the component. |
|
getLayout(): Layout
Returns the layout of the widget. |
|
isVisible(): boolean
Returns whether the widget is visible. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the component. |
|
setVisible(visible: boolean): void
Shows or hides the widget. |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the component.
Returns
string
Since
2020.20
|
| getLayout |
|
getLayout(): Layout
Returns the layout of the widget.
Returns
Layout
Since
2019.14
|
| isVisible |
|
isVisible(): boolean
Returns whether the widget is visible.
Returns
boolean |
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the component.
Parameters
Since
2020.20
|
| setVisible | |||
|
setVisible(visible: boolean): void
Shows or hides the widget.
Parameters
|
| Name and Description |
|
static searchPattern: string
Part of the name of the widgets to return. |
|
static type: WidgetType
Type of the widgets to return |
| searchPattern |
| static searchPattern: string 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 |
| static type: WidgetType Type of the widgets to return |