|
Type Libraries
|
C
C
E
C
C
C
C
C
C
O
O
O
C
O
O
O
C
E
E
C
C
C
C
C
C
|
Type Libraries
|
| Name and Description |
|
isFullHierarchyNodes: boolean
Specifies whether to return selected nodes and all their descendants (true) or only the selected nodes without descendants (false). |
|
limit: integer
Maximum number of returned members, which must be zero or a positive number. |
|
returnNullAsAlias: boolean
If true, "@NullMember" is returned as alias for null members. |
| isFullHierarchyNodes |
| isFullHierarchyNodes: boolean Specifies whether to return selected nodes and all their descendants (true) or only the selected nodes without descendants (false). The default value is true. |
| limit |
| limit: integer Maximum number of returned members, which must be zero or a positive number. If the limit isn't specified or invalid, then the default value is used (default: 100). |
| returnNullAsAlias |
| returnNullAsAlias: boolean If true, "@NullMember" is returned as alias for null members. Default is false. |
| Name and Description |
|
getActivePage(): ApplicationPage
Get the active page. |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the canvas of the first page. |
|
getFileDataSource(modelId: string): FileDataSource
Returns the data source of related modelId. |
|
getGlobalCssClass(): string
Returns the global default Cascading Style Sheet (CSS) class name. |
|
getInfo(): ApplicationInfo
Returns information about the analytic application. |
|
getInnerHeight(): LayoutValue
Get InnerHeight of first page. |
|
getInnerWidth(): LayoutValue
Get InnerWidth of first page. |
|
getMode(): ApplicationMode
Returns the mode in which the analytic application is displayed. |
|
getRolesInfo(): string[]
Returns role information about the current user. |
|
getTeamsInfo(): TeamInfo[]
Returns team information about the current user. |
|
getTheme(): string
Returns the theme ID of the analytic application. |
|
getUserInfo(): UserInfo
Returns information about the current user. |
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
isMobile(): boolean
Returns whether the analytic application is in mobile mode. |
|
openShareApplicationDialog(): void
Opens the Share Application dialog for the currently opened analytic application. |
|
postMessage(receiver: PostMessageReceiver, message: string, targetOrigin: string): void
Posts a message to the parent window or the top-level window. |
|
refreshData(dataSources?: DataSource[]): void
Triggers data refresh. |
|
setActivePage(page: ApplicationPage | string | integer): void
Switch page. |
|
setAutomaticBusyIndicatorEnabled(enabled: boolean): void
Enables or disables the automatic busy indicator. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the canvas of the first page. |
|
setCurrentDateTime(currentDateTime: CurrentDateTime): void
Sets current date/time. |
|
setGlobalCssClass(className: string): void
Sets the global default Cascading Style Sheet (CSS) class name. |
|
setMessageTypesToShow(messageTypes: ApplicationMessageType[]): void
Specifies which messages are shown, depending on their message type. |
|
setPageVisible(page: ApplicationPage | string | integer, visible: boolean): void
Set the page visible or not. |
|
setTheme(themeId?: string): void
Applies a theme to the analytic application. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
|
showMessage(messageType: ApplicationMessageType, message: string): void
Shows a message. |
| getActivePage |
|
getActivePage(): ApplicationPage
Get the active page.
Returns
ApplicationPage |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the canvas of the first page.
Returns
string |
| getFileDataSource | |||
|
getFileDataSource(modelId: string): FileDataSource
Returns the data source of related modelId.
Parameters
Returns
FileDataSource |
| getGlobalCssClass |
|
getGlobalCssClass(): string
Returns the global default Cascading Style Sheet (CSS) class name.
Returns
string |
| getInfo |
|
getInfo(): ApplicationInfo
Returns information about the analytic application.
Returns
ApplicationInfo |
| getInnerHeight |
|
getInnerHeight(): LayoutValue
Get InnerHeight of first page. If the canvas size is fixed, then the height of the canvas is returned. If the canvas size is dynamic, then the height of the viewport (the visible area of the window) is returned.
Returns
LayoutValue |
| getInnerWidth |
|
getInnerWidth(): LayoutValue
Get InnerWidth of first page. If the canvas size is fixed, then the width of the canvas is returned. If the canvas size is dynamic, then the width of the viewport (the visible area of the window) is returned.
Returns
LayoutValue |
| getMode |
|
getMode(): ApplicationMode
Returns the mode in which the analytic application is displayed.
Returns
ApplicationMode |
| getRolesInfo |
|
getRolesInfo(): string[]
Returns role information about the current user.
Returns
string[] |
| getTeamsInfo |
|
getTeamsInfo(): TeamInfo[]
Returns team information about the current user.
Returns
TeamInfo[] |
| getTheme |
|
getTheme(): string
Returns the theme ID of the analytic application. If the default theme has been applied, then the value represented by Alias.DefaultTheme is returned.
Returns
string |
| getUserInfo |
|
getUserInfo(): UserInfo
Returns information about the current user.
Returns
UserInfo |
| getWidgets | |||
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options. Just Including widgets from first page.
Parameters
Returns
<type of type>
Since
2025.14
|
| hideBusyIndicator |
| hideBusyIndicator(): void Hides the busy indicator. |
| isMobile |
|
isMobile(): boolean
Returns whether the analytic application is in mobile mode. If the analytic application is displayed on a mobile device, for example, on a smartphone or on a tablet, then true is returned, and false if it isn't. Note: The returned value may not be accurate for specific devices. For example, for some versions of Microsoft Surface Book false is returned. Note: If the analytic application was requested as a desktop website by a Safari browser on iOS, then false is returned
Returns
boolean |
| openShareApplicationDialog |
|
openShareApplicationDialog(): void
Opens the Share Application dialog for the currently opened analytic application.
Mobile Support
Not supported on mobile devices.
|
| postMessage | |||||||||
|
postMessage(receiver: PostMessageReceiver, message: string, targetOrigin: string): void
Posts a message to the parent window or the top-level window.
Parameters
|
| refreshData | |||
|
refreshData(dataSources?: DataSource[]): void
Triggers data refresh. The script is fully executed without waiting for all the associated widgets to be updated. If no data sources are specified, then all widgets bound to data sources are refreshed. If data source is specified, then only associated charts or tables are refreshed.
Parameters
|
| setActivePage | |||
|
setActivePage(page: ApplicationPage | string | integer): void
Switch page.
Parameters
|
| setAutomaticBusyIndicatorEnabled | |||
|
setAutomaticBusyIndicatorEnabled(enabled: boolean): void
Enables or disables the automatic busy indicator. If the automatic busy indicator is enabled, then it appears automatically when necessary.
Parameters
|
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the canvas of the first page.
Parameters
|
| setCurrentDateTime | |||
|
setCurrentDateTime(currentDateTime: CurrentDateTime): void
Sets current date/time.
Parameters
|
| setGlobalCssClass | |||
|
setGlobalCssClass(className: string): void
Sets the global default Cascading Style Sheet (CSS) class name.
Parameters
|
| setMessageTypesToShow | |||
|
setMessageTypesToShow(messageTypes: ApplicationMessageType[]): void
Specifies which messages are shown, depending on their message type. By default, messages of all message types are shown. If you specify an empty array, then no message is shown.
Parameters
|
| setPageVisible | ||||||
|
setPageVisible(page: ApplicationPage | string | integer, visible: boolean): void
Set the page visible or not.
Parameters
|
| setTheme | |||
|
setTheme(themeId?: string): void
Applies a theme to the analytic application. The theme is specified by a theme ID or by selecting a theme from the Files repository. If no theme ID is specified, then the default theme is applied.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| showMessage | ||||||
|
showMessage(messageType: ApplicationMessageType, message: string): void
Shows a message.
Parameters
|
| Name and Description |
| description: string |
| id: string |
| name: string |
| Name and Description |
|
static Error: ApplicationMessageType
Error message |
|
static Info: ApplicationMessageType
Information message |
|
static Success: ApplicationMessageType
Success message |
|
static Warning: ApplicationMessageType
Warning message |
| Error |
| static Error: ApplicationMessageType Error message |
| Info |
| static Info: ApplicationMessageType Information message |
| Success |
| static Success: ApplicationMessageType Success message |
| Warning |
| static Warning: ApplicationMessageType Warning message |
| Name and Description |
|
static Embed: ApplicationMode
The analytic application is displayed in embed mode. |
|
static Present: ApplicationMode
The analytic application is displayed in present mode. |
|
static View: ApplicationMode
The analytic application is displayed in view mode. |
| Embed |
| static Embed: ApplicationMode The analytic application is displayed in embed mode. |
| Present |
| static Present: ApplicationMode The analytic application is displayed in present mode. |
| View |
| static View: ApplicationMode The analytic application is displayed in view mode. |
| Name and Description |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the page. |
|
getInnerHeight(): LayoutValue
If the page size is fixed, then the height of the page is returned. |
|
getInnerWidth(): LayoutValue
If the page size is fixed, then the width of the page is returned. |
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options. |
|
refreshData(dataSources?: DataSource[]): void
Triggers a data refresh and updates the widgets associated with the refreshed data sources. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the page. |
| Name and Description |
|
onActive(): void Called when the analytic application page is set to active. |
|
onInitialization(): void Called when the analytic application page has finished loading. |
|
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. |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the page.
Returns
string |
| getInnerHeight |
|
getInnerHeight(): LayoutValue
If the page size is fixed, then the height of the page is returned. If the page size is dynamic, then the height of the viewport (the visible area of the window) is returned.
Returns
LayoutValue |
| getInnerWidth |
|
getInnerWidth(): LayoutValue
If the page size is fixed, then the width of the page is returned. If the page size is dynamic, then the width of the viewport (the visible area of the window) is returned.
Returns
LayoutValue |
| getWidgets | |||
|
getWidgets(widgetSearchOptions: WidgetSearchOptions): <type of type>
Returns an array of widgets described by the widget search options.
Parameters
Returns
<type of type>
Since
2025.14
|
| refreshData | |||
|
refreshData(dataSources?: DataSource[]): void
Triggers a data refresh and updates the widgets associated with the refreshed data sources. If no data sources are specified, then all are refreshed. If data sources are specified, then only those are refreshed. Note: When specifying data sources, then only those associated with charts or tables are refreshed.
Parameters
|
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the page.
Parameters
|
| onActive |
| onActive(): void Called when the analytic application page is set to active. |
| onInitialization |
| onInitialization(): void Called when the analytic application page has finished loading. |
| 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. |
| 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 |
|
getProperties(): BackendConditionProperties
Returns properties of the BEx condition. |
|
isSelected(): boolean
Returns whether the BEx condition is applied to the current chart. |
|
setSelected(selected: boolean): void
Selects or deselects the BEx condition, and applies to the current chart. |
| getProperties |
|
getProperties(): BackendConditionProperties
Returns properties of the BEx condition.
Returns
BackendConditionProperties |
| isSelected |
|
isSelected(): boolean
Returns whether the BEx condition is applied to the current chart.
Returns
boolean |
| setSelected | |||
|
setSelected(selected: boolean): void
Selects or deselects the BEx condition, and applies to the current chart. If the condition is not applicable, the chart isn't affected.
Parameters
|
| Name and Description |
| description: string |
| id: string |
| Name and Description |
| displayName: string |
| id: string |
|
isDefault: boolean
Specifies whether the bookmark is the default bookmark. |
|
isGlobal: boolean
Specifies whether the bookmark is visible globally. |
| name: string |
|
properties: BookmarkProperties JSON
Additional properties of the bookmark, for example, {'property1': 'value1', 'property2': 'value2'} |
| version: integer |
| displayName |
| displayName: string |
| id |
| id: string |
| isDefault |
| isDefault: boolean Specifies whether the bookmark is the default bookmark. |
| isGlobal |
| isGlobal: boolean Specifies whether the bookmark is visible globally. |
| name |
| name: string |
| properties |
| properties: BookmarkProperties JSON Additional properties of the bookmark, for example, {'property1': 'value1', 'property2': 'value2'} |
| version |
| version: integer |
| Name and Description |
|
isDefault: boolean
Specifies whether the bookmark is the default bookmark. |
|
isGlobal: boolean
Specifies whether the bookmark is visible globally. |
|
isKeepLastDynamicVariableValue: boolean
Specifies whether the bookmark should apply last value of dynamic variable. |
|
name: string
Bookmark name |
|
properties: BookmarkProperties JSON
Additional properties of the bookmark, for example, {'property1': 'value1', 'property2': 'value2'} |
|
startPageId: string
Specifies start page id. |
| isDefault |
| isDefault: boolean Specifies whether the bookmark is the default bookmark. |
| isGlobal |
| isGlobal: boolean Specifies whether the bookmark is visible globally. |
| isKeepLastDynamicVariableValue |
| isKeepLastDynamicVariableValue: boolean Specifies whether the bookmark should apply last value of dynamic variable. |
| name |
| name: string Bookmark name |
| properties |
| properties: BookmarkProperties JSON Additional properties of the bookmark, for example, {'property1': 'value1', 'property2': 'value2'} |
| startPageId |
| startPageId: string Specifies start page id. |
| Name and Description |
|
apply(bookmark: string | BookmarkInfo): boolean
Applies the bookmark to the current analytic application. |
|
deleteBookmark(bookmark: string | BookmarkInfo): boolean
Deletes a bookmark of the analytic application. |
|
getAll(): BookmarkInfo[]
Returns all valid bookmarks of the analytic application. |
|
getAppliedBookmark(): BookmarkInfo
Returns the bookmark that was applied to the analytic application. |
|
getVersion(): integer
Returns the current bookmark version of the analytic application. |
|
isSameAsApplicationState(bookmark: string | BookmarkInfo): boolean
Returns whether the current state of the analytic application is the same as the state stored in a bookmark. |
|
openShareBookmarkDialog(bookmarkId: string): void
Opens the Share Bookmark dialog for a bookmark. |
|
save(bookmarkName: string, isGlobal: boolean, overwrite?: boolean): BookmarkInfo
Deprecated This method is deprecated, use saveBookmark() instead. |
|
saveBookmark(bookmarkSaveInfo: BookmarkSaveInfo JSON, overwrite?: boolean): BookmarkInfo
Saves a bookmark based on the current state of the analytic application. |
| apply | |||
|
apply(bookmark: string | BookmarkInfo): boolean
Applies the bookmark to the current analytic application. If the bookmark is accessible to the current user, then true is returned, and false if it isn't.
Parameters
Returns
boolean |
| deleteBookmark | |||
|
deleteBookmark(bookmark: string | BookmarkInfo): boolean
Deletes a bookmark of the analytic application.
Parameters
Returns
boolean |
| getAll |
|
getAll(): BookmarkInfo[]
Returns all valid bookmarks of the analytic application.
Returns
BookmarkInfo[] |
| getAppliedBookmark |
|
getAppliedBookmark(): BookmarkInfo
Returns the bookmark that was applied to the analytic application.
Returns
BookmarkInfo |
| getVersion |
|
getVersion(): integer
Returns the current bookmark version of the analytic application.
Returns
integer |
| isSameAsApplicationState | |||
|
isSameAsApplicationState(bookmark: string | BookmarkInfo): boolean
Returns whether the current state of the analytic application is the same as the state stored in a bookmark.
Parameters
Returns
boolean |
| openShareBookmarkDialog | |||
|
openShareBookmarkDialog(bookmarkId: string): void
Opens the Share Bookmark dialog for a bookmark.
Parameters
Mobile Support
Not supported on mobile devices.
|
| save | |||||||||
|
save(bookmarkName: string, isGlobal: boolean, overwrite?: boolean): BookmarkInfo
Deprecated This method is deprecated, use saveBookmark() instead.
Parameters
Returns
BookmarkInfo
Deprecated
2025.14
|
| saveBookmark | ||||||
|
saveBookmark(bookmarkSaveInfo: BookmarkSaveInfo JSON, overwrite?: boolean): BookmarkInfo
Saves a bookmark based on the current state of the analytic application. The bookmark save info specifies by default that the bookmark is neither globally visible nor a default bookmark. Optionally, you can specify whether to overwrite a bookmark with the same name (default: false).
Parameters
Returns
BookmarkInfo |
| Name and Description |
|
getText(): string
Returns the text of the button. |
|
getTooltip(): string
Returns the tooltip text of the button. |
|
isEnabled(): boolean
Returns whether the button is enabled. |
|
setEnabled(value: boolean): void
Enables or disables the button. |
|
setText(value: string): void
Sets the text of the button. |
|
setTooltip(value: string): void
Sets the tooltip text of the button. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the button. |
|
onLongPress(): void Called when the user presses and holds the button. |
| getText |
|
getText(): string
Returns the text of the button. If no text is present, then undefined is returned.
Returns
string |
| getTooltip |
|
getTooltip(): string
Returns the tooltip text of the button. If no tooltip text is present, then undefined is returned.
Returns
string |
| isEnabled |
|
isEnabled(): boolean
Returns whether the button is enabled.
Returns
boolean |
| setEnabled | |||
|
setEnabled(value: boolean): void
Enables or disables the button.
Parameters
|
| setText | |||
|
setText(value: string): void
Sets the text of the button.
Parameters
|
| setTooltip | |||
|
setTooltip(value: string): void
Sets the tooltip text of the button.
Parameters
|
| Name and Description |
|
day: integer
day |
|
granularity: CalendarTimeGranularity
granularity |
|
halfYear: integer
halfYear |
|
month: integer
month |
|
quarter: integer
quarter |
|
week: integer
week |
|
year: integer
year |
| day |
| day: integer day |
| granularity |
| granularity: CalendarTimeGranularity granularity |
| halfYear |
| halfYear: integer halfYear |
| month |
| month: integer month |
| quarter |
| quarter: integer quarter |
| week |
| week: integer week |
| year |
| year: integer year |
| Name and Description |
|
static Day: CalendarTimeGranularity
days |
|
static HalfYear: CalendarTimeGranularity
halfYears |
|
static Month: CalendarTimeGranularity
months |
|
static Quarter: CalendarTimeGranularity
quarters |
|
static Week: CalendarTimeGranularity
weeks |
|
static Year: CalendarTimeGranularity
years |
| Day |
| static Day: CalendarTimeGranularity days |
| HalfYear |
| static HalfYear: CalendarTimeGranularity halfYears |
| Month |
| static Month: CalendarTimeGranularity months |
| Quarter |
| static Quarter: CalendarTimeGranularity quarters |
| Week |
| static Week: CalendarTimeGranularity weeks |
| Year |
| static Year: CalendarTimeGranularity years |
| Name and Description |
|
addDimension(dimension: string | DimensionInfo JSON, feed: Feed, position?: integer): void
Adds the dimension to the feed, at the specified position. |
|
addMeasure(measure: string | MeasureInfo JSON, feed: Feed, position?: integer): void
Deprecated This method is deprecated, use addMember() instead. |
|
addMember(feed: Feed, structureMember: string | MeasureInfo JSON | MemberInfo JSON, position?: integer): void
Adds the structure member to the feed, at the specified position. |
|
getDataSource(): DataSource(Chart)
Returns the data source of the chart. |
|
getDimensions(feed: Feed): string[]
Returns the dimensions of the feed. |
|
getEffectiveAxisScale(feed: Feed): ChartAxisScaleEffective
Returns effective scale's min/max of chart |
|
getMeasures(feed: Feed): string[]
Deprecated This method is deprecated, use getMembers() instead. |
|
getMembers(feed: Feed): string[]
Returns the structure members of the feed. |
|
getSelections(): Selection[]
Returns the selections of the chart. |
|
isEnabled(): boolean
Returns whether the user interaction with the chart is enabled. |
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the chart. |
|
rankBy(rankOptions: ChartRankOptions JSON): void
(Only available in optimized view mode) Creates a Top N filter to show a specified number of the lowest or highest ranked members. |
|
removeDimension(dimension: string | DimensionInfo JSON, feed: Feed): void
Removes the dimension from the feed. |
|
removeMeasure(measure: string | MeasureInfo JSON, feed: Feed): void
Deprecated This method is deprecated, use removeMember() instead. |
|
removeMember(feed: Feed, member: string | MeasureInfo JSON | MemberInfo JSON): void
Removes the structure member from the feed. |
|
removeRanking(): void
(Only available in optimized view mode) Clears ranking and shows all the members with sort order retained, if applicable. |
|
removeSorting(): void
(Only available in optimized view mode) Clears sorting and shows the members in default order. |
|
setAxisScale(feed: Feed, axisScale: ChartAxisScale JSON): void
Specifies the axis scale of chart. |
|
setBreakGroupingEnabled(enabled: boolean): void
(Only available in optimized view mode) Enables or disables Break Grouping when sorting. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the chart. |
|
setQuickActionsVisibility(quickActionsVisibility: ChartQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility. |
|
sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void
(Only available in optimized view mode) Sorts dimension members in a chart. |
|
sortByValue(structureMember: string | MemberInfo JSON | MeasureInfo JSON, sortOrder: SortOrder, secondaryStructureMember?: string | MemberInfo JSON | MeasureInfo JSON): void
(Only available in optimized view mode) Sorts measure values in a chart. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onResultChanged(): void Called when the result set displayed by the chart changes. |
|
onSelect(): void Called when the user makes a selection within the chart. |
| addDimension | |||||||||
|
addDimension(dimension: string | DimensionInfo JSON, feed: Feed, position?: integer): void
Adds the dimension to the feed, at the specified position. If no position is specified, then the dimension is added at the end of the feed.
Parameters
|
| addMeasure | |||||||||
|
addMeasure(measure: string | MeasureInfo JSON, feed: Feed, position?: integer): void
Deprecated This method is deprecated, use addMember() instead. Adds the measure to the feed, at the specified position. If no position is specified, then the measure is added at the end of the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.Color and Feed.bubbleWidth.
Parameters
Deprecated
2025.14
|
| addMember | |||||||||
|
addMember(feed: Feed, structureMember: string | MeasureInfo JSON | MemberInfo JSON, position?: integer): void
Adds the structure member to the feed, at the specified position. If no position is specified, then the member is added at the end of the feed. Specify for the structure member either a measure member for a model with measures only or an account member for a model with accounts. When the structure member is a measure, it can be only added to Feed.ValueAxis, Feed.ValueAxis2, Feed.TooltipValueAxis, Feed.Color and Feed.bubbleWidth.
Parameters
|
| getDataSource |
|
getDataSource(): DataSource(Chart)
Returns the data source of the chart.
Returns
DataSource(Chart) |
| getDimensions | |||
|
getDimensions(feed: Feed): string[]
Returns the dimensions of the feed.
Parameters
Returns
string[] |
| getEffectiveAxisScale | |||
|
getEffectiveAxisScale(feed: Feed): ChartAxisScaleEffective
Returns effective scale's min/max of chart
Parameters
Returns
ChartAxisScaleEffective |
| getMeasures | |||
|
getMeasures(feed: Feed): string[]
Deprecated This method is deprecated, use getMembers() instead. Returns the measures of the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures.
Parameters
Returns
string[]
Deprecated
2025.14
|
| getMembers | |||
|
getMembers(feed: Feed): string[]
Returns the structure members of the feed. The structure members are either measure members from a model with measures only or account members from a model with accounts.
Parameters
Returns
string[] |
| getSelections |
|
getSelections(): Selection[]
Returns the selections of the chart. You can use the elements of the returned array with DataSource.getData() to get the value of a cell. See also the documentation of Selection.
Returns
Selection[] |
| isEnabled |
|
isEnabled(): boolean
Returns whether the user interaction with the chart is enabled.
Returns
boolean |
| openDataAnalyzer | |||
|
openDataAnalyzer(newTab?: boolean): void
Opens Data Analyzer for the chart.
Parameters
Mobile Support
Not supported on mobile devices.
|
| rankBy | |||
|
rankBy(rankOptions: ChartRankOptions JSON): void
(Only available in optimized view mode) Creates a Top N filter to show a specified number of the lowest or highest ranked members. Note that it is not supported in charts with Structures.
Parameters
|
| removeDimension | ||||||
|
removeDimension(dimension: string | DimensionInfo JSON, feed: Feed): void
Removes the dimension from the feed.
Parameters
|
| removeMeasure | ||||||
|
removeMeasure(measure: string | MeasureInfo JSON, feed: Feed): void
Deprecated This method is deprecated, use removeMember() instead. Removes the measure from the feed. For models with both accounts and measures, this method might operate on the accounts instead of the measures. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.Color and Feed.bubbleWidth.
Parameters
Deprecated
2025.14
|
| removeMember | ||||||
|
removeMember(feed: Feed, member: string | MeasureInfo JSON | MemberInfo JSON): void
Removes the structure member from the feed. Specify for the structure member either a measure member for a model with measures only or an account member for a model with accounts. For charts, this API only supports Feed.ValueAxis, Feed.ValueAxis2, Feed.TooltipValueAxis, Feed.Color and Feed.bubbleWidth.
Parameters
|
| removeRanking |
| removeRanking(): void (Only available in optimized view mode) Clears ranking and shows all the members with sort order retained, if applicable. |
| removeSorting |
| removeSorting(): void (Only available in optimized view mode) Clears sorting and shows the members in default order. |
| setAxisScale | ||||||
|
setAxisScale(feed: Feed, axisScale: ChartAxisScale JSON): void
Specifies the axis scale of chart.
Parameters
|
| setBreakGroupingEnabled | |||
|
setBreakGroupingEnabled(enabled: boolean): void
(Only available in optimized view mode) Enables or disables Break Grouping when sorting.
Parameters
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the chart.
Parameters
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: ChartQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
|
| sortByMember | ||||||
|
sortByMember(dimension: string | DimensionInfo JSON, sortOrder: SortOrder): void
(Only available in optimized view mode) Sorts dimension members in a chart. You can specify the dimension that you want to sort and the sort order.
Parameters
|
| sortByValue | |||||||||
|
sortByValue(structureMember: string | MemberInfo JSON | MeasureInfo JSON, sortOrder: SortOrder, secondaryStructureMember?: string | MemberInfo JSON | MeasureInfo JSON): void
(Only available in optimized view mode) Sorts measure values in a chart. You can specify the measure that you want to sort, the sort order, and, optionally, a secondary structure member.
Parameters
|
| Name and Description |
|
dynamicAxisEnabled: boolean
let the system dynamically set the minimum and maximum values. |
|
max: string
max scale of chart |
|
min: string
min scale of chart |
| Name and Description |
|
max: number
effective max scale of chart |
|
min: number
effective min scale of chart |
|
tickInterval: number
tick interval of axis scale |
| Name and Description |
|
static addComment: boolean
Comment |
|
static addCompoundGrowthRate: boolean
CGR |
|
static breakAxis: boolean
Break Axis |
|
static chartDetail: boolean
Applied to Chart |
|
static compareTo: boolean
Compare To |
|
static dataChangeInsights: boolean
Data Change Insights |
|
static drill: boolean
Drill |
|
static expand: boolean
Expand |
|
static exporting: boolean
Export |
|
static filter: boolean
Filter/Exclude |
|
static forecast: boolean
Forecast |
|
static fullscreen: boolean
Fullscreen |
|
static openHyperlink: boolean
Open Hyperlinks |
|
static rank: boolean
Ranking |
|
static selectConversions: boolean
Select Conversions |
|
static showAsPercentage: boolean
Show as Percentage |
|
static smartGrouping: boolean
Smart Grouping |
|
static sort: boolean
Sorting |
|
static titleExpandCollapse: boolean
Collapse/Expand Title |
|
static variables: boolean
variables |
|
static zoom: boolean
Zoom |
| addComment |
| static addComment: boolean Comment |
| addCompoundGrowthRate |
| static addCompoundGrowthRate: boolean CGR |
| breakAxis |
| static breakAxis: boolean Break Axis |
| chartDetail |
| static chartDetail: boolean Applied to Chart |
| compareTo |
| static compareTo: boolean Compare To |
| dataChangeInsights |
| static dataChangeInsights: boolean Data Change Insights |
| drill |
| static drill: boolean Drill |
| expand |
| static expand: boolean Expand |
| exporting |
| static exporting: boolean Export |
| filter |
| static filter: boolean Filter/Exclude |
| forecast |
| static forecast: boolean Forecast |
| fullscreen |
| static fullscreen: boolean Fullscreen |
| openHyperlink |
| static openHyperlink: boolean Open Hyperlinks |
| rank |
| static rank: boolean Ranking |
| selectConversions |
| static selectConversions: boolean Select Conversions |
| showAsPercentage |
| static showAsPercentage: boolean Show as Percentage |
| smartGrouping |
|
static smartGrouping: boolean
Smart Grouping
Since
2025.14
|
| sort |
| static sort: boolean Sorting |
| titleExpandCollapse |
| static titleExpandCollapse: boolean Collapse/Expand Title |
| variables |
| static variables: boolean variables |
| zoom |
| static zoom: boolean Zoom |
| Name and Description |
|
rankOrder: RankOrder
Order used for ranking. |
|
secondaryStructureMember: string
Secondary structure member used for ranking |
|
structureMember: string
Structure member used for ranking |
|
value: integer
Number of values to include in the ranking filter |
|
versionId: string
Version ID |
| rankOrder |
| rankOrder: RankOrder Order used for ranking. The values RankOrder.Top or RankOrder.Bottom, for example, correspond to a descending or an ascending order of ranking, respectively. |
| secondaryStructureMember |
| secondaryStructureMember: string Secondary structure member used for ranking |
| structureMember |
| structureMember: string Structure member used for ranking |
| value |
| value: integer Number of values to include in the ranking filter |
| versionId |
| versionId: string Version ID |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the checkbox group. |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the checkbox group. |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the checkbox group. |
|
removeAllItems(): void
Removes all items from the checkbox group. |
|
removeItem(key: string): void
Removes an item from the checkbox group. |
|
setSelectedKeys(keys: string[]): void
Selects items in the checkbox group. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user changes the selection of a checkbox in the checkbox group. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the checkbox group. The item is specified by a key and an optional text. If the key or the text already exists, then this operation is ignored.
Parameters
|
| getSelectedKeys |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the checkbox group. If no items are selected, then an empty array is returned.
Returns
string[] |
| getSelectedTexts |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the checkbox group. If no items are selected, then an empty array is returned.
Returns
string[] |
| removeAllItems |
| removeAllItems(): void Removes all items from the checkbox group. |
| removeItem | |||
|
removeItem(key: string): void
Removes an item from the checkbox group. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKeys | |||
|
setSelectedKeys(keys: string[]): void
Selects items in the checkbox group. The items are specified by their keys. If the keys aren't present, then nothing is selected.
Parameters
|
| Name and Description |
|
static log(arg: any): void
Outputs a message to the Web Console. |
| Name and Description |
|
static numberToString(value: number): string
Returns a string representation of the number value. |
|
static stringToInteger(value: string): integer
Returns the integer value represented by the string. |
|
static stringToNumber(value: string): number
Returns the number value represented by the string. |
| numberToString | |||
|
static numberToString(value: number): string
Returns a string representation of the number value. If the value is undefined, then the string "undefined" is returned.
Parameters
Returns
string |
| stringToInteger | |||
|
static stringToInteger(value: string): integer
Returns the integer value represented by the string. If the string can't be parsed to a decimal integer, then NaN is returned.
Parameters
Returns
integer |
| stringToNumber | |||
|
static stringToNumber(value: string): number
Returns the number value represented by the string. If the string can't be parsed to a decimal number, then NaN is returned.
Parameters
Returns
number |
| Name and Description |
|
static createCalendarDateTime(calendartime: CalendarTime JSON): CurrentDateTime
Creates a calendar date/time with the specified calendarTime. |
|
static createFiscalDateTime(modelId: string, dimension: string | DimensionInfo JSON, fiscalTime: FiscalTime JSON): CurrentDateTime
Creates a fiscal date/time with the specified modelId, time-based dimension and fiscalTime. |
| createCalendarDateTime | |||
|
static createCalendarDateTime(calendartime: CalendarTime JSON): CurrentDateTime
Creates a calendar date/time with the specified calendarTime. See also the documentation of CalendarTime.
Parameters
Returns
CurrentDateTime |
| createFiscalDateTime | |||||||||
|
static createFiscalDateTime(modelId: string, dimension: string | DimensionInfo JSON, fiscalTime: FiscalTime JSON): CurrentDateTime
Creates a fiscal date/time with the specified modelId, time-based dimension and fiscalTime. See also the documentation of FiscalTime.
Parameters
Returns
CurrentDateTime |
| Name and Description |
| formattedValue: string |
| rawValue: string |
| Name and Description |
|
static Subscribed: DataChangeInsightsSubscriptionLevel
Subscribed |
|
static SubscribedHighImportance: DataChangeInsightsSubscriptionLevel
Subscribed with high importance |
|
static Unsubscribed: DataChangeInsightsSubscriptionLevel
Unsubscribed |
| Subscribed |
| static Subscribed: DataChangeInsightsSubscriptionLevel Subscribed |
| SubscribedHighImportance |
| static SubscribedHighImportance: DataChangeInsightsSubscriptionLevel Subscribed with high importance |
| Unsubscribed |
| static Unsubscribed: DataChangeInsightsSubscriptionLevel Unsubscribed |
| Name and Description |
|
isAbsoluteValue: boolean
Specifies whether the subscription range defines an absolute value. |
|
isDeltaValue: boolean
Specifies whether the subscription range defines a delta value. |
|
isInclude: boolean
Specifies whether the subscription range is inclusive. |
|
isMaxOrEqual: boolean
Specifies whether the subscription range defines values less or equal to the maximum value. |
|
isMinOrEqual: boolean
Specifies whether the subscription range defines values greater or equal to the minimum value. |
|
max: number
Maximum value of the subscription range |
|
min: number
Minimum value of the subscription range |
|
structureDimension: string
Structure dimension of the subscription range |
|
structureDimensionMember: string
Structure dimension member of the subscription range |
| isAbsoluteValue |
| isAbsoluteValue: boolean Specifies whether the subscription range defines an absolute value. |
| isDeltaValue |
| isDeltaValue: boolean Specifies whether the subscription range defines a delta value. |
| isInclude |
| isInclude: boolean Specifies whether the subscription range is inclusive. |
| isMaxOrEqual |
| isMaxOrEqual: boolean Specifies whether the subscription range defines values less or equal to the maximum value. |
| isMinOrEqual |
| isMinOrEqual: boolean Specifies whether the subscription range defines values greater or equal to the minimum value. |
| max |
| max: number Maximum value of the subscription range |
| min |
| min: number Minimum value of the subscription range |
| structureDimension |
| structureDimension: string Structure dimension of the subscription range |
| structureDimensionMember |
| structureDimensionMember: string Structure dimension member of the subscription range |
| Name and Description |
|
collapseNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Collapses a hierarchy node. |
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. |
|
copyVariableValueFrom(sourceDataSource: DataSource, variable?: string | string[] | VariableInfo | VariableInfo[]): void
Copies the value of a variable. |
|
expandNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Expands a hierarchy node. |
|
getBackendCondition(backendConditionId: string): BackendCondition
Gets a BEx condition by its ID. |
|
getBackendConditions(): BackendCondition[]
Gets all BEx conditions. |
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. |
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source. |
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension. |
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension. |
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. |
|
getInfo(): DataSourceInfo
Returns information about the data source. |
|
getMeasures(): MeasureInfo[]
Returns all measures of the data source. |
|
getMember(dimension: string | DimensionInfo JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. |
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension. |
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. |
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. |
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. |
|
getVariables(): VariableInfo[]
Returns all variables of the data source. |
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable. |
|
isResultEmpty(): boolean
Returns whether the result of the data source query state is empty, that is, no data cells were returned. |
|
openPromptDialog(): void
Opens the Prompt dialog for the model used by this data source. |
|
refreshData(): void
Triggers data refresh and updates the widgets associated with the data source at the same time. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. |
|
setDimensionFilter(dimension: string | DimensionInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. |
|
setHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON): void
Sets the hierarchy on the dimension. |
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. |
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension. |
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. |
| collapseNode | ||||||
|
collapseNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Collapses a hierarchy node. The dimension node specified by the selection is collapsed. For tables, only one dimension node is collapsed. The expansion state of its child nodes is restored when this dimension node is expanded again. For charts, all specified dimension nodes are collapsed, along with their child nodes. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.
Parameters
|
| copyDimensionFilterFrom | ||||||
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. If no dimensions are specified, then the filters of all matching dimensions are copied. Note: Only filters on dimensions with the same name and the same active hierarchy in both the source data source and this data source are copied. Note: Advanced Filters are not copied.
Parameters
|
| 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 JSON, selection: Selection JSON): void
Expands a hierarchy node. Only one hierarchy dimension can be expanded. Every node on the hierarchy path is expanded as well. For tables, this operation is ignored if one of the dimension nodes on the hierarchy path doesn't exist. Invalid dimensions in the selection are ignored. For charts, all dimension nodes specified by the selection are expanded. If the selection doesn't specify dimension nodes of the specified dimension, then this operation is ignored. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.
Parameters
|
| 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[] |
| getData | |||
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. If no value is available for that selection, then undefined is returned. See also the documentation of Selection.
Parameters
Returns
DataCell |
| getDataSelections | |||||||||
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a selection including all data cells is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
Selection[] |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| getDimensionProperties | |||
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. Note: Currently, this operation is only supported for data sources associated with tables.
Parameters
Returns
DimensionPropertyInfo[] |
| getDimensions |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source.
Returns
DimensionInfo[] |
| getHierarchies | |||
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension.
Parameters
Returns
HierarchyInfo[] |
| getHierarchy | |||
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension.
Parameters
Returns
HierarchyInfo |
| getHierarchyLevel | |||
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. This operation is only supported for data sources associated with tables, charts and optimized geo map bubble color. If the dimension is invalid or if the dimension doesn't have a hierarchy, then undefined is returned. Note: This operation isn't supported for data sources associated with charts on SAP BW models and undefined is returned. For non-active dimensions this operation is only supported for data sources associated with charts in optimized view mode.
Parameters
Returns
integer |
| 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 JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. Note: The member ID of a member may differ depending on its dimension's hierarchy. For example, for a SAP BW system, the member ID of the same member may be "DE" for a flat presentation hierarchy and "!DE" for an actual hierarchy. Note: If the specified hierarchy doesn't exist, then undefined is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation), then undefined is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo |
| getMemberDisplayMode | |||
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension.
Parameters
Returns
MemberDisplayMode |
| getMembers | ||||||
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. If you specify a number, then at most this many members are returned (default: 200). If you specify members options, then you can control the returned set of members even finer. Note: If the hierarchy specified in the members options doesn't exist, then an empty array is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation) in the members options, then an empty array is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo[] |
| getResultMember | ||||||
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. It is specified by a dimension and a selection.
Parameters
Returns
ResultMemberInfo |
| getResultSet | |||||||||
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. The result sets are specified by selections. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a result set including all data is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
ResultSet[] |
| 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[] |
| 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 JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. 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 JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. If the dimension has a hierarchy, then the specified members need to be part of this hierarchy. If they belong to a different hierarchy, then set that hierarchy with DataSource.setHierarchy() first before calling DataSource.setDimensionFilter().
Parameters
|
| setHierarchy | ||||||
|
setHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON): void
Sets the hierarchy on the dimension. Note: Currently, this operation is ignored for measure structures. This operation is not supported for data sources associated with geo map layers.
Parameters
|
| setHierarchyLevel | ||||||
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. If the dimension or the hierarchy level of the dimension is invalid, then this operation is ignored. The default value of the level is defined by the dimension's default level. For data sources associated with charts, the level value is optional.
Parameters
|
| setMemberDisplayMode | ||||||
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension.
Parameters
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set the variable value of a variable for a data source of a widget that overrides variables, then this operation sets only the variable value for this widget. If you set an empty variable value to a mandatory variable, then this operation is ignored. If you set a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.
Parameters
|
| Name and Description |
|
collapseNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Collapses a hierarchy node. |
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. |
|
copyVariableValueFrom(sourceDataSource: DataSource, variable?: string | string[] | VariableInfo | VariableInfo[]): void
Copies the value of a variable. |
|
expandNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Expands a hierarchy node. |
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. |
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source. |
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension. |
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension. |
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. |
|
getInfo(): DataSourceInfo
Returns information about the data source. |
|
getMeasures(): MeasureInfo[]
Returns all measures of the data source. |
|
getMember(dimension: string | DimensionInfo JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. |
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension. |
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. |
|
getRefreshPaused(): PauseMode
Returns the pause mode of the data refresh. |
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. |
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. |
|
getVariables(): VariableInfo[]
Returns all variables of the data source. |
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable. |
|
isRefreshPaused(): boolean
Deprecated This method is deprecated, use getRefreshPaused() instead. |
|
isResultEmpty(): boolean
Returns whether the result of the data source query state is empty, that is, no data cells were returned. |
|
openPromptDialog(): void
Opens the Prompt dialog for the model used by this data source. |
|
refreshData(): void
Triggers data refresh and updates the widgets associated with the data source at the same time. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. |
|
setDimensionFilter(dimension: string | DimensionInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. |
|
setHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON): void
Sets the hierarchy on the dimension. |
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. |
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension. |
|
setRefreshPaused(paused: PauseMode | boolean): void
Sets the pause mode of the data refresh. |
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. |
| collapseNode | ||||||
|
collapseNode(dimension: string | DimensionInfo JSON, selection: Selection JSON): void
Collapses a hierarchy node. The dimension node specified by the selection is collapsed. For tables, only one dimension node is collapsed. The expansion state of its child nodes is restored when this dimension node is expanded again. For charts, all specified dimension nodes are collapsed, along with their child nodes. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.
Parameters
|
| copyDimensionFilterFrom | ||||||
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. If no dimensions are specified, then the filters of all matching dimensions are copied. Note: Only filters on dimensions with the same name and the same active hierarchy in both the source data source and this data source are copied. Note: Advanced Filters are not copied.
Parameters
|
| 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 JSON, selection: Selection JSON): void
Expands a hierarchy node. Only one hierarchy dimension can be expanded. Every node on the hierarchy path is expanded as well. For tables, this operation is ignored if one of the dimension nodes on the hierarchy path doesn't exist. Invalid dimensions in the selection are ignored. For charts, all dimension nodes specified by the selection are expanded. If the selection doesn't specify dimension nodes of the specified dimension, then this operation is ignored. For Waterfall charts with one or more dimensions, the selection specifies one dimension and one measure. For Waterfall charts with one measure but no dimensions, the selection specifies this measure. For Waterfall charts with more than one measure but no dimensions, this operation is ignored. Note: Currently, this operation is not supported for data sources associated with geo map layers.
Parameters
|
| getData | |||
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. If no value is available for that selection, then undefined is returned. See also the documentation of Selection.
Parameters
Returns
DataCell |
| getDataSelections | |||||||||
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a selection including all data cells is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
Selection[] |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| getDimensionProperties | |||
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. Note: Currently, this operation is only supported for data sources associated with tables.
Parameters
Returns
DimensionPropertyInfo[] |
| getDimensions |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source.
Returns
DimensionInfo[] |
| getHierarchies | |||
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension.
Parameters
Returns
HierarchyInfo[] |
| getHierarchy | |||
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension.
Parameters
Returns
HierarchyInfo |
| getHierarchyLevel | |||
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. This operation is only supported for data sources associated with tables, charts and optimized geo map bubble color. If the dimension is invalid or if the dimension doesn't have a hierarchy, then undefined is returned. Note: This operation isn't supported for data sources associated with charts on SAP BW models and undefined is returned. For non-active dimensions this operation is only supported for data sources associated with charts in optimized view mode.
Parameters
Returns
integer |
| 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 JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. Note: The member ID of a member may differ depending on its dimension's hierarchy. For example, for a SAP BW system, the member ID of the same member may be "DE" for a flat presentation hierarchy and "!DE" for an actual hierarchy. Note: If the specified hierarchy doesn't exist, then undefined is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation), then undefined is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo |
| getMemberDisplayMode | |||
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension.
Parameters
Returns
MemberDisplayMode |
| getMembers | ||||||
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. If you specify a number, then at most this many members are returned (default: 200). If you specify members options, then you can control the returned set of members even finer. Note: If the hierarchy specified in the members options doesn't exist, then an empty array is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation) in the members options, then an empty array is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo[] |
| 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 JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. It is specified by a dimension and a selection.
Parameters
Returns
ResultMemberInfo |
| getResultSet | |||||||||
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. The result sets are specified by selections. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a result set including all data is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
ResultSet[] |
| 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 JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. 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 JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | MeasureInfo JSON | MeasureInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. If the dimension has a hierarchy, then the specified members need to be part of this hierarchy. If they belong to a different hierarchy, then set that hierarchy with DataSource.setHierarchy() first before calling DataSource.setDimensionFilter().
Parameters
|
| setHierarchy | ||||||
|
setHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON): void
Sets the hierarchy on the dimension. Note: Currently, this operation is ignored for measure structures. This operation is not supported for data sources associated with geo map layers.
Parameters
|
| setHierarchyLevel | ||||||
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. If the dimension or the hierarchy level of the dimension is invalid, then this operation is ignored. The default value of the level is defined by the dimension's default level. For data sources associated with charts, the level value is optional.
Parameters
|
| setMemberDisplayMode | ||||||
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, 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 JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set the variable value of a variable for a data source of a widget that overrides variables, then this operation sets only the variable value for this widget. If you set an empty variable value to a mandatory variable, then this operation is ignored. If you set a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.
Parameters
|
| Name and Description |
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. |
|
copyVariableValueFrom(sourceDataSource: DataSource, variable?: string | string[] | VariableInfo | VariableInfo[]): void
Copies the value of a variable. |
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. |
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source. |
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension. |
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension. |
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. |
|
getInfo(): DataSourceInfo
Returns information about the data source. |
|
getMeasures(): MeasureInfo[]
Returns all measures of the data source. |
|
getMember(dimension: string | DimensionInfo JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. |
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension. |
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. |
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. |
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. |
|
getVariables(): VariableInfo[]
Returns all variables of the data source. |
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable. |
|
isResultEmpty(): boolean
Returns whether the result of the data source query state is empty, that is, no data cells were returned. |
|
openPromptDialog(): void
Opens the Prompt dialog for the model used by this data source. |
|
refreshData(): void
Triggers data refresh and updates the widgets associated with the data source at the same time. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. |
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. |
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension. |
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. |
| copyDimensionFilterFrom | ||||||
|
copyDimensionFilterFrom(sourceDataSource: DataSource, dimension?: string | string[] | DimensionInfo JSON | DimensionInfo[] JSON): void
Copies the dimension filters of the dimensions of the source data source to the dimensions of this data source. If no dimensions are specified, then the filters of all matching dimensions are copied. Note: Only filters on dimensions with the same name and the same active hierarchy in both the source data source and this data source are copied. Note: Advanced Filters are not copied.
Parameters
|
| 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
|
| getData | |||
|
getData(selection: Selection JSON): DataCell
Returns the data cell of the selection. If no value is available for that selection, then undefined is returned. See also the documentation of Selection.
Parameters
Returns
DataCell |
| getDataSelections | |||||||||
|
getDataSelections(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): Selection[]
Returns selections of data cells. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a selection including all data cells is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
Selection[] |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| getDimensionProperties | |||
|
getDimensionProperties(dimension: string | DimensionInfo JSON): DimensionPropertyInfo[]
Returns the properties of the dimension. Note: Currently, this operation is only supported for data sources associated with tables.
Parameters
Returns
DimensionPropertyInfo[] |
| getDimensions |
|
getDimensions(): DimensionInfo[]
Returns all dimensions of the data source.
Returns
DimensionInfo[] |
| getHierarchies | |||
|
getHierarchies(dimension: string | DimensionInfo JSON): HierarchyInfo[]
Returns all hierarchies of the dimension.
Parameters
Returns
HierarchyInfo[] |
| getHierarchy | |||
|
getHierarchy(dimension: string | DimensionInfo JSON): HierarchyInfo
Returns the hierarchy set on the dimension.
Parameters
Returns
HierarchyInfo |
| getHierarchyLevel | |||
|
getHierarchyLevel(dimension: string | DimensionInfo JSON): integer
Returns the hierarchy level of the dimension. This operation is only supported for data sources associated with tables, charts and optimized geo map bubble color. If the dimension is invalid or if the dimension doesn't have a hierarchy, then undefined is returned. Note: This operation isn't supported for data sources associated with charts on SAP BW models and undefined is returned. For non-active dimensions this operation is only supported for data sources associated with charts in optimized view mode.
Parameters
Returns
integer |
| 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 JSON, memberId: string, hierarchy?: string | HierarchyInfo JSON): MemberInfo
Returns the member info object from a member ID. Note: The member ID of a member may differ depending on its dimension's hierarchy. For example, for a SAP BW system, the member ID of the same member may be "DE" for a flat presentation hierarchy and "!DE" for an actual hierarchy. Note: If the specified hierarchy doesn't exist, then undefined is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation), then undefined is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo |
| getMemberDisplayMode | |||
|
getMemberDisplayMode(dimension: string | DimensionInfo JSON): MemberDisplayMode
Returns the display mode for members of the dimension.
Parameters
Returns
MemberDisplayMode |
| getMembers | ||||||
|
getMembers(dimension: string | DimensionInfo JSON, options?: integer | MembersOptions JSON): MemberInfo[]
Returns the members of the dimension. If you specify a number, then at most this many members are returned (default: 200). If you specify members options, then you can control the returned set of members even finer. Note: If the hierarchy specified in the members options doesn't exist, then an empty array is returned. Note: If the data source is associated with an R visualization and you specify a hierarchy other than Alias.FlatHierarchy (flat presentation) in the members options, then an empty array is returned. Note: returns compounded displayId if available.
Parameters
Returns
MemberInfo[] |
| getResultMember | ||||||
|
getResultMember(dimension: string | DimensionInfo JSON, selection: Selection JSON): ResultMemberInfo
Returns the result member. It is specified by a dimension and a selection.
Parameters
Returns
ResultMemberInfo |
| getResultSet | |||||||||
|
getResultSet(selections?: Selection JSON | Selection[] JSON | SelectionContext JSON, offset?: integer, limit?: integer): ResultSet[]
Returns result sets. The result sets are specified by selections. Optionally, you can specify the offset and the limit, which must be zero or positive numbers. If no offset and limit are specified or are invalid, then a result set including all data is returned. See also the documentation of Selection or SelectionContext.
Parameters
Returns
ResultSet[] |
| 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[] |
| 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 JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable. 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
|
| setHierarchyLevel | ||||||
|
setHierarchyLevel(dimension: string | DimensionInfo JSON, level?: integer): void
Sets the hierarchy level of the dimension. If the dimension or the hierarchy level of the dimension is invalid, then this operation is ignored. The default value of the level is defined by the dimension's default level. For data sources associated with charts, the level value is optional.
Parameters
|
| setMemberDisplayMode | ||||||
|
setMemberDisplayMode(dimension: string | DimensionInfo JSON, displayMode: MemberDisplayMode): void
Sets the display mode for members of the dimension.
Parameters
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable. By default, this sets the variable value of the variable for the data source on the application. If you set the variable value of a variable for a data source of a widget that overrides variables, then this operation sets only the variable value for this widget. If you set an empty variable value to a mandatory variable, then this operation is ignored. If you set a variable value of a variable for a data source of a widget that overrides variables and the variable is of type text, then this operation is ignored. Note: The variable value will not be validated. Note: You can omit loading variable descriptions (which are displayed in the Prompt dialog and in dynamic texts) by setting the optional property loadDescriptions in the options to false.
Parameters
|
| Name and Description |
|
modelDescription: string
Description of the model |
|
modelId: string
ID of the model |
|
modelName: string
Name of the model |
|
sourceDescription: string
Description of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
|
sourceLastChangedBy: string
Name of the user who changed the SAP BW Query most recently (for SAP BW models) or undefined (for all other models) |
|
sourceLastRefreshedAt: Date
Date of the last data source refresh (for SAP BW models) or undefined (for all other models) |
|
sourceName: string
Name of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
| modelDescription |
| modelDescription: string Description of the model |
| modelId |
| modelId: string ID of the model |
| modelName |
| modelName: string Name of the model |
| sourceDescription |
| sourceDescription: string Description of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
| sourceLastChangedBy |
| sourceLastChangedBy: string Name of the user who changed the SAP BW Query most recently (for SAP BW models) or undefined (for all other models) |
| sourceLastRefreshedAt |
| sourceLastRefreshedAt: Date Date of the last data source refresh (for SAP BW models) or undefined (for all other models) |
| sourceName |
| sourceName: string Name of the SAP BW Query (for SAP BW models) or undefined (for all other models) |
| Name and Description |
|
static now(): integer
Returns the number of milliseconds elapsed since January 1, 1970, 00:00:00 UTC. |
|
static parse(source: string): integer
Parses a string representation of a date and returns the number of milliseconds since January 1, 1970, 00:00:00 UTC. |
|
static UTC(year: number, month: number, date: number, hour?: number, min?: number, sec?: number, ms?: number): integer
Returns the number of milliseconds in a date since January 1, 1970, 00:00:00 UTC. |
|
getDate(): integer
Returns the day of the month of the specified date according to local time (where 1 represents the first day of the month). |
|
getDay(): integer
Returns the day of the week of the specified date according to local time (where 0 represents Sunday). |
|
getFullYear(): integer
Returns the full year of the specified date according to local time. |
|
getHours(): integer
Returns the hour of the specified date according to local time. |
|
getMilliseconds(): number
Returns the milliseconds of the specified date according to local time. |
|
getMinutes(): integer
Returns the minutes of the specified date according to local time. |
|
getMonth(): integer
Returns the month of the specified date according to local time (where 0 represents the first month of the year). |
|
getSeconds(): integer
Returns the seconds of the specified date according to local time. |
|
getTime(): integer
Returns the numeric value corresponding to the time for the specified date according to universal time. |
|
getTimezoneOffset(): integer
Returns the time zone difference, in minutes, from the current locale to universal time. |
|
getUTCDate(): integer
Returns the day of the month of the specified date according to universal time (where 1 represents the first day of the month). |
|
getUTCDay(): integer
Returns the day of the week of the specified date according to universal time (where 0 represents Sunday). |
|
getUTCHours(): integer
Returns the hours of the specified date according to universal time. |
|
getUTCMilliseconds(): integer
Returns the milliseconds of the specified date according to universal time. |
|
getUTCMinutes(): integer
Returns the minutes of the specified date according to universal time. |
|
getUTCMonth(): integer
Returns the month of the specified date according to universal time (where 0 represents the first month of the year). |
|
getUTCSeconds(): integer
Returns the seconds of the specified date according to universal time. |
|
getYear(): integer
Returns the year of the specified date according to local time. |
|
setDate(day: number): integer
Sets the day of the month of a specified date according to local time (where 1 represents the first day of the month). |
|
setFullYear(year: number): integer
Sets the full year of a specified date according to local time. |
|
setHours(hour: number): integer
Sets the hours of a specified date according to local time. |
|
setMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to local time. |
|
setMinutes(min: number): integer
Sets the minutes of a specified date according to local time. |
|
setMonth(month: number): integer
Sets the month of a specified date according to local time (where 0 represents the first month of the year). |
|
setSeconds(sec: number): integer
Sets the seconds of a specified date according to local time. |
|
setTime(timeValue: integer): integer
Sets the date to the time represented by a number of milliseconds since January 1, 1970, 00:00:00 UTC. |
|
setUTCDate(day: number): integer
Sets the day of the month of a specified date according to universal time (where 1 represents the first day of the month). |
|
setUTCFullYear(year: number): integer
Sets the full year of a specified date according to universal time. |
|
setUTCHours(hour: number): integer
Sets the hour of a specified date according to universal time. |
|
setUTCMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to universal time. |
|
setUTCMinutes(min: number): integer
Sets the minutes of a specified date according to universal time. |
|
setUTCMonth(month: number): integer
Sets the month of a specified date according to universal time (where 0 represents the first month of the year). |
|
setUTCSeconds(sec: number): integer
Sets the seconds of a specified date according to universal time. |
|
toDateString(): string
Returns the "date" portion of a date in human readable form in American English. |
|
toISOString(): string
Converts a date to a string in ISO 8601 Extended Format. |
|
toJSON(): string
Returns a string (using toISOString()) representing the date's value. |
|
toLocaleDateString(): string
Converts a date to a string, returning the "date" portion using the operating system's locale conventions. |
|
toLocaleTimeString(): string
Converts a date to a string, returning the "time" portion using the operating system's locale conventions. |
|
toTimeString(): string
Returns the "time" portion of a date in human readable form in American English. |
|
toUTCString(): string
Converts a date to a string according to universal time. |
| UTC | |||||||||||||||||||||
|
static UTC(year: number, month: number, date: number, hour?: number, min?: number, sec?: number, ms?: number): integer
Returns the number of milliseconds in a date since January 1, 1970, 00:00:00 UTC.
Parameters
Returns
integer |
| now |
|
static now(): integer
Returns the number of milliseconds elapsed since January 1, 1970, 00:00:00 UTC.
Returns
integer |
| parse | |||
|
static parse(source: string): integer
Parses a string representation of a date and returns the number of milliseconds since January 1, 1970, 00:00:00 UTC.
Parameters
Returns
integer |
| getDate |
|
getDate(): integer
Returns the day of the month of the specified date according to local time (where 1 represents the first day of the month).
Returns
integer |
| getDay |
|
getDay(): integer
Returns the day of the week of the specified date according to local time (where 0 represents Sunday).
Returns
integer |
| getFullYear |
|
getFullYear(): integer
Returns the full year of the specified date according to local time.
Returns
integer |
| getHours |
|
getHours(): integer
Returns the hour of the specified date according to local time.
Returns
integer |
| getMilliseconds |
|
getMilliseconds(): number
Returns the milliseconds of the specified date according to local time.
Returns
number |
| getMinutes |
|
getMinutes(): integer
Returns the minutes of the specified date according to local time.
Returns
integer |
| getMonth |
|
getMonth(): integer
Returns the month of the specified date according to local time (where 0 represents the first month of the year).
Returns
integer |
| getSeconds |
|
getSeconds(): integer
Returns the seconds of the specified date according to local time.
Returns
integer |
| getTime |
|
getTime(): integer
Returns the numeric value corresponding to the time for the specified date according to universal time.
Returns
integer |
| getTimezoneOffset |
|
getTimezoneOffset(): integer
Returns the time zone difference, in minutes, from the current locale to universal time.
Returns
integer |
| getUTCDate |
|
getUTCDate(): integer
Returns the day of the month of the specified date according to universal time (where 1 represents the first day of the month).
Returns
integer |
| getUTCDay |
|
getUTCDay(): integer
Returns the day of the week of the specified date according to universal time (where 0 represents Sunday).
Returns
integer |
| getUTCHours |
|
getUTCHours(): integer
Returns the hours of the specified date according to universal time.
Returns
integer |
| getUTCMilliseconds |
|
getUTCMilliseconds(): integer
Returns the milliseconds of the specified date according to universal time.
Returns
integer |
| getUTCMinutes |
|
getUTCMinutes(): integer
Returns the minutes of the specified date according to universal time.
Returns
integer |
| getUTCMonth |
|
getUTCMonth(): integer
Returns the month of the specified date according to universal time (where 0 represents the first month of the year).
Returns
integer |
| getUTCSeconds |
|
getUTCSeconds(): integer
Returns the seconds of the specified date according to universal time.
Returns
integer |
| getYear |
|
getYear(): integer
Returns the year of the specified date according to local time.
Returns
integer |
| setDate | |||
|
setDate(day: number): integer
Sets the day of the month of a specified date according to local time (where 1 represents the first day of the month). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setFullYear | |||
|
setFullYear(year: number): integer
Sets the full year of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setHours | |||
|
setHours(hour: number): integer
Sets the hours of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setMilliseconds | |||
|
setMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setMinutes | |||
|
setMinutes(min: number): integer
Sets the minutes of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setMonth | |||
|
setMonth(month: number): integer
Sets the month of a specified date according to local time (where 0 represents the first month of the year). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setSeconds | |||
|
setSeconds(sec: number): integer
Sets the seconds of a specified date according to local time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setTime | |||
|
setTime(timeValue: integer): integer
Sets the date to the time represented by a number of milliseconds since January 1, 1970, 00:00:00 UTC.
Parameters
Returns
integer |
| setUTCDate | |||
|
setUTCDate(day: number): integer
Sets the day of the month of a specified date according to universal time (where 1 represents the first day of the month). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCFullYear | |||
|
setUTCFullYear(year: number): integer
Sets the full year of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCHours | |||
|
setUTCHours(hour: number): integer
Sets the hour of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCMilliseconds | |||
|
setUTCMilliseconds(ms: number): integer
Sets the milliseconds of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCMinutes | |||
|
setUTCMinutes(min: number): integer
Sets the minutes of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCMonth | |||
|
setUTCMonth(month: number): integer
Sets the month of a specified date according to universal time (where 0 represents the first month of the year). Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| setUTCSeconds | |||
|
setUTCSeconds(sec: number): integer
Sets the seconds of a specified date according to universal time. Returns the number of milliseconds between January 1, 1970, 00:00:00 UTC and the updated date.
Parameters
Returns
integer |
| toDateString |
|
toDateString(): string
Returns the "date" portion of a date in human readable form in American English.
Returns
string |
| toISOString |
|
toISOString(): string
Converts a date to a string in ISO 8601 Extended Format.
Returns
string |
| toJSON |
|
toJSON(): string
Returns a string (using toISOString()) representing the date's value.
Returns
string |
| toLocaleDateString |
|
toLocaleDateString(): string
Converts a date to a string, returning the "date" portion using the operating system's locale conventions.
Returns
string |
| toLocaleTimeString |
|
toLocaleTimeString(): string
Converts a date to a string, returning the "time" portion using the operating system's locale conventions.
Returns
string |
| toTimeString |
|
toTimeString(): string
Returns the "time" portion of a date in human readable form in American English.
Returns
string |
| toUTCString |
|
toUTCString(): string
Converts a date to a string according to universal time.
Returns
string |
| Name and Description |
|
static format(date: Date, pattern?: string): string
Returns a string representation of the date. |
| format | ||||||
|
static format(date: Date, pattern?: string): string
Returns a string representation of the date. Optionally, you can format the date by supplying a pattern in the Unicode Locale Data Markup Language (LDML) format. For example, with the English language set in the Profile Settings, a date representing March, 5, 2018 is formatted by the pattern "MMM dd, yyyy" as "Mar 05, 2018". Other common patterns include "yyyy/MM/dd" (resulting in "2018/03/05"), "yyyy-MM-dd" ("2018-03-05"), "yy/M/d" ("18/3/5"), "y/M/d" ("2018/3/5"), "MMM dd" ("Mar 05"), and "yyyy.QQQ" ("2018.Q1"). The letters in the patterns are case-sensitive and represent various aspects of a date. See the Date Field Symbol Table of the LDML format on the Internet for more details.
Parameters
Returns
string |
| Name and Description |
| description: string |
| id: string |
| modelId: string |
| Name and Description |
| description: string |
| id: string |
| Name and Description |
|
static Horizontal: Direction
Horizontal direction |
|
static Vertical: Direction
Vertical direction |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the dropdown. |
|
getSelectedKey(): string
Returns the key of the selected item in the dropdown. |
|
getSelectedText(): string
Returns the text of the selected item in the dropdown. |
|
removeAllItems(): void
Removes all items from the dropdown. |
|
removeItem(key: string): void
Removes an item from the dropdown. |
|
setSelectedKey(key: string): void
Selects an item in the dropdown. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user selects an item in the dropdown. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the dropdown. The item is specified by a key and an optional text. If the key or the text already exists, then this operation is ignored.
Parameters
|
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected item in the dropdown. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedText |
|
getSelectedText(): string
Returns the text of the selected item in the dropdown. If no item is selected, then undefined is returned.
Returns
string |
| removeAllItems |
| removeAllItems(): void Removes all items from the dropdown. |
| removeItem | |||
|
removeItem(key: string): void
Removes an item from the dropdown. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKey | |||
|
setSelectedKey(key: string): void
Selects an item in the dropdown. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| Name and Description |
|
exportReport(): void
Exports the included tables to an csv file. |
|
getFileName(): string
Returns the filename of the exported CSV file. |
|
getScope(): ExportScope
Returns the scope of the exported CSV file. |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported CSV file. |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported CSV file. |
|
isExportFormattedValues(): boolean
Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application. |
|
isHierarchyLevelsInIndividualCells(): boolean
Returns whether hierarchy levels are exported in individual columns. |
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported CSV file. |
|
setDateIncluded(included: boolean): void
Includes or excludes the date info in appendix of the exported CSV file. |
|
setExportFormattedValues(exportFormattedValues: boolean): void
Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application. |
|
setFileName(text: string): void
Sets the filename of the exported CSV file. |
|
setHierarchyLevelsInIndividualCells(separate: boolean): void
Specifies whether hierarchy levels are exported in individual columns. |
|
setScope(scope: ExportScope): void
Sets the scope of the exported CSV file. |
|
setWidget(table: Table): void
Sets the table of the exported CSV file. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| exportReport |
|
exportReport(): void
Exports the included tables to an csv file.
Mobile Support
Not supported on mobile devices.
|
| getFileName |
|
getFileName(): string
Returns the filename of the exported CSV file.
Returns
string |
| getScope |
|
getScope(): ExportScope
Returns the scope of the exported CSV file.
Returns
ExportScope |
| isAppendixIncluded |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported CSV file.
Returns
boolean |
| isDateIncluded |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported CSV file.
Returns
boolean |
| isExportFormattedValues |
|
isExportFormattedValues(): boolean
Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
Returns
boolean |
| isHierarchyLevelsInIndividualCells |
|
isHierarchyLevelsInIndividualCells(): boolean
Returns whether hierarchy levels are exported in individual columns.
Returns
boolean |
| setAppendixIncluded | |||
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported CSV file.
Parameters
|
| setDateIncluded | |||
|
setDateIncluded(included: boolean): void
Includes or excludes the date info in appendix of the exported CSV file.
Parameters
|
| setExportFormattedValues | |||
|
setExportFormattedValues(exportFormattedValues: boolean): void
Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
Parameters
|
| setFileName | |||
|
setFileName(text: string): void
Sets the filename of the exported CSV file.
Parameters
|
| setHierarchyLevelsInIndividualCells | |||
|
setHierarchyLevelsInIndividualCells(separate: boolean): void
Specifies whether hierarchy levels are exported in individual columns.
Parameters
|
| setScope | |||
|
setScope(scope: ExportScope): void
Sets the scope of the exported CSV file.
Parameters
|
| setWidget | |||
|
setWidget(table: Table): void
Sets the table of the exported CSV file.
Parameters
|
| Name and Description |
|
exportReport(): void
Exports the included tables to an XLSX file. |
|
getFileName(): string
Returns the filename of the exported XLSX file. |
|
getScope(): ExportScope
Returns the scope of the exported XLSX file. |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported XLSX file. |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported XLSX file. |
|
isExportFormattedValues(): boolean
Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application. |
|
isIndentedHierarchy(): boolean
Returns whether to indent hierarchical data labels (row headers). |
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported XLSX file. |
|
setDateIncluded(date: boolean): void
Includes or excludes the date info in appendix of the exported XLSX file. |
|
setExportFormattedValues(exportFormattedValues: boolean): void
Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application. |
|
setFileName(text: string): void
Sets the filename of the exported XLSX file. |
|
setIndentedHierarchy(indentedHierarchy: boolean): void
Specifies whether to indent hierarchical data labels (row headers). |
|
setScope(scope: ExportScope): void
Sets the scope of the exported XLSX file. |
|
setWidget(table: Table | Table[]): void
Sets the tables of the exported XLSX file. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| exportReport |
|
exportReport(): void
Exports the included tables to an XLSX file.
Mobile Support
Not supported on mobile devices.
|
| getFileName |
|
getFileName(): string
Returns the filename of the exported XLSX file.
Returns
string |
| getScope |
|
getScope(): ExportScope
Returns the scope of the exported XLSX file.
Returns
ExportScope |
| isAppendixIncluded |
|
isAppendixIncluded(): boolean
Returns whether the table metadata is included in the exported XLSX file.
Returns
boolean |
| isDateIncluded |
|
isDateIncluded(): boolean
Returns whether the date info is included in the appendix of the exported XLSX file.
Returns
boolean |
| isExportFormattedValues |
|
isExportFormattedValues(): boolean
Returns whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
Returns
boolean |
| isIndentedHierarchy |
|
isIndentedHierarchy(): boolean
Returns whether to indent hierarchical data labels (row headers).
Returns
boolean |
| setAppendixIncluded | |||
|
setAppendixIncluded(included: boolean): void
Includes or excludes the table metadata from the exported XLSX file.
Parameters
|
| setDateIncluded | |||
|
setDateIncluded(date: boolean): void
Includes or excludes the date info in appendix of the exported XLSX file.
Parameters
|
| setExportFormattedValues | |||
|
setExportFormattedValues(exportFormattedValues: boolean): void
Specifies whether the data values are exported using the same scaling, units, and currencies as in the model and in the analytic application.
Parameters
|
| setFileName | |||
|
setFileName(text: string): void
Sets the filename of the exported XLSX file.
Parameters
|
| setIndentedHierarchy | |||
|
setIndentedHierarchy(indentedHierarchy: boolean): void
Specifies whether to indent hierarchical data labels (row headers).
Parameters
|
| setScope | |||
|
setScope(scope: ExportScope): void
Sets the scope of the exported XLSX file.
Parameters
|
| setWidget | |||
|
setWidget(table: Table | Table[]): void
Sets the tables of the exported XLSX file.
Parameters
|
| Name and Description |
|
exportView(): boolean
Exports the story to a PDF file. |
|
getDateLocation(): PageDateLocation
Returns the location of the date in the exported PDF file. |
|
getFileName(): string
Returns the filename of the exported PDF file. |
|
getFooterText(): string
Returns the text shown in the page footer of the exported PDF file. |
|
getHeaderText(): string
Returns the text shown in the page header of the exported PDF file. |
|
getPageNumberLocation(): PageNumberLocation
Returns the location of the page number in the exported PDF file. |
|
getPageOrientation(): PageOrientation
Returns the page orientation of the exported PDF file. |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PDF. |
|
getPageSize(): PageSize
Returns the page size of the exported PDF file. |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported PDF file. |
|
isFooterVisible(): boolean
Returns whether the page footer is visible in the exported PDF file. |
|
isHeaderVisible(): boolean
Returns whether the page header is visible in the exported PDF file. |
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported PDF file. |
|
setDateLocation(location: PageDateLocation): void
Sets the location of the date in the exported PDF file. |
|
setFileName(fileName: string): void
Sets the filename of the exported PDF file. |
|
setFooterText(text: string): void
Sets the text shown in the page footer of the exported PDF file. |
|
setFooterVisible(visible: boolean): void
Shows or hides the page footer in the exported PDF file. |
|
setHeaderText(text: string): void
Sets the text shown in the page header of the exported PDF file. |
|
setHeaderVisible(visible: boolean): void
Shows or hides the page header in the exported PDF file. |
|
setPageNumberLocation(location: PageNumberLocation): void
Sets the location of the page number in the exported PDF file. |
|
setPageOrientation(orientation: PageOrientation): void
Sets the page orientation of the exported PDF file. |
|
setPageRange(value: number[]): void
Sets the pages to be exported to PDF. |
|
setPageSize(size: PageSize): void
Sets the page size of the exported PDF file. |
| exportView |
|
exportView(): boolean
Exports the story to a PDF file.
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| getDateLocation |
|
getDateLocation(): PageDateLocation
Returns the location of the date in the exported PDF file.
Returns
PageDateLocation |
| getFileName |
|
getFileName(): string
Returns the filename of the exported PDF file.
Returns
string |
| getFooterText |
|
getFooterText(): string
Returns the text shown in the page footer of the exported PDF file.
Returns
string |
| getHeaderText |
|
getHeaderText(): string
Returns the text shown in the page header of the exported PDF file.
Returns
string |
| getPageNumberLocation |
|
getPageNumberLocation(): PageNumberLocation
Returns the location of the page number in the exported PDF file.
Returns
PageNumberLocation |
| getPageOrientation |
|
getPageOrientation(): PageOrientation
Returns the page orientation of the exported PDF file.
Returns
PageOrientation |
| getPageRange |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PDF.
Returns
number[] |
| getPageSize |
|
getPageSize(): PageSize
Returns the page size of the exported PDF file.
Returns
PageSize |
| isAppendixVisible |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported PDF file.
Returns
boolean |
| isFooterVisible |
|
isFooterVisible(): boolean
Returns whether the page footer is visible in the exported PDF file.
Returns
boolean |
| isHeaderVisible |
|
isHeaderVisible(): boolean
Returns whether the page header is visible in the exported PDF file.
Returns
boolean |
| setAppendixVisible | |||
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported PDF file.
Parameters
|
| setDateLocation | |||
|
setDateLocation(location: PageDateLocation): void
Sets the location of the date in the exported PDF file.
Parameters
|
| setFileName | |||
|
setFileName(fileName: string): void
Sets the filename of the exported PDF file.
Parameters
|
| setFooterText | |||
|
setFooterText(text: string): void
Sets the text shown in the page footer of the exported PDF file.
Parameters
|
| setFooterVisible | |||
|
setFooterVisible(visible: boolean): void
Shows or hides the page footer in the exported PDF file.
Parameters
|
| setHeaderText | |||
|
setHeaderText(text: string): void
Sets the text shown in the page header of the exported PDF file.
Parameters
|
| setHeaderVisible | |||
|
setHeaderVisible(visible: boolean): void
Shows or hides the page header in the exported PDF file.
Parameters
|
| setPageNumberLocation | |||
|
setPageNumberLocation(location: PageNumberLocation): void
Sets the location of the page number in the exported PDF file.
Parameters
|
| setPageOrientation | |||
|
setPageOrientation(orientation: PageOrientation): void
Sets the page orientation of the exported PDF file.
Parameters
|
| setPageRange | |||
|
setPageRange(value: number[]): void
Sets the pages to be exported to PDF. All pages are exported if you don’t specify the page numbers. Page number starts from 1.
Parameters
|
| setPageSize | |||
|
setPageSize(size: PageSize): void
Sets the page size of the exported PDF file.
Parameters
|
| Name and Description |
|
exportView(): boolean
Exports the story to a power point file. |
|
getFileName(): string
Returns the filename of the exported power point file. |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PPTX. |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported power point file. |
|
isDateIncluded(): boolean
Returns whether date is included in the appendix of the exported power point file. |
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported power point file. |
|
setDateIncluded(included: boolean): void
Includes or excludes date in the appendix of the exported power point file. |
|
setFileName(fileName: string): void
Sets the filename of the exported power point file. |
|
setPageRange(value: number[]): void
Sets the pages to be exported to PPTX. |
| exportView |
|
exportView(): boolean
Exports the story to a power point file.
Returns
boolean
Mobile Support
Not supported on mobile devices.
|
| getFileName |
|
getFileName(): string
Returns the filename of the exported power point file.
Returns
string |
| getPageRange |
|
getPageRange(): number[]
Returns the numbers of the pages to be exported to PPTX.
Returns
number[] |
| isAppendixVisible |
|
isAppendixVisible(): boolean
Returns whether the appendix is visible in the exported power point file.
Returns
boolean |
| isDateIncluded |
|
isDateIncluded(): boolean
Returns whether date is included in the appendix of the exported power point file.
Returns
boolean |
| setAppendixVisible | |||
|
setAppendixVisible(visible: boolean): void
Shows or hides the appendix in the exported power point file.
Parameters
|
| setDateIncluded | |||
|
setDateIncluded(included: boolean): void
Includes or excludes date in the appendix of the exported power point file.
Parameters
|
| setFileName | |||
|
setFileName(fileName: string): void
Sets the filename of the exported power point file.
Parameters
|
| setPageRange | |||
|
setPageRange(value: number[]): void
Sets the pages to be exported to PPTX. All pages are exported if you don’t specify the page numbers. Page number starts from 1.
Parameters
|
| Name and Description |
|
static All: ExportScope
Export scope of "All" |
|
static PointOfView: ExportScope
Export scope of "Point of View" |
| All |
| static All: ExportScope Export scope of "All" |
| PointOfView |
| static PointOfView: ExportScope Export scope of "Point of View" |
| Name and Description |
|
static BubbleWidth: Feed
The "BubbleWidth" feed |
|
static CategoryAxis: Feed
The "CategoryAxis" feed |
|
static CategoryAxis2: Feed
The "CategoryAxis2" feed |
|
static Color: Feed
The "Color" feed |
|
static CrossCalculations: Feed
The "CrossCalculations" feed |
|
static DataContext: Feed
The "DataContext" feed |
|
static DataContext2: Feed
The "DataContext2" feed |
|
static Pattern: Feed
The "Pattern" feed |
|
static Pattern2: Feed
The "Pattern2" feed |
|
static Size: Feed
The "Size" feed |
|
static TimeAxis: Feed
The "TimeAxis" feed |
|
static Title: Feed
The "Title" feed |
|
static TooltipCategoryAxis: Feed
The "TooltipCategoryAxis" feed |
|
static TooltipValueAxis: Feed
The "TooltipValueAxis" feed |
|
static Trellis: Feed
The "Trellis" feed |
|
static ValueAxis: Feed
The "ValueAxis" feed |
|
static ValueAxis2: Feed
The "ValueAxis2" feed |
|
static Weight: Feed
The "Weight" feed |
| BubbleWidth |
| static BubbleWidth: Feed The "BubbleWidth" feed |
| CategoryAxis |
| static CategoryAxis: Feed The "CategoryAxis" feed |
| CategoryAxis2 |
| static CategoryAxis2: Feed The "CategoryAxis2" feed |
| Color |
| static Color: Feed The "Color" feed |
| CrossCalculations |
| static CrossCalculations: Feed The "CrossCalculations" feed |
| DataContext |
| static DataContext: Feed The "DataContext" feed |
| DataContext2 |
| static DataContext2: Feed The "DataContext2" feed |
| Pattern |
| static Pattern: Feed The "Pattern" feed |
| Pattern2 |
| static Pattern2: Feed The "Pattern2" feed |
| Size |
| static Size: Feed The "Size" feed |
| TimeAxis |
| static TimeAxis: Feed The "TimeAxis" feed |
| Title |
| static Title: Feed The "Title" feed |
| TooltipCategoryAxis |
| static TooltipCategoryAxis: Feed The "TooltipCategoryAxis" feed |
| TooltipValueAxis |
| static TooltipValueAxis: Feed The "TooltipValueAxis" feed |
| Trellis |
| static Trellis: Feed The "Trellis" feed |
| ValueAxis |
| static ValueAxis: Feed The "ValueAxis" feed |
| ValueAxis2 |
| static ValueAxis2: Feed The "ValueAxis2" feed |
| Weight |
| static Weight: Feed The "Weight" feed |
| Name and Description |
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. |
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable on the story. |
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. |
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable on the story. |
|
setDimensionFilterWithHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. |
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable on the story. |
| getDimensionFilters | |||
|
getDimensionFilters(dimension: string | DimensionInfo JSON): FilterValue[]
Returns the dimension filters. They don't contain Advanced Filters. Note: Currently, they don't contain time range filters.
Parameters
Returns
FilterValue[] |
| getVariableValues | |||
|
getVariableValues(variable: string | VariableInfo): VariableValue[]
Returns the values of the variable on the story. Each value can be a single, multiple, or range variable value. To access its type-specific properties, cast the value to the corresponding value type based on the "type" property, using the global cast function.
Parameters
Returns
VariableValue[] |
| removeDimensionFilter | |||
|
removeDimensionFilter(dimension: string | DimensionInfo JSON): void
Removes any filter that is set on the dimension. Advanced Filters aren't affected.
Parameters
|
| removeVariableValue | |||
|
removeVariableValue(variable: string | VariableInfo): void
Removes the value of the variable on the story. This removes the variable value of the variable for the data source on the story.
Parameters
|
| setDimensionFilterWithHierarchy | |||||||||
|
setDimensionFilterWithHierarchy(dimension: string | DimensionInfo JSON, hierarchy: string | HierarchyInfo JSON, member: string | string[] | MemberInfo JSON | MemberInfo[] JSON | TimeRange | TimeRange[] | FilterValue JSON | RangeFilterValue[] JSON): void
Sets a filter on the dimension. Any existing filter (except Advanced Filters) on the dimension is overwritten. For most dimensions, you can specify one or multiple members to be included or excluded in the filter. For date- and time-based dimensions, you can specify one or more time ranges to be included in the filter. For numeric dimensions, you can specify one or more filter ranges to be included in the filter. The specified members need to be part of the hierarchy.
Parameters
|
| setVariableValue | |||||||||
|
setVariableValue(variable: string | VariableInfo, variableValue: string | number | VariableValue JSON | VariableValue[] JSON, options?: SetVariableValueOptions JSON): void
Sets the value of the variable on the story. If you set an empty variable value to a mandatory variable, then this operation is ignored. Note: The variable value will not be validated.
Parameters
|
| Name and Description |
|
type: FilterValueType
Type of the filter value |
| Name and Description |
|
static Multiple: FilterValueType
An object representing multiple filter values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
|
static Range: FilterValueType
An object representing a range of filter values from dimension members, like: {<operator>: '<memberId>'}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
|
static Single: FilterValueType
An object representing a single filter value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Multiple |
| static Multiple: FilterValueType An object representing multiple filter values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
| Range |
| static Range: FilterValueType An object representing a range of filter values from dimension members, like: {<operator>: '<memberId>'}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
| Single |
| static Single: FilterValueType An object representing a single filter value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Name and Description |
|
fiscalDay: integer
fiscalDay |
|
fiscalQuarter: integer
fiscalQuarter |
|
fiscalYear: integer
fiscalYear |
|
granularity: FiscalTimeGranularity
granularity |
|
period: integer
period |
| fiscalDay |
| fiscalDay: integer fiscalDay |
| fiscalQuarter |
| fiscalQuarter: integer fiscalQuarter |
| fiscalYear |
| fiscalYear: integer fiscalYear |
| granularity |
| granularity: FiscalTimeGranularity granularity |
| period |
| period: integer period |
| Name and Description |
|
static FiscalDay: FiscalTimeGranularity
fiscal days |
|
static FiscalQuarter: FiscalTimeGranularity
fiscal quarters |
|
static FiscalYear: FiscalTimeGranularity
fiscal years |
|
static Period: FiscalTimeGranularity
fiscal periods |
| FiscalDay |
| static FiscalDay: FiscalTimeGranularity fiscal days |
| FiscalQuarter |
| static FiscalQuarter: FiscalTimeGranularity fiscal quarters |
| FiscalYear |
| static FiscalYear: FiscalTimeGranularity fiscal years |
| Period |
| static Period: FiscalTimeGranularity fiscal periods |
| Name and Description |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
static Auto: ForecastType
The forecast is performed on the available data. |
|
static None: ForecastType
No forecast is performed. |
|
static TripleExponentialSmoothing: ForecastType
The forecast is performed using the Triple Exponential Smoothing algorithm to account for seasonal changes as well as trends. |
| Auto |
| static Auto: ForecastType The forecast is performed on the available data. |
| None |
| static None: ForecastType No forecast is performed. |
| TripleExponentialSmoothing |
| static TripleExponentialSmoothing: ForecastType The forecast is performed using the Triple Exponential Smoothing algorithm to account for seasonal changes as well as trends. |
| Name and Description |
|
getLayer(index: integer): GeoMapLayer
Returns the layer. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setQuickActionsVisibility(quickActionsVisibility: GeoMapQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| getLayer | |||
|
getLayer(index: integer): GeoMapLayer
Returns the layer. The layer is specified by an index.
Parameters
Returns
GeoMapLayer
Mobile Support
Not supported on mobile devices.
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
|
| setQuickActionsVisibility | |||
|
setQuickActionsVisibility(quickActionsVisibility: GeoMapQuickActionsVisibility): void
Shows or hides Quick Actions specified by the Quick Actions visibility.
Parameters
Mobile Support
Not supported on mobile devices.
|
| Name and Description |
|
getDataSource(): DataSource(GeoMapLayer)
(Only available in optimized view mode) Returns the data source of the layer. |
|
getSelections(): Selection[]
Returns the selections of the layer. |
|
isVisible(): boolean
Returns whether the layer is visible. |
|
setVisible(visible: boolean): void
Shows or hides the layer. |
| getDataSource |
|
getDataSource(): DataSource(GeoMapLayer)
(Only available in optimized view mode) Returns the data source of the layer.
Returns
DataSource(GeoMapLayer) |
| getSelections |
|
getSelections(): Selection[]
Returns the selections of the layer. The API only works for the geo map bubble layer with a dimension as the bubble color. Otherwise, it returns an empty array. You can use the elements of the returned array with DataSource.getData() to get the value of a cell. See also the documentation of Selection.
Returns
Selection[] |
| isVisible |
|
isVisible(): boolean
Returns whether the layer is visible.
Returns
boolean |
| setVisible | |||
|
setVisible(visible: boolean): void
Shows or hides the layer.
Parameters
|
| Name and Description |
|
static addComment: boolean
Comment |
|
static drill: boolean
Drill |
|
static filter: boolean
Filter/Exclude |
|
static fullscreen: boolean
Fullscreen |
|
static geomapDetail: boolean
Applied to Geomap |
|
static ranking: boolean
Ranking |
| Name and Description |
| description: string |
| id: string |
| Name and Description |
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the image will navigate to when clicked. |
|
setImage(url: string): void
Sets the URL of the image. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the image. |
|
onLongPress(): void Called when the user presses and holds the image. |
| Name and Description |
|
getInputControlDataSource(): InputControlDataSource
Returns the data source of input control widget |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user changes the selections on the input control. |
| getInputControlDataSource |
|
getInputControlDataSource(): InputControlDataSource
Returns the data source of input control widget
Returns
InputControlDataSource |
| Name and Description |
|
getActiveSelectedMembers(options?: integer): MemberInfo[]
Returns the active selected dimension members. |
|
getActiveSelectedMembersWithUnbooked(options?: integer | ActiveSelectedMembersOptions JSON): MemberInfo[]
Returns the active selected dimension members on the input control, including unbooked ones. |
|
isAllMembersSelected(): boolean
Returns whether all members have been selected on the input control. |
|
setAllMembersSelected(): void
Selects all members on the input control. |
|
setSelectedMembers(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control. |
|
setSelectedMembersWithUnbooked(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control, including unbooked ones. |
| getActiveSelectedMembers | |||
|
getActiveSelectedMembers(options?: integer): MemberInfo[]
Returns the active selected dimension members. You can define how many members are returned at most. By default it's 100 if not specified. Note: Not supported for input controls that display all available members including unbooked ones. Not supported for range filters and advanced filters. Not supported for members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting. Note: Please consider the performance impact when using this API. Always try to use it on input controls with low cardinality dimensions, or turn on cascading effect to narrow down the dimension members on input controls.
Parameters
Returns
MemberInfo[] |
| getActiveSelectedMembersWithUnbooked | |||
|
getActiveSelectedMembersWithUnbooked(options?: integer | ActiveSelectedMembersOptions JSON): MemberInfo[]
Returns the active selected dimension members on the input control, including unbooked ones. To use this API, ensure that the input control is either dimension member or calculation input control, and cascading effect off. Other types such as range filters aren't supported. Members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting aren’t supported. You can limit the number of returned members (by default 100). Be mindful of performance impacts on high cardinality dimensions.
Parameters
Returns
MemberInfo[] |
| isAllMembersSelected |
|
isAllMembersSelected(): boolean
Returns whether all members have been selected on the input control. Note: Not supported for excluded members, range filters and advanced filters.
Returns
boolean |
| setAllMembersSelected |
| setAllMembersSelected(): void Selects all members on the input control. Note: Not supported for excluded members, range filters and advanced filters. |
| setSelectedMembers | |||
|
setSelectedMembers(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control. The dimension members should be from the selected members configured at design time. Note: Not supported for input controls that display all available members including unbooked ones. Not supported for range filters and advanced filters. Not supported for members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting.
Parameters
|
| setSelectedMembersWithUnbooked | |||
|
setSelectedMembersWithUnbooked(member: string | string[] | MemberInfo JSON | MemberInfo[] JSON): void
Sets dimension members on the input control, including unbooked ones. To use this API, ensure that the input control is either dimension member or calculation input control, and cascading effect off. Other types such as range filters aren't supported. Members excluded via “Exclude selected members”, or selecting “All Members” and then deselecting aren’t supported. The dimension members should be from the selected members configured at design time.
Parameters
|
| Name and Description |
|
getValue(): string
Returns the value of the input field. |
|
isEditable(): boolean
Returns whether the input field is editable. |
|
isEnabled(): boolean
Returns whether the input field is enabled. |
|
setEditable(editable: boolean): void
Enables or disables editing of the input field. |
|
setEnabled(enabled: boolean): void
Enables or disables the input field. |
|
setStyle(style: InputFieldStyle JSON): void
Applies the style to the input field. |
|
setValue(value: string): void
Sets the value of the input field. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the input field doesn't have the focus anymore, for example, after the user has entered text and pressed the "Enter" key. |
| getValue |
|
getValue(): string
Returns the value of the input field.
Returns
string |
| isEditable |
|
isEditable(): boolean
Returns whether the input field is editable.
Returns
boolean |
| isEnabled |
|
isEnabled(): boolean
Returns whether the input field is enabled.
Returns
boolean |
| setEditable | |||
|
setEditable(editable: boolean): void
Enables or disables editing of the input field.
Parameters
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the input field.
Parameters
|
| setStyle | |||
|
setStyle(style: InputFieldStyle JSON): void
Applies the style to the input field. You can also pass a JSON object for the style argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
|
| setValue | |||
|
setValue(value: string): void
Sets the value of the input field.
Parameters
|
| Name and Description |
|
backgroundColor: string
Background color of the input field |
|
borderColor: string
Border color of the input field |
|
color: string
Font color of the input field |
| Name and Description |
|
getBottom(): LayoutValue
Returns the bottom margin between the widget and the widget's parent container. |
|
getHeight(): LayoutValue
Returns the height of the widget. |
|
getLeft(): LayoutValue
Returns the left margin between the widget and the widget's parent container. |
|
getRight(): LayoutValue
Returns the right margin between the widget and the widget's parent container. |
|
getTop(): LayoutValue
Returns the top margin between the widget and the widget's parent container. |
|
getWidth(): LayoutValue
Returns the width of the widget. |
|
setBottom(value: LayoutValue | integer): void
Sets the bottom margin between the widget and the widget's parent container. |
|
setHeight(value: LayoutValue | integer): void
Sets the height of the widget. |
|
setLeft(value: LayoutValue | integer): void
Sets the left margin between the widget and the widget's parent container. |
|
setRight(value: LayoutValue | integer): void
Sets the right margin between the widget and the widget's parent container. |
|
setTop(value: LayoutValue | integer): void
Sets the top margin between the widget and the widget's parent container. |
|
setWidth(value: LayoutValue | integer): void
Sets the width of the widget. |
| getBottom |
|
getBottom(): LayoutValue
Returns the bottom margin between the widget and the widget's parent container.
Returns
LayoutValue |
| getHeight |
|
getHeight(): LayoutValue
Returns the height of the widget.
Returns
LayoutValue |
| getLeft |
|
getLeft(): LayoutValue
Returns the left margin between the widget and the widget's parent container.
Returns
LayoutValue |
| getRight |
|
getRight(): LayoutValue
Returns the right margin between the widget and the widget's parent container.
Returns
LayoutValue |
| getTop |
|
getTop(): LayoutValue
Returns the top margin between the widget and the widget's parent container.
Returns
LayoutValue |
| getWidth |
|
getWidth(): LayoutValue
Returns the width of the widget.
Returns
LayoutValue |
| setBottom | |||
|
setBottom(value: LayoutValue | integer): void
Sets the bottom margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.
Parameters
|
| setHeight | |||
|
setHeight(value: LayoutValue | integer): void
Sets the height of the widget. If you specify an integer, then pixel units are used.
Parameters
|
| setLeft | |||
|
setLeft(value: LayoutValue | integer): void
Sets the left margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.
Parameters
|
| setRight | |||
|
setRight(value: LayoutValue | integer): void
Sets the right margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.
Parameters
|
| setTop | |||
|
setTop(value: LayoutValue | integer): void
Sets the top margin between the widget and the widget's parent container. If you specify an integer, then pixel units are used.
Parameters
|
| setWidth | |||
|
setWidth(value: LayoutValue | integer): void
Sets the width of the widget. If you specify an integer, then pixel units are used.
Parameters
|
| Name and Description |
| static Auto: LayoutUnit |
| static Grid: LayoutUnit |
| static Percent: LayoutUnit |
| static Pixel: LayoutUnit |
| Auto |
| static Auto: LayoutUnit |
| Grid |
| static Grid: LayoutUnit |
| Percent |
| static Percent: LayoutUnit |
| Pixel |
| static Pixel: LayoutUnit |
| Name and Description |
| static Auto: LayoutValue |
| Name and Description |
|
static create(value: number, unit: LayoutUnit): LayoutValue
Creates a Unit with a value and type. |
| create | ||||||
|
static create(value: number, unit: LayoutUnit): LayoutValue
Creates a Unit with a value and type.
Parameters
Returns
LayoutValue |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the list box. |
|
getSelectedKey(): string
Returns the key of the selected item in the list box. |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the list box. |
|
getSelectedText(): string
Returns the text of the selected item in the list box. |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the list box. |
|
removeAllItems(): void
Removes all items from the list box. |
|
removeItem(key: string): void
Removes an item from the list box. |
|
setSelectedKey(key: string): void
Selects an item in the list box. |
|
setSelectedKeys(keys: string[]): void
Selects items in the list box. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user selects an item in the list box. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the list box. The item is specified by a key and an optional text. If the key or the text already exists, then this operation is ignored.
Parameters
|
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected item in the list box. If the list box allows multiple selections, then the key of the first selected item is returned. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedKeys |
|
getSelectedKeys(): string[]
Returns the keys of the selected items in the list box. If no items are selected, then an empty array is returned.
Returns
string[] |
| getSelectedText |
|
getSelectedText(): string
Returns the text of the selected item in the list box. If the list box allows multiple selections, then the text of the first selected item is returned. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedTexts |
|
getSelectedTexts(): string[]
Returns the texts of the selected items in the list box. If no items are selected, then an empty array is returned.
Returns
string[] |
| removeAllItems |
| removeAllItems(): void Removes all items from the list box. |
| removeItem | |||
|
removeItem(key: string): void
Removes an item from the list box. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKey | |||
|
setSelectedKey(key: string): void
Selects an item in the list box. The item is specified by its key. If the key isn't present in the list box, then nothing is selected.
Parameters
|
| setSelectedKeys | |||
|
setSelectedKeys(keys: string[]): void
Selects items in the list box. The items are specified by their keys. If the list box allows only a single selection, then the first of the specified keys is selected that is present in the list box. If the keys aren't present in the list box, then nothing is selected.
Parameters
|
| Name and Description |
|
static E: number
Euler's constant and the base of natural logarithms, approximately 2.718. |
|
static LN10: number
Natural logarithm of 10, approximately 2.302. |
|
static LN2: number
Natural logarithm of 2, approximately 0.693. |
|
static LOG10E: number
Base 10 logarithm of E, approximately 0.434. |
|
static LOG2E: number
Base 2 logarithm of E, approximately 1.443. |
|
static PI: number
Ratio of the circumference of a circle to its diameter, approximately 3.14159. |
|
static SQRT1_2: number
Square root of 1/2; equivalently, 1 over the square root of 2, approximately 0.707. |
|
static SQRT2: number
Square root of 2, approximately 1.414. |
| Name and Description |
|
static abs(x: number): number
Returns the absolute value of a number. |
|
static acos(x: number): number
Returns the arccosine (in radians) of a number. |
|
static acosh(x: number): number
Returns the hyperbolic arccosine of a number. |
|
static asin(x: number): number
Returns the arcsine (in radians) of a number. |
|
static asinh(x: number): number
Returns the hyperbolic arcsine of a number. |
|
static atan(x: number): number
Returns the arctangent (in radians) of a number. |
|
static atan2(y: number, x: number): number
Returns the arctangent of the quotient y/x. |
|
static atanh(x: number): number
Returns the hyperbolic arctangent of a number. |
|
static cbrt(x: number): number
Returns the cube root of a number. |
|
static ceil(x: number): integer
Returns the smallest integer greater than or equal to a number. |
|
static clz32(x: number): integer
Returns the number of leading zero bits in the 32-bit binary representation of a number. |
|
static cos(x: number): number
Returns the cosine of a number. |
|
static cosh(x: number): number
Returns the hyperbolic cosine of a number. |
|
static exp(x: number): number
Returns E to the power of x, where E is Euler's constant, the base of the natural logarithm. |
|
static expm1(x: number): number
Returns exp(x) - 1. |
|
static floor(x: number): integer
Returns the largest integer less than or equal to a number. |
|
static fround(x: number): integer
Returns the nearest single precision float representation of a number. |
|
static hypot(value: number): number
Returns the square root of the sum of squares of its arguments. |
|
static imul(a: number, b: number): integer
Returns the result of a 32-bit integer multiplication. |
|
static log(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of a number. |
|
static log10(x: number): number
Returns the base 10 logarithm of a number. |
|
static log1p(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of 1 + x. |
|
static log2(x: number): number
Returns the base 2 logarithm of a number. |
|
static max(a: number, a: number): number
Returns the largest of zero or more numbers. |
|
static min(a: number, b: number): number
Returns the smallest of zero or more numbers. |
|
static pow(base: number, exponent: number): number
Returns base to the power of exponent, that is, base^exponent. |
|
static random(): number
Returns a floating-point pseudo-random number in the range [0, 1), that is, from 0 (inclusive) up to but not including 1 (exclusive). |
|
static round(x: number): integer
Returns the value of a number rounded to the nearest integer. |
|
static sign(x: number): integer
Returns the sign of a number, indicating whether the number is positive, negative, or zero. |
|
static sin(x: number): number
Returns the sine of a number. |
|
static sinh(x: number): number
Returns the hyperbolic sine of a number. |
|
static sqrt(x: number): number
Returns the square root of a number. |
|
static tan(x: number): number
Returns the tangent of a number. |
|
static tanh(x: number): number
Returns the hyperbolic tangent of a number. |
|
static trunc(x: number): integer
Returns the integer part of a number, removing any fractional digits. |
| E |
| static E: number Euler's constant and the base of natural logarithms, approximately 2.718. |
| LN10 |
| static LN10: number Natural logarithm of 10, approximately 2.302. |
| LN2 |
| static LN2: number Natural logarithm of 2, approximately 0.693. |
| LOG10E |
| static LOG10E: number Base 10 logarithm of E, approximately 0.434. |
| LOG2E |
| static LOG2E: number Base 2 logarithm of E, approximately 1.443. |
| PI |
| static PI: number Ratio of the circumference of a circle to its diameter, approximately 3.14159. |
| SQRT1_2 |
| static SQRT1_2: number Square root of 1/2; equivalently, 1 over the square root of 2, approximately 0.707. |
| SQRT2 |
| static SQRT2: number Square root of 2, approximately 1.414. |
| abs | |||
|
static abs(x: number): number
Returns the absolute value of a number.
Parameters
Returns
number |
| acos | |||
|
static acos(x: number): number
Returns the arccosine (in radians) of a number.
Parameters
Returns
number |
| acosh | |||
|
static acosh(x: number): number
Returns the hyperbolic arccosine of a number.
Parameters
Returns
number |
| asin | |||
|
static asin(x: number): number
Returns the arcsine (in radians) of a number.
Parameters
Returns
number |
| asinh | |||
|
static asinh(x: number): number
Returns the hyperbolic arcsine of a number.
Parameters
Returns
number |
| atan | |||
|
static atan(x: number): number
Returns the arctangent (in radians) of a number.
Parameters
Returns
number |
| atan2 | ||||||
|
static atan2(y: number, x: number): number
Returns the arctangent of the quotient y/x.
Parameters
Returns
number |
| atanh | |||
|
static atanh(x: number): number
Returns the hyperbolic arctangent of a number.
Parameters
Returns
number |
| cbrt | |||
|
static cbrt(x: number): number
Returns the cube root of a number.
Parameters
Returns
number |
| ceil | |||
|
static ceil(x: number): integer
Returns the smallest integer greater than or equal to a number.
Parameters
Returns
integer |
| clz32 | |||
|
static clz32(x: number): integer
Returns the number of leading zero bits in the 32-bit binary representation of a number.
Parameters
Returns
integer |
| cos | |||
|
static cos(x: number): number
Returns the cosine of a number.
Parameters
Returns
number |
| cosh | |||
|
static cosh(x: number): number
Returns the hyperbolic cosine of a number.
Parameters
Returns
number |
| exp | |||
|
static exp(x: number): number
Returns E to the power of x, where E is Euler's constant, the base of the natural logarithm.
Parameters
Returns
number |
| expm1 | |||
|
static expm1(x: number): number
Returns exp(x) - 1.
Parameters
Returns
number |
| floor | |||
|
static floor(x: number): integer
Returns the largest integer less than or equal to a number.
Parameters
Returns
integer |
| fround | |||
|
static fround(x: number): integer
Returns the nearest single precision float representation of a number.
Parameters
Returns
integer |
| hypot | |||
|
static hypot(value: number): number
Returns the square root of the sum of squares of its arguments.
Parameters
Returns
number |
| imul | ||||||
|
static imul(a: number, b: number): integer
Returns the result of a 32-bit integer multiplication.
Parameters
Returns
integer |
| log | |||
|
static log(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of a number.
Parameters
Returns
number |
| log10 | |||
|
static log10(x: number): number
Returns the base 10 logarithm of a number.
Parameters
Returns
number |
| log1p | |||
|
static log1p(x: number): number
Returns the natural logarithm (logarithm to base E, also ln(x)) of 1 + x.
Parameters
Returns
number |
| log2 | |||
|
static log2(x: number): number
Returns the base 2 logarithm of a number.
Parameters
Returns
number |
| max | ||||||
|
static max(a: number, a: number): number
Returns the largest of zero or more numbers.
Parameters
Returns
number |
| min | ||||||
|
static min(a: number, b: number): number
Returns the smallest of zero or more numbers.
Parameters
Returns
number |
| pow | ||||||
|
static pow(base: number, exponent: number): number
Returns base to the power of exponent, that is, base^exponent.
Parameters
Returns
number |
| random |
|
static random(): number
Returns a floating-point pseudo-random number in the range [0, 1), that is, from 0 (inclusive) up to but not including 1 (exclusive).
Returns
number |
| round | |||
|
static round(x: number): integer
Returns the value of a number rounded to the nearest integer.
Parameters
Returns
integer |
| sign | |||
|
static sign(x: number): integer
Returns the sign of a number, indicating whether the number is positive, negative, or zero.
Parameters
Returns
integer |
| sin | |||
|
static sin(x: number): number
Returns the sine of a number.
Parameters
Returns
number |
| sinh | |||
|
static sinh(x: number): number
Returns the hyperbolic sine of a number.
Parameters
Returns
number |
| sqrt | |||
|
static sqrt(x: number): number
Returns the square root of a number.
Parameters
Returns
number |
| tan | |||
|
static tan(x: number): number
Returns the tangent of a number.
Parameters
Returns
number |
| tanh | |||
|
static tanh(x: number): number
Returns the hyperbolic tangent of a number.
Parameters
Returns
number |
| trunc | |||
|
static trunc(x: number): integer
Returns the integer part of a number, removing any fractional digits.
Parameters
Returns
integer |
| Name and Description |
| description: string |
| dimensionId: string |
| id: string |
| modelId: string |
| Name and Description |
|
static BookedValues: MemberAccessMode
Only members which have booked values |
|
static MasterData: MemberAccessMode
Full set of available members |
| BookedValues |
| static BookedValues: MemberAccessMode Only members which have booked values |
| MasterData |
| static MasterData: MemberAccessMode Full set of available members |
| Name and Description |
|
static Description: MemberDisplayMode
Members are visualized using their description. |
|
static DisplayId: MemberDisplayMode
Members are visualized using their display ID. |
|
static DisplayIdAndDescription: MemberDisplayMode
Members are visualized using their display ID and description. |
| Description |
| static Description: MemberDisplayMode Members are visualized using their description. |
| DisplayId |
| static DisplayId: MemberDisplayMode Members are visualized using their display ID. |
| DisplayIdAndDescription |
| static DisplayIdAndDescription: MemberDisplayMode Members are visualized using their display ID and description. |
| Name and Description |
| description: string |
| dimensionId: string |
| displayId: string |
| id: string |
| modelId: string |
| Name and Description |
|
accessMode: MemberAccessMode
Type of members to retrieve (default: MemberAccessMode.MasterData) |
|
hierarchyId: string
Hierarchy ID (default: currently active hierarchy) |
|
limit: integer
Maximum number of returned members, which must be zero or a positive number. |
| accessMode |
| accessMode: MemberAccessMode Type of members to retrieve (default: MemberAccessMode.MasterData) |
| hierarchyId |
| hierarchyId: string Hierarchy ID (default: currently active hierarchy) |
| limit |
| limit: integer Maximum number of returned members, which must be zero or a positive number. If the limit isn't specified or invalid, then the default value is used (default: 200). |
| Name and Description |
|
static EPSILON: number
Difference between 1 and the smallest value greater than 1 that can be represented as a Number. |
|
static MAX_SAFE_INTEGER: integer
Maximum safe integer in JavaScript (2^53 - 1). |
|
static MAX_VALUE: number
Maximum numeric value representable in JavaScript. |
|
static MIN_SAFE_INTEGER: integer
Minimum safe integer in JavaScript (-(2^53 - 1)). |
|
static MIN_VALUE: number
Smallest positive numeric value representable in JavaScript. |
|
static NEGATIVE_INFINITY: number
Negative Infinity value. |
|
static POSITIVE_INFINITY: number
Positive Infinity value. |
| Name and Description |
|
static isFinite(testValue: <any type>): boolean
Returns whether the value is a finite number. |
|
static isInteger(testValue: <any type>): boolean
Returns whether the value is an integer. |
|
static isNaN(testValue: <any type>): boolean
Returns whether the value is NaN and its type is a Number. |
|
static isSafeInteger(testValue: <any type>): boolean
Returns whether the value is a safe integer. |
|
static parseFloat(string: string): number
Parses a string and returns a floating-point number. |
|
static parseInt(string: string, radix?: number): integer
Parses a string and returns an integer of the specified radix or base. |
|
toExponential(significantDigits?: number): string
Returns a string representing the number in exponential notation. |
|
toFixed(significantDigits?: number): string
Returns a string representing the number in fixed-point notation. |
|
toPrecision(significantDigits?: number): string
Returns a string representing the number to the specified precision. |
|
toString(radix?: number): string
Returns a string representing the number in the (optionally) specified radix or base. |
| EPSILON |
| static EPSILON: number Difference between 1 and the smallest value greater than 1 that can be represented as a Number. |
| MAX_SAFE_INTEGER |
| static MAX_SAFE_INTEGER: integer Maximum safe integer in JavaScript (2^53 - 1). |
| MAX_VALUE |
| static MAX_VALUE: number Maximum numeric value representable in JavaScript. |
| MIN_SAFE_INTEGER |
| static MIN_SAFE_INTEGER: integer Minimum safe integer in JavaScript (-(2^53 - 1)). |
| MIN_VALUE |
| static MIN_VALUE: number Smallest positive numeric value representable in JavaScript. |
| NEGATIVE_INFINITY |
| static NEGATIVE_INFINITY: number Negative Infinity value. |
| POSITIVE_INFINITY |
| static POSITIVE_INFINITY: number Positive Infinity value. |
| isFinite | |||
|
static isFinite(testValue: <any type>): boolean
Returns whether the value is a finite number.
Parameters
Returns
boolean |
| isInteger | |||
|
static isInteger(testValue: <any type>): boolean
Returns whether the value is an integer.
Parameters
Returns
boolean |
| isNaN | |||
|
static isNaN(testValue: <any type>): boolean
Returns whether the value is NaN and its type is a Number.
Parameters
Returns
boolean |
| isSafeInteger | |||
|
static isSafeInteger(testValue: <any type>): boolean
Returns whether the value is a safe integer. A safe integer is an integer that can be exactly represented as an IEEE-754 double precision number and whose IEEE-754 representation can't be the result of rounding any other integer to fit the IEEE-754 representation.
Parameters
Returns
boolean |
| parseFloat | |||
|
static parseFloat(string: string): number
Parses a string and returns a floating-point number.
Parameters
Returns
number |
| parseInt | ||||||
|
static parseInt(string: string, radix?: number): integer
Parses a string and returns an integer of the specified radix or base.
Parameters
Returns
integer |
| toExponential | |||
|
toExponential(significantDigits?: number): string
Returns a string representing the number in exponential notation. It has one digit before the decimal point and is rounded to significantDigits digits after the decimal point.
Parameters
Returns
string |
| toFixed | |||
|
toFixed(significantDigits?: number): string
Returns a string representing the number in fixed-point notation. It is rounded to significantDigits digits after the decimal point.
Parameters
Returns
string |
| toPrecision | |||
|
toPrecision(significantDigits?: number): string
Returns a string representing the number to the specified precision. It is rounded to significantDigits digits after the decimal point.
Parameters
Returns
string |
| toString | |||
|
toString(radix?: number): string
Returns a string representing the number in the (optionally) specified radix or base.
Parameters
Returns
string |
| Name and Description |
|
static create(): NumberFormat
Creates a number format. |
|
static format(value: number): string
Formats a number by applying the current user settings. |
| create |
|
static create(): NumberFormat
Creates a number format.
Returns
NumberFormat |
| format | |||
|
static format(value: number): string
Formats a number by applying the current user settings.
Parameters
Returns
string |
| Name and Description |
| static Cells: NumberFormatDisplayUnit |
| static Column: NumberFormatDisplayUnit |
| static Default: NumberFormatDisplayUnit |
| static Row: NumberFormatDisplayUnit |
| Cells |
| static Cells: NumberFormatDisplayUnit |
| Column |
| static Column: NumberFormatDisplayUnit |
| Default |
| static Default: NumberFormatDisplayUnit |
| Row |
| static Row: NumberFormatDisplayUnit |
| Name and Description |
| static Default: NumberFormatScaleFormat |
| static Long: NumberFormatScaleFormat |
| static Short: NumberFormatScaleFormat |
| Default |
| static Default: NumberFormatScaleFormat |
| Long |
| static Long: NumberFormatScaleFormat |
| Short |
| static Short: NumberFormatScaleFormat |
| Name and Description |
| static AutoFormatted: NumberFormatScaleUnit |
| static Billion: NumberFormatScaleUnit |
| static Default: NumberFormatScaleUnit |
| static Million: NumberFormatScaleUnit |
| static Thousand: NumberFormatScaleUnit |
| static Unformatted: NumberFormatScaleUnit |
| AutoFormatted |
| static AutoFormatted: NumberFormatScaleUnit |
| Billion |
| static Billion: NumberFormatScaleUnit |
| Default |
| static Default: NumberFormatScaleUnit |
| Million |
| static Million: NumberFormatScaleUnit |
| Thousand |
| static Thousand: NumberFormatScaleUnit |
| Unformatted |
| static Unformatted: NumberFormatScaleUnit |
| Name and Description |
|
static Default: NumberFormatSignDisplay
A default format is applied to positive and negative numbers. |
|
static MinusAsParentheses: NumberFormatSignDisplay
Negative numbers are nested in parentheses (()). |
|
static MinusAsPrefix: NumberFormatSignDisplay
Negative numbers are prefixed with a minus sign (-). |
|
static PlusMinusAsPrefix: NumberFormatSignDisplay
Positive numbers are prefixed with a plus sign (+), negative numbers are prefixed with a minus sign (-). |
| Default |
| static Default: NumberFormatSignDisplay A default format is applied to positive and negative numbers. |
| MinusAsParentheses |
| static MinusAsParentheses: NumberFormatSignDisplay Negative numbers are nested in parentheses (()). |
| MinusAsPrefix |
| static MinusAsPrefix: NumberFormatSignDisplay Negative numbers are prefixed with a minus sign (-). |
| PlusMinusAsPrefix |
| static PlusMinusAsPrefix: NumberFormatSignDisplay Positive numbers are prefixed with a plus sign (+), negative numbers are prefixed with a minus sign (-). |
| Name and Description |
| static Appendix: PageDateLocation |
| static Header: PageDateLocation |
| static HeaderAndAppendix: PageDateLocation |
| static None: PageDateLocation |
| Appendix |
| static Appendix: PageDateLocation |
| Header |
| static Header: PageDateLocation |
| HeaderAndAppendix |
| static HeaderAndAppendix: PageDateLocation |
| None |
| static None: PageDateLocation |
| Name and Description |
| static Footer: PageNumberLocation |
| static Header: PageNumberLocation |
| static HeaderAndFooter: PageNumberLocation |
| static None: PageNumberLocation |
| Footer |
| static Footer: PageNumberLocation |
| Header |
| static Header: PageNumberLocation |
| HeaderAndFooter |
| static HeaderAndFooter: PageNumberLocation |
| None |
| static None: PageNumberLocation |
| Name and Description |
| static Landscape: PageOrientation |
| static Portrait: PageOrientation |
| Landscape |
| static Landscape: PageOrientation |
| Portrait |
| static Portrait: PageOrientation |
| Name and Description |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
static Auto: PauseMode
Pause data refresh is automatically turned on for invisible widgets. |
|
static Off: PauseMode
Pause data refresh is turned off. |
|
static On: PauseMode
Pause data refresh is turned on. |
| Auto |
| static Auto: PauseMode Pause data refresh is automatically turned on for invisible widgets. For example, result set-related methods return the latest result set. Some specific restrictions apply for this value for tables. |
| Off |
| static Off: PauseMode Pause data refresh is turned off. |
| On |
| static On: PauseMode Pause data refresh is turned on. Any operations resulting in a data refresh are paused. |
| Name and Description |
| static Parent: PostMessageReceiver |
| static Top: PostMessageReceiver |
| Name and Description |
|
addItem(key: string, text?: string): void
Adds a new item to the radio button group. |
|
getSelectedKey(): string
Returns the key of the selected item in the radio button group. |
|
getSelectedText(): string
Returns the text of the selected item in the radio button group. |
|
removeAllItems(): void
Removes all items from the radio button group. |
|
removeItem(key: string): void
Removes the item from the radio button group. |
|
setSelectedKey(key: string): void
Selects an item in the radio button group. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user changes the selection in the radio button group. |
| addItem | ||||||
|
addItem(key: string, text?: string): void
Adds a new item to the radio button group. The item is specified by a key and an optional text. If the key or the text already exists, then this operation is ignored.
Parameters
|
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected item in the radio button group. If no item is selected, then undefined is returned.
Returns
string |
| getSelectedText |
|
getSelectedText(): string
Returns the text of the selected item in the radio button group. If no item is selected, then undefined is returned.
Returns
string |
| removeAllItems |
| removeAllItems(): void Removes all items from the radio button group. |
| removeItem | |||
|
removeItem(key: string): void
Removes the item from the radio button group. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| setSelectedKey | |||
|
setSelectedKey(key: string): void
Selects an item in the radio button group. The item is specified by its key. If the key isn't present, then this operation is ignored.
Parameters
|
| Name and Description |
|
from: string
Start filter value of a range |
|
greater: string
Filter value specifying a range of filter values greater than this filter value |
|
greaterOrEqual: string
Filter value specifying a range of filter values greater or equal than this filter value |
|
less: string
Filter value specifying a range of filter values less than this filter value |
|
lessOrEqual: string
Filter value specifying a range of filter values less or equal than this filter value |
|
to: string
End filter value of a range |
| Inherited from FilterValue |
| type |
| from |
| from: string Start filter value of a range |
| greater |
| greater: string Filter value specifying a range of filter values greater than this filter value |
| greaterOrEqual |
| greaterOrEqual: string Filter value specifying a range of filter values greater or equal than this filter value |
| less |
| less: string Filter value specifying a range of filter values less than this filter value |
| lessOrEqual |
| lessOrEqual: string Filter value specifying a range of filter values less or equal than this filter value |
| to |
| to: string End filter value of a range |
| Name and Description |
|
getMaxValue(): number
Returns the maximum value of the range slider. |
|
getMinValue(): number
Returns the minimum value of the range slider. |
|
getRange(): Range
Returns the range of the range slider. |
|
setMaxValue(value: number): void
Sets the maximum value of the range slider. |
|
setMinValue(value: number): void
Sets the minimum value of the range slider. |
|
setRange(range: Range): void
Sets the range of the range slider. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the range slider doesn't have the focus anymore. |
| getMaxValue |
|
getMaxValue(): number
Returns the maximum value of the range slider.
Returns
number |
| getMinValue |
|
getMinValue(): number
Returns the minimum value of the range slider.
Returns
number |
| getRange |
|
getRange(): Range
Returns the range of the range slider.
Returns
Range |
| setMaxValue | |||
|
setMaxValue(value: number): void
Sets the maximum value of the range slider.
Parameters
|
| setMinValue | |||
|
setMinValue(value: number): void
Sets the minimum value of the range slider.
Parameters
|
| setRange | |||
|
setRange(range: Range): void
Sets the range of the range slider.
Parameters
|
| Name and Description |
|
description: string
Member description |
|
id: string
Member ID |
|
parentId: string
Parent ID of member |
|
properties: ResultMemberProperties
Properties of a dimension |
| description |
| description: string Member description |
| id |
| id: string Member ID |
| parentId |
| parentId: string Parent ID of member |
| properties |
| properties: ResultMemberProperties Properties of a dimension |
| Name and Description |
|
loadDescriptions: boolean
Specifies whether to load the variable value descriptions for the Prompt dialog and for dynamic texts (default: true). |
| loadDescriptions |
| loadDescriptions: boolean Specifies whether to load the variable value descriptions for the Prompt dialog and for dynamic texts (default: true). If set to false, then this may improve the performance of the analytic application, however at the cost of displaying variable value IDs instead of variable value descriptions in the Prompt dialog and in dynamic texts. |
| Name and Description |
|
setHyperlink(type: UrlType, value?: string): void
Sets the hyperlink that the shape will navigate to. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the shape. |
|
onLongPress(): void Called when the user presses and holds the shape. |
| Name and Description |
|
getMaxValue(): number
Returns the maximum value of the slider. |
|
getMinValue(): number
Returns the minimum value of the slider. |
|
getValue(): number
Returns the value of the slider. |
|
setMaxValue(value: number): void
Sets the maximum value of the slider. |
|
setMinValue(value: number): void
Sets the minimum value of the slider. |
|
setValue(value: number): void
Sets the value of the slider. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the slider doesn't have the focus anymore. |
| getMaxValue |
|
getMaxValue(): number
Returns the maximum value of the slider.
Returns
number |
| getMinValue |
|
getMinValue(): number
Returns the minimum value of the slider.
Returns
number |
| getValue |
|
getValue(): number
Returns the value of the slider.
Returns
number |
| setMaxValue | |||
|
setMaxValue(value: number): void
Sets the maximum value of the slider.
Parameters
|
| setMinValue | |||
|
setMinValue(value: number): void
Sets the minimum value of the slider.
Parameters
|
| setValue | |||
|
setValue(value: number): void
Sets the value of the slider.
Parameters
|
| Name and Description |
|
static Ascending: SortOrder
Ascending order of sorting (lowest to highest for a measure, earliest to latest for a time-based dimension, and alphabetically ascending for a non-time-based dimension) |
|
static Default: SortOrder
Default order of sorting |
|
static Descending: SortOrder
Descending order of sorting (highest to lowest for a measure, latest to earliest for a time-based dimension, and alphabetically descending for a non-time-based dimension) |
| Ascending |
| static Ascending: SortOrder Ascending order of sorting (lowest to highest for a measure, earliest to latest for a time-based dimension, and alphabetically ascending for a non-time-based dimension) |
| Default |
| static Default: SortOrder Default order of sorting |
| Descending |
| static Descending: SortOrder Descending order of sorting (highest to lowest for a measure, latest to earliest for a time-based dimension, and alphabetically descending for a non-time-based dimension) |
| Name and Description |
|
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 |
|
static replaceAll(value: string, searchFor: string, replaceWith: string): string
Replaces all occurrences of the searchFor string with the replaceWith string. |
| Name and Description |
|
isEnabled(): boolean
Returns whether the switch is enabled. |
|
isOn(): boolean
Returns whether the switch is turned on. |
|
setEnabled(enabled: boolean): void
Enables or disables the switch. |
|
setOn(on: boolean): void
Turns the switch on or off. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the switch has been turned on or off. |
| isEnabled |
|
isEnabled(): boolean
Returns whether the switch is enabled.
Returns
boolean |
| isOn |
|
isOn(): boolean
Returns whether the switch is turned on.
Returns
boolean |
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the switch.
Parameters
|
| setOn | |||
|
setOn(on: boolean): void
Turns the switch on or off.
Parameters
|
| Name and Description |
|
getKey(): string
Returns the key of the tab. |
|
getText(): string
Returns the text displayed on the tab. |
|
isVisible(): boolean
Returns whether the tab is visible. |
|
setText(text: string): void
Sets the text displayed on the tab. |
|
setVisible(visible: boolean): void
Shows or hides the tab. |
| getKey |
|
getKey(): string
Returns the key of the tab.
Returns
string |
| getText |
|
getText(): string
Returns the text displayed on the tab.
Returns
string |
| isVisible |
|
isVisible(): boolean
Returns whether the tab is visible.
Returns
boolean |
| setText | |||
|
setText(text: string): void
Sets the text displayed on the tab.
Parameters
|
| setVisible | |||
|
setVisible(visible: boolean): void
Shows or hides the tab.
Parameters
|
| Name and Description |
|
getActiveDimensionProperties(dimension: string | DimensionInfo JSON): string[]
Returns the IDs of the currently active properties of the dimension. |
|
getColumnCount(): integer
Returns the number of columns of the table. |
|
getDataSource(): DataSource(Table)
Returns the data source of the table. |
|
getDimensionsOnColumns(): string[]
Returns the dimensions on the Columns axis. |
|
getDimensionsOnRows(): string[]
Returns the dimensions on the Rows axis. |
|
getRowCount(): integer
Returns the number of rows of the table. |
|
isCompactDisplayEnabled(axis: TableAxis): boolean
Returns whether the compact display is enabled for the axis. |
|
isEnabled(): boolean
Returns whether the user interaction with the table is enabled. |
|
isZeroSuppressionEnabled(axis: TableAxis): boolean
Returns whether zero suppression is enabled for the axis. |
|
setActiveDimensionProperties(dimension: string | DimensionInfo JSON, properties: string[] | DimensionPropertyInfo[]): void
Sets the active properties of the dimension. |
|
setCompactDisplayEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables the compact display for the axis. |
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu. |
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the table. |
|
setZeroSuppressionEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables zero suppression for the axis. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onResultChanged(): void Called when the result set displayed by the table changes. |
|
onSelect(): void Called when the user makes a selection within the table. |
| getActiveDimensionProperties | |||
|
getActiveDimensionProperties(dimension: string | DimensionInfo JSON): string[]
Returns the IDs of the currently active properties of the dimension.
Parameters
Returns
string[] |
| getColumnCount |
|
getColumnCount(): integer
Returns the number of columns of the table.
Returns
integer |
| getDataSource |
|
getDataSource(): DataSource(Table)
Returns the data source of the table.
Returns
DataSource(Table) |
| getDimensionsOnColumns |
|
getDimensionsOnColumns(): string[]
Returns the dimensions on the Columns axis.
Returns
string[] |
| getDimensionsOnRows |
|
getDimensionsOnRows(): string[]
Returns the dimensions on the Rows axis.
Returns
string[] |
| getRowCount |
|
getRowCount(): integer
Returns the number of rows of the table.
Returns
integer |
| isCompactDisplayEnabled | |||
|
isCompactDisplayEnabled(axis: TableAxis): boolean
Returns whether the compact display is enabled for the axis. Note: Compact display is only supported for SAP BW models.
Parameters
Returns
boolean |
| isEnabled |
|
isEnabled(): boolean
Returns whether the user interaction with the table is enabled.
Returns
boolean |
| isZeroSuppressionEnabled | |||
|
isZeroSuppressionEnabled(axis: TableAxis): boolean
Returns whether zero suppression is enabled for the axis. Note: Zero suppression is only supported for SAP BW models.
Parameters
Returns
boolean |
| setActiveDimensionProperties | ||||||
|
setActiveDimensionProperties(dimension: string | DimensionInfo JSON, properties: string[] | DimensionPropertyInfo[]): void
Sets the active properties of the dimension.
Parameters
|
| setCompactDisplayEnabled | ||||||
|
setCompactDisplayEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables the compact display for the axis. Note: Compact display is only supported for SAP BW models.
Parameters
|
| setContextMenuVisible | |||
|
setContextMenuVisible(visible: boolean): void
Shows or hides the More Actions button and the context menu.
Parameters
Mobile Support
Not supported on mobile devices.
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the user interaction with the table.
Parameters
|
| setZeroSuppressionEnabled | ||||||
|
setZeroSuppressionEnabled(axis: TableAxis, enabled: boolean): void
Enables or disables zero suppression for the axis. Note: Zero suppression is only supported for SAP BW models.
Parameters
|
| Name and Description |
|
getSelectedKey(): string
Returns the key of the selected tab of the tab strip. |
|
getTab(tabKey: string): Tab
Returns a tab of the tab strip. |
|
hideBusyIndicator(): void
Hides the busy indicator. |
|
setSelectedKey(tabKey: string): void
Selects a tab. |
|
showBusyIndicator(text?: string): void
Shows the busy indicator. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onSelect(): void Called when the user selects a tab. |
| getSelectedKey |
|
getSelectedKey(): string
Returns the key of the selected tab of the tab strip.
Returns
string |
| getTab | |||
|
getTab(tabKey: string): Tab
Returns a tab of the tab strip. The tab is specified by the key of the tab. If the tab doesn't exist, then undefined is returned.
Parameters
Returns
Tab |
| hideBusyIndicator |
| hideBusyIndicator(): void Hides the busy indicator. |
| setSelectedKey | |||
|
setSelectedKey(tabKey: string): void
Selects a tab. The tab is specified by the key of the tab. The selected tab is the visible tab of the tab strip. If the tab doesn't exist, then this operation is ignored.
Parameters
|
| showBusyIndicator | |||
|
showBusyIndicator(text?: string): void
Shows the busy indicator.
Parameters
|
| Name and Description |
| description: string |
| name: string |
| Name and Description |
|
applyText(text: string): void
Replaces the text of the first formatted section of the Text widget. |
|
getPlainText(): string
Returns the text of the Text widget, with no formatting or markup information. |
|
setStyle(textStyle: TextStyle JSON): void
Applies the style to the text. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onClick(): void Called when the user clicks the text. |
| applyText | |||
|
applyText(text: string): void
Replaces the text of the first formatted section of the Text widget. If multiple text styles are present within the contents, then only the text with the first configured style is replaced. If only one text style is present, then the entire text is replaced.
Parameters
|
| getPlainText |
|
getPlainText(): string
Returns the text of the Text widget, with no formatting or markup information.
Returns
string |
| setStyle | |||
|
setStyle(textStyle: TextStyle JSON): void
Applies the style to the text. You can also pass a JSON object for this argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
|
| Name and Description |
|
getValue(): string
Returns the value of the text area. |
|
isEditable(): boolean
Returns whether the text area is editable. |
|
isEnabled(): boolean
Returns whether the text area is enabled. |
|
setEditable(editable: boolean): void
Enables or disables editing of the text area. |
|
setEnabled(enabled: boolean): void
Enables or disables the text area. |
|
setStyle(style: TextAreaStyle JSON): void
Applies the style to the text area. |
|
setValue(value: string): void
Sets the value of the text area. |
| Inherited from Widget |
| getCssClass, getLayout, isVisible, setCssClass, setVisible |
| Name and Description |
|
onChange(): void Called when the text area doesn't have the focus anymore, for example, after the user has entered text and pressed the "Enter" key. |
| getValue |
|
getValue(): string
Returns the value of the text area.
Returns
string |
| isEditable |
|
isEditable(): boolean
Returns whether the text area is editable.
Returns
boolean |
| isEnabled |
|
isEnabled(): boolean
Returns whether the text area is enabled.
Returns
boolean |
| setEditable | |||
|
setEditable(editable: boolean): void
Enables or disables editing of the text area.
Parameters
|
| setEnabled | |||
|
setEnabled(enabled: boolean): void
Enables or disables the text area.
Parameters
|
| setStyle | |||
|
setStyle(style: TextAreaStyle JSON): void
Applies the style to the text area. You can also pass a JSON object for this argument. In the script editor, type "{}", place the cursor between the curly brackets, then press Ctrl+Space to list the available properties.
Parameters
|
| setValue | |||
|
setValue(value: string): void
Sets the value of the text area.
Parameters
|
| Name and Description |
|
backgroundColor: string
Background color of the text area |
|
borderColor: string
Border color of the text area |
|
color: string
Font color of the text area |
| Name and Description |
|
getText(textId: string): string
fetch the string corresponding to the textId. |
| Name and Description |
|
backgroundColor: string
Background color of the text |
|
color: string
Font color of the text |
| Name and Description |
|
isRunning(): boolean
Returns whether the timer is running. |
|
start(delayInSeconds: number): void
Starts the timer. |
|
stop(): void
Stops the timer. |
| Name and Description |
|
onTimeout(): void Called when the set timespan of the timer has elapsed. |
| Name and Description |
|
static create(granularity: TimeRangeGranularity, start: Date, end: Date): TimeRange
Creates a time range with the specified granularity, start date, and end date. |
|
static createMonthRange(startYear: integer, startMonth: integer, endYear: integer, endMonth: integer): TimeRange
Creates a time range with the specified start and end years and months. |
|
static createWeekRange(startYear: integer, startWeek: integer, endYear: integer, endWeek: integer): TimeRange
Creates a time range with the specified start and end years and weeks. |
|
static createYearRange(start: integer, end: integer): TimeRange
Creates a time range with the specified start year and end year. |
| create | |||||||||
|
static create(granularity: TimeRangeGranularity, start: Date, end: Date): TimeRange
Creates a time range with the specified granularity, start date, and end date.
Parameters
Returns
TimeRange |
| createMonthRange | ||||||||||||
|
static createMonthRange(startYear: integer, startMonth: integer, endYear: integer, endMonth: integer): TimeRange
Creates a time range with the specified start and end years and months.
Parameters
Returns
TimeRange |
| createWeekRange | ||||||||||||
|
static createWeekRange(startYear: integer, startWeek: integer, endYear: integer, endWeek: integer): TimeRange
Creates a time range with the specified start and end years and weeks.
Parameters
Returns
TimeRange |
| createYearRange | ||||||
|
static createYearRange(start: integer, end: integer): TimeRange
Creates a time range with the specified start year and end year.
Parameters
Returns
TimeRange |
| Name and Description |
|
static Day: TimeRangeGranularity
A range of days |
|
static HalfYear: TimeRangeGranularity
A range of half-years |
|
static Hour: TimeRangeGranularity
A range of hours |
|
static Millisecond: TimeRangeGranularity
A range of milliseconds |
|
static Minute: TimeRangeGranularity
A range of minutes |
|
static Month: TimeRangeGranularity
A range of months |
|
static Quarter: TimeRangeGranularity
A range of quarters |
|
static Second: TimeRangeGranularity
A range of seconds |
|
static Year: TimeRangeGranularity
A range of years |
| Day |
| static Day: TimeRangeGranularity A range of days |
| HalfYear |
| static HalfYear: TimeRangeGranularity A range of half-years |
| Hour |
| static Hour: TimeRangeGranularity A range of hours |
| Millisecond |
| static Millisecond: TimeRangeGranularity A range of milliseconds |
| Minute |
| static Minute: TimeRangeGranularity A range of minutes |
| Month |
| static Month: TimeRangeGranularity A range of months |
| Quarter |
| static Quarter: TimeRangeGranularity A range of quarters |
| Second |
| static Second: TimeRangeGranularity A range of seconds |
| Year |
| static Year: TimeRangeGranularity A range of years |
| Name and Description |
|
static create(parameterName: string, parameterValueNotEncoded: string): UrlParameter
Creates a URL parameter. |
| create | ||||||
|
static create(parameterName: string, parameterValueNotEncoded: string): UrlParameter
Creates a URL parameter.
Parameters
Returns
UrlParameter |
| Name and Description |
| displayName: string |
| id: string |
| Name and Description |
| description: string |
| id: string |
| isInputEnabled: boolean |
| modelId: string |
| Name and Description |
|
type: VariableValueType
Type of the variable value |
| Name and Description |
|
static Multiple: VariableValueType
An object representing multiple variable values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
|
static Range: VariableValueType
An object representing a range of dimension members, like: {<operator>: '<memberId>'} or {<operator>: '<memberId>', exclude: true}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
|
static Single: VariableValueType
An object representing a single variable value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Multiple |
| static Multiple: VariableValueType An object representing multiple variable values, like: {values: ['<memberId1>', '<memberId2>']} or {values: ['<memberId1>', '<memberId2>'], exclude: true} |
| Range |
| static Range: VariableValueType An object representing a range of dimension members, like: {<operator>: '<memberId>'} or {<operator>: '<memberId>', exclude: true}, with operator being one of "from", "to", "less", "greater", "lessOrEqual", or "greaterOrEqual". |
| Single |
| static Single: VariableValueType An object representing a single variable value, like: {value: '<memberId>'} or {value: '<memberId>', exclude: true} |
| Name and Description |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the component. |
|
getLayout(): Layout
Returns the layout of the widget. |
|
isVisible(): boolean
Returns whether the widget is visible. |
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the component. |
|
setVisible(visible: boolean): void
Shows or hides the widget. |
| getCssClass |
|
getCssClass(): string
Returns the Cascading Style Sheet (CSS) class name of the component.
Returns
string |
| getLayout |
|
getLayout(): Layout
Returns the layout of the widget.
Returns
Layout |
| isVisible |
|
isVisible(): boolean
Returns whether the widget is visible.
Returns
boolean |
| setCssClass | |||
|
setCssClass(className: string): void
Sets the Cascading Style Sheet (CSS) class name of the component.
Parameters
|
| setVisible | |||
|
setVisible(visible: boolean): void
Shows or hides the widget.
Parameters
|
| Name and Description |
|
static searchPattern: string
Part of the name of the widgets to return. |
|
static type: WidgetType
Type of the widgets to return |
| searchPattern |
| static searchPattern: string Part of the name of the widgets to return. The search pattern is case-sensitive, for example, the search patterns "SalesChart" and "saleschart" return different results. |
| type |
| static type: WidgetType Type of the widgets to return |