@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.12
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 +7 -4
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -3
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +17 -1
- 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/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +5 -2
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +110 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- 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 +298 -161
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +274 -133
- 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-D-9WUCUl.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 +7 -4
- 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/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/dist/src/hostEventsTypeMapping.d.ts +2 -0
- package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
- package/dist/src/types.d.ts +298 -161
- 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 +287 -142
- package/dist/tsembed-react.js +286 -141
- package/dist/tsembed.es.js +287 -142
- package/dist/tsembed.js +286 -141
- package/dist/visual-embed-sdk-react-full.d.ts +316 -167
- package/dist/visual-embed-sdk-react.d.ts +316 -167
- package/dist/visual-embed-sdk.d.ts +316 -167
- 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 +7 -4
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -3
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +17 -1
- 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/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +5 -2
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +111 -1
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- 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 +298 -161
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +274 -133
- 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 +317 -168
- 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 +23 -2
- package/src/embed/liveboard.ts +11 -8
- package/src/embed/ts-embed.spec.ts +160 -1
- package/src/embed/ts-embed.ts +4 -4
- package/src/types.ts +300 -164
package/dist/src/types.d.ts
CHANGED
|
@@ -14,7 +14,7 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
|
|
|
14
14
|
*/
|
|
15
15
|
export declare enum AuthType {
|
|
16
16
|
/**
|
|
17
|
-
* No authentication on the SDK.
|
|
17
|
+
* No authentication on the SDK. Pass-through to the embedded App. Alias for
|
|
18
18
|
* `Passthrough`.
|
|
19
19
|
* @example
|
|
20
20
|
* ```js
|
|
@@ -211,8 +211,8 @@ export interface customCssInterface {
|
|
|
211
211
|
/**
|
|
212
212
|
* The custom css variables, which can be set.
|
|
213
213
|
* The allowed list is in the CustomCssVariables
|
|
214
|
-
* interface.
|
|
215
|
-
*
|
|
214
|
+
* interface. For more information, see
|
|
215
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
216
216
|
*/
|
|
217
217
|
variables?: CustomCssVariables;
|
|
218
218
|
/**
|
|
@@ -254,7 +254,7 @@ export interface CustomStyles {
|
|
|
254
254
|
}
|
|
255
255
|
/**
|
|
256
256
|
* Configuration to define the customization on the Embedded
|
|
257
|
-
*
|
|
257
|
+
* ThoughtSpot components.
|
|
258
258
|
* You can customize styles, text strings, and icons.
|
|
259
259
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
260
260
|
* @example
|
|
@@ -374,7 +374,7 @@ export interface EmbedConfig {
|
|
|
374
374
|
/**
|
|
375
375
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
376
376
|
* should be encoded in base64. This provides additional security to
|
|
377
|
-
*
|
|
377
|
+
* ThoughtSpot clusters against cross-site scripting attacks.
|
|
378
378
|
* @default false
|
|
379
379
|
*/
|
|
380
380
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -527,18 +527,18 @@ export interface EmbedConfig {
|
|
|
527
527
|
*/
|
|
528
528
|
disableSDKTracking?: boolean;
|
|
529
529
|
/**
|
|
530
|
-
* Overrides default/user
|
|
531
|
-
* @version SDK: 1.28.4 |
|
|
530
|
+
* Overrides default/user preferred locale for date formatting
|
|
531
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
532
532
|
*/
|
|
533
533
|
dateFormatLocale?: string;
|
|
534
534
|
/**
|
|
535
|
-
* Overrides default/user
|
|
536
|
-
* @version SDK: 1.28.4 |
|
|
535
|
+
* Overrides default/user preferred locale for number formatting
|
|
536
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
537
537
|
*/
|
|
538
538
|
numberFormatLocale?: string;
|
|
539
539
|
/**
|
|
540
540
|
* Format to be used for currency when currency format is set to infer from browser
|
|
541
|
-
* @version SDK: 1.28.4 |
|
|
541
|
+
* @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw
|
|
542
542
|
*/
|
|
543
543
|
currencyFormat?: string;
|
|
544
544
|
/**
|
|
@@ -552,12 +552,12 @@ export interface EmbedConfig {
|
|
|
552
552
|
* disableTokenVerification : true
|
|
553
553
|
* })
|
|
554
554
|
* ```
|
|
555
|
-
* @version SDK: 1.28.5 |
|
|
555
|
+
* @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
556
556
|
*/
|
|
557
557
|
disableTokenVerification?: boolean;
|
|
558
558
|
/**
|
|
559
559
|
* This flag is used to disable showing the login failure page in the embedded app.
|
|
560
|
-
* @version SDK 1.32.3 |
|
|
560
|
+
* @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
561
561
|
*/
|
|
562
562
|
disableLoginFailurePage?: boolean;
|
|
563
563
|
/**
|
|
@@ -595,7 +595,7 @@ export interface EmbedConfig {
|
|
|
595
595
|
* }
|
|
596
596
|
* });
|
|
597
597
|
* ```
|
|
598
|
-
* @version SDK 1.37.0 |
|
|
598
|
+
* @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
|
|
599
599
|
*/
|
|
600
600
|
customVariablesForThirdPartyTools?: Record<string, any>;
|
|
601
601
|
}
|
|
@@ -754,7 +754,7 @@ export interface ViewConfig {
|
|
|
754
754
|
/**
|
|
755
755
|
* The list of parameter override to apply to a search answer,
|
|
756
756
|
* visualization, or Liveboard.
|
|
757
|
-
* @version SDK : 1.25.0 |
|
|
757
|
+
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
758
758
|
* @example
|
|
759
759
|
* ```js
|
|
760
760
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -814,7 +814,7 @@ export interface ViewConfig {
|
|
|
814
814
|
/**
|
|
815
815
|
* Insert as a sibling of the target container, instead of appending to a
|
|
816
816
|
* child inside it.
|
|
817
|
-
* @version SDK: 1.2.0 |
|
|
817
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
818
818
|
* @example
|
|
819
819
|
* ```js
|
|
820
820
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -887,7 +887,7 @@ export interface ViewConfig {
|
|
|
887
887
|
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
888
888
|
* });
|
|
889
889
|
* ```
|
|
890
|
-
* @version SDK: 1.26.0 |
|
|
890
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
891
891
|
*/
|
|
892
892
|
hiddenTabs?: string[];
|
|
893
893
|
/**
|
|
@@ -897,7 +897,7 @@ export interface ViewConfig {
|
|
|
897
897
|
* **Note**: This option does not apply to the classic homepage.
|
|
898
898
|
* To access the updated modular homepage, set
|
|
899
899
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
900
|
-
* @version SDK: 1.28.0 |
|
|
900
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
901
901
|
* @example
|
|
902
902
|
* ```js
|
|
903
903
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -914,7 +914,7 @@ export interface ViewConfig {
|
|
|
914
914
|
* **Note**: This option does not apply to the classic homepage.
|
|
915
915
|
* To access the updated modular homepage, set
|
|
916
916
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
917
|
-
* @version SDK: 1.28.0|
|
|
917
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
918
918
|
* @example
|
|
919
919
|
* ```js
|
|
920
920
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -929,7 +929,7 @@ export interface ViewConfig {
|
|
|
929
929
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
930
930
|
*
|
|
931
931
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
932
|
-
* @version SDK: 1.26.0 |
|
|
932
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
933
933
|
* @example
|
|
934
934
|
* ```js
|
|
935
935
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -957,7 +957,7 @@ export interface ViewConfig {
|
|
|
957
957
|
* **Note**: This option does not apply to the classic homepage.
|
|
958
958
|
* To access the updated modular homepage, set
|
|
959
959
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
960
|
-
* @version SDK: 1.28.0 |
|
|
960
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
961
961
|
*/
|
|
962
962
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
963
963
|
/**
|
|
@@ -972,7 +972,7 @@ export interface ViewConfig {
|
|
|
972
972
|
* });
|
|
973
973
|
* embed.showPreRender();
|
|
974
974
|
* ```
|
|
975
|
-
* @version SDK: 1.25.0 |
|
|
975
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
976
976
|
*/
|
|
977
977
|
preRenderId?: string;
|
|
978
978
|
/**
|
|
@@ -1026,7 +1026,7 @@ export interface ViewConfig {
|
|
|
1026
1026
|
/**
|
|
1027
1027
|
* To set the initial state of the search bar in case of saved Answers.
|
|
1028
1028
|
* @default true
|
|
1029
|
-
* @version SDK: 1.34.0 |
|
|
1029
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1030
1030
|
* @example
|
|
1031
1031
|
* ```js
|
|
1032
1032
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1050,7 +1050,7 @@ export interface ViewConfig {
|
|
|
1050
1050
|
/**
|
|
1051
1051
|
* Flag to control Data panel experience
|
|
1052
1052
|
* @default false
|
|
1053
|
-
* @version SDK: 1.34.0 |
|
|
1053
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
1054
1054
|
* @example
|
|
1055
1055
|
* ```js
|
|
1056
1056
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1062,7 +1062,7 @@ export interface ViewConfig {
|
|
|
1062
1062
|
dataPanelV2?: boolean;
|
|
1063
1063
|
/**
|
|
1064
1064
|
* To enable custom column groups in data panel v2
|
|
1065
|
-
* @version SDK: 1.32.0 |
|
|
1065
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
1066
1066
|
* @default false
|
|
1067
1067
|
* @example
|
|
1068
1068
|
* ```js
|
|
@@ -1090,9 +1090,10 @@ export interface ViewConfig {
|
|
|
1090
1090
|
*/
|
|
1091
1091
|
overrideOrgId?: number;
|
|
1092
1092
|
/**
|
|
1093
|
-
* Flag to
|
|
1093
|
+
* Flag to enhance the visual effects of charts
|
|
1094
|
+
* This feature is a beta release for 10.6
|
|
1094
1095
|
* @default false
|
|
1095
|
-
* @version SDK: 1.36.0 |
|
|
1096
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
1096
1097
|
*/
|
|
1097
1098
|
enableFlipTooltipToContextMenu?: boolean;
|
|
1098
1099
|
}
|
|
@@ -1212,7 +1213,7 @@ export declare enum RuntimeFilterOp {
|
|
|
1212
1213
|
* **Note**: This option does not apply to the classic homepage.
|
|
1213
1214
|
* To access the updated modular homepage, set
|
|
1214
1215
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1215
|
-
* @version SDK: 1.28.0 |
|
|
1216
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
1216
1217
|
*/
|
|
1217
1218
|
export declare enum HomepageModule {
|
|
1218
1219
|
/**
|
|
@@ -2055,7 +2056,7 @@ export declare enum EmbedEvent {
|
|
|
2055
2056
|
*/
|
|
2056
2057
|
Explore = "explore",
|
|
2057
2058
|
/**
|
|
2058
|
-
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2059
|
+
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
2059
2060
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2060
2061
|
* @example
|
|
2061
2062
|
*```js
|
|
@@ -2105,23 +2106,26 @@ export declare enum EmbedEvent {
|
|
|
2105
2106
|
*/
|
|
2106
2107
|
FilterChanged = "filterChanged",
|
|
2107
2108
|
/**
|
|
2108
|
-
* Emitted when a user clicks the **Go** button
|
|
2109
|
-
*
|
|
2109
|
+
* Emitted when a user clicks the **Go** button to initiate
|
|
2110
|
+
* a Natural Language Search query
|
|
2111
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2110
2112
|
*/
|
|
2111
2113
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2112
2114
|
/**
|
|
2113
|
-
* Emitted when a user selects a data source on the
|
|
2114
|
-
*
|
|
2115
|
+
* Emitted when a user selects a data source on the embedded
|
|
2116
|
+
* Natural Language Search interface.
|
|
2117
|
+
*
|
|
2118
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2115
2119
|
*/
|
|
2116
2120
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2117
2121
|
/**
|
|
2118
2122
|
* Emitted when a user updates a connection on the **Data** page
|
|
2119
|
-
* @version SDK : 1.27.0 |
|
|
2123
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
2120
2124
|
*/
|
|
2121
2125
|
UpdateConnection = "updateConnection",
|
|
2122
2126
|
/**
|
|
2123
2127
|
* Emitted when a user updates a connection on the **Data** page
|
|
2124
|
-
* @version SDK : 1.27.0 |
|
|
2128
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
2125
2129
|
*/
|
|
2126
2130
|
CreateConnection = "createConnection",
|
|
2127
2131
|
/**
|
|
@@ -2131,7 +2135,7 @@ export declare enum EmbedEvent {
|
|
|
2131
2135
|
* @returns viewId: string
|
|
2132
2136
|
* @returns liveboardId: string
|
|
2133
2137
|
* @returns isPublic: boolean
|
|
2134
|
-
* @version SDK : 1.26.0 |
|
|
2138
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2135
2139
|
*/
|
|
2136
2140
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2137
2141
|
/**
|
|
@@ -2140,7 +2144,7 @@ export declare enum EmbedEvent {
|
|
|
2140
2144
|
* @returns viewId: string
|
|
2141
2145
|
* @returns liveboardId: string
|
|
2142
2146
|
* @returns isPublic: boolean
|
|
2143
|
-
* @version SDK : 1.26.0 |
|
|
2147
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2144
2148
|
*/
|
|
2145
2149
|
SavePersonalisedView = "savePersonalisedView",
|
|
2146
2150
|
/**
|
|
@@ -2149,28 +2153,28 @@ export declare enum EmbedEvent {
|
|
|
2149
2153
|
* @returns viewId: string
|
|
2150
2154
|
* @returns liveboardId: string
|
|
2151
2155
|
* @returns isPublic: boolean
|
|
2152
|
-
* @version SDK : 1.26.0 |
|
|
2156
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2153
2157
|
*/
|
|
2154
2158
|
ResetLiveboard = "resetLiveboard",
|
|
2155
2159
|
/**
|
|
2156
2160
|
* Emitted when a PersonalisedView is deleted.
|
|
2157
2161
|
* @returns views: string[]
|
|
2158
2162
|
* @returns liveboardId: string
|
|
2159
|
-
* @version SDK : 1.26.0 |
|
|
2163
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
2160
2164
|
*/
|
|
2161
2165
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
2162
2166
|
/**
|
|
2163
2167
|
* Emitted when a user creates a new worksheet
|
|
2164
|
-
* @version SDK : 1.27.0 |
|
|
2168
|
+
* @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
|
|
2165
2169
|
*/
|
|
2166
2170
|
CreateWorksheet = "createWorksheet",
|
|
2167
2171
|
/**
|
|
2168
|
-
* Emitted when Ask Sage is initialized.
|
|
2172
|
+
* Emitted when the *Ask Sage* is initialized.
|
|
2169
2173
|
* @returns viewName: string
|
|
2170
2174
|
* @returns viewId: string
|
|
2171
2175
|
* @returns liveboardId: string
|
|
2172
2176
|
* @returns isPublic: boolean
|
|
2173
|
-
* @version SDK : 1.29.0 |
|
|
2177
|
+
* @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
2174
2178
|
*/
|
|
2175
2179
|
AskSageInit = "AskSageInit",
|
|
2176
2180
|
/**
|
|
@@ -2198,7 +2202,7 @@ export declare enum EmbedEvent {
|
|
|
2198
2202
|
*
|
|
2199
2203
|
* error: Developers can customize the error message text when `execute`
|
|
2200
2204
|
* returns `false` using the error parameter in responder.
|
|
2201
|
-
* @version SDK : 1.29.0 |
|
|
2205
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
2202
2206
|
* @example
|
|
2203
2207
|
*```js
|
|
2204
2208
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -2246,9 +2250,26 @@ export declare enum EmbedEvent {
|
|
|
2246
2250
|
* console.log('payload', payload);
|
|
2247
2251
|
* })
|
|
2248
2252
|
*```
|
|
2249
|
-
* @version SDK : 1.29.0 |
|
|
2253
|
+
* @version SDK : 1.29.0 | ThoughtSpot : 10.3.0.cl
|
|
2254
|
+
*/
|
|
2255
|
+
ParameterChanged = "parameterChanged",
|
|
2256
|
+
/**
|
|
2257
|
+
* Emitted when the table viz renders.
|
|
2258
|
+
* You can use this event as a hook to trigger
|
|
2259
|
+
* other events on the rendered table viz data.
|
|
2260
|
+
* @example
|
|
2261
|
+
* ```js
|
|
2262
|
+
* searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
|
|
2263
|
+
* console.log(payload);
|
|
2264
|
+
* const columnDataLite = payload.data.data.columnDataLite;
|
|
2265
|
+
* columnDataLite[0].dataValue[0]="new fob";
|
|
2266
|
+
* console.log('>>> new Data', columnDataLite);
|
|
2267
|
+
* searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
|
|
2268
|
+
* })
|
|
2269
|
+
* ```
|
|
2270
|
+
* @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
|
|
2250
2271
|
*/
|
|
2251
|
-
|
|
2272
|
+
TableVizRendered = "TableVizRendered"
|
|
2252
2273
|
}
|
|
2253
2274
|
/**
|
|
2254
2275
|
* Event types that can be triggered by the host application
|
|
@@ -2393,7 +2414,7 @@ export declare enum HostEvent {
|
|
|
2393
2414
|
* const url = embed.trigger(HostEvent.GetIframeUrl);
|
|
2394
2415
|
* console.log("iFrameURL",url);
|
|
2395
2416
|
* ```
|
|
2396
|
-
* @version SDK: 1.35.0 |
|
|
2417
|
+
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2397
2418
|
*/
|
|
2398
2419
|
GetIframeUrl = "GetIframeUrl",
|
|
2399
2420
|
/**
|
|
@@ -2426,6 +2447,11 @@ export declare enum HostEvent {
|
|
|
2426
2447
|
* attributes passed with this event are appended to the existing runtime
|
|
2427
2448
|
* filters applied on a Liveboard.
|
|
2428
2449
|
*
|
|
2450
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
|
|
2451
|
+
* and `AppEmbed` only. In full application embedding, this event updates
|
|
2452
|
+
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
2453
|
+
*
|
|
2454
|
+
*
|
|
2429
2455
|
* Pass an array of runtime filters with the following attributes:
|
|
2430
2456
|
*
|
|
2431
2457
|
* `columnName` - _String_. The name of the column to filter on.
|
|
@@ -2436,9 +2462,12 @@ export declare enum HostEvent {
|
|
|
2436
2462
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
2437
2463
|
* single value, whereas BW and IN accept multiple values.
|
|
2438
2464
|
*
|
|
2439
|
-
* **Note**:
|
|
2440
|
-
*
|
|
2441
|
-
*
|
|
2465
|
+
* **Note**: Updating runtime filters resets the ThoughtSpot
|
|
2466
|
+
* object to its original state and applies new filter conditions.
|
|
2467
|
+
* Any user changes (like drilling into a visualization)
|
|
2468
|
+
* will be cleared, restoring the original visualization
|
|
2469
|
+
* with the updated filters.
|
|
2470
|
+
*
|
|
2442
2471
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2443
2472
|
* @example
|
|
2444
2473
|
* ```js
|
|
@@ -2453,7 +2482,7 @@ export declare enum HostEvent {
|
|
|
2453
2482
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
2454
2483
|
/**
|
|
2455
2484
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2456
|
-
* This is the same as calling `appEmbed.navigateToPage(path, true)
|
|
2485
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`.
|
|
2457
2486
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
2458
2487
|
* be a number; for example, `1`, `-1`.
|
|
2459
2488
|
* @example
|
|
@@ -2649,7 +2678,7 @@ export declare enum HostEvent {
|
|
|
2649
2678
|
* @param - an object with `vizId` as a key
|
|
2650
2679
|
* @example
|
|
2651
2680
|
* ```js
|
|
2652
|
-
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
2681
|
+
* liveboardEmbed.trigger(HostEvent.CreateMonitor, {
|
|
2653
2682
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2654
2683
|
* })
|
|
2655
2684
|
* ```
|
|
@@ -2748,7 +2777,9 @@ export declare enum HostEvent {
|
|
|
2748
2777
|
*/
|
|
2749
2778
|
GetTML = "getTML",
|
|
2750
2779
|
/**
|
|
2751
|
-
* Trigger the **Show underlying data** action on
|
|
2780
|
+
* Trigger the **Show underlying data** action on a
|
|
2781
|
+
* chart or table.
|
|
2782
|
+
*
|
|
2752
2783
|
* @param - an object with vizId as a key
|
|
2753
2784
|
* @example
|
|
2754
2785
|
* ```js
|
|
@@ -2782,8 +2813,8 @@ export declare enum HostEvent {
|
|
|
2782
2813
|
*/
|
|
2783
2814
|
Delete = "onDeleteAnswer",
|
|
2784
2815
|
/**
|
|
2785
|
-
* Trigger the **SpotIQ analyze** action on
|
|
2786
|
-
* or
|
|
2816
|
+
* Trigger the **SpotIQ analyze** action on a
|
|
2817
|
+
* chart or table.
|
|
2787
2818
|
* @param - Liveboard embed takes `vizId` as a
|
|
2788
2819
|
* key. Can be left undefined when embedding Search or
|
|
2789
2820
|
* visualization.
|
|
@@ -3056,7 +3087,7 @@ export declare enum HostEvent {
|
|
|
3056
3087
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
3057
3088
|
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
3058
3089
|
* ```
|
|
3059
|
-
* @version SDK: 1.26.0 |
|
|
3090
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3060
3091
|
*/
|
|
3061
3092
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
3062
3093
|
/**
|
|
@@ -3069,7 +3100,7 @@ export declare enum HostEvent {
|
|
|
3069
3100
|
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
3070
3101
|
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
3071
3102
|
* ```
|
|
3072
|
-
* @version SDK: 1.26.0 |
|
|
3103
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3073
3104
|
*/
|
|
3074
3105
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
3075
3106
|
/**
|
|
@@ -3083,7 +3114,7 @@ export declare enum HostEvent {
|
|
|
3083
3114
|
* executeSearch: true,
|
|
3084
3115
|
* })
|
|
3085
3116
|
* ```
|
|
3086
|
-
* @version SDK: 1.26.0 |
|
|
3117
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
3087
3118
|
*/
|
|
3088
3119
|
UpdateSageQuery = "updateSageQuery",
|
|
3089
3120
|
/**
|
|
@@ -3100,21 +3131,22 @@ export declare enum HostEvent {
|
|
|
3100
3131
|
* ```js
|
|
3101
3132
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
3102
3133
|
* ```
|
|
3103
|
-
* @version SDK: 1.26.0 |
|
|
3134
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
3104
3135
|
*/
|
|
3105
3136
|
GetAnswerSession = "getAnswerSession",
|
|
3106
3137
|
/**
|
|
3107
|
-
* Trigger Ask Sage for
|
|
3138
|
+
* Trigger the *Ask Sage* action for visualizations
|
|
3108
3139
|
* @example
|
|
3109
3140
|
* ```js
|
|
3110
3141
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
3111
3142
|
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
3112
3143
|
* ```
|
|
3113
|
-
* @version SDK: 1.29.0 |
|
|
3144
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
3114
3145
|
*/
|
|
3115
3146
|
AskSage = "AskSage",
|
|
3116
3147
|
/**
|
|
3117
|
-
* Trigger cross filter update action on a Liveboard
|
|
3148
|
+
* Trigger cross filter update action on a Liveboard.
|
|
3149
|
+
*
|
|
3118
3150
|
* @example
|
|
3119
3151
|
* ```js
|
|
3120
3152
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -3125,7 +3157,7 @@ export declare enum HostEvent {
|
|
|
3125
3157
|
* ],
|
|
3126
3158
|
* });
|
|
3127
3159
|
* ```
|
|
3128
|
-
* @version SDK: 1.29.0 |
|
|
3160
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw
|
|
3129
3161
|
*/
|
|
3130
3162
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
3131
3163
|
/**
|
|
@@ -3134,11 +3166,13 @@ export declare enum HostEvent {
|
|
|
3134
3166
|
* ```js
|
|
3135
3167
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
3136
3168
|
* ```
|
|
3137
|
-
* @version SDK: 1.29.0 |
|
|
3169
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
|
|
3138
3170
|
*/
|
|
3139
3171
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
3140
3172
|
/**
|
|
3141
|
-
* Triggers an
|
|
3173
|
+
* Triggers an action to update Parameter values on embedded
|
|
3174
|
+
* Answers and Liveboard.
|
|
3175
|
+
*
|
|
3142
3176
|
* @example
|
|
3143
3177
|
* ```js
|
|
3144
3178
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -3146,37 +3180,56 @@ export declare enum HostEvent {
|
|
|
3146
3180
|
* value: "almond"
|
|
3147
3181
|
* }])
|
|
3148
3182
|
*
|
|
3149
|
-
* @version SDK: 1.29.0 |
|
|
3183
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3150
3184
|
*/
|
|
3151
3185
|
UpdateParameters = "UpdateParameters",
|
|
3152
3186
|
/**
|
|
3153
|
-
* Triggers GetParameters to fetch the runtime
|
|
3187
|
+
* Triggers GetParameters to fetch the runtime Parameters.
|
|
3154
3188
|
* ```js
|
|
3155
3189
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
3156
3190
|
* console.log('parameters', parameter);
|
|
3157
3191
|
* });
|
|
3158
3192
|
*```
|
|
3159
|
-
* @version SDK: 1.29.0 |
|
|
3193
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3160
3194
|
*/
|
|
3161
3195
|
GetParameters = "GetParameters",
|
|
3162
3196
|
/**
|
|
3163
|
-
* Triggers an event to update a
|
|
3197
|
+
* Triggers an event to update a personalized view of a Liveboard.
|
|
3164
3198
|
* ```js
|
|
3165
3199
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
3166
3200
|
* ```
|
|
3167
|
-
* @version SDK: 1.36.0 |
|
|
3201
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3168
3202
|
*/
|
|
3169
3203
|
UpdatePersonalisedView = "UpdatePersonalisedView",
|
|
3170
3204
|
/**
|
|
3171
|
-
* Triggers the action to get the current view of the
|
|
3172
|
-
* @version SDK: 1.36.0 |
|
|
3205
|
+
* Triggers the action to get the current view of the Liveboard.
|
|
3206
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3173
3207
|
*/
|
|
3174
3208
|
SaveAnswer = "saveAnswer",
|
|
3175
3209
|
/**
|
|
3176
3210
|
* EmbedApi
|
|
3177
3211
|
* @hidden
|
|
3178
3212
|
*/
|
|
3179
|
-
UIPassthrough = "UiPassthrough"
|
|
3213
|
+
UIPassthrough = "UiPassthrough",
|
|
3214
|
+
/**
|
|
3215
|
+
* Triggers the table viz rerender with the updated data.
|
|
3216
|
+
* Includes the following properties:
|
|
3217
|
+
* @param - columnDataLite - an array of object containing data
|
|
3218
|
+
* transformed from data picked from TableVizRendered event.
|
|
3219
|
+
* For example, { columnDataLite: []}
|
|
3220
|
+
* @example
|
|
3221
|
+
* ```js
|
|
3222
|
+
* searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => {
|
|
3223
|
+
* console.log(payload);
|
|
3224
|
+
* const columnDataLite = payload.data.data.columnDataLite;
|
|
3225
|
+
* columnDataLite[0].dataValue[0]="new fob";
|
|
3226
|
+
* console.log('>>> new Data', columnDataLite);
|
|
3227
|
+
* searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
|
|
3228
|
+
* })
|
|
3229
|
+
* ```
|
|
3230
|
+
* @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
|
|
3231
|
+
*/
|
|
3232
|
+
TransformTableVizData = "TransformTableVizData"
|
|
3180
3233
|
}
|
|
3181
3234
|
/**
|
|
3182
3235
|
* The different visual modes that the data sources panel within
|
|
@@ -3238,7 +3291,7 @@ export declare enum Param {
|
|
|
3238
3291
|
AuthType = "authType",
|
|
3239
3292
|
IconSpriteUrl = "iconSprite",
|
|
3240
3293
|
cookieless = "cookieless",
|
|
3241
|
-
ContextMenuTrigger = "
|
|
3294
|
+
ContextMenuTrigger = "contextMenuEnabledOnWhichClick",
|
|
3242
3295
|
LinkOverride = "linkOverride",
|
|
3243
3296
|
blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
|
|
3244
3297
|
ShowInsertToSlide = "insertInToSlide",
|
|
@@ -3389,7 +3442,8 @@ export declare enum Action {
|
|
|
3389
3442
|
ResetLayout = "resetLayout",
|
|
3390
3443
|
/**
|
|
3391
3444
|
* The **Schedule** menu action on a Liveboard.
|
|
3392
|
-
* Allows scheduling a Liveboard
|
|
3445
|
+
* Allows scheduling a Liveboard job, for example,
|
|
3446
|
+
* sending periodic notifications.
|
|
3393
3447
|
* @example
|
|
3394
3448
|
* ```js
|
|
3395
3449
|
* disabledActions: [Action.Schedule]
|
|
@@ -3431,7 +3485,7 @@ export declare enum Action {
|
|
|
3431
3485
|
* ```js
|
|
3432
3486
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
3433
3487
|
* ```
|
|
3434
|
-
* @version SDK: 1.32.0 |
|
|
3488
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3435
3489
|
*/
|
|
3436
3490
|
AddDataPanelObjects = "addDataPanelObjects",
|
|
3437
3491
|
/**
|
|
@@ -3444,7 +3498,28 @@ export declare enum Action {
|
|
|
3444
3498
|
* ```
|
|
3445
3499
|
*/
|
|
3446
3500
|
ConfigureFilter = "configureFilter",
|
|
3501
|
+
/**
|
|
3502
|
+
* The **Collapse data sources** icon on the Search page.
|
|
3503
|
+
* Collapses the panel showing data sources.
|
|
3504
|
+
*
|
|
3505
|
+
* @example
|
|
3506
|
+
* ```js
|
|
3507
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
3508
|
+
* ```
|
|
3509
|
+
* @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3510
|
+
*/
|
|
3447
3511
|
CollapseDataSources = "collapseDataSources",
|
|
3512
|
+
/**
|
|
3513
|
+
* The **Collapse data panel** icon on the Search page.
|
|
3514
|
+
* Collapses the data panel view.
|
|
3515
|
+
*
|
|
3516
|
+
* @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
|
|
3517
|
+
*
|
|
3518
|
+
* @example
|
|
3519
|
+
* ```js
|
|
3520
|
+
* disabledActions: [Action.CollapseDataPanel]
|
|
3521
|
+
* ```
|
|
3522
|
+
*/
|
|
3448
3523
|
CollapseDataPanel = "collapseDataPanel",
|
|
3449
3524
|
/**
|
|
3450
3525
|
* The **Choose sources** button on Search page.
|
|
@@ -3480,7 +3555,7 @@ export declare enum Action {
|
|
|
3480
3555
|
* ```js
|
|
3481
3556
|
* disabledActions: [Action.AddColumnSet]
|
|
3482
3557
|
* ```
|
|
3483
|
-
* @version SDK: 1.32.0 |
|
|
3558
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3484
3559
|
*/
|
|
3485
3560
|
AddColumnSet = "addSimpleCohort",
|
|
3486
3561
|
/**
|
|
@@ -3490,7 +3565,7 @@ export declare enum Action {
|
|
|
3490
3565
|
* ```js
|
|
3491
3566
|
* disabledActions: [Action.AddQuerySet]
|
|
3492
3567
|
* ```
|
|
3493
|
-
* @version SDK: 1.32.0 |
|
|
3568
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
3494
3569
|
*/
|
|
3495
3570
|
AddQuerySet = "addAdvancedCohort",
|
|
3496
3571
|
/**
|
|
@@ -3522,6 +3597,8 @@ export declare enum Action {
|
|
|
3522
3597
|
/**
|
|
3523
3598
|
* The **Show underlying data** menu action on a visualization or
|
|
3524
3599
|
* Answer page.
|
|
3600
|
+
* Displays detailed information and raw data
|
|
3601
|
+
* for a given visualization.
|
|
3525
3602
|
* @example
|
|
3526
3603
|
* ```js
|
|
3527
3604
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -3723,6 +3800,7 @@ export declare enum Action {
|
|
|
3723
3800
|
AnalysisInfo = "analysisInfo",
|
|
3724
3801
|
/**
|
|
3725
3802
|
* The **Schedule** menu action on a Liveboard.
|
|
3803
|
+
* Allows scheduling a Liveboard job.
|
|
3726
3804
|
* @example
|
|
3727
3805
|
* ```js
|
|
3728
3806
|
* disabledActions: [Action.Subscription]
|
|
@@ -3792,8 +3870,13 @@ export declare enum Action {
|
|
|
3792
3870
|
*/
|
|
3793
3871
|
RequestAccess = "requestAccess",
|
|
3794
3872
|
/**
|
|
3795
|
-
* The **Query visualizer** and **Query SQL** buttons in
|
|
3796
|
-
* of the Answer page
|
|
3873
|
+
* The **Query visualizer** and **Query SQL** buttons in
|
|
3874
|
+
* Query details panel of the Answer page.
|
|
3875
|
+
*
|
|
3876
|
+
* **Query visualizer** - Displays the tables
|
|
3877
|
+
* and filters used in a search query.
|
|
3878
|
+
* **Query SQL** - Displays the SQL statements used
|
|
3879
|
+
* in a search query to fetch data.
|
|
3797
3880
|
* @example
|
|
3798
3881
|
* ```js
|
|
3799
3882
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3811,7 +3894,10 @@ export declare enum Action {
|
|
|
3811
3894
|
*/
|
|
3812
3895
|
AnswerDelete = "onDeleteAnswer",
|
|
3813
3896
|
/**
|
|
3814
|
-
* The
|
|
3897
|
+
* The chart switcher icon on Answer page and
|
|
3898
|
+
* visualizations in edit mode.
|
|
3899
|
+
* Allows switching to the table or chart mode
|
|
3900
|
+
* when editing a visualization.
|
|
3815
3901
|
* @example
|
|
3816
3902
|
* ```js
|
|
3817
3903
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3820,7 +3906,10 @@ export declare enum Action {
|
|
|
3820
3906
|
*/
|
|
3821
3907
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3822
3908
|
/**
|
|
3823
|
-
* Favorites icon (*)
|
|
3909
|
+
* The Favorites icon (*) for Answers,
|
|
3910
|
+
* Liveboard, and data objects like Worksheet, Model,
|
|
3911
|
+
* Tables and Views.
|
|
3912
|
+
* Allows adding an object to the user’s favorites list.
|
|
3824
3913
|
* @example
|
|
3825
3914
|
* ```js
|
|
3826
3915
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3838,7 +3927,9 @@ export declare enum Action {
|
|
|
3838
3927
|
*/
|
|
3839
3928
|
EditDetails = "editDetails",
|
|
3840
3929
|
/**
|
|
3841
|
-
* The Create alert action
|
|
3930
|
+
* The *Create alert* action for KPI charts.
|
|
3931
|
+
* Allows users to schedule threshold-based alerts
|
|
3932
|
+
* for KPI charts.
|
|
3842
3933
|
* @example
|
|
3843
3934
|
* ```js
|
|
3844
3935
|
* disabledActions: [Action.CreateMonitor]
|
|
@@ -3894,7 +3985,7 @@ export declare enum Action {
|
|
|
3894
3985
|
* ```js
|
|
3895
3986
|
* disabledActions: [Action.CrossFilter]
|
|
3896
3987
|
* ```
|
|
3897
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3988
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw
|
|
3898
3989
|
*/
|
|
3899
3990
|
CrossFilter = "context-menu-item-cross-filter",
|
|
3900
3991
|
/**
|
|
@@ -3904,7 +3995,7 @@ export declare enum Action {
|
|
|
3904
3995
|
* ```js
|
|
3905
3996
|
* disabledActions: [Action.SyncToSlack]
|
|
3906
3997
|
* ```
|
|
3907
|
-
* @version @version SDK : 1.32.0 |
|
|
3998
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
3908
3999
|
*/
|
|
3909
4000
|
SyncToSlack = "syncToSlack",
|
|
3910
4001
|
/**
|
|
@@ -3914,7 +4005,7 @@ export declare enum Action {
|
|
|
3914
4005
|
* ```js
|
|
3915
4006
|
* disabledActions: [Action.SyncToTeams]
|
|
3916
4007
|
* ```
|
|
3917
|
-
* @version @version SDK : 1.32.0 |
|
|
4008
|
+
* @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl
|
|
3918
4009
|
*/
|
|
3919
4010
|
SyncToTeams = "syncToTeams",
|
|
3920
4011
|
/**
|
|
@@ -3925,7 +4016,7 @@ export declare enum Action {
|
|
|
3925
4016
|
* ```js
|
|
3926
4017
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
3927
4018
|
* ```
|
|
3928
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4019
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3929
4020
|
*/
|
|
3930
4021
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
3931
4022
|
/**
|
|
@@ -3936,7 +4027,7 @@ export declare enum Action {
|
|
|
3936
4027
|
* ```js
|
|
3937
4028
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
3938
4029
|
* ```
|
|
3939
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4030
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3940
4031
|
*/
|
|
3941
4032
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
3942
4033
|
/**
|
|
@@ -3947,17 +4038,19 @@ export declare enum Action {
|
|
|
3947
4038
|
* ```js
|
|
3948
4039
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
3949
4040
|
* ```
|
|
3950
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4041
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3951
4042
|
*/
|
|
3952
4043
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
3953
4044
|
/**
|
|
3954
4045
|
* The **Filter** action in the chart axis or table column
|
|
3955
4046
|
* customization menu.
|
|
4047
|
+
* Allows adding, editing, or removing filters.
|
|
4048
|
+
*
|
|
3956
4049
|
* @example
|
|
3957
4050
|
* ```js
|
|
3958
4051
|
* disabledActions: [Action.AxisMenuFilter]
|
|
3959
4052
|
* ```
|
|
3960
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4053
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3961
4054
|
*/
|
|
3962
4055
|
AxisMenuFilter = "axisMenuFilter",
|
|
3963
4056
|
/**
|
|
@@ -3968,7 +4061,7 @@ export declare enum Action {
|
|
|
3968
4061
|
* ```js
|
|
3969
4062
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
3970
4063
|
* ```
|
|
3971
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4064
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3972
4065
|
*/
|
|
3973
4066
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
3974
4067
|
/**
|
|
@@ -3979,7 +4072,7 @@ export declare enum Action {
|
|
|
3979
4072
|
* ```js
|
|
3980
4073
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
3981
4074
|
* ```
|
|
3982
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4075
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3983
4076
|
*/
|
|
3984
4077
|
AxisMenuSort = "axisMenuSort",
|
|
3985
4078
|
/**
|
|
@@ -3991,7 +4084,7 @@ export declare enum Action {
|
|
|
3991
4084
|
* ```js
|
|
3992
4085
|
* disabledActions: [Action.AxisMenuGroup]
|
|
3993
4086
|
* ```
|
|
3994
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4087
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
3995
4088
|
*/
|
|
3996
4089
|
AxisMenuGroup = "axisMenuGroup",
|
|
3997
4090
|
/**
|
|
@@ -4002,7 +4095,7 @@ export declare enum Action {
|
|
|
4002
4095
|
* ```js
|
|
4003
4096
|
* disabledActions: [Action.AxisMenuPosition]
|
|
4004
4097
|
* ```
|
|
4005
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4098
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4006
4099
|
*/
|
|
4007
4100
|
AxisMenuPosition = "axisMenuPosition",
|
|
4008
4101
|
/**
|
|
@@ -4012,7 +4105,7 @@ export declare enum Action {
|
|
|
4012
4105
|
* ```js
|
|
4013
4106
|
* disabledActions: [Action.AxisMenuRename]
|
|
4014
4107
|
* ```
|
|
4015
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4108
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4016
4109
|
*/
|
|
4017
4110
|
AxisMenuRename = "axisMenuRename",
|
|
4018
4111
|
/**
|
|
@@ -4023,7 +4116,7 @@ export declare enum Action {
|
|
|
4023
4116
|
* ```js
|
|
4024
4117
|
* disabledActions: [Action.AxisMenuEdit]
|
|
4025
4118
|
* ```
|
|
4026
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4119
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4027
4120
|
*/
|
|
4028
4121
|
AxisMenuEdit = "axisMenuEdit",
|
|
4029
4122
|
/**
|
|
@@ -4033,7 +4126,7 @@ export declare enum Action {
|
|
|
4033
4126
|
* ```js
|
|
4034
4127
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
4035
4128
|
* ```
|
|
4036
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4129
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4037
4130
|
*/
|
|
4038
4131
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
4039
4132
|
/**
|
|
@@ -4043,7 +4136,7 @@ export declare enum Action {
|
|
|
4043
4136
|
* ```js
|
|
4044
4137
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
4045
4138
|
* ```
|
|
4046
|
-
* @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
|
|
4047
4140
|
*/
|
|
4048
4141
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
4049
4142
|
/**
|
|
@@ -4055,7 +4148,7 @@ export declare enum Action {
|
|
|
4055
4148
|
* ```js
|
|
4056
4149
|
* disabledActions: [Action.AxisMenuRemove]
|
|
4057
4150
|
* ```
|
|
4058
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
4151
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw
|
|
4059
4152
|
*/
|
|
4060
4153
|
AxisMenuRemove = "axisMenuRemove",
|
|
4061
4154
|
/**
|
|
@@ -4069,26 +4162,27 @@ export declare enum Action {
|
|
|
4069
4162
|
* ```js
|
|
4070
4163
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
4071
4164
|
* ```
|
|
4072
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4165
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw
|
|
4073
4166
|
*/
|
|
4074
4167
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
4075
4168
|
/**
|
|
4076
|
-
*
|
|
4169
|
+
* The *Request verification* action on a Liveboard.
|
|
4170
|
+
* Initiates a request for Liveboard verification.
|
|
4077
4171
|
* @example
|
|
4078
4172
|
* ```js
|
|
4079
4173
|
* disabledActions: [Action.RequestVerification]
|
|
4080
4174
|
* ```
|
|
4081
|
-
* @version SDK: 1.25.0 |
|
|
4175
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
4082
4176
|
*/
|
|
4083
4177
|
RequestVerification = "requestVerification",
|
|
4084
4178
|
/**
|
|
4085
4179
|
*
|
|
4086
|
-
*Allows users to mark a Liveboard as verified.
|
|
4180
|
+
* Allows users to mark a Liveboard as verified.
|
|
4087
4181
|
* @example
|
|
4088
4182
|
* ```js
|
|
4089
4183
|
* disabledActions: [Action.MarkAsVerified]
|
|
4090
4184
|
* ```
|
|
4091
|
-
* @version SDK: 1.25.0 |
|
|
4185
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw
|
|
4092
4186
|
*/
|
|
4093
4187
|
MarkAsVerified = "markAsVerified",
|
|
4094
4188
|
/**
|
|
@@ -4098,7 +4192,7 @@ export declare enum Action {
|
|
|
4098
4192
|
* ```js
|
|
4099
4193
|
* disabledActions: [Action.AddTab]
|
|
4100
4194
|
* ```
|
|
4101
|
-
* @version SDK: 1.26.0 |
|
|
4195
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
4102
4196
|
*/
|
|
4103
4197
|
AddTab = "addTab",
|
|
4104
4198
|
/**
|
|
@@ -4108,35 +4202,42 @@ export declare enum Action {
|
|
|
4108
4202
|
* ```js
|
|
4109
4203
|
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
4110
4204
|
* ```
|
|
4111
|
-
* @version SDK: 1.25.0 |
|
|
4205
|
+
* @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
|
|
4112
4206
|
*/
|
|
4113
4207
|
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
4114
4208
|
/**
|
|
4209
|
+
* Action ID to hide or disable Natural Language Search query.
|
|
4115
4210
|
*
|
|
4116
4211
|
* @example
|
|
4117
4212
|
* ```js
|
|
4118
4213
|
* disabledActions: [Action.ShowSageQuery]
|
|
4119
4214
|
* ```
|
|
4120
|
-
* @version SDK: 1.26.0 |
|
|
4215
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
4121
4216
|
*/
|
|
4122
4217
|
ShowSageQuery = "showSageQuery",
|
|
4123
4218
|
/**
|
|
4219
|
+
*
|
|
4220
|
+
* Action ID to hide or disable the edit option for the
|
|
4221
|
+
* results generated from the
|
|
4222
|
+
* Natural Language Search query.
|
|
4124
4223
|
*
|
|
4125
4224
|
* @example
|
|
4126
4225
|
* ```js
|
|
4127
4226
|
* disabledActions: [Action.EditSageAnswer]
|
|
4128
4227
|
* ```
|
|
4129
|
-
* @version SDK: 1.26.0 |
|
|
4228
|
+
* @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl
|
|
4130
4229
|
*/
|
|
4131
4230
|
EditSageAnswer = "editSageAnswer",
|
|
4132
4231
|
/**
|
|
4232
|
+
* The feedback widget for AI-generated Answers.
|
|
4233
|
+
* Allows users to send feedback on the Answers generated
|
|
4234
|
+
* from a Natural Language Search query.
|
|
4133
4235
|
*
|
|
4134
|
-
*This action allows users to send feedback on AI-generated Answers.
|
|
4135
4236
|
* @example
|
|
4136
4237
|
* ```js
|
|
4137
4238
|
* disabledActions: [Action.SageAnswerFeedback]
|
|
4138
4239
|
* ```
|
|
4139
|
-
* @version SDK: 1.26.0 |
|
|
4240
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
4140
4241
|
*/
|
|
4141
4242
|
SageAnswerFeedback = "sageAnswerFeedback",
|
|
4142
4243
|
/**
|
|
@@ -4145,7 +4246,7 @@ export declare enum Action {
|
|
|
4145
4246
|
* ```js
|
|
4146
4247
|
* disabledActions: [Action.ModifySageAnswer]
|
|
4147
4248
|
* ```
|
|
4148
|
-
* @version SDK: 1.26.0 |
|
|
4249
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
4149
4250
|
*/
|
|
4150
4251
|
ModifySageAnswer = "modifySageAnswer",
|
|
4151
4252
|
/**
|
|
@@ -4158,7 +4259,10 @@ export declare enum Action {
|
|
|
4158
4259
|
*/
|
|
4159
4260
|
MoveToTab = "onContainerMove",
|
|
4160
4261
|
/**
|
|
4161
|
-
* The **Manage
|
|
4262
|
+
* The **Manage Alerts** menu action on KPI visualizations.
|
|
4263
|
+
* Allows creating, viewing, and editing monitor
|
|
4264
|
+
* alerts for a KPI chart.
|
|
4265
|
+
*
|
|
4162
4266
|
* @example
|
|
4163
4267
|
* ```js
|
|
4164
4268
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -4166,21 +4270,23 @@ export declare enum Action {
|
|
|
4166
4270
|
*/
|
|
4167
4271
|
ManageMonitor = "manageMonitor",
|
|
4168
4272
|
/**
|
|
4169
|
-
*
|
|
4273
|
+
* The Liveboard Personalised Views dropdown.
|
|
4274
|
+
* Allows navigating to a personalized Liveboard View.
|
|
4170
4275
|
* @example
|
|
4171
4276
|
* ```js
|
|
4172
4277
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4173
4278
|
* ```
|
|
4174
|
-
* @version SDK : 1.26.0 |
|
|
4279
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4175
4280
|
*/
|
|
4176
4281
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
4177
4282
|
/**
|
|
4178
|
-
* Action ID for
|
|
4283
|
+
* Action ID for show or hide the user details on a
|
|
4284
|
+
* Liveboard (Recently visited / social proof)
|
|
4179
4285
|
* @example
|
|
4180
4286
|
* ```js
|
|
4181
4287
|
* disabledActions: [Action.LiveboardUsers]
|
|
4182
4288
|
* ```
|
|
4183
|
-
* @version SDK : 1.26.0 |
|
|
4289
|
+
* @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4184
4290
|
*/
|
|
4185
4291
|
LiveboardUsers = "liveboardUsers",
|
|
4186
4292
|
/**
|
|
@@ -4198,108 +4304,124 @@ export declare enum Action {
|
|
|
4198
4304
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4199
4305
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4200
4306
|
* ```
|
|
4201
|
-
* @version SDK : 1.28.3 |
|
|
4307
|
+
* @version SDK : 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4202
4308
|
*/
|
|
4203
4309
|
TML = "tml",
|
|
4204
4310
|
/**
|
|
4205
|
-
*
|
|
4206
|
-
* and Pin modal
|
|
4311
|
+
* The **Create Liveboard* action on
|
|
4312
|
+
* the Liveboards page and the Pin modal.
|
|
4313
|
+
* Allows users to create a Liveboard.
|
|
4314
|
+
*
|
|
4207
4315
|
* @example
|
|
4208
4316
|
* ```js
|
|
4209
4317
|
* hiddenAction: [Action.CreateLiveboard]
|
|
4210
4318
|
* disabledActions: [Action.CreateLiveboard]
|
|
4211
4319
|
* ```
|
|
4212
|
-
* @version SDK: 1.32.0 |
|
|
4320
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
4213
4321
|
*/
|
|
4214
4322
|
CreateLiveboard = "createLiveboard",
|
|
4215
4323
|
/**
|
|
4216
|
-
* Action ID for to hide
|
|
4324
|
+
* Action ID for to hide or disable the
|
|
4325
|
+
* Verified Liveboard banner.
|
|
4217
4326
|
* @example
|
|
4218
4327
|
* ```js
|
|
4219
4328
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
4220
4329
|
* ```
|
|
4221
|
-
* @version SDK: 1.29.0 |
|
|
4330
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
4222
4331
|
*/
|
|
4223
4332
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
4224
4333
|
/**
|
|
4225
|
-
*
|
|
4334
|
+
* The *Ask Sage* action for Answers and visualizations.
|
|
4335
|
+
* Allows initiating a Natural Language Search query.
|
|
4336
|
+
*
|
|
4226
4337
|
* @example
|
|
4227
4338
|
* ```js
|
|
4228
4339
|
* hiddenAction: [Action.AskAi]
|
|
4229
4340
|
* ```
|
|
4230
|
-
* @version SDK: 1.29.0 |
|
|
4341
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
4231
4342
|
*/
|
|
4232
4343
|
AskAi = "AskAi",
|
|
4233
4344
|
/**
|
|
4234
4345
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
4346
|
+
* Adds a KPI chart to the watchlist on the Home page.
|
|
4235
4347
|
* @example
|
|
4236
4348
|
* ```js
|
|
4237
4349
|
* disabledActions: [Action.AddToWatchlist]
|
|
4238
4350
|
* ```
|
|
4239
|
-
* @version SDK : 1.27.9 |
|
|
4351
|
+
* @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4240
4352
|
*/
|
|
4241
4353
|
AddToWatchlist = "addToWatchlist",
|
|
4242
4354
|
/**
|
|
4243
4355
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
4356
|
+
* Removes a KPI chart from the watchlist on the Home page.
|
|
4244
4357
|
* @example
|
|
4245
4358
|
* ```js
|
|
4246
4359
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4247
4360
|
* ```
|
|
4248
|
-
* @version SDK : 1.27.9 |
|
|
4361
|
+
* @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4249
4362
|
*/
|
|
4250
4363
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
4251
4364
|
/**
|
|
4252
|
-
* The **
|
|
4365
|
+
* The **Organize Favourites** action on Homepage
|
|
4366
|
+
* *Favorites* module.
|
|
4367
|
+
*
|
|
4253
4368
|
* @example
|
|
4254
4369
|
* ```js
|
|
4255
4370
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4256
4371
|
* ```
|
|
4257
|
-
* @version SDK : 1.32.0 |
|
|
4372
|
+
* @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4258
4373
|
*/
|
|
4259
4374
|
OrganiseFavourites = "organiseFavourites",
|
|
4260
4375
|
/**
|
|
4261
|
-
*
|
|
4376
|
+
* The **AI Highlights** action on a Liveboard.
|
|
4377
|
+
*
|
|
4262
4378
|
* @example
|
|
4263
4379
|
* ```js
|
|
4264
4380
|
* hiddenAction: [Action.AIHighlights]
|
|
4265
4381
|
* ```
|
|
4266
|
-
* @version SDK: 1.27.10 |
|
|
4382
|
+
* @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4267
4383
|
*/
|
|
4268
4384
|
AIHighlights = "AIHighlights",
|
|
4269
4385
|
/**
|
|
4270
|
-
*
|
|
4386
|
+
* The *Edit* action on the *Liveboard Schedules* page
|
|
4387
|
+
* (new Homepage experience).
|
|
4388
|
+
* Allows editing Liveboard schedules.
|
|
4389
|
+
*
|
|
4271
4390
|
* @example
|
|
4272
4391
|
* ```js
|
|
4273
4392
|
* disabledActions: [Action.EditScheduleHomepage]
|
|
4274
4393
|
* ```
|
|
4275
|
-
* @version SDK: 1.34.0 |
|
|
4394
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4276
4395
|
*/
|
|
4277
4396
|
EditScheduleHomepage = "editScheduleHomepage",
|
|
4278
4397
|
/**
|
|
4279
|
-
*
|
|
4398
|
+
* The *Pause* action on the *Liveboard Schedules* page
|
|
4399
|
+
* Pauses a scheduled Liveboard job.
|
|
4280
4400
|
* @example
|
|
4281
4401
|
* ```js
|
|
4282
4402
|
* disabledActions: [Action.PauseScheduleHomepage]
|
|
4283
4403
|
* ```
|
|
4284
|
-
* @version SDK: 1.34.0 |
|
|
4404
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4285
4405
|
*/
|
|
4286
4406
|
PauseScheduleHomepage = "pauseScheduleHomepage",
|
|
4287
4407
|
/**
|
|
4288
|
-
*
|
|
4408
|
+
* The **View run history** action **Liveboard Schedules** page.
|
|
4409
|
+
* Allows viewing schedule run history.
|
|
4289
4410
|
* @example
|
|
4290
4411
|
* ```js
|
|
4291
4412
|
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
4292
4413
|
* ```
|
|
4293
|
-
* @version SDK: 1.34.0 |
|
|
4414
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
4294
4415
|
*/
|
|
4295
4416
|
ViewScheduleRunHomepage = "viewScheduleRunHomepage",
|
|
4296
4417
|
/**
|
|
4297
|
-
* Action ID
|
|
4418
|
+
* Action ID to hide or disable the
|
|
4419
|
+
* unsubscribe option for Liveboard schedules.
|
|
4298
4420
|
* @example
|
|
4299
4421
|
* ```js
|
|
4300
4422
|
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
4301
4423
|
* ```
|
|
4302
|
-
* @version SDK: 1.34.0 |
|
|
4424
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
4303
4425
|
*/
|
|
4304
4426
|
UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
|
|
4305
4427
|
/**
|
|
@@ -4308,16 +4430,17 @@ export declare enum Action {
|
|
|
4308
4430
|
* ```js
|
|
4309
4431
|
* disabledActions: [Action.ManageTags]
|
|
4310
4432
|
* ```
|
|
4311
|
-
* @version SDK : 1.34.0 |
|
|
4433
|
+
* @version SDK : 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4312
4434
|
*/
|
|
4313
4435
|
ManageTags = "manageTags",
|
|
4314
4436
|
/**
|
|
4315
|
-
*
|
|
4437
|
+
* The **Delete** action on the **Liveboard Schedules* page.
|
|
4438
|
+
* Deletes a Liveboard schedule.
|
|
4316
4439
|
* @example
|
|
4317
4440
|
* ```js
|
|
4318
4441
|
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
4319
4442
|
* ```
|
|
4320
|
-
* @version SDK: 1.34.0 |
|
|
4443
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
4321
4444
|
*/
|
|
4322
4445
|
DeleteScheduleHomepage = "deleteScheduleHomepage",
|
|
4323
4446
|
/**
|
|
@@ -4326,7 +4449,7 @@ export declare enum Action {
|
|
|
4326
4449
|
* ```js
|
|
4327
4450
|
* disabledActions: [Action.KPIAnalysisCTA]
|
|
4328
4451
|
* ```
|
|
4329
|
-
* @version SDK: 1.34.0 |
|
|
4452
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4330
4453
|
*/
|
|
4331
4454
|
KPIAnalysisCTA = "kpiAnalysisCTA",
|
|
4332
4455
|
/**
|
|
@@ -4335,61 +4458,73 @@ export declare enum Action {
|
|
|
4335
4458
|
* ```js
|
|
4336
4459
|
* const disabledActions = [Action.DisableChipReorder]
|
|
4337
4460
|
* ```
|
|
4338
|
-
* @version SDK: 1.36.0 |
|
|
4461
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4339
4462
|
*/
|
|
4340
4463
|
DisableChipReorder = "disableChipReorder",
|
|
4341
4464
|
/**
|
|
4342
|
-
* Action ID
|
|
4465
|
+
* Action ID to show, hide, or disable filters
|
|
4466
|
+
* in a Liveboard tab.
|
|
4467
|
+
*
|
|
4343
4468
|
* @example
|
|
4344
4469
|
* ```js
|
|
4345
4470
|
* hiddenAction: [Action.ChangeFilterVisibilityInTab]
|
|
4346
4471
|
* ```
|
|
4347
|
-
* @version SDK: 1.36.0 |
|
|
4472
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4348
4473
|
*/
|
|
4349
4474
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
4350
4475
|
/**
|
|
4351
|
-
*
|
|
4476
|
+
* The **Preview data** button on the Spotter interface.
|
|
4477
|
+
* Allows previewing the data used for Spotter queries.
|
|
4478
|
+
*
|
|
4352
4479
|
* @example
|
|
4353
4480
|
* ```js
|
|
4354
4481
|
* hiddenAction: [Action.PreviewDataSpotter]
|
|
4355
4482
|
* ```
|
|
4356
|
-
* @version SDK: 1.36.0 |
|
|
4483
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4357
4484
|
*/
|
|
4358
4485
|
PreviewDataSpotter = "previewDataSpotter",
|
|
4359
4486
|
/**
|
|
4360
|
-
*
|
|
4487
|
+
* The **Reset** link on the Spotter interface.
|
|
4488
|
+
* Resets the conversation with Spotter.
|
|
4489
|
+
*
|
|
4361
4490
|
* @example
|
|
4362
4491
|
* ```js
|
|
4363
4492
|
* hiddenAction: [Action.ResetSpotterChat]
|
|
4364
4493
|
* ```
|
|
4365
|
-
* @version SDK: 1.36.0 |
|
|
4494
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4366
4495
|
*/
|
|
4367
4496
|
ResetSpotterChat = "resetSpotterChat",
|
|
4368
4497
|
/**
|
|
4369
|
-
* Action ID for hide
|
|
4498
|
+
* Action ID for hide or disable the
|
|
4499
|
+
* Spotter feedback widget.
|
|
4500
|
+
*
|
|
4370
4501
|
* @example
|
|
4371
4502
|
* ```js
|
|
4372
4503
|
* hiddenAction: [Action.SpotterFeedback]
|
|
4373
4504
|
* ```
|
|
4374
|
-
* @version SDK: 1.36.0 |
|
|
4505
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4375
4506
|
*/
|
|
4376
4507
|
SpotterFeedback = "spotterFeedback",
|
|
4377
4508
|
/**
|
|
4378
|
-
* Action ID for hide
|
|
4509
|
+
* Action ID for hide or disable
|
|
4510
|
+
* the previous prompt edit option in Spotter.
|
|
4511
|
+
*
|
|
4379
4512
|
* @example
|
|
4380
4513
|
* ```js
|
|
4381
4514
|
* hiddenAction: [Action.EditPreviousPrompt]
|
|
4382
4515
|
* ```
|
|
4383
|
-
* @version SDK: 1.36.0 |
|
|
4516
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4384
4517
|
*/
|
|
4385
4518
|
EditPreviousPrompt = "editPreviousPrompt",
|
|
4386
4519
|
/**
|
|
4387
|
-
* Action ID for hide
|
|
4520
|
+
* Action ID for hide or disable
|
|
4521
|
+
* the previous prompt deletion option in Spotter.
|
|
4522
|
+
*
|
|
4388
4523
|
* @example
|
|
4389
4524
|
* ```js
|
|
4390
4525
|
* hiddenAction: [Action.DeletePreviousPrompt]
|
|
4391
4526
|
* ```
|
|
4392
|
-
* @version SDK: 1.36.0 |
|
|
4527
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4393
4528
|
*/
|
|
4394
4529
|
DeletePreviousPrompt = "deletePreviousPrompt",
|
|
4395
4530
|
/**
|
|
@@ -4398,7 +4533,7 @@ export declare enum Action {
|
|
|
4398
4533
|
* ```js
|
|
4399
4534
|
* hiddenAction: [Action.EditTokens]
|
|
4400
4535
|
* ```
|
|
4401
|
-
* @version SDK: 1.36.0 |
|
|
4536
|
+
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
4402
4537
|
*/
|
|
4403
4538
|
EditTokens = "editTokens"
|
|
4404
4539
|
}
|
|
@@ -4413,10 +4548,12 @@ export declare enum PrefetchFeatures {
|
|
|
4413
4548
|
}
|
|
4414
4549
|
/**
|
|
4415
4550
|
* Enum for options to change context trigger
|
|
4551
|
+
* BOTH_CLICKS option is introduced in 10.7
|
|
4416
4552
|
*/
|
|
4417
4553
|
export declare enum ContextMenuTriggerOptions {
|
|
4418
4554
|
LEFT_CLICK = "left-click",
|
|
4419
|
-
RIGHT_CLICK = "right-click"
|
|
4555
|
+
RIGHT_CLICK = "right-click",
|
|
4556
|
+
BOTH_CLICKS = "both-clicks"
|
|
4420
4557
|
}
|
|
4421
4558
|
export interface ColumnValue {
|
|
4422
4559
|
column: {
|
|
@@ -4469,7 +4606,7 @@ export declare enum LogLevel {
|
|
|
4469
4606
|
* logLevel: LogLevel.SILENT,
|
|
4470
4607
|
* })
|
|
4471
4608
|
* ```
|
|
4472
|
-
* @version SDK: 1.26.7 |
|
|
4609
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4473
4610
|
*/
|
|
4474
4611
|
SILENT = "SILENT",
|
|
4475
4612
|
/**
|
|
@@ -4481,7 +4618,7 @@ export declare enum LogLevel {
|
|
|
4481
4618
|
* logLevel: LogLevel.ERROR,
|
|
4482
4619
|
* })
|
|
4483
4620
|
* ```
|
|
4484
|
-
* @version SDK: 1.26.7 |
|
|
4621
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4485
4622
|
*/
|
|
4486
4623
|
ERROR = "ERROR",
|
|
4487
4624
|
/**
|
|
@@ -4493,7 +4630,7 @@ export declare enum LogLevel {
|
|
|
4493
4630
|
* logLevel: LogLevel.WARN,
|
|
4494
4631
|
* })
|
|
4495
4632
|
* ```
|
|
4496
|
-
* @version SDK: 1.26.7 |
|
|
4633
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4497
4634
|
*/
|
|
4498
4635
|
WARN = "WARN",
|
|
4499
4636
|
/**
|
|
@@ -4505,7 +4642,7 @@ export declare enum LogLevel {
|
|
|
4505
4642
|
* logLevel: LogLevel.INFO,
|
|
4506
4643
|
* })
|
|
4507
4644
|
* ```
|
|
4508
|
-
* @version SDK: 1.26.7 |
|
|
4645
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4509
4646
|
*/
|
|
4510
4647
|
INFO = "INFO",
|
|
4511
4648
|
/**
|
|
@@ -4517,7 +4654,7 @@ export declare enum LogLevel {
|
|
|
4517
4654
|
* logLevel: LogLevel.DEBUG,
|
|
4518
4655
|
* })
|
|
4519
4656
|
* ```
|
|
4520
|
-
* @version SDK: 1.26.7 |
|
|
4657
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4521
4658
|
*/
|
|
4522
4659
|
DEBUG = "DEBUG",
|
|
4523
4660
|
/**
|
|
@@ -4529,7 +4666,7 @@ export declare enum LogLevel {
|
|
|
4529
4666
|
* logLevel: LogLevel.TRACE,
|
|
4530
4667
|
* })
|
|
4531
4668
|
* ```
|
|
4532
|
-
* @version SDK: 1.26.7 |
|
|
4669
|
+
* @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl
|
|
4533
4670
|
*/
|
|
4534
4671
|
TRACE = "TRACE"
|
|
4535
4672
|
}
|