|
Type Libraries
|
C
C
C
C
C
C
C
O
O
O
O
O
O
E
E
C
E
C
C
C
C
|
Type Libraries
|
| Name and Description |
|
moveWidget(widget: Widget): void
Moves the widget into the first page canvas. |
|
sendNotification(notification: NotificationOptions JSON): boolean
Sends a notification. |
| 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. |
| moveWidget | |||
|
moveWidget(widget: Widget): void
Moves the widget into the first page canvas.
Parameters
|
| 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 |
| 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
|
| 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. |
| onShake |
| onShake(): void Called when the user shakes the mobile device. Note: This method is called every two seconds during shaking. |
| Name and Description |
|
moveWidget(widget: Widget): void
Moves the widget into the page. |
| Name and Description |
|
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void Called when the user changes the orientation of the mobile device. |
|
onShake(): void Called when the user shakes the mobile device. |
| moveWidget | |||
|
moveWidget(widget: Widget): void
Moves the widget into the page.
Parameters
|
| onOrientationChange | ||||||
|
onOrientationChange(angle: DeviceOrientation, previousAngle: DeviceOrientation): void
Called when the user changes the orientation of the mobile device.
Parameters
|
| onShake |
| onShake(): void Called when the user shakes the mobile device. Note: This method is called every two seconds during shaking. |
| 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 |
| 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 |
| 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> |
| 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 |
|
setDimensionFilter(dimension: string | DimensionInfo, members: string | string[] | MemberInfo | MemberInfo[] | RangeFilterValue | RangeFilterValue[]): void
Sets a filter on the dimension. |
| setDimensionFilter | ||||||
|
setDimensionFilter(dimension: string | DimensionInfo, members: string | string[] | MemberInfo | MemberInfo[] | RangeFilterValue | RangeFilterValue[]): void
Sets a filter on the dimension. The filter will be used in batch export. Only dimension member and range filter is supported.
Parameters
|
| 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. |
| 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.
|
| getBpcPlanningSequenceDataSource |
|
getBpcPlanningSequenceDataSource(): BpcPlanningSequenceDataSource
Returns the data source of the BPC Planning Sequence.
Returns
BpcPlanningSequenceDataSource
Mobile Support
Not supported on mobile devices.
|
| 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.
|
| 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
|
| 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 | VariableValue[], options?: SetVariableValueOptions): 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
|
| 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[] |
| getVariables |
|
getVariables(): BpcPlanningSequenceVariableInfo[]
Returns all variables of the data source.
Returns
BpcPlanningSequenceVariableInfo[] |
| 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
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | BpcPlanningSequenceVariableInfo, variableValue: string | number | VariableValue | VariableValue[], options?: SetVariableValueOptions): 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
|
| 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 |
|
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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| dependencies |
| dependencies: CalendarDependencies JSON Dependencies of the calendar task |
| 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
2025.14
|
| 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 |
| 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
Hierarchy of the context filter |
|
members: MemberInfo[]
Members of the context filter |
| hierarchy |
| hierarchy: HierarchyInfo Hierarchy of the context filter |
| members |
| members: MemberInfo[] 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 |
| 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
2025.14
|
| 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 |
| 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 |
| 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
Deprecated
2025.14
|
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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
Deprecated
2025.14
|
| 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 |
| 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
Deprecated
2025.14
|
| 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[] |
| 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[]
Deprecated
2025.14
|
| 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 |
| 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 |
| 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". |
| Inactive |
| static Inactive: CalendarTaskStatus The calendar task is in status "Inactive". |
| InProgress |
| static InProgress: CalendarTaskStatus The calendar task is in status "In Progress". |
| NoAssignee |
| static NoAssignee: CalendarTaskStatus The calendar task is in status "No Assignee". |
| 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". |
| Successful |
| static Successful: CalendarTaskStatus The calendar task is in status "Successful". |
| 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 |
| 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 |
|
getDataChangeInsights(): ChartDataChangeInsights
Returns the Data Change Insights of the chart. |
|
getForecast(): Forecast
Returns the forecast of the chart. |
|
getSmartGrouping(): SmartGrouping
Returns the Smart Grouping of the chart. |
|
openInNewStory(): void
Creates a new story with this widget. |
|
openSelectModelDialog(): void
Opens the select model dialog. |
|
setModel(modelId: string, setModelOptions?: SetModelOptions JSON): boolean
Sets the model and replaces the old one. |
| getDataChangeInsights |
|
getDataChangeInsights(): ChartDataChangeInsights
Returns the Data Change Insights of the chart.
Returns
ChartDataChangeInsights |
| getForecast |
|
getForecast(): Forecast
Returns the forecast of the chart.
Returns
Forecast
Mobile Support
Not supported on mobile devices.
|
| getSmartGrouping |
|
getSmartGrouping(): SmartGrouping
Returns the Smart Grouping of the chart.
Returns
SmartGrouping
Mobile Support
Not supported on mobile devices.
|
| openInNewStory |
|
openInNewStory(): void
Creates a new story with this widget.
Mobile Support
Not supported on mobile devices.
|
| openSelectModelDialog |
| openSelectModelDialog(): void Opens the select model dialog. Selecting a model replaces the model of the chart. |
| setModel | ||||||
|
setModel(modelId: string, setModelOptions?: SetModelOptions JSON): boolean
Sets the model and replaces the old one.
Parameters
Returns
boolean |
| 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): 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): void
Sets the subscription range settings.
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. |
| getCommentingDataSource |
|
getCommentingDataSource(): CommentingDataSource
Returns the data source of the commenting widget.
Returns
CommentingDataSource |
| Name and Description |
|
getDimensionFilters(dimension: string | DimensionInfo): FilterValue[]
Returns the dimension filters. |
|
removeDimensionFilter(dimension: string | DimensionInfo): void
Removes any filter that is set on the dimension. |
|
setDimensionFilter(dimension: string | DimensionInfo, member: string | string[] | MemberInfo | MemberInfo[] | MeasureInfo | MeasureInfo[] | TimeRange | TimeRange[]): void
Sets a filter on the dimension. |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo): 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): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| setDimensionFilter | ||||||
|
setDimensionFilter(dimension: string | DimensionInfo, member: string | string[] | MemberInfo | MemberInfo[] | MeasureInfo | MeasureInfo[] | 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 |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Name and Description |
|
static log(arg: any): void
Outputs a message to the Web Console. |
| Name and Description |
|
bindInputControl(id: string, inputControl: InputControl): void
Binds the given input control to the parameter. |
|
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. |
|
getBoundInputControl(id: string): InputControl
Returns the input control bound to the given parameter. |
|
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. |
| bindInputControl | ||||||
|
bindInputControl(id: string, inputControl: InputControl): void
Binds the given input control to the parameter. The input control selection is automatically used a the parameter value.
Parameters
Since
2025.20
|
| 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 |
| getBoundInputControl | |||
|
getBoundInputControl(id: string): InputControl
Returns the input control bound to the given parameter.
Parameters
Returns
InputControl
Since
2025.20
|
| getExecutionProgress | |||
|
getExecutionProgress(executionId: string): DataActionExecutionResponseStatus
Returns status of given Data Action execution.
Parameters
Returns
DataActionExecutionResponseStatus |
| 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 |
| setAllMembersSelected | ||||||
|
setAllMembersSelected(id: string, hierarchy?: string): void
Sets the all member as parameter value.
Parameters
|
| 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
|
| 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. |
| Error |
| static Error: DataActionBackgroundExecutionResponseStatus Execution ended with errors. |
| 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. |
| Canceled |
| static Canceled: DataActionExecutionResponseStatus Execution has been canceled. |
| Error |
| static Error: DataActionExecutionResponseStatus Execution ended with errors. |
| Queued |
| static Queued: DataActionExecutionResponseStatus Execution is queued. Not available for executions started with 'Run in synchronous mode'. |
| Running |
| static Running: DataActionExecutionResponseStatus Execution is running. |
| 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 |
| Member |
| static Member: DataActionParameterValueType Member value type |
| Number |
| static Number: DataActionParameterValueType Number value type |
| PlanningModelMember |
| static PlanningModelMember: DataActionParameterValueType Planning Model Member value type |
| 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 |
| Name and Description |
|
onBeforeExecute(): boolean Called when the user clicks the data action starter. |
| Name and Description |
|
openSelectModelDialog(): void
Opens the select model dialog. |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
| openSelectModelDialog |
|
openSelectModelDialog(): void
Opens the select model dialog. Selecting a model replaces the model and clears the query of the databinding.
Since
2026.4
|
| setModel | |||
|
setModel(modelId: string): boolean
Sets the model and replaces the old one.
Parameters
Returns
boolean
Since
2026.4
|
| 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 |
| 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 |
| 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.
|
| 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 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 |
| rawValue |
| rawValue: string Raw (unformatted) value (measures only) |
| Name and Description |
|
getState(selection: Selection): DataLockingState
Returns the data locking state of a data cell. |
|
getStates(selections: Selection[]): DataLockingState[]
Returns the lock state of multiple selected data cells. |
|
setState(selection: Selection, value: DataLockingState): boolean
Sets the data locking state of a data cell. |
|
setStates(selections: Selection[], value: DataLockingState): boolean
Sets the locks state for the given data cell selections. |
| getState | |||
|
getState(selection: Selection): DataLockingState
Returns the data locking state of a data cell. The data cell is specified by the selection.
Parameters
Returns
DataLockingState |
| getStates | |||
|
getStates(selections: Selection[]): DataLockingState[]
Returns the lock state of multiple selected data cells. The data cells are specified by given selections.
Parameters
Returns
DataLockingState[]
Since
2026.7
|
| setState | ||||||
|
setState(selection: Selection, 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 |
| setStates | ||||||
|
setStates(selections: Selection[], value: DataLockingState): boolean
Sets the locks state for the given data cell selections. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean
Since
2026.7
|
| 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, selection: Selection): void
Collapses a hierarchy node. |
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo | DimensionInfo[]): 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, selection: Selection): 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): DataCell
Returns the data cell of the selection. |
|
getDataSelections(selections?: Selection | Selection[] | SelectionContext, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. |
|
getDimensionFilters(dimension: string | DimensionInfo): FilterValue[]
Returns the dimension filters. |
|
getDimensionProperties(dimension: string | DimensionInfo): DimensionPropertyInfo[]
Returns the properties of the dimension. |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source. |
|
getHierarchies(dimension: string | DimensionInfo): HierarchyInfo[]
Returns all hierarchies of the dimension. |
|
getHierarchy(dimension: string | DimensionInfo): HierarchyInfo
Returns the hierarchy set on the dimension. |
|
getHierarchyLevel(dimension: string | DimensionInfo): 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, memberId: string, hierarchy?: string | HierarchyInfo): MemberInfo
Returns the member info object from a member ID. |
|
getMemberDisplayMode(dimension: string | DimensionInfo): MemberDisplayMode
Returns the display mode for members of the dimension. |
|
getMembers(dimension: string | DimensionInfo, options?: integer | MembersOptions): MemberInfo[]
Returns the members of the dimension. |
|
getRefreshPaused(): PauseMode
Returns the pause mode of the data refresh. |
|
getResultMember(dimension: string | DimensionInfo, selection: Selection): ResultMemberInfo
Returns the result member. |
|
getResultSet(selections?: Selection | Selection[] | SelectionContext, 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): 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, member: string | string[] | MemberInfo | MemberInfo[] | MeasureInfo | MeasureInfo[] | TimeRange | TimeRange[] | FilterValue | SingleFilterValue JSON | MultipleFilterValue JSON | RangeFilterValue | RangeFilterValue[]): void
Sets a filter on the dimension. |
|
setHierarchy(dimension: string | DimensionInfo, hierarchy: string | HierarchyInfo, hierarchyMode?: HierarchyMode): void
Sets the hierarchy on the dimension. |
|
setHierarchyLevel(dimension: string | DimensionInfo, level?: integer): void
Sets the hierarchy level of the dimension. |
|
setMemberDisplayMode(dimension: string | DimensionInfo, 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 | SingleVariableValue JSON | MultipleVariableValue JSON | RangeVariableValue JSON | VariableValue[], options?: SetVariableValueOptions): void
Sets the value of the variable. |
| collapseNode | ||||||
|
collapseNode(dimension: string | DimensionInfo, selection: Selection): 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
|
| copyDimensionFilterFrom | ||||||
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo | DimensionInfo[]): 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
|
| 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
|
| expandNode | ||||||
|
expandNode(dimension: string | DimensionInfo, selection: Selection): 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
|
| getBackendCondition | |||
|
getBackendCondition(backendConditionId: string): BackendCondition
Gets a BEx condition by its ID. Note: Only supported for data sources associated with charts.
Parameters
Returns
BackendCondition |
| getBackendConditions |
|
getBackendConditions(): BackendCondition[]
Gets all BEx conditions. Note: Only supported for data sources associated with charts.
Returns
BackendCondition[] |
| 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
Deprecated
2025.14
|
| getData | |||
|
getData(selection: Selection): 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 |
| getDataSelections | |||||||||
|
getDataSelections(selections?: Selection | Selection[] | SelectionContext, 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[] |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| getDimensionProperties | |||
|
getDimensionProperties(dimension: string | DimensionInfo): DimensionPropertyInfo[]
Returns the properties of the dimension. Note: Currently, this operation is only supported for data sources associated with tables.
Parameters
Returns
DimensionPropertyInfo[] |
| getDimensions |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source.
Returns
DimensionInfo[] |
| getHierarchies | |||
|
getHierarchies(dimension: string | DimensionInfo): HierarchyInfo[]
Returns all hierarchies of the dimension.
Parameters
Returns
HierarchyInfo[] |
| getHierarchy | |||
|
getHierarchy(dimension: string | DimensionInfo): HierarchyInfo
Returns the hierarchy set on the dimension.
Parameters
Returns
HierarchyInfo |
| getHierarchyLevel | |||
|
getHierarchyLevel(dimension: string | DimensionInfo): 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 |
| getInfo |
|
getInfo(): DataSourceInfo
Returns information about the data source.
Returns
DataSourceInfo |
| getMeasures |
|
getMeasures(): MeasureInfo[]
Returns all measures of the data source.
Returns
MeasureInfo[] |
| getMember | |||||||||
|
getMember(dimension: string | DimensionInfo, memberId: string, hierarchy?: string | HierarchyInfo): 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 |
| getMemberDisplayMode | |||
|
getMemberDisplayMode(dimension: string | DimensionInfo): MemberDisplayMode
Returns the display mode for members of the dimension.
Parameters
Returns
MemberDisplayMode |
| getMembers | ||||||
|
getMembers(dimension: string | DimensionInfo, options?: integer | MembersOptions): 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[] |
| 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 |
| getResultMember | ||||||
|
getResultMember(dimension: string | DimensionInfo, selection: Selection): ResultMemberInfo
Returns the result member. It is specified by a dimension and a selection.
Parameters
Returns
ResultMemberInfo |
| getResultSet | |||||||||
|
getResultSet(selections?: Selection | Selection[] | SelectionContext, 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[] |
| 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[] |
| getVariables |
|
getVariables(): VariableInfo[]
Returns all variables of the data source.
Returns
VariableInfo[] |
| 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
Deprecated
2025.14
|
| 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. |
| removeDimensionFilter | |||
|
removeDimensionFilter(dimension: string | DimensionInfo): 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. 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
|
| setDimensionFilter | ||||||
|
setDimensionFilter(dimension: string | DimensionInfo, member: string | string[] | MemberInfo | MemberInfo[] | MeasureInfo | MeasureInfo[] | TimeRange | TimeRange[] | FilterValue | SingleFilterValue JSON | MultipleFilterValue JSON | RangeFilterValue | RangeFilterValue[]): 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. Note that for charts, the exclude option doesn't support Alias.MeasureDimension from SAP BW models. 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
2026.3
|
| setHierarchy | |||||||||
|
setHierarchy(dimension: string | DimensionInfo, hierarchy: string | HierarchyInfo, hierarchyMode?: HierarchyMode): void
Sets the hierarchy on the dimension. Optionally, only for widget Table, you can specify the hierarchy mode (e.g., Full or LeavesOnly). 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
2026.5
|
| setHierarchyLevel | ||||||
|
setHierarchyLevel(dimension: string | DimensionInfo, 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
|
| setMemberDisplayMode | ||||||
|
setMemberDisplayMode(dimension: string | DimensionInfo, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension.
Parameters
|
| 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
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue | SingleVariableValue JSON | MultipleVariableValue JSON | RangeVariableValue JSON | VariableValue[], options?: SetVariableValueOptions): 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
Last Update
2026.3
|
| Name and Description |
|
addComment(selection: Selection, value: string): CommentInfo
Adds a comment to data cells. |
|
addComments(selection: Selection, value: string[]): CommentInfo[]
Adds multiple comments to data cells. |
|
getAllComments(selection: Selection): CommentInfo[]
Returns all comments of data cells. |
|
getComment(commentId: string): CommentInfo
Returns a comment. |
|
isDataPointCommentPaused(): boolean
"return boolean indicate pause mode of the table data point comments. |
|
removeAllComments(selection: Selection): 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. |
|
setDataPointCommentPaused(paused: boolean): void
"Sets the pause mode of the table data point comments. |
|
updateComment(commentId: string, value: string): CommentInfo
Updates a comment. |
| addComment | ||||||
|
addComment(selection: Selection, 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, 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): 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.
|
| isDataPointCommentPaused |
|
isDataPointCommentPaused(): boolean
"return boolean indicate pause mode of the table data point comments. By default table data point comments works in non-pause mode. Note: Only supported for native SAC models.
Returns
boolean
Mobile Support
Not supported on mobile devices.
Since
2026.1
|
| removeAllComments | |||
|
removeAllComments(selection: Selection): 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.
|
| setDataPointCommentPaused | |||
|
setDataPointCommentPaused(paused: boolean): void
"Sets the pause mode of the table data point comments. When set to true, changes to table data point comment e.g. addComment() will be cached, when set to false, all cached changes will be flushed. Note: Only supported for native SAC models.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2026.1
|
| 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.
|
| 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 |
|
continue: boolean
Specifies whether the starter should continue with the execution. |
|
modifiedFileContent: string[][]
Specifies the modified content to be used for the import. |
| Name and Description |
|
onAfterExecute(status: DataUploadExecutionResponseStatus, message: string, statistics: DataUploadStatistics, rejectedDetails: string[][], versionName: string, fileName: string): void Called when the Data Upload Starter execution ends. |
|
onBeforeExecute(): boolean Called when the user clicks the Data Upload Starter. |
|
onBeforeImport(fileName: string, fileContent: string[][], versionName: string, firstRowAsHeaders: boolean): DataUploadFileHandler Called when the Data Upload Starter is about to import data. |
| onAfterExecute | ||||||||||||||||||
|
onAfterExecute(status: DataUploadExecutionResponseStatus, message: string, statistics: DataUploadStatistics, rejectedDetails: string[][], versionName: string, fileName: string): void
Called when the Data Upload Starter execution ends.
Parameters
Last Update
2026.7
|
| 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
|
| onBeforeImport | ||||||||||||
|
onBeforeImport(fileName: string, fileContent: string[][], versionName: string, firstRowAsHeaders: boolean): DataUploadFileHandler
Called when the Data Upload Starter is about to import data.
Parameters
Returns
DataUploadFileHandler
Since
2026.1
|
| Name and Description |
|
deletedRowCount: integer
Number of deleted rows. |
|
rejectedRowCount: integer
Number of rejected rows. |
|
skippedDeletionCount: integer
Number of skipped deletions. |
|
uploadedRowCount: integer
Number of uploaded rows. |
| deletedRowCount |
| deletedRowCount: integer Number of deleted rows. |
| rejectedRowCount |
| rejectedRowCount: integer Number of rejected rows. |
| skippedDeletionCount |
| skippedDeletionCount: integer Number of skipped deletions. |
| uploadedRowCount |
|
uploadedRowCount: integer
Number of uploaded rows.
Since
2026.8
|
| 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 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 |
|
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. |
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId. |
|
includeComponent(component: Widget | Popup): void
Includes a widget or a popup 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. |
|
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(). |
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export. |
|
setCommentsVisible(visible: boolean): void
Shows or hides the comments in the exported PDF file. |
|
setExportInBackgroundEnabled(isEnabled: boolean): void
Enables or disables the export of the PDF file in the background. |
|
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
|
| exportReport |
|
exportReport(): void
Exports all included tables in full length (report) to a PDF file.
Mobile Support
Not supported on mobile devices.
|
| getBatchExportDataSource | |||
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId.
Parameters
Returns
BatchExportDataSource |
| includeComponent | |||
|
includeComponent(component: Widget | Popup): void
Includes a widget or a popup in the exported PDF file.
Parameters
|
| isBatchExportEnabled |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled.
Returns
boolean |
| 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 |
| 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 |
| setBatchExportEnabled | |||
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export.
Parameters
|
| setCommentsVisible | |||
|
setCommentsVisible(visible: boolean): void
Shows or hides the comments in the exported PDF file.
Parameters
|
| setExportInBackgroundEnabled | |||
|
setExportInBackgroundEnabled(isEnabled: boolean): void
Enables or disables the export of the PDF file in the background.
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
|
| Name and Description |
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId. |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled. |
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export. |
| getBatchExportDataSource | |||
|
getBatchExportDataSource(modelId: string): BatchExportDataSource
Returns the data source of related modelId.
Parameters
Returns
BatchExportDataSource |
| isBatchExportEnabled |
|
isBatchExportEnabled(): boolean
Returns whether batch export is enabled.
Returns
boolean |
| setBatchExportEnabled | |||
|
setBatchExportEnabled(isEnabled: boolean): void
Enable or disable batch export.
Parameters
|
| Name and Description |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
| Name and Description |
|
isVisible(): boolean
Returns whether FilterPanel is visible. |
|
setVisible(visible: boolean): void
Shows or hides FilterPanel. |
| Name and Description |
|
moveWidget(widget: Widget): void
Moves the widget into the panel. |
| 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 |
|
openInNewStory(): void
Creates a new story with this widget. |
| Name and Description |
|
context: Selection
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 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 |
| static Auto: LayoutValue |
| unit: LayoutUnit |
| 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 |
|
category: string
Category of the version |
|
creationTime: string
Creation time of the version |
|
description: string
Description of the version |
|
id: string
Unique identifier of ModelPrivateVersion |
|
isInPublicEditMode: boolean
Specifies whether the version is public edit version. |
|
owner: string
ID of version owner |
|
ownerDisplayName: string
Name of version owner |
|
sourceVersionId: string
ID of ModelPrivateVersion's source version |
|
versionId: string
ID of the planning version |
| category |
| category: string Category of the version |
| creationTime |
| creationTime: string Creation time of the version |
| description |
| description: string Description of the version |
| id |
| id: string Unique identifier of ModelPrivateVersion |
| isInPublicEditMode |
| isInPublicEditMode: boolean Specifies whether the version is public edit version. |
| owner |
| owner: string ID of version owner |
| ownerDisplayName |
| ownerDisplayName: string Name of version owner |
| sourceVersionId |
| sourceVersionId: string ID of ModelPrivateVersion's source version |
| versionId |
| versionId: string ID of the planning version |
| Name and Description |
|
execute(): MultiActionExecutionResponse
Executes the multi action as a blocking operation, which prevents other scripts from running until the multi action execution is complete. |
|
executeInBackground(executionName: string): MultiActionBackgroundExecutionResponse
Executes the multi action as a non-blocking operation. |
|
getParameterValue(id: string): MultiActionParameterValue
Returns the value of the parameter. |
|
isAllMembersSelected(id: string): boolean
Returns whether the parameter has the all member as value. |
|
setAllMembersSelected(id: string, hierarchy?: string): void
Sets the all member as parameter value. |
|
setParameterValue(id: string, value: string | string[] | MultiActionParameterValue JSON | number): void
Sets the value of the parameter. |
| 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.
|
| isAllMembersSelected | |||
|
isAllMembersSelected(id: string): boolean
Returns whether the parameter has the all member as value.
Parameters
Returns
boolean |
| setAllMembersSelected | ||||||
|
setAllMembersSelected(id: string, hierarchy?: string): void
Sets the all member as parameter value.
Parameters
|
| 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
|
| Name and Description |
|
hierarchy: string
Hierarchy name |
| Inherited from MultiActionParameterValue |
| type |
| 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 |
|
values: string[]
Datetime values |
| Inherited from MultiActionParameterValue |
| type |
| Name and Description |
|
message: string
Execution result message |
|
status: MultiActionExecutionResponseStatus
Execution result status |
| message |
| message: string Execution result message |
| 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. |
| 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 All: MultiActionParameterValueType
All member selection type |
|
static Datetime: MultiActionParameterValueType
Datetime value type |
|
static Member: MultiActionParameterValueType
Member value type |
|
static Number: MultiActionParameterValueType
Number value type |
|
static String: MultiActionParameterValueType
String value type |
| All |
| static All: MultiActionParameterValueType All member selection type |
| Datetime |
| static Datetime: MultiActionParameterValueType Datetime value type |
| Member |
| static Member: MultiActionParameterValueType Member value type |
| Number |
| static Number: MultiActionParameterValueType Number value type |
| String |
| static String: MultiActionParameterValueType String value type |
| Name and Description |
|
values: string[]
String values |
| Inherited from MultiActionParameterValue |
| type |
| 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 |
| 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). |
| 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 |
|
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. |
| 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 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 AutoFormattedLakhCrore: NumberFormatScaleUnit |
| static Billion: NumberFormatScaleUnit |
| static Crore: NumberFormatScaleUnit |
| static Default: NumberFormatScaleUnit |
| static Lakh: NumberFormatScaleUnit |
| static Million: NumberFormatScaleUnit |
| static Thousand: NumberFormatScaleUnit |
| static Unformatted: NumberFormatScaleUnit |
| AutoFormatted |
| static AutoFormatted: NumberFormatScaleUnit |
| AutoFormattedLakhCrore |
| static AutoFormattedLakhCrore: NumberFormatScaleUnit |
| Billion |
| static Billion: NumberFormatScaleUnit |
| Crore |
| static Crore: NumberFormatScaleUnit |
| Default |
| static Default: NumberFormatScaleUnit |
| Lakh |
| static Lakh: 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
2026.8
|
| MinusAsParentheses |
|
static MinusAsParentheses: NumberFormatSignDisplay
Negative numbers are nested in parentheses (()).
Since
2026.8
|
| MinusAsPrefix |
|
static MinusAsPrefix: NumberFormatSignDisplay
Negative numbers are prefixed with a minus sign (-).
Since
2026.8
|
| PlusMinusAsPrefix |
|
static PlusMinusAsPrefix: NumberFormatSignDisplay
Positive numbers are prefixed with a plus sign (+), negative numbers are prefixed with a minus sign (-).
Since
2026.8
|
| Name and Description |
|
moveWidget(pageKey: string, widget: Widget): void
Moves the widget into the specified page of the page book. |
| Name and Description |
|
moveWidget(widget: Widget): void
Moves the widget into the panel. |
| 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, 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 |
| 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 |
| 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 |
| getPrivateVersions |
|
getPrivateVersions(): PlanningPrivateVersion[]
Returns all private versions associated with the data source.
Returns
PlanningPrivateVersion[] |
| 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 |
| getPublicVersions |
|
getPublicVersions(): PlanningPublicVersion[]
Returns all public versions associated with the data source.
Returns
PlanningPublicVersion[] |
| 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, 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 |
| 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 |
| Name and Description |
|
changeFilter(dimension: string | DimensionInfo, memberInfo: PlanningAreaMemberInfo JSON): PlanningAreaInfo
Sets a filter on the dimension. |
|
getFilters(): PlanningAreaFilter[]
Returns filters that define the planning area. |
|
removeFilter(dimension: string | DimensionInfo): PlanningAreaInfo
Removes any filter that is set on the dimension. |
| changeFilter | ||||||
|
changeFilter(dimension: string | DimensionInfo, 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): 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 |
| 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. |
| 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.
Deprecated
2025.14
|
| VisibleData |
| static VisibleData: PlanningCopyOption Visible data based on the table is included when copying a version. |
| Name and Description |
|
createMembers(dimensionId: string, members: PlanningModelMember JSON | PlanningModelMember[] JSON): boolean
Creates planning model members. |
|
deleteAllModelPrivateVersions(): boolean
Deletes all private and public edit versions of the model. |
|
deleteMembers(dimensionId: string, members: string | string[]): boolean
Deletes planning model members. |
|
deleteModelPrivateVersions(modelPrivateVersionIds: string[]): boolean
Deletes specified private and public edit versions of the model. |
|
getMember(dimensionId: string, memberId: string): PlanningModelMember
Returns a planning model member. |
|
getMembers(dimensionId: string, options?: PlanningModelMemberOptions JSON): PlanningModelMember[]
Returns planning model members. |
|
getModelPrivateVersions(): ModelPrivateVersion[]
Returns all private and public edit versions of the model. |
|
getPrivateVersion(versionId: string): PlanningModelPrivateVersion
Returns a private version associated with the data source. |
|
getPrivateVersions(): PlanningModelPrivateVersion[]
Returns all private versions associated with the data source. |
|
getPublicVersion(versionId: string): PlanningModelPublicVersion
Returns a public version associated with the data source. |
|
getPublicVersions(): PlanningModelPublicVersion[]
Returns all public versions associated with the data source. |
|
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 |
| deleteAllModelPrivateVersions |
|
deleteAllModelPrivateVersions(): boolean
Deletes all private and public edit versions of the model. If this operation was successful, then "true" is returned, and "false" if it wasn't.
Returns
boolean
Since
2025.19
|
| 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 |
| deleteModelPrivateVersions | |||
|
deleteModelPrivateVersions(modelPrivateVersionIds: string[]): boolean
Deletes specified private and public edit versions of the model. If this operation was successful, then "true" is returned, and "false" if it wasn't.
Parameters
Returns
boolean
Since
2025.19
|
| 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[] |
| getModelPrivateVersions |
|
getModelPrivateVersions(): ModelPrivateVersion[]
Returns all private and public edit versions of the model.
Returns
ModelPrivateVersion[]
Since
2025.19
|
| getPrivateVersion | |||
|
getPrivateVersion(versionId: string): PlanningModelPrivateVersion
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
PlanningModelPrivateVersion |
| getPrivateVersions |
|
getPrivateVersions(): PlanningModelPrivateVersion[]
Returns all private versions associated with the data source.
Returns
PlanningModelPrivateVersion[] |
| getPublicVersion | |||
|
getPublicVersion(versionId: string): PlanningModelPublicVersion
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
PlanningModelPublicVersion |
| getPublicVersions |
|
getPublicVersions(): PlanningModelPublicVersion[]
Returns all public versions associated with the data source.
Returns
PlanningModelPublicVersion[] |
| 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 |
|
static AllData: PlanningModelCopyOption
All data is included when copying a version. |
|
static NoData: PlanningModelCopyOption
All data is excluded when copying a version. |
| AllData |
| static AllData: PlanningModelCopyOption All data is included when copying a version. |
| NoData |
| static NoData: PlanningModelCopyOption All data is excluded when copying a version. |
| 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 |
| 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 |
| 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?: PlanningModelPublicVersion, 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 PlanningModelVersion |
| copy, deleteVersion, getDisplayId, getId, redo, undo |
| getOwnerId |
|
getOwnerId(): string
Returns the user ID of the user who created this private version.
Returns
string |
| publish | |||||||||
|
publish(targetVersion?: PlanningModelPublicVersion, 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 |
| 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: PlanningModelPublicEditOption
All data is included when starting edit version. |
|
static PlanningArea: PlanningModelPublicEditOption
Planning Area data is included when starting edit version. |
| AllData |
| static AllData: PlanningModelPublicEditOption All data is included when starting edit version. |
| PlanningArea |
| static PlanningArea: PlanningModelPublicEditOption Planning Area data 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: PlanningModelPublicEditOption): boolean
Starts the edit mode for public version. |
|
updateProperty(propertyName: string, propertyValue: string | PlanningCategory): boolean
Updates the property of this version. |
| Inherited from PlanningModelVersion |
| copy, deleteVersion, getDisplayId, getId, redo, undo |
| 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 PlanningModelPublicVersion.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 |
| 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 PlanningModelPublicVersion.isDirty() if there are modifications available that can be reverted.
Returns
boolean |
| startEditMode | |||
|
startEditMode(planningPublicEditOption: PlanningModelPublicEditOption): 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 PlanningModelPublicVersion.isDirty() to false.
Parameters
Returns
boolean |
| updateProperty | ||||||
|
updateProperty(propertyName: string, propertyValue: string | PlanningCategory): boolean
Updates the property of this version. If this operation was successful, then true is returned, and false if it wasn't.
Parameters
Returns
boolean |
| Name and Description |
|
copy(newVersionName: string, planningCopyOption: PlanningModelCopyOption, versionCategory?: PlanningCategory): 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. |
|
redo(): boolean
Redoes changes to the version. |
|
undo(): boolean
Undoes changes to the version. |
| copy | |||||||||
|
copy(newVersionName: string, planningCopyOption: PlanningModelCopyOption, versionCategory?: PlanningCategory): 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 |
| 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 |
| getId |
|
getId(): string
Returns the ID of this version. You can use it, for example, when calling DataSource.getData().
Returns
string |
| redo |
|
redo(): boolean
Redoes changes to the version. If the operation is successful, then "true" is returned, and "false" if it isn't.
Returns
boolean |
| undo |
|
undo(): boolean
Undoes changes to the version. If the operation is successful, then "true" is returned, and "false" if it isn't.
Returns
boolean |
| 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, redo, undo |
| getOwnerId |
|
getOwnerId(): string
Returns the user ID of the user who created this private version.
Returns
string |
| 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 |
| 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, redo, undo |
| 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 |
| 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 |
| Name and Description |
|
copy(newVersionName: string, planningCopyOption: PlanningCopyOption, versionCategory?: PlanningCategory, planningAreaFilter?: PlanningAreaFilter[] JSON, hideUnbooked?: boolean): 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. |
|
redo(): boolean
Redoes changes to the version. |
|
undo(): boolean
Undoes changes to the version. |
| copy | |||||||||||||||
|
copy(newVersionName: string, planningCopyOption: PlanningCopyOption, versionCategory?: PlanningCategory, planningAreaFilter?: PlanningAreaFilter[] JSON, hideUnbooked?: boolean): 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 |
| 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 |
| getId |
|
getId(): string
Returns the ID of this version. You can use it, for example, when calling DataSource.getData().
Returns
string |
| redo |
|
redo(): boolean
Redoes changes to the version. If the operation is successful, then "true" is returned, and "false" if it isn't.
Returns
boolean |
| undo |
|
undo(): boolean
Undoes changes to the version. If the operation is successful, then "true" is returned, and "false" if it isn't.
Returns
boolean |
| 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. |
| 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: PopupSizeOptions): void
Sets the popup size.
Parameters
|
| setTitle | |||
|
setTitle(title: string): void
Sets the title of the popup.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| 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 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 |
|
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. |
| 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 |
|
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 |
| 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 |
|
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. |
| 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. |
| 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.
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
|
| 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.
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: RVisualizationQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
|
| 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
|
| openSubscriptionDialog |
|
static openSubscriptionDialog(): void
Opens the scheduling subscription dialog.
Mobile Support
Not supported on mobile devices.
|
| 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 | VariableValue[]): 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 |
| closeDialog |
| closeDialog(): void |
| getVariables | |||
|
getVariables(modelId: string): VariableInfo[]
Returns the variable values stored in this Search to Insight component.
Parameters
Returns
VariableInfo[] |
| 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 | VariableValue[]): void
Stores a variable value in this Search to Insight component. The variable value is applied to a chart when calling SearchToInsight.applySearchToChart().
Parameters
|
| 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 |
|
suppressPromptDialog: boolean
suppress prompt dialog |
| Name and Description |
|
description: string
Filter description |
|
exclude: boolean
Indicates whether to exclude the filter value. |
|
value: string
Filter value |
| 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
|
| setTooltipMeasureIncluded | |||
|
setTooltipMeasureIncluded(included: boolean): void
Deprecated This method is deprecated, use setTooltipFeedsIncluded() instead. Includes or excludes the tooltip measure.
Parameters
Deprecated
2025.14
|
| setVisible | |||
|
setVisible(visible: boolean): void
Enables or disables Smart Grouping.
Parameters
|
| 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. |
| 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
|
| setTitle | |||
|
setTitle(title: string): void
Sets the title of the popup.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| 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 |
| 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 |
| codePointAt | |||
|
codePointAt(pos: integer): integer
Returns a non-negative integer that is the UTF-16 encoded code point value.
Parameters
Returns
integer |
| 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 |
| includes | ||||||
|
includes(searchString: string, position?: integer): boolean
Returns whether one string may be found within another string.
Parameters
Returns
boolean |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| split | ||||||
|
split(separator?: string, limit?: integer): string[]
Splits a string into an array of strings by separating the string into substrings.
Parameters
Returns
string[] |
| startsWith | ||||||
|
startsWith(searchString: string, position?: integer): boolean
Returns whether a string begins with the characters of another string.
Parameters
Returns
boolean |
| 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 |
| 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 |
| 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 |
|
closeNavigationPanel(): void
Closes the navigation panel. |
|
closeQuickBuilder(): void
Closes the Quick Builder panel. |
|
getComments(): TableComments
Returns the comments of the data source. |
|
getPlanning(): Planning
Returns the Planning object of the table. |
|
isQuickBuilderOpen(): boolean
Returns whether the Quick Builder panel is open. |
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the table. |
|
openInNewStory(): void
Creates a new story with this widget. |
|
openNavigationPanel(navigationPanelOptions?: NavigationPanelOptions): void
Opens the navigation panel. |
|
openQuickBuilder(): void
Opens the Quick Builder panel. |
|
openSelectModelDialog(): void
Opens the select model dialog. |
|
setModel(modelId: string): boolean
Sets the model and replaces the old one. |
| Name and Description |
|
onAfterDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext): void Called after a data change in a table through single data entry, mass data entry, fluid data entry, copy & paste or submitData() API. |
|
onBeforeDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext): boolean[] Called after a data change in a table through single data entry, mass data entry, fluid data entry, or copy and paste. |
| closeNavigationPanel |
| closeNavigationPanel(): void Closes the navigation panel. Note: The API will be deprecated soon. Recommend to use closeQuickBuilder instead. |
| closeQuickBuilder |
|
closeQuickBuilder(): void
Closes the Quick Builder panel. Note: Only available in new table build experience.
Since
2026.1
|
| 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 |
| 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 |
| isQuickBuilderOpen |
|
isQuickBuilderOpen(): boolean
Returns whether the Quick Builder panel is open. Note: Only available in new table build experience.
Returns
boolean
Since
2026.1
|
| openDataAnalyzer | |||
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the table.
Parameters
Mobile Support
Not supported on mobile devices.
|
| openInNewStory |
|
openInNewStory(): void
Creates a new story with this widget.
Mobile Support
Not supported on mobile devices.
|
| openNavigationPanel | |||
|
openNavigationPanel(navigationPanelOptions?: NavigationPanelOptions): void
Opens the navigation panel. Note: This operation is ignored if the table is contained in a mobile application or a popup. The API will be deprecated soon. Recommend to use openQuickBuilder instead.
Parameters
|
| openQuickBuilder |
|
openQuickBuilder(): void
Opens the Quick Builder panel. Note: This operation is ignored if the table is within a mobile application or popup and is available only in the new table build experience.
Since
2026.1
|
| openSelectModelDialog |
| openSelectModelDialog(): void Opens the select model dialog. Selecting a model replaces the model of the table. |
| setModel | |||
|
setModel(modelId: string): boolean
Sets the model and replaces the old one.
Parameters
Returns
boolean |
| onAfterDataEntryProcess | ||||||
|
onAfterDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext): void
Called after a data change in a table through single data entry, mass data entry, fluid data entry, copy & paste or submitData() API. This event is called after data changes are processed to launch data actions.
Parameters
|
| onBeforeDataEntryProcess | ||||||
|
onBeforeDataEntryProcess(cells: IChangedCell[], effectiveContext: SelectionContext): boolean[]
Called after a data change in a table through single data entry, mass data entry, fluid data entry, or copy and paste. This event is called before data changes are processed to prevent unexpected data manipulation.
Parameters
Returns
boolean[]
Since
2026.8
|
| Name and Description |
|
addComment(selection: Selection, value: string): CommentInfo
Adds a comment to data cells. |
|
addComments(selection: Selection, value: string[]): CommentInfo[]
Adds multiple comments to data cells. |
|
getAllComments(selection: Selection): CommentInfo[]
Returns all comments of data cells. |
|
getComment(commentId: string): CommentInfo
Returns a comment. |
|
getDimensionComment(selection: Selection): CommentInfo
Returns the dimension comment of a data cell. |
|
isDataPointCommentPaused(): boolean
"return boolean indicate pause mode of the table data point comments. |
|
removeAllComments(selection: Selection): boolean
Removes all comments on data cells. |
|
removeComment(commentId: string): boolean
Removes a comment. |
|
removeDimensionComment(selection: Selection): 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. |
|
setDataPointCommentPaused(paused: boolean): void
"Sets the pause mode of the table data point comments. |
|
setDimensionComment(selection: Selection, value: string): void
Sets the dimension comment of a data cell. |
|
updateComment(commentId: string, value: string): CommentInfo
Updates a comment. |
| addComment | ||||||
|
addComment(selection: Selection, 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, 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): 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): 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.
|
| isDataPointCommentPaused |
|
isDataPointCommentPaused(): boolean
"return boolean indicate pause mode of the table data point comments. By default table data point comments works in non-pause mode. Note: Only supported for native SAC models.
Returns
boolean
Mobile Support
Not supported on mobile devices.
Since
2026.1
|
| removeAllComments | |||
|
removeAllComments(selection: Selection): 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): 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.
|
| setDataPointCommentPaused | |||
|
setDataPointCommentPaused(paused: boolean): void
"Sets the pause mode of the table data point comments. When set to true, changes to table data point comment e.g. addComment() will be cached, when set to false, all cached changes will be flushed. Note: Only supported for native SAC models.
Parameters
Mobile Support
Not supported on mobile devices.
Since
2026.1
|
| setDimensionComment | ||||||
|
setDimensionComment(selection: Selection, 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.
|
| Name and Description |
|
static variables: boolean
Variables. |
| Name and Description |
|
moveWidget(tabName: string, widget: Widget): void
Moves the widget into the specified tab of the tab strip. |
| Name and Description |
| displayName: string |
| id: string |
| Name and Description |
|
setNumberDecimalPlaces(decimalPlaces: integer): void
Sets the decimal places of the variance in number. |
|
setPercentageDecimalPlaces(decimalPlaces: integer): void
Sets the decimal places of the variance in percentage. |
| setNumberDecimalPlaces | |||
|
setNumberDecimalPlaces(decimalPlaces: integer): void
Sets the decimal places of the variance in number.
Parameters
|
| setPercentageDecimalPlaces | |||
|
setPercentageDecimalPlaces(decimalPlaces: integer): void
Sets the decimal places of the variance in percentage.
Parameters
|
| 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. |