@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +11 -2
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +1 -1
- package/cjs/src/embed/liveboard.d.ts +2 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +16 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js +104 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
- package/cjs/src/hostEventsTypeMapping.d.ts +2 -0
- package/cjs/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/cjs/src/hostEventsTypeMapping.js +4 -0
- package/cjs/src/hostEventsTypeMapping.js.map +1 -0
- package/cjs/src/types.d.ts +253 -155
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +229 -131
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/embedApi/contracts.d.ts +101 -0
- package/cjs/src/utils/embedApi/contracts.d.ts.map +1 -0
- package/cjs/src/utils/embedApi/contracts.js +17 -0
- package/cjs/src/utils/embedApi/contracts.js.map +1 -0
- package/cjs/src/utils/embedApi/embedApiClient.d.ts +12 -0
- package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
- package/cjs/src/utils/embedApi/embedApiClient.js +46 -0
- package/cjs/src/utils/embedApi/embedApiClient.js.map +1 -0
- package/cjs/src/utils/embedApi/processEmbedApi.d.ts +9 -0
- package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
- package/cjs/src/utils/embedApi/processEmbedApi.js +18 -0
- package/cjs/src/utils/embedApi/processEmbedApi.js.map +1 -0
- package/dist/{index-DWOIXXJ1.js → index-BBBimG1x.js} +1 -1
- package/dist/index-BGnxP5NY.js +7370 -0
- package/dist/index-CENLvayL.js +7370 -0
- package/dist/index-CbltIawo.js +7370 -0
- package/dist/index-CoQfqaHj.js +7370 -0
- package/dist/index-CzwzS0P4.js +7370 -0
- package/dist/index-DFwi_pV_.js +7370 -0
- package/dist/index-DOIjN0N_.js +7370 -0
- package/dist/index-DYBx8SuE.js +7370 -0
- package/dist/index-DaLHJaLd.js +7370 -0
- package/dist/index-DnJX-gN2.js +7370 -0
- package/dist/index-IDmSUe93.js +7370 -0
- package/dist/index-nWevLycs.js +7370 -0
- package/dist/src/embed/app.d.ts +11 -2
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +1 -1
- package/dist/src/embed/liveboard.d.ts +2 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
- package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
- package/dist/src/hostEventsTypeMapping.d.ts +2 -0
- package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/dist/src/types.d.ts +253 -155
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/embedApi/contracts.d.ts +101 -0
- package/dist/src/utils/embedApi/contracts.d.ts.map +1 -0
- package/dist/src/utils/embedApi/embedApiClient.d.ts +12 -0
- package/dist/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
- package/dist/src/utils/embedApi/processEmbedApi.d.ts +9 -0
- package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
- package/dist/tsembed-react.es.js +234 -136
- package/dist/tsembed-react.js +233 -135
- package/dist/tsembed.es.js +234 -136
- package/dist/tsembed.js +233 -135
- package/dist/visual-embed-sdk-react-full.d.ts +267 -158
- package/dist/visual-embed-sdk-react.d.ts +267 -158
- package/dist/visual-embed-sdk.d.ts +267 -158
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +11 -2
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +1 -1
- package/lib/src/embed/liveboard.d.ts +2 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +16 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.js +101 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
- package/lib/src/hostEventsTypeMapping.d.ts +2 -0
- package/lib/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/lib/src/hostEventsTypeMapping.js +2 -0
- package/lib/src/hostEventsTypeMapping.js.map +1 -0
- package/lib/src/types.d.ts +253 -155
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +229 -131
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/embedApi/contracts.d.ts +101 -0
- package/lib/src/utils/embedApi/contracts.d.ts.map +1 -0
- package/lib/src/utils/embedApi/contracts.js +14 -0
- package/lib/src/utils/embedApi/contracts.js.map +1 -0
- package/lib/src/utils/embedApi/embedApiClient.d.ts +12 -0
- package/lib/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
- package/lib/src/utils/embedApi/embedApiClient.js +42 -0
- package/lib/src/utils/embedApi/embedApiClient.js.map +1 -0
- package/lib/src/utils/embedApi/processEmbedApi.d.ts +9 -0
- package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
- package/lib/src/utils/embedApi/processEmbedApi.js +14 -0
- package/lib/src/utils/embedApi/processEmbedApi.js.map +1 -0
- package/lib/src/visual-embed-sdk.d.ts +267 -158
- package/package.json +1 -1
- package/src/embed/app.ts +11 -2
- package/src/embed/hostEventClient/contracts.ts +1 -1
- package/src/embed/liveboard.spec.ts +22 -1
- package/src/embed/liveboard.ts +3 -1
- package/src/types.ts +253 -161
package/src/types.ts
CHANGED
|
@@ -17,7 +17,7 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
|
|
|
17
17
|
// eslint-disable-next-line no-shadow
|
|
18
18
|
export enum AuthType {
|
|
19
19
|
/**
|
|
20
|
-
* No authentication on the SDK.
|
|
20
|
+
* No authentication on the SDK. Pass-through to the embedded App. Alias for
|
|
21
21
|
* `Passthrough`.
|
|
22
22
|
* @example
|
|
23
23
|
* ```js
|
|
@@ -216,8 +216,8 @@ export interface customCssInterface {
|
|
|
216
216
|
/**
|
|
217
217
|
* The custom css variables, which can be set.
|
|
218
218
|
* The allowed list is in the CustomCssVariables
|
|
219
|
-
* interface.
|
|
220
|
-
*
|
|
219
|
+
* interface. For more information, see
|
|
220
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
221
221
|
*/
|
|
222
222
|
variables?: CustomCssVariables;
|
|
223
223
|
/**
|
|
@@ -261,7 +261,7 @@ export interface CustomStyles {
|
|
|
261
261
|
|
|
262
262
|
/**
|
|
263
263
|
* Configuration to define the customization on the Embedded
|
|
264
|
-
*
|
|
264
|
+
* ThoughtSpot components.
|
|
265
265
|
* You can customize styles, text strings, and icons.
|
|
266
266
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
267
267
|
* @example
|
|
@@ -388,7 +388,7 @@ export interface EmbedConfig {
|
|
|
388
388
|
/**
|
|
389
389
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
390
390
|
* should be encoded in base64. This provides additional security to
|
|
391
|
-
*
|
|
391
|
+
* ThoughtSpot clusters against cross-site scripting attacks.
|
|
392
392
|
* @default false
|
|
393
393
|
*/
|
|
394
394
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -553,18 +553,18 @@ export interface EmbedConfig {
|
|
|
553
553
|
*/
|
|
554
554
|
disableSDKTracking?: boolean;
|
|
555
555
|
/**
|
|
556
|
-
* Overrides default/user
|
|
557
|
-
* @version SDK: 1.28.4 |
|
|
556
|
+
* Overrides default/user preferred locale for date formatting
|
|
557
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
558
558
|
*/
|
|
559
559
|
dateFormatLocale?: string;
|
|
560
560
|
/**
|
|
561
|
-
* Overrides default/user
|
|
562
|
-
* @version SDK: 1.28.4 |
|
|
561
|
+
* Overrides default/user preferred locale for number formatting
|
|
562
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
563
563
|
*/
|
|
564
564
|
numberFormatLocale?: string;
|
|
565
565
|
/**
|
|
566
566
|
* Format to be used for currency when currency format is set to infer from browser
|
|
567
|
-
* @version SDK: 1.28.4 |
|
|
567
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
568
568
|
*/
|
|
569
569
|
currencyFormat?: string;
|
|
570
570
|
|
|
@@ -579,13 +579,13 @@ export interface EmbedConfig {
|
|
|
579
579
|
* disableTokenVerification : true
|
|
580
580
|
* })
|
|
581
581
|
* ```
|
|
582
|
-
* @version SDK: 1.28.5 |
|
|
582
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
583
583
|
*/
|
|
584
584
|
disableTokenVerification?: boolean;
|
|
585
585
|
|
|
586
586
|
/**
|
|
587
587
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
588
|
-
* @version SDK 1.32.3 |
|
|
588
|
+
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
589
589
|
*/
|
|
590
590
|
disableLoginFailurePage?: boolean;
|
|
591
591
|
/**
|
|
@@ -621,7 +621,7 @@ export interface EmbedConfig {
|
|
|
621
621
|
* }
|
|
622
622
|
* });
|
|
623
623
|
* ```
|
|
624
|
-
* @version SDK 1.37.0 |
|
|
624
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
|
|
625
625
|
*/
|
|
626
626
|
customVariablesForThirdPartyTools?: Record< string, any >;
|
|
627
627
|
}
|
|
@@ -784,7 +784,7 @@ export interface ViewConfig {
|
|
|
784
784
|
/**
|
|
785
785
|
* The list of parameter override to apply to a search answer,
|
|
786
786
|
* visualization, or Liveboard.
|
|
787
|
-
* @version SDK : 1.25.0 |
|
|
787
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
788
788
|
* @example
|
|
789
789
|
* ```js
|
|
790
790
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -842,7 +842,7 @@ export interface ViewConfig {
|
|
|
842
842
|
/**
|
|
843
843
|
* Insert as a sibling of the target container, instead of appending to a
|
|
844
844
|
* child inside it.
|
|
845
|
-
* @version SDK: 1.2.0 |
|
|
845
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
846
846
|
* @example
|
|
847
847
|
* ```js
|
|
848
848
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -915,7 +915,7 @@ export interface ViewConfig {
|
|
|
915
915
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
916
916
|
* });
|
|
917
917
|
* ```
|
|
918
|
-
* @version SDK: 1.26.0 |
|
|
918
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
919
919
|
*/
|
|
920
920
|
hiddenTabs?: string[];
|
|
921
921
|
/**
|
|
@@ -925,7 +925,7 @@ export interface ViewConfig {
|
|
|
925
925
|
* **Note**: This option does not apply to the classic homepage.
|
|
926
926
|
* To access the updated modular homepage, set
|
|
927
927
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
928
|
-
* @version SDK: 1.28.0 |
|
|
928
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
929
929
|
* @example
|
|
930
930
|
* ```js
|
|
931
931
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -942,7 +942,7 @@ export interface ViewConfig {
|
|
|
942
942
|
* **Note**: This option does not apply to the classic homepage.
|
|
943
943
|
* To access the updated modular homepage, set
|
|
944
944
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
945
|
-
* @version SDK: 1.28.0|
|
|
945
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
946
946
|
* @example
|
|
947
947
|
* ```js
|
|
948
948
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -957,7 +957,7 @@ export interface ViewConfig {
|
|
|
957
957
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
958
958
|
*
|
|
959
959
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
960
|
-
* @version SDK: 1.26.0 |
|
|
960
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
961
961
|
* @example
|
|
962
962
|
* ```js
|
|
963
963
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -985,7 +985,7 @@ export interface ViewConfig {
|
|
|
985
985
|
* **Note**: This option does not apply to the classic homepage.
|
|
986
986
|
* To access the updated modular homepage, set
|
|
987
987
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
988
|
-
* @version SDK: 1.28.0 |
|
|
988
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
989
989
|
*/
|
|
990
990
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
991
991
|
/**
|
|
@@ -1000,7 +1000,7 @@ export interface ViewConfig {
|
|
|
1000
1000
|
* });
|
|
1001
1001
|
* embed.showPreRender();
|
|
1002
1002
|
* ```
|
|
1003
|
-
* @version SDK: 1.25.0 |
|
|
1003
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1004
1004
|
*/
|
|
1005
1005
|
preRenderId?: string;
|
|
1006
1006
|
|
|
@@ -1056,7 +1056,7 @@ export interface ViewConfig {
|
|
|
1056
1056
|
/**
|
|
1057
1057
|
* To set the initial state of the search bar in case of saved Answers.
|
|
1058
1058
|
* @default true
|
|
1059
|
-
* @version SDK: 1.34.0 |
|
|
1059
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1060
1060
|
* @example
|
|
1061
1061
|
* ```js
|
|
1062
1062
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1080,7 +1080,7 @@ export interface ViewConfig {
|
|
|
1080
1080
|
/**
|
|
1081
1081
|
* Flag to control Data panel experience
|
|
1082
1082
|
* @default false
|
|
1083
|
-
* @version SDK: 1.34.0 |
|
|
1083
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
1084
1084
|
* @example
|
|
1085
1085
|
* ```js
|
|
1086
1086
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1092,7 +1092,7 @@ export interface ViewConfig {
|
|
|
1092
1092
|
dataPanelV2?: boolean;
|
|
1093
1093
|
/**
|
|
1094
1094
|
* To enable custom column groups in data panel v2
|
|
1095
|
-
* @version SDK: 1.32.0 |
|
|
1095
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
1096
1096
|
* @default false
|
|
1097
1097
|
* @example
|
|
1098
1098
|
* ```js
|
|
@@ -1122,7 +1122,7 @@ export interface ViewConfig {
|
|
|
1122
1122
|
/**
|
|
1123
1123
|
* Flag to control new flip tooltip context menu experience
|
|
1124
1124
|
* @default false
|
|
1125
|
-
* @version SDK: 1.36.0 |
|
|
1125
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1126
1126
|
*/
|
|
1127
1127
|
enableFlipTooltipToContextMenu?: boolean;
|
|
1128
1128
|
}
|
|
@@ -1255,7 +1255,7 @@ export enum RuntimeFilterOp {
|
|
|
1255
1255
|
* **Note**: This option does not apply to the classic homepage.
|
|
1256
1256
|
* To access the updated modular homepage, set
|
|
1257
1257
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1258
|
-
* @version SDK: 1.28.0 |
|
|
1258
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1259
1259
|
*/
|
|
1260
1260
|
// eslint-disable-next-line no-shadow
|
|
1261
1261
|
export enum HomepageModule {
|
|
@@ -2102,7 +2102,7 @@ export enum EmbedEvent {
|
|
|
2102
2102
|
*/
|
|
2103
2103
|
Explore = 'explore',
|
|
2104
2104
|
/**
|
|
2105
|
-
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2105
|
+
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
2106
2106
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2107
2107
|
* @example
|
|
2108
2108
|
*```js
|
|
@@ -2152,23 +2152,26 @@ export enum EmbedEvent {
|
|
|
2152
2152
|
*/
|
|
2153
2153
|
FilterChanged = 'filterChanged',
|
|
2154
2154
|
/**
|
|
2155
|
-
* Emitted when a user clicks the **Go** button
|
|
2156
|
-
*
|
|
2155
|
+
* Emitted when a user clicks the **Go** button to initiate
|
|
2156
|
+
* a Natural Language Search query
|
|
2157
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2157
2158
|
*/
|
|
2158
2159
|
SageEmbedQuery = 'sageEmbedQuery',
|
|
2159
2160
|
/**
|
|
2160
|
-
* Emitted when a user selects a data source on the
|
|
2161
|
-
*
|
|
2161
|
+
* Emitted when a user selects a data source on the embedded
|
|
2162
|
+
* Natural Language Search interface.
|
|
2163
|
+
*
|
|
2164
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2162
2165
|
*/
|
|
2163
2166
|
SageWorksheetUpdated = 'sageWorksheetUpdated',
|
|
2164
2167
|
/**
|
|
2165
2168
|
* Emitted when a user updates a connection on the **Data** page
|
|
2166
|
-
* @version SDK : 1.27.0 |
|
|
2169
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
2167
2170
|
*/
|
|
2168
2171
|
UpdateConnection = 'updateConnection',
|
|
2169
2172
|
/**
|
|
2170
2173
|
* Emitted when a user updates a connection on the **Data** page
|
|
2171
|
-
* @version SDK : 1.27.0 |
|
|
2174
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
2172
2175
|
*/
|
|
2173
2176
|
CreateConnection = 'createConnection',
|
|
2174
2177
|
/**
|
|
@@ -2178,7 +2181,7 @@ export enum EmbedEvent {
|
|
|
2178
2181
|
* @returns viewId: string
|
|
2179
2182
|
* @returns liveboardId: string
|
|
2180
2183
|
* @returns isPublic: boolean
|
|
2181
|
-
* @version SDK : 1.26.0 |
|
|
2184
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2182
2185
|
*/
|
|
2183
2186
|
UpdatePersonalisedView = 'updatePersonalisedView',
|
|
2184
2187
|
/**
|
|
@@ -2187,7 +2190,7 @@ export enum EmbedEvent {
|
|
|
2187
2190
|
* @returns viewId: string
|
|
2188
2191
|
* @returns liveboardId: string
|
|
2189
2192
|
* @returns isPublic: boolean
|
|
2190
|
-
* @version SDK : 1.26.0 |
|
|
2193
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2191
2194
|
*/
|
|
2192
2195
|
SavePersonalisedView = 'savePersonalisedView',
|
|
2193
2196
|
/**
|
|
@@ -2196,28 +2199,28 @@ export enum EmbedEvent {
|
|
|
2196
2199
|
* @returns viewId: string
|
|
2197
2200
|
* @returns liveboardId: string
|
|
2198
2201
|
* @returns isPublic: boolean
|
|
2199
|
-
* @version SDK : 1.26.0 |
|
|
2202
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2200
2203
|
*/
|
|
2201
2204
|
ResetLiveboard = 'resetLiveboard',
|
|
2202
2205
|
/**
|
|
2203
2206
|
* Emitted when a PersonalisedView is deleted.
|
|
2204
2207
|
* @returns views: string[]
|
|
2205
2208
|
* @returns liveboardId: string
|
|
2206
|
-
* @version SDK : 1.26.0 |
|
|
2209
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2207
2210
|
*/
|
|
2208
2211
|
DeletePersonalisedView = 'deletePersonalisedView',
|
|
2209
2212
|
/**
|
|
2210
2213
|
* Emitted when a user creates a new worksheet
|
|
2211
|
-
* @version SDK : 1.27.0 |
|
|
2214
|
+
* @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
2212
2215
|
*/
|
|
2213
2216
|
CreateWorksheet = 'createWorksheet',
|
|
2214
2217
|
/**
|
|
2215
|
-
* Emitted when Ask Sage is initialized.
|
|
2218
|
+
* Emitted when the *Ask Sage* is initialized.
|
|
2216
2219
|
* @returns viewName: string
|
|
2217
2220
|
* @returns viewId: string
|
|
2218
2221
|
* @returns liveboardId: string
|
|
2219
2222
|
* @returns isPublic: boolean
|
|
2220
|
-
* @version SDK : 1.29.0 |
|
|
2223
|
+
* @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
2221
2224
|
*/
|
|
2222
2225
|
AskSageInit = 'AskSageInit',
|
|
2223
2226
|
/**
|
|
@@ -2245,7 +2248,7 @@ export enum EmbedEvent {
|
|
|
2245
2248
|
*
|
|
2246
2249
|
* error: Developers can customize the error message text when `execute`
|
|
2247
2250
|
* returns `false` using the error parameter in responder.
|
|
2248
|
-
* @version SDK : 1.29.0 |
|
|
2251
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
2249
2252
|
* @example
|
|
2250
2253
|
*```js
|
|
2251
2254
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -2293,7 +2296,7 @@ export enum EmbedEvent {
|
|
|
2293
2296
|
* console.log('payload', payload);
|
|
2294
2297
|
* })
|
|
2295
2298
|
*```
|
|
2296
|
-
* @version SDK : 1.29.0 |
|
|
2299
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
2297
2300
|
*/
|
|
2298
2301
|
ParameterChanged = 'parameterChanged',
|
|
2299
2302
|
}
|
|
@@ -2442,7 +2445,7 @@ export enum HostEvent {
|
|
|
2442
2445
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
2443
2446
|
* console.log("iFrameURL",url);
|
|
2444
2447
|
* ```
|
|
2445
|
-
* @version SDK: 1.35.0 |
|
|
2448
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2446
2449
|
*/
|
|
2447
2450
|
GetIframeUrl = 'GetIframeUrl',
|
|
2448
2451
|
/**
|
|
@@ -2475,6 +2478,11 @@ export enum HostEvent {
|
|
|
2475
2478
|
* attributes passed with this event are appended to the existing runtime
|
|
2476
2479
|
* filters applied on a Liveboard.
|
|
2477
2480
|
*
|
|
2481
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
|
|
2482
|
+
* and `AppEmbed` only. In full application embedding, this event updates
|
|
2483
|
+
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
2484
|
+
*
|
|
2485
|
+
*
|
|
2478
2486
|
* Pass an array of runtime filters with the following attributes:
|
|
2479
2487
|
*
|
|
2480
2488
|
* `columnName` - _String_. The name of the column to filter on.
|
|
@@ -2485,9 +2493,12 @@ export enum HostEvent {
|
|
|
2485
2493
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
2486
2494
|
* single value, whereas BW and IN accept multiple values.
|
|
2487
2495
|
*
|
|
2488
|
-
* **Note**:
|
|
2489
|
-
*
|
|
2490
|
-
*
|
|
2496
|
+
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
2497
|
+
* object to its original state and applies new filter conditions.
|
|
2498
|
+
* Any user changes (like drilling into a visualization)
|
|
2499
|
+
* will be cleared, restoring the original visualization
|
|
2500
|
+
* with the updated filters.
|
|
2501
|
+
*
|
|
2491
2502
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2492
2503
|
* @example
|
|
2493
2504
|
* ```js
|
|
@@ -2502,7 +2513,7 @@ export enum HostEvent {
|
|
|
2502
2513
|
UpdateRuntimeFilters = 'UpdateRuntimeFilters',
|
|
2503
2514
|
/**
|
|
2504
2515
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2505
|
-
* This is the same as calling `appEmbed.navigateToPage(path, true)
|
|
2516
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
2506
2517
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
2507
2518
|
* be a number; for example, `1`, `-1`.
|
|
2508
2519
|
* @example
|
|
@@ -2797,7 +2808,9 @@ export enum HostEvent {
|
|
|
2797
2808
|
*/
|
|
2798
2809
|
GetTML = 'getTML',
|
|
2799
2810
|
/**
|
|
2800
|
-
* Trigger the **Show underlying data** action on
|
|
2811
|
+
* Trigger the **Show underlying data** action on a
|
|
2812
|
+
* chart or table.
|
|
2813
|
+
*
|
|
2801
2814
|
* @param - an object with vizId as a key
|
|
2802
2815
|
* @example
|
|
2803
2816
|
* ```js
|
|
@@ -2831,8 +2844,8 @@ export enum HostEvent {
|
|
|
2831
2844
|
*/
|
|
2832
2845
|
Delete = 'onDeleteAnswer',
|
|
2833
2846
|
/**
|
|
2834
|
-
* Trigger the **SpotIQ analyze** action on
|
|
2835
|
-
* or
|
|
2847
|
+
* Trigger the **SpotIQ analyze** action on a
|
|
2848
|
+
* chart or table.
|
|
2836
2849
|
* @param - Liveboard embed takes `vizId` as a
|
|
2837
2850
|
* key. Can be left undefined when embedding Search or
|
|
2838
2851
|
* visualization.
|
|
@@ -3105,7 +3118,7 @@ export enum HostEvent {
|
|
|
3105
3118
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3106
3119
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
3107
3120
|
* ```
|
|
3108
|
-
* @version SDK: 1.26.0 |
|
|
3121
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3109
3122
|
*/
|
|
3110
3123
|
SetVisibleTabs = 'SetPinboardVisibleTabs',
|
|
3111
3124
|
/**
|
|
@@ -3118,7 +3131,7 @@ export enum HostEvent {
|
|
|
3118
3131
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
3119
3132
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
3120
3133
|
* ```
|
|
3121
|
-
* @version SDK: 1.26.0 |
|
|
3134
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3122
3135
|
*/
|
|
3123
3136
|
SetHiddenTabs = 'SetPinboardHiddenTabs',
|
|
3124
3137
|
/**
|
|
@@ -3132,7 +3145,7 @@ export enum HostEvent {
|
|
|
3132
3145
|
* executeSearch: true,
|
|
3133
3146
|
* })
|
|
3134
3147
|
* ```
|
|
3135
|
-
* @version SDK: 1.26.0 |
|
|
3148
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3136
3149
|
*/
|
|
3137
3150
|
UpdateSageQuery = 'updateSageQuery',
|
|
3138
3151
|
/**
|
|
@@ -3149,21 +3162,22 @@ export enum HostEvent {
|
|
|
3149
3162
|
* ```js
|
|
3150
3163
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
3151
3164
|
* ```
|
|
3152
|
-
* @version SDK: 1.26.0 |
|
|
3165
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
3153
3166
|
*/
|
|
3154
3167
|
GetAnswerSession = 'getAnswerSession',
|
|
3155
3168
|
/**
|
|
3156
|
-
* Trigger Ask Sage for
|
|
3169
|
+
* Trigger the *Ask Sage* action for visualizations
|
|
3157
3170
|
* @example
|
|
3158
3171
|
* ```js
|
|
3159
3172
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
3160
3173
|
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
3161
3174
|
* ```
|
|
3162
|
-
* @version SDK: 1.29.0 |
|
|
3175
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3163
3176
|
*/
|
|
3164
3177
|
AskSage = 'AskSage',
|
|
3165
3178
|
/**
|
|
3166
|
-
* Trigger cross filter update action on a Liveboard
|
|
3179
|
+
* Trigger cross filter update action on a Liveboard.
|
|
3180
|
+
*
|
|
3167
3181
|
* @example
|
|
3168
3182
|
* ```js
|
|
3169
3183
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -3174,7 +3188,7 @@ export enum HostEvent {
|
|
|
3174
3188
|
* ],
|
|
3175
3189
|
* });
|
|
3176
3190
|
* ```
|
|
3177
|
-
* @version SDK: 1.29.0 |
|
|
3191
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
|
|
3178
3192
|
*/
|
|
3179
3193
|
UpdateCrossFilter = 'UpdateCrossFilter',
|
|
3180
3194
|
/**
|
|
@@ -3183,11 +3197,13 @@ export enum HostEvent {
|
|
|
3183
3197
|
* ```js
|
|
3184
3198
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
3185
3199
|
* ```
|
|
3186
|
-
* @version SDK: 1.29.0 |
|
|
3200
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
3187
3201
|
*/
|
|
3188
3202
|
ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
|
|
3189
3203
|
/**
|
|
3190
|
-
* Triggers an
|
|
3204
|
+
* Triggers an action to update Parameter values on embedded
|
|
3205
|
+
* Answers and Liveboard.
|
|
3206
|
+
*
|
|
3191
3207
|
* @example
|
|
3192
3208
|
* ```js
|
|
3193
3209
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -3195,30 +3211,30 @@ export enum HostEvent {
|
|
|
3195
3211
|
* value: "almond"
|
|
3196
3212
|
* }])
|
|
3197
3213
|
*
|
|
3198
|
-
* @version SDK: 1.29.0 |
|
|
3214
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3199
3215
|
*/
|
|
3200
3216
|
UpdateParameters = 'UpdateParameters',
|
|
3201
3217
|
/**
|
|
3202
|
-
* Triggers GetParameters to fetch the runtime
|
|
3218
|
+
* Triggers GetParameters to fetch the runtime Parameters.
|
|
3203
3219
|
* ```js
|
|
3204
3220
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
3205
3221
|
* console.log('parameters', parameter);
|
|
3206
3222
|
* });
|
|
3207
3223
|
*```
|
|
3208
|
-
* @version SDK: 1.29.0 |
|
|
3224
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3209
3225
|
*/
|
|
3210
3226
|
GetParameters = 'GetParameters',
|
|
3211
3227
|
/**
|
|
3212
|
-
* Triggers an event to update a
|
|
3228
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
3213
3229
|
* ```js
|
|
3214
3230
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
3215
3231
|
* ```
|
|
3216
|
-
* @version SDK: 1.36.0 |
|
|
3232
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3217
3233
|
*/
|
|
3218
3234
|
UpdatePersonalisedView = 'UpdatePersonalisedView',
|
|
3219
3235
|
/**
|
|
3220
|
-
* Triggers the action to get the current view of the
|
|
3221
|
-
* @version SDK: 1.36.0 |
|
|
3236
|
+
* Triggers the action to get the current view of the Liveboard.
|
|
3237
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3222
3238
|
*/
|
|
3223
3239
|
SaveAnswer = 'saveAnswer',
|
|
3224
3240
|
/**
|
|
@@ -3445,7 +3461,8 @@ export enum Action {
|
|
|
3445
3461
|
ResetLayout = 'resetLayout',
|
|
3446
3462
|
/**
|
|
3447
3463
|
* The **Schedule** menu action on a Liveboard.
|
|
3448
|
-
* Allows scheduling a Liveboard
|
|
3464
|
+
* Allows scheduling a Liveboard job, for example,
|
|
3465
|
+
* sending periodic notifications.
|
|
3449
3466
|
* @example
|
|
3450
3467
|
* ```js
|
|
3451
3468
|
* disabledActions: [Action.Schedule]
|
|
@@ -3487,7 +3504,7 @@ export enum Action {
|
|
|
3487
3504
|
* ```js
|
|
3488
3505
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
3489
3506
|
* ```
|
|
3490
|
-
* @version SDK: 1.32.0 |
|
|
3507
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3491
3508
|
*/
|
|
3492
3509
|
AddDataPanelObjects = 'addDataPanelObjects',
|
|
3493
3510
|
/**
|
|
@@ -3500,7 +3517,28 @@ export enum Action {
|
|
|
3500
3517
|
* ```
|
|
3501
3518
|
*/
|
|
3502
3519
|
ConfigureFilter = 'configureFilter',
|
|
3520
|
+
/**
|
|
3521
|
+
* The **Collapse data sources** icon on the Search page.
|
|
3522
|
+
* Collapses the panel showing data sources.
|
|
3523
|
+
*
|
|
3524
|
+
* @example
|
|
3525
|
+
* ```js
|
|
3526
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
3527
|
+
* ```
|
|
3528
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3529
|
+
*/
|
|
3503
3530
|
CollapseDataSources = 'collapseDataSources',
|
|
3531
|
+
/**
|
|
3532
|
+
* The **Collapse data panel** icon on the Search page.
|
|
3533
|
+
* Collapses the data panel view.
|
|
3534
|
+
*
|
|
3535
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
|
|
3536
|
+
*
|
|
3537
|
+
* @example
|
|
3538
|
+
* ```js
|
|
3539
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
3540
|
+
* ```
|
|
3541
|
+
*/
|
|
3504
3542
|
CollapseDataPanel = 'collapseDataPanel',
|
|
3505
3543
|
/**
|
|
3506
3544
|
* The **Choose sources** button on Search page.
|
|
@@ -3536,7 +3574,7 @@ export enum Action {
|
|
|
3536
3574
|
* ```js
|
|
3537
3575
|
* disabledActions: [Action.AddColumnSet]
|
|
3538
3576
|
* ```
|
|
3539
|
-
* @version SDK: 1.32.0 |
|
|
3577
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3540
3578
|
*/
|
|
3541
3579
|
AddColumnSet = 'addSimpleCohort',
|
|
3542
3580
|
/**
|
|
@@ -3546,7 +3584,7 @@ export enum Action {
|
|
|
3546
3584
|
* ```js
|
|
3547
3585
|
* disabledActions: [Action.AddQuerySet]
|
|
3548
3586
|
* ```
|
|
3549
|
-
* @version SDK: 1.32.0 |
|
|
3587
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3550
3588
|
*/
|
|
3551
3589
|
AddQuerySet = 'addAdvancedCohort',
|
|
3552
3590
|
/**
|
|
@@ -3578,6 +3616,8 @@ export enum Action {
|
|
|
3578
3616
|
/**
|
|
3579
3617
|
* The **Show underlying data** menu action on a visualization or
|
|
3580
3618
|
* Answer page.
|
|
3619
|
+
* Displays detailed information and raw data
|
|
3620
|
+
* for a given visualization.
|
|
3581
3621
|
* @example
|
|
3582
3622
|
* ```js
|
|
3583
3623
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -3779,6 +3819,7 @@ export enum Action {
|
|
|
3779
3819
|
AnalysisInfo = 'analysisInfo',
|
|
3780
3820
|
/**
|
|
3781
3821
|
* The **Schedule** menu action on a Liveboard.
|
|
3822
|
+
* Allows scheduling a Liveboard job.
|
|
3782
3823
|
* @example
|
|
3783
3824
|
* ```js
|
|
3784
3825
|
* disabledActions: [Action.Subscription]
|
|
@@ -3849,8 +3890,13 @@ export enum Action {
|
|
|
3849
3890
|
*/
|
|
3850
3891
|
RequestAccess = 'requestAccess',
|
|
3851
3892
|
/**
|
|
3852
|
-
* The **Query visualizer** and **Query SQL** buttons in
|
|
3853
|
-
* of the Answer page
|
|
3893
|
+
* The **Query visualizer** and **Query SQL** buttons in
|
|
3894
|
+
* Query details panel of the Answer page.
|
|
3895
|
+
*
|
|
3896
|
+
* **Query visualizer** - Displays the tables
|
|
3897
|
+
* and filters used in a search query.
|
|
3898
|
+
* **Query SQL** - Displays the SQL statements used
|
|
3899
|
+
* in a search query to fetch data.
|
|
3854
3900
|
* @example
|
|
3855
3901
|
* ```js
|
|
3856
3902
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3868,7 +3914,10 @@ export enum Action {
|
|
|
3868
3914
|
*/
|
|
3869
3915
|
AnswerDelete = 'onDeleteAnswer',
|
|
3870
3916
|
/**
|
|
3871
|
-
* The
|
|
3917
|
+
* The chart switcher icon on Answer page and
|
|
3918
|
+
* visualizations in edit mode.
|
|
3919
|
+
* Allows switching to the table or chart mode
|
|
3920
|
+
* when editing a visualization.
|
|
3872
3921
|
* @example
|
|
3873
3922
|
* ```js
|
|
3874
3923
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3877,7 +3926,10 @@ export enum Action {
|
|
|
3877
3926
|
*/
|
|
3878
3927
|
AnswerChartSwitcher = 'answerChartSwitcher',
|
|
3879
3928
|
/**
|
|
3880
|
-
* Favorites icon (*)
|
|
3929
|
+
* The Favorites icon (*) for Answers,
|
|
3930
|
+
* Liveboard, and data objects like Worksheet, Model,
|
|
3931
|
+
* Tables and Views.
|
|
3932
|
+
* Allows adding an object to the user’s favorites list.
|
|
3881
3933
|
* @example
|
|
3882
3934
|
* ```js
|
|
3883
3935
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3895,7 +3947,9 @@ export enum Action {
|
|
|
3895
3947
|
*/
|
|
3896
3948
|
EditDetails = 'editDetails',
|
|
3897
3949
|
/**
|
|
3898
|
-
* The Create alert action
|
|
3950
|
+
* The *Create alert* action for KPI charts.
|
|
3951
|
+
* Allows users to schedule threshold-based alerts
|
|
3952
|
+
* for KPI charts.
|
|
3899
3953
|
* @example
|
|
3900
3954
|
* ```js
|
|
3901
3955
|
* disabledActions: [Action.CreateMonitor]
|
|
@@ -3951,7 +4005,7 @@ export enum Action {
|
|
|
3951
4005
|
* ```js
|
|
3952
4006
|
* disabledActions: [Action.CrossFilter]
|
|
3953
4007
|
* ```
|
|
3954
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4008
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
|
|
3955
4009
|
*/
|
|
3956
4010
|
CrossFilter = 'context-menu-item-cross-filter',
|
|
3957
4011
|
/**
|
|
@@ -3961,7 +4015,7 @@ export enum Action {
|
|
|
3961
4015
|
* ```js
|
|
3962
4016
|
* disabledActions: [Action.SyncToSlack]
|
|
3963
4017
|
* ```
|
|
3964
|
-
* @version @version SDK : 1.32.0 |
|
|
4018
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
3965
4019
|
*/
|
|
3966
4020
|
SyncToSlack = 'syncToSlack',
|
|
3967
4021
|
/**
|
|
@@ -3971,7 +4025,7 @@ export enum Action {
|
|
|
3971
4025
|
* ```js
|
|
3972
4026
|
* disabledActions: [Action.SyncToTeams]
|
|
3973
4027
|
* ```
|
|
3974
|
-
* @version @version SDK : 1.32.0 |
|
|
4028
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
3975
4029
|
*/
|
|
3976
4030
|
SyncToTeams = 'syncToTeams',
|
|
3977
4031
|
/**
|
|
@@ -3982,7 +4036,7 @@ export enum Action {
|
|
|
3982
4036
|
* ```js
|
|
3983
4037
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
3984
4038
|
* ```
|
|
3985
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4039
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3986
4040
|
*/
|
|
3987
4041
|
RemoveCrossFilter = 'context-menu-item-remove-cross-filter',
|
|
3988
4042
|
/**
|
|
@@ -3993,7 +4047,7 @@ export enum Action {
|
|
|
3993
4047
|
* ```js
|
|
3994
4048
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
3995
4049
|
* ```
|
|
3996
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4050
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3997
4051
|
*/
|
|
3998
4052
|
AxisMenuAggregate = 'axisMenuAggregate',
|
|
3999
4053
|
/**
|
|
@@ -4004,17 +4058,19 @@ export enum Action {
|
|
|
4004
4058
|
* ```js
|
|
4005
4059
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
4006
4060
|
* ```
|
|
4007
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4061
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4008
4062
|
*/
|
|
4009
4063
|
AxisMenuTimeBucket = 'axisMenuTimeBucket',
|
|
4010
4064
|
/**
|
|
4011
4065
|
* The **Filter** action in the chart axis or table column
|
|
4012
4066
|
* customization menu.
|
|
4067
|
+
* Allows adding, editing, or removing filters.
|
|
4068
|
+
*
|
|
4013
4069
|
* @example
|
|
4014
4070
|
* ```js
|
|
4015
4071
|
* disabledActions: [Action.AxisMenuFilter]
|
|
4016
4072
|
* ```
|
|
4017
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4073
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4018
4074
|
*/
|
|
4019
4075
|
AxisMenuFilter = 'axisMenuFilter',
|
|
4020
4076
|
/**
|
|
@@ -4025,7 +4081,7 @@ export enum Action {
|
|
|
4025
4081
|
* ```js
|
|
4026
4082
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
4027
4083
|
* ```
|
|
4028
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4084
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4029
4085
|
*/
|
|
4030
4086
|
AxisMenuConditionalFormat = 'axisMenuConditionalFormat',
|
|
4031
4087
|
/**
|
|
@@ -4036,7 +4092,7 @@ export enum Action {
|
|
|
4036
4092
|
* ```js
|
|
4037
4093
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
4038
4094
|
* ```
|
|
4039
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4095
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4040
4096
|
*/
|
|
4041
4097
|
AxisMenuSort = 'axisMenuSort',
|
|
4042
4098
|
/**
|
|
@@ -4048,7 +4104,7 @@ export enum Action {
|
|
|
4048
4104
|
* ```js
|
|
4049
4105
|
* disabledActions: [Action.AxisMenuGroup]
|
|
4050
4106
|
* ```
|
|
4051
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4107
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4052
4108
|
*/
|
|
4053
4109
|
AxisMenuGroup = 'axisMenuGroup',
|
|
4054
4110
|
/**
|
|
@@ -4059,7 +4115,7 @@ export enum Action {
|
|
|
4059
4115
|
* ```js
|
|
4060
4116
|
* disabledActions: [Action.AxisMenuPosition]
|
|
4061
4117
|
* ```
|
|
4062
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4118
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4063
4119
|
*/
|
|
4064
4120
|
AxisMenuPosition = 'axisMenuPosition',
|
|
4065
4121
|
/**
|
|
@@ -4069,7 +4125,7 @@ export enum Action {
|
|
|
4069
4125
|
* ```js
|
|
4070
4126
|
* disabledActions: [Action.AxisMenuRename]
|
|
4071
4127
|
* ```
|
|
4072
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4128
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4073
4129
|
*/
|
|
4074
4130
|
AxisMenuRename = 'axisMenuRename',
|
|
4075
4131
|
/**
|
|
@@ -4080,7 +4136,7 @@ export enum Action {
|
|
|
4080
4136
|
* ```js
|
|
4081
4137
|
* disabledActions: [Action.AxisMenuEdit]
|
|
4082
4138
|
* ```
|
|
4083
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4139
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4084
4140
|
*/
|
|
4085
4141
|
AxisMenuEdit = 'axisMenuEdit',
|
|
4086
4142
|
/**
|
|
@@ -4090,7 +4146,7 @@ export enum Action {
|
|
|
4090
4146
|
* ```js
|
|
4091
4147
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
4092
4148
|
* ```
|
|
4093
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4149
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4094
4150
|
*/
|
|
4095
4151
|
AxisMenuNumberFormat = 'axisMenuNumberFormat',
|
|
4096
4152
|
/**
|
|
@@ -4100,7 +4156,7 @@ export enum Action {
|
|
|
4100
4156
|
* ```js
|
|
4101
4157
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
4102
4158
|
* ```
|
|
4103
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4159
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4104
4160
|
*/
|
|
4105
4161
|
AxisMenuTextWrapping = 'axisMenuTextWrapping',
|
|
4106
4162
|
/**
|
|
@@ -4112,7 +4168,7 @@ export enum Action {
|
|
|
4112
4168
|
* ```js
|
|
4113
4169
|
* disabledActions: [Action.AxisMenuRemove]
|
|
4114
4170
|
* ```
|
|
4115
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4171
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4116
4172
|
*/
|
|
4117
4173
|
AxisMenuRemove = 'axisMenuRemove',
|
|
4118
4174
|
/**
|
|
@@ -4126,26 +4182,27 @@ export enum Action {
|
|
|
4126
4182
|
* ```js
|
|
4127
4183
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
4128
4184
|
* ```
|
|
4129
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4185
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
|
|
4130
4186
|
*/
|
|
4131
4187
|
RenameModalTitleDescription = 'renameModalTitleDescription',
|
|
4132
4188
|
/**
|
|
4133
|
-
*
|
|
4189
|
+
* The *Request verification* action on a Liveboard.
|
|
4190
|
+
* Initiates a request for Liveboard verification.
|
|
4134
4191
|
* @example
|
|
4135
4192
|
* ```js
|
|
4136
4193
|
* disabledActions: [Action.RequestVerification]
|
|
4137
4194
|
* ```
|
|
4138
|
-
* @version SDK: 1.25.0 |
|
|
4195
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
4139
4196
|
*/
|
|
4140
4197
|
RequestVerification = 'requestVerification',
|
|
4141
4198
|
/**
|
|
4142
4199
|
*
|
|
4143
|
-
*Allows users to mark a Liveboard as verified.
|
|
4200
|
+
* Allows users to mark a Liveboard as verified.
|
|
4144
4201
|
* @example
|
|
4145
4202
|
* ```js
|
|
4146
4203
|
* disabledActions: [Action.MarkAsVerified]
|
|
4147
4204
|
* ```
|
|
4148
|
-
* @version SDK: 1.25.0 |
|
|
4205
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
4149
4206
|
*/
|
|
4150
4207
|
MarkAsVerified = 'markAsVerified',
|
|
4151
4208
|
/**
|
|
@@ -4155,7 +4212,7 @@ export enum Action {
|
|
|
4155
4212
|
* ```js
|
|
4156
4213
|
* disabledActions: [Action.AddTab]
|
|
4157
4214
|
* ```
|
|
4158
|
-
* @version SDK: 1.26.0 |
|
|
4215
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4159
4216
|
*/
|
|
4160
4217
|
AddTab = 'addTab',
|
|
4161
4218
|
/**
|
|
@@ -4165,35 +4222,42 @@ export enum Action {
|
|
|
4165
4222
|
* ```js
|
|
4166
4223
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
4167
4224
|
* ```
|
|
4168
|
-
* @version SDK: 1.25.0 |
|
|
4225
|
+
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
4169
4226
|
*/
|
|
4170
4227
|
EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
|
|
4171
4228
|
/**
|
|
4229
|
+
* Action ID to hide or disable Natural Language Search query.
|
|
4172
4230
|
*
|
|
4173
4231
|
* @example
|
|
4174
4232
|
* ```js
|
|
4175
4233
|
* disabledActions: [Action.ShowSageQuery]
|
|
4176
4234
|
* ```
|
|
4177
|
-
* @version SDK: 1.26.0 |
|
|
4235
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
4178
4236
|
*/
|
|
4179
4237
|
ShowSageQuery = 'showSageQuery',
|
|
4180
4238
|
/**
|
|
4239
|
+
*
|
|
4240
|
+
* Action ID to hide or disable the edit option for the
|
|
4241
|
+
* results generated from the
|
|
4242
|
+
* Natural Language Search query.
|
|
4181
4243
|
*
|
|
4182
4244
|
* @example
|
|
4183
4245
|
* ```js
|
|
4184
4246
|
* disabledActions: [Action.EditSageAnswer]
|
|
4185
4247
|
* ```
|
|
4186
|
-
* @version SDK: 1.26.0 |
|
|
4248
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
4187
4249
|
*/
|
|
4188
4250
|
EditSageAnswer = 'editSageAnswer',
|
|
4189
4251
|
/**
|
|
4252
|
+
* The feedback widget for AI-generated Answers.
|
|
4253
|
+
* Allows users to send feedback on the Answers generated
|
|
4254
|
+
* from a Natural Language Search query.
|
|
4190
4255
|
*
|
|
4191
|
-
*This action allows users to send feedback on AI-generated Answers.
|
|
4192
4256
|
* @example
|
|
4193
4257
|
* ```js
|
|
4194
4258
|
* disabledActions: [Action.SageAnswerFeedback]
|
|
4195
4259
|
* ```
|
|
4196
|
-
* @version SDK: 1.26.0 |
|
|
4260
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
4197
4261
|
*/
|
|
4198
4262
|
SageAnswerFeedback = 'sageAnswerFeedback',
|
|
4199
4263
|
/**
|
|
@@ -4202,7 +4266,7 @@ export enum Action {
|
|
|
4202
4266
|
* ```js
|
|
4203
4267
|
* disabledActions: [Action.ModifySageAnswer]
|
|
4204
4268
|
* ```
|
|
4205
|
-
* @version SDK: 1.26.0 |
|
|
4269
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
4206
4270
|
*/
|
|
4207
4271
|
ModifySageAnswer = 'modifySageAnswer',
|
|
4208
4272
|
/**
|
|
@@ -4215,7 +4279,10 @@ export enum Action {
|
|
|
4215
4279
|
*/
|
|
4216
4280
|
MoveToTab = 'onContainerMove',
|
|
4217
4281
|
/**
|
|
4218
|
-
* The **Manage
|
|
4282
|
+
* The **Manage Alerts** menu action on KPI visualizations.
|
|
4283
|
+
* Allows creating, viewing, and editing monitor
|
|
4284
|
+
* alerts for a KPI chart.
|
|
4285
|
+
*
|
|
4219
4286
|
* @example
|
|
4220
4287
|
* ```js
|
|
4221
4288
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -4223,21 +4290,23 @@ export enum Action {
|
|
|
4223
4290
|
*/
|
|
4224
4291
|
ManageMonitor = 'manageMonitor',
|
|
4225
4292
|
/**
|
|
4226
|
-
*
|
|
4293
|
+
* The Liveboard Personalised Views dropdown.
|
|
4294
|
+
* Allows navigating to a personalized Liveboard View.
|
|
4227
4295
|
* @example
|
|
4228
4296
|
* ```js
|
|
4229
4297
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4230
4298
|
* ```
|
|
4231
|
-
* @version SDK : 1.26.0 |
|
|
4299
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4232
4300
|
*/
|
|
4233
4301
|
PersonalisedViewsDropdown = 'personalisedViewsDropdown',
|
|
4234
4302
|
/**
|
|
4235
|
-
* Action ID for
|
|
4303
|
+
* Action ID for show or hide the user details on a
|
|
4304
|
+
* Liveboard (Recently visited / social proof)
|
|
4236
4305
|
* @example
|
|
4237
4306
|
* ```js
|
|
4238
4307
|
* disabledActions: [Action.LiveboardUsers]
|
|
4239
4308
|
* ```
|
|
4240
|
-
* @version SDK : 1.26.0 |
|
|
4309
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4241
4310
|
*/
|
|
4242
4311
|
LiveboardUsers = 'liveboardUsers',
|
|
4243
4312
|
|
|
@@ -4256,119 +4325,133 @@ export enum Action {
|
|
|
4256
4325
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4257
4326
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4258
4327
|
* ```
|
|
4259
|
-
* @version SDK : 1.28.3 |
|
|
4328
|
+
* @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4260
4329
|
*/
|
|
4261
4330
|
TML = 'tml',
|
|
4262
|
-
|
|
4263
4331
|
/**
|
|
4264
|
-
*
|
|
4265
|
-
* and Pin modal
|
|
4332
|
+
* The **Create Liveboard* action on
|
|
4333
|
+
* the Liveboards page and the Pin modal.
|
|
4334
|
+
* Allows users to create a Liveboard.
|
|
4335
|
+
*
|
|
4266
4336
|
* @example
|
|
4267
4337
|
* ```js
|
|
4268
4338
|
* hiddenAction: [Action.CreateLiveboard]
|
|
4269
4339
|
* disabledActions: [Action.CreateLiveboard]
|
|
4270
4340
|
* ```
|
|
4271
|
-
* @version SDK: 1.32.0 |
|
|
4341
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4272
4342
|
*/
|
|
4273
4343
|
CreateLiveboard = 'createLiveboard',
|
|
4274
4344
|
|
|
4275
4345
|
/**
|
|
4276
|
-
* Action ID for to hide
|
|
4346
|
+
* Action ID for to hide or disable the
|
|
4347
|
+
* Verified Liveboard banner.
|
|
4277
4348
|
* @example
|
|
4278
4349
|
* ```js
|
|
4279
4350
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
4280
4351
|
* ```
|
|
4281
|
-
* @version SDK: 1.29.0 |
|
|
4352
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
4282
4353
|
*/
|
|
4283
4354
|
VerifiedLiveboard = 'verifiedLiveboard',
|
|
4284
4355
|
|
|
4285
4356
|
/**
|
|
4286
|
-
*
|
|
4357
|
+
* The *Ask Sage* action for Answers and visualizations.
|
|
4358
|
+
* Allows initiating a Natural Language Search query.
|
|
4359
|
+
*
|
|
4287
4360
|
* @example
|
|
4288
4361
|
* ```js
|
|
4289
4362
|
* hiddenAction: [Action.AskAi]
|
|
4290
4363
|
* ```
|
|
4291
|
-
* @version SDK: 1.29.0 |
|
|
4364
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4292
4365
|
*/
|
|
4293
4366
|
AskAi = 'AskAi',
|
|
4294
4367
|
|
|
4295
4368
|
/**
|
|
4296
4369
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
4370
|
+
* Adds a KPI chart to the watchlist on the Home page.
|
|
4297
4371
|
* @example
|
|
4298
4372
|
* ```js
|
|
4299
4373
|
* disabledActions: [Action.AddToWatchlist]
|
|
4300
4374
|
* ```
|
|
4301
|
-
* @version SDK : 1.27.9 |
|
|
4375
|
+
* @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4302
4376
|
*/
|
|
4303
4377
|
AddToWatchlist = 'addToWatchlist',
|
|
4304
4378
|
|
|
4305
4379
|
/**
|
|
4306
4380
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
4381
|
+
* Removes a KPI chart from the watchlist on the Home page.
|
|
4307
4382
|
* @example
|
|
4308
4383
|
* ```js
|
|
4309
4384
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4310
4385
|
* ```
|
|
4311
|
-
* @version SDK : 1.27.9 |
|
|
4386
|
+
* @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4312
4387
|
*/
|
|
4313
4388
|
RemoveFromWatchlist = 'removeFromWatchlist',
|
|
4314
|
-
|
|
4315
4389
|
/**
|
|
4316
|
-
* The **
|
|
4390
|
+
* The **Organize Favourites** action on Homepage
|
|
4391
|
+
* *Favorites* module.
|
|
4392
|
+
*
|
|
4317
4393
|
* @example
|
|
4318
4394
|
* ```js
|
|
4319
4395
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4320
4396
|
* ```
|
|
4321
|
-
* @version SDK : 1.32.0 |
|
|
4397
|
+
* @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4322
4398
|
*/
|
|
4323
4399
|
OrganiseFavourites = 'organiseFavourites',
|
|
4324
4400
|
|
|
4325
4401
|
/**
|
|
4326
|
-
*
|
|
4402
|
+
* The **AI Highlights** action on a Liveboard.
|
|
4403
|
+
*
|
|
4327
4404
|
* @example
|
|
4328
4405
|
* ```js
|
|
4329
4406
|
* hiddenAction: [Action.AIHighlights]
|
|
4330
4407
|
* ```
|
|
4331
|
-
* @version SDK: 1.27.10 |
|
|
4408
|
+
* @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4332
4409
|
*/
|
|
4333
4410
|
AIHighlights = 'AIHighlights',
|
|
4334
4411
|
|
|
4335
4412
|
/**
|
|
4336
|
-
*
|
|
4413
|
+
* The *Edit* action on the *Liveboard Schedules* page
|
|
4414
|
+
* (new Homepage experience).
|
|
4415
|
+
* Allows editing Liveboard schedules.
|
|
4416
|
+
*
|
|
4337
4417
|
* @example
|
|
4338
4418
|
* ```js
|
|
4339
4419
|
* disabledActions: [Action.EditScheduleHomepage]
|
|
4340
4420
|
* ```
|
|
4341
|
-
* @version SDK: 1.34.0 |
|
|
4421
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4342
4422
|
*/
|
|
4343
4423
|
EditScheduleHomepage = 'editScheduleHomepage',
|
|
4344
4424
|
|
|
4345
4425
|
/**
|
|
4346
|
-
*
|
|
4426
|
+
* The *Pause* action on the *Liveboard Schedules* page
|
|
4427
|
+
* Pauses a scheduled Liveboard job.
|
|
4347
4428
|
* @example
|
|
4348
4429
|
* ```js
|
|
4349
4430
|
* disabledActions: [Action.PauseScheduleHomepage]
|
|
4350
4431
|
* ```
|
|
4351
|
-
* @version SDK: 1.34.0 |
|
|
4432
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4352
4433
|
*/
|
|
4353
4434
|
PauseScheduleHomepage = 'pauseScheduleHomepage',
|
|
4354
4435
|
|
|
4355
4436
|
/**
|
|
4356
|
-
*
|
|
4437
|
+
* The **View run history** action **Liveboard Schedules** page.
|
|
4438
|
+
* Allows viewing schedule run history.
|
|
4357
4439
|
* @example
|
|
4358
4440
|
* ```js
|
|
4359
4441
|
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
4360
4442
|
* ```
|
|
4361
|
-
* @version SDK: 1.34.0 |
|
|
4443
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
4362
4444
|
*/
|
|
4363
4445
|
ViewScheduleRunHomepage = 'viewScheduleRunHomepage',
|
|
4364
4446
|
|
|
4365
4447
|
/**
|
|
4366
|
-
* Action ID
|
|
4448
|
+
* Action ID to hide or disable the
|
|
4449
|
+
* unsubscribe option for Liveboard schedules.
|
|
4367
4450
|
* @example
|
|
4368
4451
|
* ```js
|
|
4369
4452
|
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
4370
4453
|
* ```
|
|
4371
|
-
* @version SDK: 1.34.0 |
|
|
4454
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
4372
4455
|
*/
|
|
4373
4456
|
UnsubscribeScheduleHomepage = 'unsubscribeScheduleHomepage',
|
|
4374
4457
|
|
|
@@ -4378,17 +4461,18 @@ export enum Action {
|
|
|
4378
4461
|
* ```js
|
|
4379
4462
|
* disabledActions: [Action.ManageTags]
|
|
4380
4463
|
* ```
|
|
4381
|
-
* @version SDK : 1.34.0 |
|
|
4464
|
+
* @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4382
4465
|
*/
|
|
4383
4466
|
ManageTags = 'manageTags',
|
|
4384
4467
|
|
|
4385
4468
|
/**
|
|
4386
|
-
*
|
|
4469
|
+
* The **Delete** action on the **Liveboard Schedules* page.
|
|
4470
|
+
* Deletes a Liveboard schedule.
|
|
4387
4471
|
* @example
|
|
4388
4472
|
* ```js
|
|
4389
4473
|
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
4390
4474
|
* ```
|
|
4391
|
-
* @version SDK: 1.34.0 |
|
|
4475
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
4392
4476
|
*/
|
|
4393
4477
|
DeleteScheduleHomepage = 'deleteScheduleHomepage',
|
|
4394
4478
|
|
|
@@ -4398,7 +4482,7 @@ export enum Action {
|
|
|
4398
4482
|
* ```js
|
|
4399
4483
|
* disabledActions: [Action.KPIAnalysisCTA]
|
|
4400
4484
|
* ```
|
|
4401
|
-
* @version SDK: 1.34.0 |
|
|
4485
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4402
4486
|
*/
|
|
4403
4487
|
KPIAnalysisCTA = 'kpiAnalysisCTA',
|
|
4404
4488
|
/**
|
|
@@ -4407,77 +4491,85 @@ export enum Action {
|
|
|
4407
4491
|
* ```js
|
|
4408
4492
|
* const disabledActions = [Action.DisableChipReorder]
|
|
4409
4493
|
* ```
|
|
4410
|
-
* @version SDK: 1.36.0 |
|
|
4494
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4411
4495
|
*/
|
|
4412
4496
|
DisableChipReorder = 'disableChipReorder',
|
|
4413
4497
|
|
|
4414
4498
|
/**
|
|
4415
|
-
* Action ID
|
|
4499
|
+
* Action ID to show, hide, or disable filters
|
|
4500
|
+
* in a Liveboard tab.
|
|
4501
|
+
*
|
|
4416
4502
|
* @example
|
|
4417
4503
|
* ```js
|
|
4418
4504
|
* hiddenAction: [Action.ChangeFilterVisibilityInTab]
|
|
4419
4505
|
* ```
|
|
4420
|
-
* @version SDK: 1.36.0 |
|
|
4506
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4421
4507
|
*/
|
|
4422
4508
|
ChangeFilterVisibilityInTab = 'changeFilterVisibilityInTab',
|
|
4423
4509
|
|
|
4424
4510
|
/**
|
|
4425
|
-
*
|
|
4511
|
+
* The **Preview data** button on the Spotter interface.
|
|
4512
|
+
* Allows previewing the data used for Spotter queries.
|
|
4513
|
+
*
|
|
4426
4514
|
* @example
|
|
4427
4515
|
* ```js
|
|
4428
4516
|
* hiddenAction: [Action.PreviewDataSpotter]
|
|
4429
4517
|
* ```
|
|
4430
|
-
* @version SDK: 1.36.0 |
|
|
4518
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4431
4519
|
*/
|
|
4432
4520
|
PreviewDataSpotter = 'previewDataSpotter',
|
|
4433
4521
|
|
|
4434
4522
|
/**
|
|
4435
|
-
*
|
|
4523
|
+
* The **Reset** link on the Spotter interface.
|
|
4524
|
+
* Resets the conversation with Spotter.
|
|
4525
|
+
*
|
|
4436
4526
|
* @example
|
|
4437
4527
|
* ```js
|
|
4438
4528
|
* hiddenAction: [Action.ResetSpotterChat]
|
|
4439
4529
|
* ```
|
|
4440
|
-
* @version SDK: 1.36.0 |
|
|
4530
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4441
4531
|
*/
|
|
4442
4532
|
ResetSpotterChat = 'resetSpotterChat',
|
|
4443
|
-
|
|
4444
4533
|
/**
|
|
4445
|
-
* Action ID for hide
|
|
4534
|
+
* Action ID for hide or disable the
|
|
4535
|
+
* Spotter feedback widget.
|
|
4536
|
+
*
|
|
4446
4537
|
* @example
|
|
4447
4538
|
* ```js
|
|
4448
4539
|
* hiddenAction: [Action.SpotterFeedback]
|
|
4449
4540
|
* ```
|
|
4450
|
-
* @version SDK: 1.36.0 |
|
|
4541
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4451
4542
|
*/
|
|
4452
4543
|
SpotterFeedback = 'spotterFeedback',
|
|
4453
|
-
|
|
4454
4544
|
/**
|
|
4455
|
-
* Action ID for hide
|
|
4545
|
+
* Action ID for hide or disable
|
|
4546
|
+
* the previous prompt edit option in Spotter.
|
|
4547
|
+
*
|
|
4456
4548
|
* @example
|
|
4457
4549
|
* ```js
|
|
4458
4550
|
* hiddenAction: [Action.EditPreviousPrompt]
|
|
4459
4551
|
* ```
|
|
4460
|
-
* @version SDK: 1.36.0 |
|
|
4552
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4461
4553
|
*/
|
|
4462
4554
|
EditPreviousPrompt = 'editPreviousPrompt',
|
|
4463
|
-
|
|
4464
4555
|
/**
|
|
4465
|
-
* Action ID for hide
|
|
4556
|
+
* Action ID for hide or disable
|
|
4557
|
+
* the previous prompt deletion option in Spotter.
|
|
4558
|
+
*
|
|
4466
4559
|
* @example
|
|
4467
4560
|
* ```js
|
|
4468
4561
|
* hiddenAction: [Action.DeletePreviousPrompt]
|
|
4469
4562
|
* ```
|
|
4470
|
-
* @version SDK: 1.36.0 |
|
|
4563
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4471
4564
|
*/
|
|
4472
4565
|
DeletePreviousPrompt = 'deletePreviousPrompt',
|
|
4473
|
-
|
|
4474
4566
|
/**
|
|
4475
4567
|
* Action ID for hide/disable edit of tokens on spotter results.
|
|
4476
4568
|
* @example
|
|
4477
4569
|
* ```js
|
|
4478
4570
|
* hiddenAction: [Action.EditTokens]
|
|
4479
4571
|
* ```
|
|
4480
|
-
* @version SDK: 1.36.0 |
|
|
4572
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4481
4573
|
*/
|
|
4482
4574
|
EditTokens = 'editTokens',
|
|
4483
4575
|
}
|
|
@@ -4559,7 +4651,7 @@ export enum LogLevel {
|
|
|
4559
4651
|
* logLevel: LogLevel.SILENT,
|
|
4560
4652
|
* })
|
|
4561
4653
|
* ```
|
|
4562
|
-
* @version SDK: 1.26.7 |
|
|
4654
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4563
4655
|
*/
|
|
4564
4656
|
SILENT = 'SILENT',
|
|
4565
4657
|
/**
|
|
@@ -4571,7 +4663,7 @@ export enum LogLevel {
|
|
|
4571
4663
|
* logLevel: LogLevel.ERROR,
|
|
4572
4664
|
* })
|
|
4573
4665
|
* ```
|
|
4574
|
-
* @version SDK: 1.26.7 |
|
|
4666
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4575
4667
|
*/
|
|
4576
4668
|
ERROR = 'ERROR',
|
|
4577
4669
|
/**
|
|
@@ -4583,7 +4675,7 @@ export enum LogLevel {
|
|
|
4583
4675
|
* logLevel: LogLevel.WARN,
|
|
4584
4676
|
* })
|
|
4585
4677
|
* ```
|
|
4586
|
-
* @version SDK: 1.26.7 |
|
|
4678
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4587
4679
|
*/
|
|
4588
4680
|
WARN = 'WARN',
|
|
4589
4681
|
/**
|
|
@@ -4595,7 +4687,7 @@ export enum LogLevel {
|
|
|
4595
4687
|
* logLevel: LogLevel.INFO,
|
|
4596
4688
|
* })
|
|
4597
4689
|
* ```
|
|
4598
|
-
* @version SDK: 1.26.7 |
|
|
4690
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4599
4691
|
*/
|
|
4600
4692
|
INFO = 'INFO',
|
|
4601
4693
|
|
|
@@ -4608,7 +4700,7 @@ export enum LogLevel {
|
|
|
4608
4700
|
* logLevel: LogLevel.DEBUG,
|
|
4609
4701
|
* })
|
|
4610
4702
|
* ```
|
|
4611
|
-
* @version SDK: 1.26.7 |
|
|
4703
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4612
4704
|
*/
|
|
4613
4705
|
DEBUG = 'DEBUG',
|
|
4614
4706
|
/**
|
|
@@ -4620,7 +4712,7 @@ export enum LogLevel {
|
|
|
4620
4712
|
* logLevel: LogLevel.TRACE,
|
|
4621
4713
|
* })
|
|
4622
4714
|
* ```
|
|
4623
|
-
* @version SDK: 1.26.7 |
|
|
4715
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4624
4716
|
*/
|
|
4625
4717
|
TRACE = 'TRACE',
|
|
4626
4718
|
}
|