@thoughtspot/visual-embed-sdk 1.23.0-alpha.0 → 1.23.1
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/README.md +1 -1
- package/cjs/package.json +8 -1
- package/cjs/src/css-variables.d.ts +1 -1
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +1 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +8 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +8 -0
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +6 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +12 -0
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +15 -0
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +13 -3
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +1 -1
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/search.d.ts +4 -0
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +11 -1
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +69 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.spec.js +12 -0
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +972 -199
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +914 -180
- package/cjs/src/types.js.map +1 -1
- package/dist/src/css-variables.d.ts +1 -1
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +1 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +8 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +6 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +15 -0
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +4 -0
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +972 -199
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +945 -188
- package/dist/tsembed-react.js +927 -180
- package/dist/tsembed.es.js +953 -188
- package/dist/tsembed.js +935 -180
- package/dist/visual-embed-sdk-react-full.d.ts +1008 -202
- package/dist/visual-embed-sdk-react.d.ts +1018 -212
- package/dist/visual-embed-sdk.d.ts +1018 -212
- package/lib/package.json +8 -1
- package/lib/src/css-variables.d.ts +1 -1
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +8 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -0
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +6 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +12 -0
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +15 -0
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +13 -3
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +1 -1
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +4 -0
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +11 -1
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +69 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.spec.js +12 -0
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +972 -199
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +914 -180
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +1018 -212
- package/package.json +8 -1
- package/src/css-variables.ts +1 -1
- package/src/embed/app.ts +1 -1
- package/src/embed/base.ts +8 -0
- package/src/embed/liveboard.spec.ts +16 -0
- package/src/embed/liveboard.ts +10 -0
- package/src/embed/sage.spec.ts +1 -1
- package/src/embed/sage.ts +25 -2
- package/src/embed/search.ts +5 -0
- package/src/embed/ts-embed.spec.ts +79 -0
- package/src/embed/ts-embed.ts +13 -1
- package/src/react/index.spec.tsx +29 -0
- package/src/types.ts +973 -199
package/cjs/src/types.d.ts
CHANGED
|
@@ -163,7 +163,7 @@ export declare enum AuthType {
|
|
|
163
163
|
* .then((data) => data.token);
|
|
164
164
|
* }
|
|
165
165
|
* ```
|
|
166
|
-
* @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1
|
|
166
|
+
* @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1.sw
|
|
167
167
|
*/
|
|
168
168
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
169
169
|
/**
|
|
@@ -253,6 +253,9 @@ export interface CustomStyles {
|
|
|
253
253
|
export interface CustomisationsInterface {
|
|
254
254
|
style?: CustomStyles;
|
|
255
255
|
content?: {
|
|
256
|
+
/**
|
|
257
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
258
|
+
*/
|
|
256
259
|
strings?: Record<string, any>;
|
|
257
260
|
[key: string]: any;
|
|
258
261
|
};
|
|
@@ -334,7 +337,7 @@ export interface EmbedConfig {
|
|
|
334
337
|
*
|
|
335
338
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
336
339
|
*
|
|
337
|
-
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1
|
|
340
|
+
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
|
|
338
341
|
*/
|
|
339
342
|
redirectPath?: string;
|
|
340
343
|
/** @internal */
|
|
@@ -376,14 +379,14 @@ export interface EmbedConfig {
|
|
|
376
379
|
* This flag is typically used alongside the combination of auth modes such as {@link
|
|
377
380
|
* AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
|
|
378
381
|
*
|
|
379
|
-
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
382
|
+
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
380
383
|
* @default false
|
|
381
384
|
*/
|
|
382
385
|
disableLoginRedirect?: boolean;
|
|
383
386
|
/**
|
|
384
387
|
* This message is displayed on the embed view when the login fails.
|
|
385
388
|
*
|
|
386
|
-
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
389
|
+
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
387
390
|
*/
|
|
388
391
|
loginFailedMessage?: string;
|
|
389
392
|
/**
|
|
@@ -405,7 +408,7 @@ export interface EmbedConfig {
|
|
|
405
408
|
* Dynamic CSS Url to be injected in the loaded application.
|
|
406
409
|
* You would also need to set `style-src` in the CSP settings.
|
|
407
410
|
*
|
|
408
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
411
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
409
412
|
* @default ''
|
|
410
413
|
*/
|
|
411
414
|
customCssUrl?: string;
|
|
@@ -417,13 +420,13 @@ export interface EmbedConfig {
|
|
|
417
420
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
418
421
|
* involves an extra network call.
|
|
419
422
|
*
|
|
420
|
-
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
423
|
+
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
421
424
|
*/
|
|
422
425
|
detectCookieAccessSlow?: boolean;
|
|
423
426
|
/**
|
|
424
427
|
* Hide beta alert warning message for SearchEmbed.
|
|
425
428
|
*
|
|
426
|
-
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1
|
|
429
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
427
430
|
*/
|
|
428
431
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
429
432
|
/**
|
|
@@ -471,7 +474,7 @@ export interface EmbedConfig {
|
|
|
471
474
|
* Disable Full App access of Embedded app outside of the iFrame.
|
|
472
475
|
*
|
|
473
476
|
* @default true
|
|
474
|
-
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1
|
|
477
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
475
478
|
*/
|
|
476
479
|
blockNonEmbedFullAppAccess?: boolean;
|
|
477
480
|
/**
|
|
@@ -574,14 +577,14 @@ export interface ViewConfig {
|
|
|
574
577
|
*
|
|
575
578
|
* Use either this or hiddenActions.
|
|
576
579
|
*
|
|
577
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
580
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
578
581
|
* @important
|
|
579
582
|
*/
|
|
580
583
|
visibleActions?: Action[];
|
|
581
584
|
/**
|
|
582
585
|
* Show alert messages and toast messages in the embedded view.
|
|
583
586
|
*
|
|
584
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
587
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
585
588
|
*/
|
|
586
589
|
showAlerts?: boolean;
|
|
587
590
|
/**
|
|
@@ -592,7 +595,7 @@ export interface ViewConfig {
|
|
|
592
595
|
/**
|
|
593
596
|
* The locale/language to use for the embedded view.
|
|
594
597
|
*
|
|
595
|
-
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1
|
|
598
|
+
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
596
599
|
*/
|
|
597
600
|
locale?: string;
|
|
598
601
|
/**
|
|
@@ -603,7 +606,7 @@ export interface ViewConfig {
|
|
|
603
606
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
604
607
|
* list of supported keys and values associated with each.
|
|
605
608
|
*
|
|
606
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
609
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
607
610
|
*/
|
|
608
611
|
additionalFlags?: {
|
|
609
612
|
[key: string]: string | number | boolean;
|
|
@@ -612,7 +615,7 @@ export interface ViewConfig {
|
|
|
612
615
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
613
616
|
* You would also need to set `style-src` in the CSP settings.
|
|
614
617
|
*
|
|
615
|
-
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1
|
|
618
|
+
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
616
619
|
* @default ''
|
|
617
620
|
*/
|
|
618
621
|
customizations?: CustomisationsInterface;
|
|
@@ -660,24 +663,60 @@ export interface ViewConfig {
|
|
|
660
663
|
/**
|
|
661
664
|
* Boolean to hide liveboard header
|
|
662
665
|
*
|
|
663
|
-
* @version SDK: 1.
|
|
666
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
664
667
|
* @default false
|
|
665
668
|
*/
|
|
666
669
|
hideLiveboardHeader?: boolean;
|
|
667
670
|
/**
|
|
668
671
|
* Boolean to show liveboard title
|
|
669
672
|
*
|
|
670
|
-
* @version SDK: 1.
|
|
673
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
671
674
|
* @default false
|
|
672
675
|
*/
|
|
673
676
|
showLiveboardTitle?: boolean;
|
|
674
677
|
/**
|
|
675
678
|
* Boolean to show liveboard description
|
|
676
679
|
*
|
|
677
|
-
* @version SDK: 1.
|
|
680
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
678
681
|
* @default false
|
|
679
682
|
*/
|
|
680
683
|
showLiveboardDescription?: boolean;
|
|
684
|
+
/**
|
|
685
|
+
* The list of tab IDs to hide from the embedded.
|
|
686
|
+
* This Tabs will be hidden from their respective LBs.
|
|
687
|
+
* Use this to hide an tabID.
|
|
688
|
+
*
|
|
689
|
+
* @example
|
|
690
|
+
* ```js
|
|
691
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
692
|
+
* ... // other liveboard view config
|
|
693
|
+
* hiddenTabs: [
|
|
694
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
695
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
696
|
+
* });
|
|
697
|
+
* ```
|
|
698
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
699
|
+
*/
|
|
700
|
+
hiddenTabs?: string[];
|
|
701
|
+
/**
|
|
702
|
+
* The list of tab IDs to show in the embedded.
|
|
703
|
+
* Only this Tabs will be shown in their respective LBs.
|
|
704
|
+
* Use this to show an tabID.
|
|
705
|
+
*
|
|
706
|
+
* Use either this or hiddenTabs.
|
|
707
|
+
*
|
|
708
|
+
* @example
|
|
709
|
+
* ```js
|
|
710
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
711
|
+
* ... // other liveboard view config
|
|
712
|
+
* visibleTabs: [
|
|
713
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
714
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
715
|
+
* });
|
|
716
|
+
* ```
|
|
717
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
718
|
+
*/
|
|
719
|
+
visibleTabs?: string[];
|
|
681
720
|
}
|
|
682
721
|
/**
|
|
683
722
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
@@ -883,7 +922,7 @@ export declare enum EmbedEvent {
|
|
|
883
922
|
* One or more data columns have been selected.
|
|
884
923
|
*
|
|
885
924
|
* @returns columnIds - the list of columns
|
|
886
|
-
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
925
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
887
926
|
*/
|
|
888
927
|
AddRemoveColumns = "addRemoveColumns",
|
|
889
928
|
/**
|
|
@@ -916,7 +955,7 @@ export declare enum EmbedEvent {
|
|
|
916
955
|
* });
|
|
917
956
|
* ```
|
|
918
957
|
* @return viz, clickedPoint - metadata about point that is clicked
|
|
919
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
958
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
920
959
|
* @important
|
|
921
960
|
*/
|
|
922
961
|
VizPointClick = "vizPointClick",
|
|
@@ -966,7 +1005,7 @@ export declare enum EmbedEvent {
|
|
|
966
1005
|
* Emitted when the "Get Data" button in Search Bar embed
|
|
967
1006
|
* is clicked.
|
|
968
1007
|
*
|
|
969
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0
|
|
1008
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
970
1009
|
*/
|
|
971
1010
|
GetDataClick = "getDataClick",
|
|
972
1011
|
/**
|
|
@@ -996,13 +1035,13 @@ export declare enum EmbedEvent {
|
|
|
996
1035
|
/**
|
|
997
1036
|
* Emitted when any modal is opened in the app
|
|
998
1037
|
*
|
|
999
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1038
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1000
1039
|
*/
|
|
1001
1040
|
DialogOpen = "dialog-open",
|
|
1002
1041
|
/**
|
|
1003
1042
|
* Emitted when any modal is closed in the app
|
|
1004
1043
|
*
|
|
1005
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1044
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1006
1045
|
*/
|
|
1007
1046
|
DialogClose = "dialog-close",
|
|
1008
1047
|
/**
|
|
@@ -1010,136 +1049,136 @@ export declare enum EmbedEvent {
|
|
|
1010
1049
|
* You can use this event as a hook to trigger
|
|
1011
1050
|
* other events on the rendered Liveboard.
|
|
1012
1051
|
*
|
|
1013
|
-
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
1052
|
+
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1014
1053
|
*/
|
|
1015
1054
|
LiveboardRendered = "PinboardRendered",
|
|
1016
1055
|
/**
|
|
1017
1056
|
* This can be used to register an event listener which
|
|
1018
1057
|
* is triggered on all events.
|
|
1019
1058
|
*
|
|
1020
|
-
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1
|
|
1059
|
+
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1021
1060
|
*/
|
|
1022
1061
|
ALL = "*",
|
|
1023
1062
|
/**
|
|
1024
|
-
* Emitted when
|
|
1063
|
+
* Emitted when an Answer is saved in the app
|
|
1025
1064
|
*
|
|
1026
|
-
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1065
|
+
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1027
1066
|
*/
|
|
1028
1067
|
Save = "save",
|
|
1029
1068
|
/**
|
|
1030
1069
|
* Emitted when the download action is triggered on an answer
|
|
1031
1070
|
*
|
|
1032
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1071
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1033
1072
|
*/
|
|
1034
1073
|
Download = "download",
|
|
1035
1074
|
/**
|
|
1036
1075
|
* Emitted when the download action is triggered on an answer
|
|
1037
1076
|
*
|
|
1038
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0
|
|
1077
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1039
1078
|
*/
|
|
1040
1079
|
DownloadAsPng = "downloadAsPng",
|
|
1041
1080
|
/**
|
|
1042
1081
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
1043
1082
|
*
|
|
1044
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1083
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1045
1084
|
*/
|
|
1046
1085
|
DownloadAsPdf = "downloadAsPdf",
|
|
1047
1086
|
/**
|
|
1048
1087
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
1049
1088
|
*
|
|
1050
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1089
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1051
1090
|
*/
|
|
1052
1091
|
DownloadAsCsv = "downloadAsCsv",
|
|
1053
1092
|
/**
|
|
1054
1093
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1055
1094
|
*
|
|
1056
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1095
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1057
1096
|
*/
|
|
1058
1097
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
1059
1098
|
/**
|
|
1060
1099
|
* Emitted when an answer is deleted in the app
|
|
1061
1100
|
*
|
|
1062
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1101
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1063
1102
|
*/
|
|
1064
1103
|
AnswerDelete = "answerDelete",
|
|
1065
1104
|
/**
|
|
1066
1105
|
* Emitted when an answer is pinned to a Liveboard
|
|
1067
1106
|
*
|
|
1068
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1107
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1069
1108
|
*/
|
|
1070
1109
|
Pin = "pin",
|
|
1071
1110
|
/**
|
|
1072
1111
|
* Emitted when SpotIQ analysis is triggered
|
|
1073
1112
|
*
|
|
1074
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1113
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1075
1114
|
*/
|
|
1076
1115
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1077
1116
|
/**
|
|
1078
1117
|
* Emitted when a user shares an object with another user or group
|
|
1079
1118
|
*
|
|
1080
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1119
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1081
1120
|
*/
|
|
1082
1121
|
Share = "share",
|
|
1083
1122
|
/**
|
|
1084
1123
|
* Emitted when a user clicks the Include action to include a specific value or data
|
|
1085
1124
|
* on a chart or table
|
|
1086
1125
|
*
|
|
1087
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1126
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1088
1127
|
*/
|
|
1089
1128
|
DrillInclude = "context-menu-item-include",
|
|
1090
1129
|
/**
|
|
1091
1130
|
* Emitted when a user clicks the Exclude action to exclude a specific value or data
|
|
1092
1131
|
* on a chart or table
|
|
1093
1132
|
*
|
|
1094
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1133
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1095
1134
|
*/
|
|
1096
1135
|
DrillExclude = "context-menu-item-exclude",
|
|
1097
1136
|
/**
|
|
1098
1137
|
* Emitted when copied column value on the app
|
|
1099
1138
|
*
|
|
1100
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1139
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1101
1140
|
*/
|
|
1102
1141
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
1103
1142
|
/**
|
|
1104
1143
|
* Emitted when a user clicks the Update TML action
|
|
1105
1144
|
*
|
|
1106
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1145
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1107
1146
|
*/
|
|
1108
1147
|
UpdateTML = "updateTSL",
|
|
1109
1148
|
/**
|
|
1110
1149
|
* Emitted when a user clicks the Edit TML action
|
|
1111
1150
|
*
|
|
1112
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1151
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1113
1152
|
*/
|
|
1114
1153
|
EditTML = "editTSL",
|
|
1115
1154
|
/**
|
|
1116
1155
|
* Emitted when ExportTML trigger in answer on the app
|
|
1117
1156
|
*
|
|
1118
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1157
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1119
1158
|
*/
|
|
1120
1159
|
ExportTML = "exportTSL",
|
|
1121
1160
|
/**
|
|
1122
1161
|
* Emitted when an answer is saved as a view
|
|
1123
1162
|
*
|
|
1124
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1163
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1125
1164
|
*/
|
|
1126
1165
|
SaveAsView = "saveAsView",
|
|
1127
1166
|
/**
|
|
1128
1167
|
* Emitted when copy of existing answer on the app
|
|
1129
1168
|
*
|
|
1130
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1169
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1131
1170
|
*/
|
|
1132
1171
|
CopyAEdit = "copyAEdit",
|
|
1133
1172
|
/**
|
|
1134
1173
|
* Emitted when a user clicks Show underlying data on an answe
|
|
1135
1174
|
*
|
|
1136
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1175
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1137
1176
|
*/
|
|
1138
1177
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1139
1178
|
/**
|
|
1140
1179
|
* Emitted when an answer is switched to a chart or table view
|
|
1141
1180
|
*
|
|
1142
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1
|
|
1181
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1143
1182
|
*/
|
|
1144
1183
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
1145
1184
|
/**
|
|
@@ -1151,67 +1190,67 @@ export declare enum EmbedEvent {
|
|
|
1151
1190
|
/**
|
|
1152
1191
|
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
1153
1192
|
*
|
|
1154
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1193
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1155
1194
|
*/
|
|
1156
1195
|
LiveboardInfo = "pinboardInfo",
|
|
1157
1196
|
/**
|
|
1158
1197
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1159
1198
|
*
|
|
1160
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1199
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1161
1200
|
*/
|
|
1162
1201
|
AddToFavorites = "addToFavorites",
|
|
1163
1202
|
/**
|
|
1164
1203
|
* Emitted when a user clicks Schedule on a Liveboard
|
|
1165
1204
|
*
|
|
1166
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1205
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1167
1206
|
*/
|
|
1168
1207
|
Schedule = "subscription",
|
|
1169
1208
|
/**
|
|
1170
1209
|
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
1171
1210
|
*
|
|
1172
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1211
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1173
1212
|
*/
|
|
1174
1213
|
Edit = "edit",
|
|
1175
1214
|
/**
|
|
1176
1215
|
* Emitted when a user clicks Make a copy on a Liveboard
|
|
1177
1216
|
*
|
|
1178
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1217
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1179
1218
|
*/
|
|
1180
1219
|
MakeACopy = "makeACopy",
|
|
1181
1220
|
/**
|
|
1182
1221
|
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
1183
1222
|
*
|
|
1184
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1223
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1185
1224
|
*/
|
|
1186
1225
|
Present = "present",
|
|
1187
1226
|
/**
|
|
1188
1227
|
* Emitted when a user clicks Delete on a Liveboard
|
|
1189
1228
|
*
|
|
1190
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1229
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1191
1230
|
*/
|
|
1192
1231
|
Delete = "delete",
|
|
1193
1232
|
/**
|
|
1194
1233
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1195
1234
|
*
|
|
1196
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1235
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1197
1236
|
*/
|
|
1198
1237
|
SchedulesList = "schedule-list",
|
|
1199
1238
|
/**
|
|
1200
1239
|
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
1201
1240
|
*
|
|
1202
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1241
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1203
1242
|
*/
|
|
1204
1243
|
Cancel = "cancel",
|
|
1205
1244
|
/**
|
|
1206
1245
|
* Emitted when a user clicks Explore on a visualization
|
|
1207
1246
|
*
|
|
1208
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1247
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1209
1248
|
*/
|
|
1210
1249
|
Explore = "explore",
|
|
1211
1250
|
/**
|
|
1212
1251
|
* Emitted when a user clicks Copy link action on a visualization
|
|
1213
1252
|
*
|
|
1214
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1253
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1215
1254
|
*/
|
|
1216
1255
|
CopyLink = "embedDocument",
|
|
1217
1256
|
/**
|
|
@@ -1231,7 +1270,25 @@ export declare enum EmbedEvent {
|
|
|
1231
1270
|
*
|
|
1232
1271
|
* @hidden
|
|
1233
1272
|
*/
|
|
1234
|
-
InsertIntoSlide = "insertInToSlide"
|
|
1273
|
+
InsertIntoSlide = "insertInToSlide",
|
|
1274
|
+
/**
|
|
1275
|
+
* Emitted when a user changes any filter on a Liveboard.
|
|
1276
|
+
*
|
|
1277
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1278
|
+
*/
|
|
1279
|
+
FilterChanged = "filterChanged",
|
|
1280
|
+
/**
|
|
1281
|
+
* Emitted when a user click on Go button in Sage Embed
|
|
1282
|
+
*
|
|
1283
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1284
|
+
*/
|
|
1285
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
1286
|
+
/**
|
|
1287
|
+
* Emitten when a user select data source in Sage Embed
|
|
1288
|
+
*
|
|
1289
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
|
|
1290
|
+
*/
|
|
1291
|
+
SageWorksheetUpdated = "sageWorksheetUpdated"
|
|
1235
1292
|
}
|
|
1236
1293
|
/**
|
|
1237
1294
|
* Event types that can be triggered by the host application
|
|
@@ -1257,13 +1314,15 @@ export declare enum EmbedEvent {
|
|
|
1257
1314
|
*/
|
|
1258
1315
|
export declare enum HostEvent {
|
|
1259
1316
|
/**
|
|
1260
|
-
*
|
|
1317
|
+
* Triggers a search query in AppEmbed and SearchEmbed
|
|
1318
|
+
* deployments.
|
|
1319
|
+
* Includes the following properties:
|
|
1261
1320
|
*
|
|
1262
1321
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
1263
1322
|
* - Although an array, only a single source
|
|
1264
|
-
* is supported
|
|
1265
|
-
* @param - searchQuery -
|
|
1266
|
-
* @param - execute -
|
|
1323
|
+
* is supported.
|
|
1324
|
+
* @param - searchQuery - Query string with search tokens
|
|
1325
|
+
* @param - execute - executes the existing / updated query
|
|
1267
1326
|
* @example
|
|
1268
1327
|
* ```js
|
|
1269
1328
|
* searchEmbed.trigger(HostEvent.Search, {
|
|
@@ -1275,13 +1334,14 @@ export declare enum HostEvent {
|
|
|
1275
1334
|
*/
|
|
1276
1335
|
Search = "search",
|
|
1277
1336
|
/**
|
|
1278
|
-
*
|
|
1337
|
+
* Triggers a drill on certain points of the specified column
|
|
1338
|
+
* Includes the following properties:
|
|
1279
1339
|
*
|
|
1280
1340
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
1281
|
-
*
|
|
1282
|
-
* @param - columnGuid -
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1341
|
+
* to drill to. For example, { selectedPoints: []}
|
|
1342
|
+
* @param - columnGuid - Optional. GUID of the column to drill
|
|
1343
|
+
* by. If not provided it will auto drill by the configured
|
|
1344
|
+
* column.
|
|
1285
1345
|
* @example
|
|
1286
1346
|
* ```js
|
|
1287
1347
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -1314,17 +1374,17 @@ export declare enum HostEvent {
|
|
|
1314
1374
|
*/
|
|
1315
1375
|
Reload = "reload",
|
|
1316
1376
|
/**
|
|
1317
|
-
*
|
|
1377
|
+
* Sets the visible visualizations on a Liveboard.
|
|
1318
1378
|
*
|
|
1319
|
-
* @param -
|
|
1320
|
-
*
|
|
1379
|
+
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
1380
|
+
* in this parameter will be hidden.
|
|
1321
1381
|
* @example
|
|
1322
1382
|
* ```js
|
|
1323
1383
|
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
1324
1384
|
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
1325
1385
|
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
1326
1386
|
* ```
|
|
1327
|
-
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1
|
|
1387
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1328
1388
|
*/
|
|
1329
1389
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
1330
1390
|
/**
|
|
@@ -1341,8 +1401,18 @@ export declare enum HostEvent {
|
|
|
1341
1401
|
*/
|
|
1342
1402
|
SetActiveTab = "SetActiveTab",
|
|
1343
1403
|
/**
|
|
1344
|
-
*
|
|
1345
|
-
*
|
|
1404
|
+
* Updates runtime filters applied on a Saved Answer or Liveboard. The
|
|
1405
|
+
* runtime filters passed here are appended to the existing runtime
|
|
1406
|
+
* filters.
|
|
1407
|
+
* Pass an array of runtime filters with the following attributes:
|
|
1408
|
+
* `columnName`
|
|
1409
|
+
* _String_. The name of the column to filter on.
|
|
1410
|
+
* `operator`
|
|
1411
|
+
* Runtime filter operator to apply. For information,
|
|
1412
|
+
* see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
1413
|
+
* `values`
|
|
1414
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
1415
|
+
* operators such as BW and IN accept multiple operands.
|
|
1346
1416
|
*
|
|
1347
1417
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
1348
1418
|
* @example
|
|
@@ -1352,12 +1422,12 @@ export declare enum HostEvent {
|
|
|
1352
1422
|
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
|
|
1353
1423
|
* ])
|
|
1354
1424
|
* ```
|
|
1355
|
-
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1
|
|
1425
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1356
1426
|
* @important
|
|
1357
1427
|
*/
|
|
1358
1428
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
1359
1429
|
/**
|
|
1360
|
-
* Navigate to a specific page in
|
|
1430
|
+
* Navigate to a specific page in the embedded application without reloading the page.
|
|
1361
1431
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1362
1432
|
*
|
|
1363
1433
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
@@ -1365,12 +1435,12 @@ export declare enum HostEvent {
|
|
|
1365
1435
|
* ```js
|
|
1366
1436
|
* appEmbed.navigateToPage(-1)
|
|
1367
1437
|
* ```
|
|
1368
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1
|
|
1438
|
+
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
1369
1439
|
*/
|
|
1370
1440
|
Navigate = "Navigate",
|
|
1371
1441
|
/**
|
|
1372
1442
|
* Opens the filter panel for a particular column.
|
|
1373
|
-
* Works with Search embed.
|
|
1443
|
+
* Works with Search and Liveboard embed.
|
|
1374
1444
|
*
|
|
1375
1445
|
* @param - { columnId: string,
|
|
1376
1446
|
* name: string,
|
|
@@ -1379,233 +1449,257 @@ export declare enum HostEvent {
|
|
|
1379
1449
|
* @example
|
|
1380
1450
|
* ```js
|
|
1381
1451
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
1382
|
-
*
|
|
1452
|
+
* { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
|
|
1453
|
+
* LiveboardEmbed.trigger(HostEvent.OpenFilter,
|
|
1454
|
+
* { columnId: '<column-GUID>'})
|
|
1383
1455
|
* ```
|
|
1384
1456
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1385
1457
|
*/
|
|
1386
1458
|
OpenFilter = "openFilter",
|
|
1387
1459
|
/**
|
|
1388
|
-
* Adds
|
|
1460
|
+
* Adds columns to the current search query.
|
|
1389
1461
|
*
|
|
1390
1462
|
* @param - { columnIds: string[] }
|
|
1391
1463
|
* @example
|
|
1392
1464
|
* ```js
|
|
1393
|
-
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['
|
|
1465
|
+
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
|
|
1394
1466
|
* ```
|
|
1395
1467
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1396
1468
|
*/
|
|
1397
1469
|
AddColumns = "addColumns",
|
|
1398
1470
|
/**
|
|
1399
|
-
* Removes a column from the current
|
|
1471
|
+
* Removes a column from the current search query.
|
|
1400
1472
|
*
|
|
1401
1473
|
* @param - { columnId: string }
|
|
1402
1474
|
* @example
|
|
1403
1475
|
* ```js
|
|
1404
|
-
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '
|
|
1476
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
|
|
1405
1477
|
* ```
|
|
1406
1478
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1407
1479
|
*/
|
|
1408
1480
|
RemoveColumn = "removeColumn",
|
|
1409
1481
|
/**
|
|
1410
|
-
* Gets the current
|
|
1482
|
+
* Gets the current Liveboard content.
|
|
1411
1483
|
*
|
|
1412
1484
|
* @example
|
|
1413
1485
|
* ```js
|
|
1414
1486
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
1415
1487
|
* ```
|
|
1416
|
-
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1
|
|
1488
|
+
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
1417
1489
|
*/
|
|
1418
1490
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
1419
1491
|
/**
|
|
1420
|
-
* Triggers the Pin action on an embedded object
|
|
1492
|
+
* Triggers the **Pin** action on an embedded object
|
|
1421
1493
|
*
|
|
1422
|
-
* @param -
|
|
1423
|
-
*
|
|
1494
|
+
* @param - Liveboard embed takes the `vizId` as a
|
|
1495
|
+
* key. Can be left undefined when embedding Search, full app or
|
|
1496
|
+
* a visualization.
|
|
1424
1497
|
* @example
|
|
1425
1498
|
* ```js
|
|
1426
1499
|
* liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1500
|
+
* ```
|
|
1501
|
+
* ```js
|
|
1427
1502
|
* vizEmbed.trigger(HostEvent.Pin)
|
|
1503
|
+
* ```
|
|
1504
|
+
* ```js
|
|
1428
1505
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
1429
1506
|
* ```
|
|
1430
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1507
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1431
1508
|
*/
|
|
1432
1509
|
Pin = "pin",
|
|
1433
1510
|
/**
|
|
1434
|
-
* Triggers the Show Liveboard details action on a Liveboard
|
|
1511
|
+
* Triggers the **Show Liveboard details** action on a Liveboard
|
|
1435
1512
|
*
|
|
1436
1513
|
* @example
|
|
1437
1514
|
* ```js
|
|
1438
1515
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
1439
1516
|
* ```
|
|
1440
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1517
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1441
1518
|
*/
|
|
1442
1519
|
LiveboardInfo = "pinboardInfo",
|
|
1443
1520
|
/**
|
|
1444
|
-
* Triggers the Schedule action on a Liveboard
|
|
1521
|
+
* Triggers the **Schedule** action on a Liveboard
|
|
1445
1522
|
*
|
|
1446
1523
|
* @example
|
|
1447
1524
|
* ```js
|
|
1448
1525
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
1449
1526
|
* ```
|
|
1450
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1527
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1451
1528
|
*/
|
|
1452
1529
|
Schedule = "subscription",
|
|
1453
1530
|
/**
|
|
1454
|
-
* Triggers the Manage schedule action on a Liveboard
|
|
1531
|
+
* Triggers the **Manage schedule** action on a Liveboard
|
|
1455
1532
|
*
|
|
1456
1533
|
* @example
|
|
1457
1534
|
* ```js
|
|
1458
1535
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
1459
1536
|
* ```
|
|
1460
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1537
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1461
1538
|
*/
|
|
1462
1539
|
SchedulesList = "schedule-list",
|
|
1463
1540
|
/**
|
|
1464
|
-
* Triggers the Export TML action on a Liveboard
|
|
1541
|
+
* Triggers the **Export TML** action on a Liveboard
|
|
1465
1542
|
*
|
|
1466
1543
|
* @example
|
|
1467
1544
|
* ```js
|
|
1468
1545
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
1469
1546
|
* ```
|
|
1470
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1547
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1471
1548
|
*/
|
|
1472
1549
|
ExportTML = "exportTSL",
|
|
1473
1550
|
/**
|
|
1474
|
-
* Triggers the Edit TML action on a Liveboard
|
|
1551
|
+
* Triggers the **Edit TML** action on a Liveboard
|
|
1475
1552
|
*
|
|
1476
1553
|
* @example
|
|
1477
1554
|
* ```js
|
|
1478
1555
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
1479
1556
|
* ```
|
|
1480
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1557
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1481
1558
|
*/
|
|
1482
1559
|
EditTML = "editTSL",
|
|
1483
1560
|
/**
|
|
1484
|
-
* Triggers the Update TML action on a Liveboard
|
|
1561
|
+
* Triggers the **Update TML** action on a Liveboard
|
|
1485
1562
|
*
|
|
1486
1563
|
* @example
|
|
1487
1564
|
* ```js
|
|
1488
1565
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
1489
1566
|
* ```
|
|
1490
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1567
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1491
1568
|
*/
|
|
1492
1569
|
UpdateTML = "updateTSL",
|
|
1493
1570
|
/**
|
|
1494
|
-
* Triggers the Download PDF action on a Liveboard
|
|
1571
|
+
* Triggers the **Download PDF** action on a Liveboard
|
|
1495
1572
|
*
|
|
1496
1573
|
* @example
|
|
1497
1574
|
* ```js
|
|
1498
1575
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
1499
1576
|
* ```
|
|
1500
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1577
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1501
1578
|
*/
|
|
1502
1579
|
DownloadAsPdf = "downloadAsPdf",
|
|
1503
1580
|
/**
|
|
1504
|
-
* Triggers the Make a copy action on a Liveboard,
|
|
1581
|
+
* Triggers the **Make a copy** action on a Liveboard, Search, or
|
|
1582
|
+
* visualization page
|
|
1505
1583
|
*
|
|
1506
1584
|
* @example
|
|
1507
1585
|
* ```js
|
|
1508
1586
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1587
|
+
* ```
|
|
1588
|
+
* ```js
|
|
1509
1589
|
* vizEmbed.trigger(HostEvent.MakeACopy)
|
|
1590
|
+
* ```
|
|
1591
|
+
* ```js
|
|
1510
1592
|
* searchEmbed.trigger(HostEvent.MakeACopy)
|
|
1511
1593
|
* ```
|
|
1512
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1594
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1513
1595
|
*/
|
|
1514
1596
|
MakeACopy = "makeACopy",
|
|
1515
1597
|
/**
|
|
1516
|
-
* Triggers the Delete action on a Liveboard
|
|
1598
|
+
* Triggers the **Delete** action on a Liveboard
|
|
1517
1599
|
*
|
|
1518
1600
|
* @example
|
|
1519
1601
|
* ```js
|
|
1520
1602
|
* appEmbed.trigger(HostEvent.Remove)
|
|
1521
1603
|
* ```
|
|
1522
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1604
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1523
1605
|
*/
|
|
1524
1606
|
Remove = "delete",
|
|
1525
1607
|
/**
|
|
1526
|
-
* Triggers the Explore action on a visualization
|
|
1608
|
+
* Triggers the **Explore* action on a visualization
|
|
1527
1609
|
*
|
|
1528
|
-
* @param - an object with vizId as a key
|
|
1610
|
+
* @param - an object with `vizId` as a key
|
|
1529
1611
|
* @example
|
|
1530
1612
|
* ```js
|
|
1531
1613
|
* liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1532
1614
|
* ```
|
|
1533
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1615
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1534
1616
|
*/
|
|
1535
1617
|
Explore = "explore",
|
|
1536
1618
|
/**
|
|
1537
|
-
* Triggers the Create alert action on a visualization
|
|
1619
|
+
* Triggers the **Create alert** action on a visualization
|
|
1538
1620
|
*
|
|
1539
|
-
* @param - an object with vizId as a key
|
|
1621
|
+
* @param - an object with `vizId` as a key
|
|
1540
1622
|
* @example
|
|
1541
1623
|
* ```js
|
|
1542
1624
|
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
1543
1625
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1544
1626
|
* })
|
|
1545
1627
|
* ```
|
|
1546
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1628
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1547
1629
|
*/
|
|
1548
1630
|
CreateMonitor = "createMonitor",
|
|
1549
1631
|
/**
|
|
1550
|
-
* Triggers the Manage
|
|
1632
|
+
* Triggers the **Manage alerts** action on a visualization
|
|
1551
1633
|
*
|
|
1552
|
-
* @param - an object with vizId as a key
|
|
1634
|
+
* @param - an object with `vizId` as a key
|
|
1553
1635
|
* @example
|
|
1554
1636
|
* ```js
|
|
1555
1637
|
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
1556
1638
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1557
1639
|
* })
|
|
1558
1640
|
* ```
|
|
1559
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1641
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1560
1642
|
*/
|
|
1561
1643
|
ManageMonitor = "manageMonitor",
|
|
1562
1644
|
/**
|
|
1563
|
-
* Triggers the Edit action on a Liveboard or visualization
|
|
1645
|
+
* Triggers the **Edit** action on a Liveboard or visualization
|
|
1564
1646
|
*
|
|
1565
|
-
* @param - object -
|
|
1566
|
-
*
|
|
1647
|
+
* @param - object - To trigger the action for a specific visualization
|
|
1648
|
+
* in Liveboard embed, pass in `vizId` as a key.
|
|
1649
|
+
* Can be left undefined when embedding Search, full app, or
|
|
1650
|
+
* a visualization.
|
|
1567
1651
|
* @example
|
|
1568
1652
|
* ```js
|
|
1569
1653
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
1570
|
-
*
|
|
1654
|
+
* ```
|
|
1655
|
+
* ```js
|
|
1571
1656
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
1572
1657
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1573
|
-
*
|
|
1658
|
+
* ```
|
|
1659
|
+
* ```js
|
|
1574
1660
|
* vizEmbed.trigger((HostEvent.Edit)
|
|
1575
1661
|
* ```
|
|
1576
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1662
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1577
1663
|
*/
|
|
1578
1664
|
Edit = "edit",
|
|
1579
1665
|
/**
|
|
1580
|
-
* Triggers the Copy link action on a Liveboard or visualization
|
|
1666
|
+
* Triggers the **Copy link** action on a Liveboard or visualization
|
|
1581
1667
|
*
|
|
1582
|
-
* @param - object - to trigger the action for a
|
|
1583
|
-
*
|
|
1668
|
+
* @param - object - to trigger the action for a
|
|
1669
|
+
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
1584
1670
|
* @example
|
|
1585
1671
|
* ```js
|
|
1586
1672
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
1673
|
+
* ```
|
|
1674
|
+
* ```js
|
|
1587
1675
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1676
|
+
* ```
|
|
1677
|
+
* ```js
|
|
1588
1678
|
* vizEmbed.trigger((HostEvent.CopyLink)
|
|
1589
1679
|
* ```
|
|
1590
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1680
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1591
1681
|
*/
|
|
1592
1682
|
CopyLink = "embedDocument",
|
|
1593
1683
|
/**
|
|
1594
|
-
* Triggers the Present action on a Liveboard or visualization
|
|
1684
|
+
* Triggers the **Present** action on a Liveboard or visualization
|
|
1595
1685
|
*
|
|
1596
|
-
* @param - object - to trigger the action for a
|
|
1597
|
-
* in Liveboard embed, pass in vizId as a key
|
|
1686
|
+
* @param - object - to trigger the action for a specific visualization
|
|
1687
|
+
* in Liveboard embed, pass in `vizId` as a key
|
|
1598
1688
|
* @example
|
|
1599
1689
|
* ```js
|
|
1600
1690
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
1691
|
+
* ```
|
|
1692
|
+
* ```js
|
|
1601
1693
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1694
|
+
* ```
|
|
1695
|
+
* ```js
|
|
1602
1696
|
* vizEmbed.trigger((HostEvent.Present)
|
|
1603
1697
|
* ```
|
|
1604
|
-
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1
|
|
1698
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1605
1699
|
*/
|
|
1606
1700
|
Present = "present",
|
|
1607
1701
|
/**
|
|
1608
|
-
*
|
|
1702
|
+
* Gets TML for the current search.
|
|
1609
1703
|
*
|
|
1610
1704
|
* @example
|
|
1611
1705
|
* ```js
|
|
@@ -1615,78 +1709,90 @@ export declare enum HostEvent {
|
|
|
1615
1709
|
* );
|
|
1616
1710
|
* })
|
|
1617
1711
|
* ```
|
|
1618
|
-
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1
|
|
1712
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
1619
1713
|
* @important
|
|
1620
1714
|
*/
|
|
1621
1715
|
GetTML = "getTML",
|
|
1622
1716
|
/**
|
|
1623
|
-
* Triggers the
|
|
1717
|
+
* Triggers the **Show underlying data** action on visualization or search
|
|
1624
1718
|
*
|
|
1625
1719
|
* @param - an object with vizId as a key
|
|
1626
1720
|
* @example
|
|
1627
1721
|
* ```js
|
|
1628
1722
|
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
1629
1723
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1630
|
-
*
|
|
1724
|
+
* ```
|
|
1725
|
+
* ```js
|
|
1631
1726
|
* vizEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
1632
|
-
*
|
|
1727
|
+
* ```
|
|
1728
|
+
* ```js
|
|
1633
1729
|
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
1634
1730
|
* ```
|
|
1635
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1731
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1636
1732
|
*/
|
|
1637
1733
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1638
1734
|
/**
|
|
1639
|
-
* Triggers the Delete action on visualization or search
|
|
1735
|
+
* Triggers the **Delete** action on visualization or search
|
|
1640
1736
|
*
|
|
1641
|
-
* @param -
|
|
1642
|
-
*
|
|
1737
|
+
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
1738
|
+
* Can be left empty if embedding Search or visualization.
|
|
1643
1739
|
* @example
|
|
1644
1740
|
* ```js
|
|
1645
1741
|
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
1646
1742
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1647
|
-
*
|
|
1743
|
+
* ```
|
|
1744
|
+
* ```js
|
|
1648
1745
|
* vizEmbed.trigger(HostEvent.Delete)
|
|
1649
|
-
*
|
|
1746
|
+
* ```
|
|
1747
|
+
* ```js
|
|
1650
1748
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
1651
1749
|
* ```
|
|
1652
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1750
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1653
1751
|
*/
|
|
1654
1752
|
Delete = "onDeleteAnswer",
|
|
1655
1753
|
/**
|
|
1656
|
-
* Triggers the
|
|
1754
|
+
* Triggers the **SpotIQ analyze** action on visualization
|
|
1755
|
+
* or search.
|
|
1657
1756
|
*
|
|
1658
|
-
* @param -
|
|
1659
|
-
*
|
|
1757
|
+
* @param - Liveboard embed takes `vizId` as a
|
|
1758
|
+
* key. Can be left undefined when embedding Search or
|
|
1759
|
+
* visualization.
|
|
1660
1760
|
* @example
|
|
1661
1761
|
* ```js
|
|
1662
1762
|
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
1663
1763
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1664
|
-
*
|
|
1764
|
+
* ```
|
|
1765
|
+
* ```js
|
|
1665
1766
|
* vizEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
1666
|
-
*
|
|
1767
|
+
* ```
|
|
1768
|
+
* ```js
|
|
1667
1769
|
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
1668
1770
|
* ```
|
|
1669
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1771
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1670
1772
|
*/
|
|
1671
1773
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1672
1774
|
/**
|
|
1673
|
-
* Triggers the Download action on
|
|
1775
|
+
* Triggers the **Download** action on charts in
|
|
1776
|
+
* the embedded view.
|
|
1674
1777
|
*
|
|
1675
1778
|
* @example
|
|
1676
1779
|
* ```js
|
|
1677
1780
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
1678
1781
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1679
|
-
*
|
|
1782
|
+
* ```
|
|
1783
|
+
* ```js
|
|
1680
1784
|
* vizEmbed.trigger(HostEvent.Download)
|
|
1681
|
-
*
|
|
1785
|
+
* ```
|
|
1786
|
+
* ```js
|
|
1682
1787
|
* searchEmbed.trigger(HostEvent.Download)
|
|
1683
1788
|
* ```
|
|
1684
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1
|
|
1685
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1789
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw ,Use {@link DownloadAsPng}
|
|
1790
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1686
1791
|
*/
|
|
1687
1792
|
Download = "downloadAsPng",
|
|
1688
1793
|
/**
|
|
1689
|
-
* Triggers the Download action on
|
|
1794
|
+
* Triggers the **Download** > **PNG** action on
|
|
1795
|
+
* charts in the embedded view.
|
|
1690
1796
|
*
|
|
1691
1797
|
* @example
|
|
1692
1798
|
* ```js
|
|
@@ -1697,115 +1803,197 @@ export declare enum HostEvent {
|
|
|
1697
1803
|
*
|
|
1698
1804
|
* searchEmbed.trigger(HostEvent.DownloadAsPng)
|
|
1699
1805
|
* ```
|
|
1700
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1
|
|
1806
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
|
|
1701
1807
|
*/
|
|
1702
1808
|
DownloadAsPng = "downloadAsPng",
|
|
1703
1809
|
/**
|
|
1704
|
-
* Triggers the
|
|
1810
|
+
* Triggers the **Download** > **CSV** action on tables in
|
|
1811
|
+
* the embedded view.
|
|
1705
1812
|
*
|
|
1706
1813
|
* @example
|
|
1707
1814
|
* ```js
|
|
1708
1815
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
1709
1816
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1710
|
-
*
|
|
1817
|
+
* ```
|
|
1818
|
+
* ```js
|
|
1711
1819
|
* vizEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
1712
|
-
*
|
|
1820
|
+
* ```
|
|
1821
|
+
* ```js
|
|
1713
1822
|
* searchEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
1714
1823
|
* ```
|
|
1715
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1824
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1716
1825
|
*/
|
|
1717
1826
|
DownloadAsCsv = "downloadAsCSV",
|
|
1718
1827
|
/**
|
|
1719
|
-
* Triggers the
|
|
1828
|
+
* Triggers the **Download** > **XLSX** action on tables
|
|
1829
|
+
* in the embedded view.
|
|
1720
1830
|
*
|
|
1721
1831
|
* @example
|
|
1722
1832
|
* ```js
|
|
1723
1833
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
1724
1834
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1725
|
-
*
|
|
1835
|
+
* ```
|
|
1836
|
+
* ```js
|
|
1726
1837
|
* vizEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
1727
|
-
*
|
|
1838
|
+
* ```
|
|
1839
|
+
* ```js
|
|
1728
1840
|
* searchEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
1729
1841
|
* ```
|
|
1730
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1842
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1731
1843
|
*/
|
|
1732
1844
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
1733
1845
|
/**
|
|
1734
|
-
* Triggers the Share action on
|
|
1846
|
+
* Triggers the **Share** action on an embedded
|
|
1847
|
+
* Liveboard or Answer.
|
|
1735
1848
|
*
|
|
1736
1849
|
* @example
|
|
1737
1850
|
* ```js
|
|
1738
1851
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
1739
|
-
*
|
|
1852
|
+
* ```
|
|
1853
|
+
* ```js
|
|
1740
1854
|
* searchEmbed.trigger(HostEvent.Share)
|
|
1741
1855
|
* ```
|
|
1742
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1856
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1743
1857
|
*/
|
|
1744
1858
|
Share = "share",
|
|
1745
1859
|
/**
|
|
1746
|
-
*
|
|
1860
|
+
* Triggers the **Save** action on a Liveboard or Answer.
|
|
1861
|
+
* Saves the changes.
|
|
1747
1862
|
*
|
|
1748
1863
|
* @example
|
|
1749
1864
|
* ```js
|
|
1750
1865
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
1751
|
-
*
|
|
1866
|
+
* ```
|
|
1867
|
+
* ```js
|
|
1752
1868
|
* searchEmbed.trigger(HostEvent.Save)
|
|
1753
1869
|
* ```
|
|
1754
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1870
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1755
1871
|
*/
|
|
1756
1872
|
Save = "save",
|
|
1757
1873
|
/**
|
|
1758
|
-
* Triggers the
|
|
1874
|
+
* Triggers the **Sync to Sheets** action on an embedded visualization or Answer
|
|
1875
|
+
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
1759
1876
|
*
|
|
1760
|
-
* @param - an object with vizId as a key
|
|
1877
|
+
* @param - an object with `vizId` as a key
|
|
1761
1878
|
* @example
|
|
1762
1879
|
* ```js
|
|
1763
1880
|
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
1764
1881
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1765
|
-
*
|
|
1882
|
+
* ```
|
|
1883
|
+
* ```js
|
|
1766
1884
|
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
1767
1885
|
* ```
|
|
1768
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1886
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1769
1887
|
*/
|
|
1770
1888
|
SyncToSheets = "sync-to-sheets",
|
|
1771
1889
|
/**
|
|
1772
|
-
* Triggers the
|
|
1890
|
+
* Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
1891
|
+
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
1892
|
+
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
1773
1893
|
*
|
|
1774
1894
|
* @param - an object with vizId as a key
|
|
1775
1895
|
* @example
|
|
1776
1896
|
* ```js
|
|
1777
1897
|
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
1778
1898
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1779
|
-
*
|
|
1899
|
+
* ```
|
|
1900
|
+
* ```js
|
|
1780
1901
|
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
1781
1902
|
* ```
|
|
1782
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1903
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1783
1904
|
*/
|
|
1784
1905
|
SyncToOtherApps = "sync-to-other-apps",
|
|
1785
1906
|
/**
|
|
1786
|
-
* Triggers the
|
|
1907
|
+
* Triggers the **Manage pipelines** action on an embedded
|
|
1908
|
+
* visualization or Answer.
|
|
1909
|
+
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
1787
1910
|
*
|
|
1788
|
-
* @param - an object with vizId as a key
|
|
1911
|
+
* @param - an object with `vizId` as a key
|
|
1789
1912
|
* @example
|
|
1790
1913
|
* ```js
|
|
1791
1914
|
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
1792
1915
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1793
|
-
*
|
|
1916
|
+
* ```
|
|
1917
|
+
* ```js
|
|
1794
1918
|
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
1795
1919
|
* ```
|
|
1796
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1
|
|
1920
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1797
1921
|
*/
|
|
1798
1922
|
ManagePipelines = "manage-pipeline",
|
|
1799
1923
|
/**
|
|
1800
|
-
* Triggers the Reset search
|
|
1924
|
+
* Triggers the Reset search on the Search page
|
|
1801
1925
|
*
|
|
1802
1926
|
* @example
|
|
1803
1927
|
* ```js
|
|
1804
1928
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
1805
1929
|
* ```
|
|
1806
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1
|
|
1930
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
1807
1931
|
*/
|
|
1808
|
-
ResetSearch = "resetSearch"
|
|
1932
|
+
ResetSearch = "resetSearch",
|
|
1933
|
+
/**
|
|
1934
|
+
* Gets the currents visible and runtime filters applied on a Liveboard
|
|
1935
|
+
*
|
|
1936
|
+
* @example
|
|
1937
|
+
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
1938
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1939
|
+
*/
|
|
1940
|
+
GetFilters = "getFilters",
|
|
1941
|
+
/**
|
|
1942
|
+
* Updates the visible filters on the Liveboard.
|
|
1943
|
+
*
|
|
1944
|
+
* @param - filter: filter object containing column name and filter operation and values
|
|
1945
|
+
* @example
|
|
1946
|
+
*
|
|
1947
|
+
* ```js
|
|
1948
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
1949
|
+
* filter: { column: 'column name', oper: 'in', values: [1,2,3], is_mandatory: false }
|
|
1950
|
+
* })
|
|
1951
|
+
* ```
|
|
1952
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1953
|
+
*/
|
|
1954
|
+
UpdateFilters = "updateFilters",
|
|
1955
|
+
/**
|
|
1956
|
+
* Get Tab for the current Liveboard.
|
|
1957
|
+
*
|
|
1958
|
+
* @example
|
|
1959
|
+
* ```js
|
|
1960
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
1961
|
+
* console.log(
|
|
1962
|
+
* tabDetails // TabDetails of current LB
|
|
1963
|
+
* );
|
|
1964
|
+
* })
|
|
1965
|
+
* ```
|
|
1966
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
1967
|
+
*/
|
|
1968
|
+
GetTabs = "getTabs",
|
|
1969
|
+
/**
|
|
1970
|
+
* Set the visible Tabs on a Liveboard.
|
|
1971
|
+
*
|
|
1972
|
+
* @param - an array of ids of Tabs to show, the ids not passed
|
|
1973
|
+
* will be hidden.
|
|
1974
|
+
* @example
|
|
1975
|
+
* ```js
|
|
1976
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
|
|
1977
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1978
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
1979
|
+
* ```
|
|
1980
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1981
|
+
*/
|
|
1982
|
+
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
1983
|
+
/**
|
|
1984
|
+
* Set the hidden tabs on a Liveboard.
|
|
1985
|
+
*
|
|
1986
|
+
* @param - an array of ids of Tabs to hide, the ids not passed
|
|
1987
|
+
* will be shown.
|
|
1988
|
+
* @example
|
|
1989
|
+
* ```js
|
|
1990
|
+
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
1991
|
+
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
1992
|
+
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
1993
|
+
* ```
|
|
1994
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1995
|
+
*/
|
|
1996
|
+
SetHiddenTabs = "SetPinboardHiddenTabs"
|
|
1809
1997
|
}
|
|
1810
1998
|
/**
|
|
1811
1999
|
* The different visual modes that the data sources panel within
|
|
@@ -1882,26 +2070,51 @@ export declare enum Param {
|
|
|
1882
2070
|
HideEurekaSuggestions = "hideEurekaSuggestions",
|
|
1883
2071
|
HideLiveboardHeader = "hideLiveboardHeader",
|
|
1884
2072
|
ShowLiveboardDescription = "showLiveboardDescription",
|
|
1885
|
-
ShowLiveboardTitle = "showLiveboardTitle"
|
|
2073
|
+
ShowLiveboardTitle = "showLiveboardTitle",
|
|
2074
|
+
HiddenTabs = "hideTabs",
|
|
2075
|
+
VisibleTabs = "visibleTabs",
|
|
2076
|
+
HideTabPanel = "hideTabPanel",
|
|
2077
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
2078
|
+
WorksheetId = "worksheetId",
|
|
2079
|
+
Query = "query,"
|
|
1886
2080
|
}
|
|
1887
2081
|
/**
|
|
1888
|
-
*
|
|
1889
|
-
*
|
|
1890
|
-
*
|
|
1891
|
-
*
|
|
1892
|
-
*
|
|
2082
|
+
* ThoughtSpot application pages include actions and menu commands
|
|
2083
|
+
* for various user-initiated operations. These actions are represented
|
|
2084
|
+
* as enumeration members in the SDK. To show, hide, or disable
|
|
2085
|
+
* specific actions in the embedded view, define the Action
|
|
2086
|
+
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
2087
|
+
* or `hiddenActions` array.
|
|
1893
2088
|
*
|
|
1894
2089
|
* @example
|
|
1895
2090
|
* ```js
|
|
1896
2091
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1897
2092
|
* ... // other options
|
|
1898
|
-
* visibleActions: [Action.Save, Action.Explore],
|
|
1899
|
-
*
|
|
1900
|
-
* hiddenActions: [
|
|
2093
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
|
|
2094
|
+
* disabledActions: [Action.Download],
|
|
2095
|
+
* //hiddenActions: [], // Set either this or visibleActions
|
|
2096
|
+
* })
|
|
2097
|
+
* ```
|
|
2098
|
+
* @example
|
|
2099
|
+
* ```js
|
|
2100
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
2101
|
+
* ... // other options
|
|
2102
|
+
* //visibleActions: [],
|
|
2103
|
+
* disabledActions: [Action.Download],
|
|
2104
|
+
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
1901
2105
|
* })
|
|
1902
2106
|
* ```
|
|
1903
2107
|
*/
|
|
1904
2108
|
export declare enum Action {
|
|
2109
|
+
/**
|
|
2110
|
+
* The **Save** action on an Answer or Liveboard.
|
|
2111
|
+
* Allows users to save the changes.
|
|
2112
|
+
*
|
|
2113
|
+
* @example
|
|
2114
|
+
* ```js
|
|
2115
|
+
* disabledActions: [Action.SaveAsView]
|
|
2116
|
+
* ```
|
|
2117
|
+
*/
|
|
1905
2118
|
Save = "save",
|
|
1906
2119
|
/**
|
|
1907
2120
|
* @hidden
|
|
@@ -1911,27 +2124,147 @@ export declare enum Action {
|
|
|
1911
2124
|
* @hidden
|
|
1912
2125
|
*/
|
|
1913
2126
|
SaveUntitled = "saveUntitled",
|
|
2127
|
+
/**
|
|
2128
|
+
* The **Save as View** action on the Answer
|
|
2129
|
+
* page. Saves an Answer as a View object.
|
|
2130
|
+
*
|
|
2131
|
+
* @example
|
|
2132
|
+
* ```js
|
|
2133
|
+
* disabledActions: [Action.SaveAsView]
|
|
2134
|
+
* ```
|
|
2135
|
+
*/
|
|
1914
2136
|
SaveAsView = "saveAsView",
|
|
2137
|
+
/**
|
|
2138
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
2139
|
+
* page.
|
|
2140
|
+
* Creates a copy of the Liveboard, visualization,
|
|
2141
|
+
* or Answer.
|
|
2142
|
+
*
|
|
2143
|
+
* @example
|
|
2144
|
+
* ```js
|
|
2145
|
+
* disabledActions: [Action.MakeACopy]
|
|
2146
|
+
* ```
|
|
2147
|
+
*/
|
|
1915
2148
|
MakeACopy = "makeACopy",
|
|
2149
|
+
/**
|
|
2150
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
2151
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
2152
|
+
*
|
|
2153
|
+
* @example
|
|
2154
|
+
* ```js
|
|
2155
|
+
* disabledActions: [Action.EditACopy]
|
|
2156
|
+
* ```
|
|
2157
|
+
*/
|
|
1916
2158
|
EditACopy = "editACopy",
|
|
2159
|
+
/**
|
|
2160
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
2161
|
+
* Copies the visualization URL
|
|
2162
|
+
*
|
|
2163
|
+
* @example
|
|
2164
|
+
* ```js
|
|
2165
|
+
* disabledActions: [Action.CopyLink]
|
|
2166
|
+
* ```
|
|
2167
|
+
*/
|
|
1917
2168
|
CopyLink = "embedDocument",
|
|
1918
2169
|
/**
|
|
1919
2170
|
* @hidden
|
|
1920
2171
|
*/
|
|
1921
2172
|
ResetLayout = "resetLayout",
|
|
2173
|
+
/**
|
|
2174
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2175
|
+
* Allows scheduling a Liveboard notification.
|
|
2176
|
+
*
|
|
2177
|
+
* @example
|
|
2178
|
+
* ```js
|
|
2179
|
+
* disabledActions: [Action.Schedule]
|
|
2180
|
+
* ```
|
|
2181
|
+
*/
|
|
1922
2182
|
Schedule = "subscription",
|
|
2183
|
+
/**
|
|
2184
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
2185
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
2186
|
+
*
|
|
2187
|
+
* @example
|
|
2188
|
+
* ```js
|
|
2189
|
+
* disabledActions: [Action.SchedulesList]
|
|
2190
|
+
* ```
|
|
2191
|
+
*/
|
|
1923
2192
|
SchedulesList = "schedule-list",
|
|
2193
|
+
/**
|
|
2194
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
2195
|
+
* Allows users to share an object with other users and groups.
|
|
2196
|
+
*
|
|
2197
|
+
* @example
|
|
2198
|
+
* ```js
|
|
2199
|
+
* disabledActions: [Action.Share]
|
|
2200
|
+
* ```
|
|
2201
|
+
*/
|
|
1924
2202
|
Share = "share",
|
|
2203
|
+
/**
|
|
2204
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
2205
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
2206
|
+
*
|
|
2207
|
+
* @example
|
|
2208
|
+
* ```js
|
|
2209
|
+
* disabledActions: [Action.AddFilter]
|
|
2210
|
+
* ```
|
|
2211
|
+
*/
|
|
1925
2212
|
AddFilter = "addFilter",
|
|
2213
|
+
/**
|
|
2214
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
2215
|
+
* Allows configuring filter options when adding filters to a
|
|
2216
|
+
* Liveboard or Answer.
|
|
2217
|
+
*
|
|
2218
|
+
* @example
|
|
2219
|
+
* ```js
|
|
2220
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
2221
|
+
* ```
|
|
2222
|
+
*/
|
|
1926
2223
|
ConfigureFilter = "configureFilter",
|
|
1927
2224
|
CollapseDataSources = "collapseDataSources",
|
|
2225
|
+
/**
|
|
2226
|
+
* The **Choose sources** button on Search page.
|
|
2227
|
+
* Allows selecting data sources for search queries.
|
|
2228
|
+
*
|
|
2229
|
+
* @example
|
|
2230
|
+
* ```js
|
|
2231
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
2232
|
+
* ```
|
|
2233
|
+
*/
|
|
1928
2234
|
ChooseDataSources = "chooseDataSources",
|
|
2235
|
+
/**
|
|
2236
|
+
* The **Create formula** action on a Search or Answer page.
|
|
2237
|
+
* Allows adding formulas to an Answer.
|
|
2238
|
+
*
|
|
2239
|
+
* @example
|
|
2240
|
+
* ```js
|
|
2241
|
+
* disabledActions: [Action.AddFormula]
|
|
2242
|
+
* ```
|
|
2243
|
+
*/
|
|
1929
2244
|
AddFormula = "addFormula",
|
|
2245
|
+
/**
|
|
2246
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
2247
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
2248
|
+
*
|
|
2249
|
+
* @example
|
|
2250
|
+
* ```js
|
|
2251
|
+
* disabledActions: [Action.AddParameter]
|
|
2252
|
+
* ```
|
|
2253
|
+
*/
|
|
1930
2254
|
AddParameter = "addParameter",
|
|
1931
2255
|
/**
|
|
1932
2256
|
* @hidden
|
|
1933
2257
|
*/
|
|
1934
2258
|
SearchOnTop = "searchOnTop",
|
|
2259
|
+
/**
|
|
2260
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
2261
|
+
* Answer page.
|
|
2262
|
+
*
|
|
2263
|
+
* @example
|
|
2264
|
+
* ```js
|
|
2265
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
2266
|
+
* ```
|
|
2267
|
+
*/
|
|
1935
2268
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1936
2269
|
/**
|
|
1937
2270
|
* @hidden
|
|
@@ -1946,24 +2279,165 @@ export declare enum Action {
|
|
|
1946
2279
|
* @hidden
|
|
1947
2280
|
*/
|
|
1948
2281
|
ReplaySearch = "replaySearch",
|
|
2282
|
+
/**
|
|
2283
|
+
* The **Show underlying data** menu action on a visualization or
|
|
2284
|
+
* Answer page.
|
|
2285
|
+
*
|
|
2286
|
+
* @example
|
|
2287
|
+
* ```js
|
|
2288
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
2289
|
+
* ```
|
|
2290
|
+
*/
|
|
1949
2291
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2292
|
+
/**
|
|
2293
|
+
* The **Download** menu action on Liveboard visualizations
|
|
2294
|
+
* and Answers.
|
|
2295
|
+
* Allows downloading a visualization or Answer.
|
|
2296
|
+
*
|
|
2297
|
+
* @example
|
|
2298
|
+
* ```js
|
|
2299
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2300
|
+
* ```
|
|
2301
|
+
*/
|
|
1950
2302
|
Download = "download",
|
|
2303
|
+
/**
|
|
2304
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
2305
|
+
* or Answer page.
|
|
2306
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
2307
|
+
*
|
|
2308
|
+
* @example
|
|
2309
|
+
* ```js
|
|
2310
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
2311
|
+
* ```
|
|
2312
|
+
*/
|
|
1951
2313
|
DownloadAsPng = "downloadAsPng",
|
|
2314
|
+
/**
|
|
2315
|
+
* The **Download** > **PDF** menu action on a Liveboard.
|
|
2316
|
+
* Downloads a visualization or Answer as a PDF file.
|
|
2317
|
+
*
|
|
2318
|
+
* @example
|
|
2319
|
+
* ```js
|
|
2320
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
2321
|
+
* ```
|
|
2322
|
+
*/
|
|
1952
2323
|
DownloadAsPdf = "downloadAsPdf",
|
|
2324
|
+
/**
|
|
2325
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
2326
|
+
* or Answer page.
|
|
2327
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2328
|
+
*
|
|
2329
|
+
* @example
|
|
2330
|
+
* ```js
|
|
2331
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
2332
|
+
* ```
|
|
2333
|
+
*/
|
|
1953
2334
|
DownloadAsCsv = "downloadAsCSV",
|
|
2335
|
+
/**
|
|
2336
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
2337
|
+
* or Answer page.
|
|
2338
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
2339
|
+
*
|
|
2340
|
+
* @example
|
|
2341
|
+
* ```js
|
|
2342
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
2343
|
+
* ```
|
|
2344
|
+
*/
|
|
1954
2345
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
1955
2346
|
/**
|
|
1956
2347
|
* @hidden
|
|
1957
2348
|
*/
|
|
1958
2349
|
DownloadTrace = "downloadTrace",
|
|
2350
|
+
/**
|
|
2351
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
2352
|
+
* Worksheets and Data Connections page.
|
|
2353
|
+
* Exports an object as a TML file.
|
|
2354
|
+
*
|
|
2355
|
+
* @example
|
|
2356
|
+
* ```js
|
|
2357
|
+
* disabledActions: [Action.ExportTML]
|
|
2358
|
+
* ```
|
|
2359
|
+
*/
|
|
1959
2360
|
ExportTML = "exportTSL",
|
|
2361
|
+
/**
|
|
2362
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
2363
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
2364
|
+
*
|
|
2365
|
+
* @example
|
|
2366
|
+
* ```js
|
|
2367
|
+
* disabledActions: [Action.ImportTML]
|
|
2368
|
+
* ```
|
|
2369
|
+
*/
|
|
1960
2370
|
ImportTML = "importTSL",
|
|
2371
|
+
/**
|
|
2372
|
+
* The **Update TML** menu action for Liveboards and Answers.
|
|
2373
|
+
* Update TML representation of ThoughtSpot objects.
|
|
2374
|
+
*
|
|
2375
|
+
* @example
|
|
2376
|
+
* ```js
|
|
2377
|
+
* disabledActions: [Action.UpdateTML]
|
|
2378
|
+
* ```
|
|
2379
|
+
*/
|
|
1961
2380
|
UpdateTML = "updateTSL",
|
|
2381
|
+
/**
|
|
2382
|
+
* The **Edit TML** menu action for Liveboards and Answers.
|
|
2383
|
+
* Opens the TML editor.
|
|
2384
|
+
*
|
|
2385
|
+
* @example
|
|
2386
|
+
* ```js
|
|
2387
|
+
* disabledActions: [Action.EditTML]
|
|
2388
|
+
* ```
|
|
2389
|
+
*/
|
|
1962
2390
|
EditTML = "editTSL",
|
|
2391
|
+
/**
|
|
2392
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
2393
|
+
* Allows presenting a Liveboard or visualization in
|
|
2394
|
+
* slideshow mode.
|
|
2395
|
+
*
|
|
2396
|
+
* @example
|
|
2397
|
+
* ```js
|
|
2398
|
+
* disabledActions: [Action.Present]
|
|
2399
|
+
* ```
|
|
2400
|
+
*/
|
|
1963
2401
|
Present = "present",
|
|
2402
|
+
/**
|
|
2403
|
+
* The tile resize options in the visualization menu.
|
|
2404
|
+
* Allows switching between different preset layouts.
|
|
2405
|
+
*
|
|
2406
|
+
* @example
|
|
2407
|
+
* ```js
|
|
2408
|
+
* disabledActions: [Action.ToggleSize]
|
|
2409
|
+
* ```
|
|
2410
|
+
*/
|
|
1964
2411
|
ToggleSize = "toggleSize",
|
|
2412
|
+
/**
|
|
2413
|
+
* The *Edit* action on the Liveboard page and in the
|
|
2414
|
+
* visualization menu.
|
|
2415
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
2416
|
+
*
|
|
2417
|
+
* @example
|
|
2418
|
+
* ```js
|
|
2419
|
+
* disabledActions: [Action.Edit]
|
|
2420
|
+
* ```
|
|
2421
|
+
*/
|
|
1965
2422
|
Edit = "edit",
|
|
2423
|
+
/**
|
|
2424
|
+
* The text edit option for Liveboard and visualization titles.
|
|
2425
|
+
*
|
|
2426
|
+
* @example
|
|
2427
|
+
* ```js
|
|
2428
|
+
* disabledActions: [Action.EditTitle]
|
|
2429
|
+
* ```
|
|
2430
|
+
*/
|
|
1966
2431
|
EditTitle = "editTitle",
|
|
2432
|
+
/**
|
|
2433
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
2434
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
2435
|
+
*
|
|
2436
|
+
* @example
|
|
2437
|
+
* ```js
|
|
2438
|
+
* disabledActions: [Action.Remove]
|
|
2439
|
+
* ```
|
|
2440
|
+
*/
|
|
1967
2441
|
Remove = "delete",
|
|
1968
2442
|
/**
|
|
1969
2443
|
* @hidden
|
|
@@ -1985,6 +2459,17 @@ export declare enum Action {
|
|
|
1985
2459
|
* @hidden
|
|
1986
2460
|
*/
|
|
1987
2461
|
PinboardInfo = "pinboardInfo",
|
|
2462
|
+
/**
|
|
2463
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
2464
|
+
* Displays details such as the name, description, and
|
|
2465
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
2466
|
+
* and update.
|
|
2467
|
+
*
|
|
2468
|
+
* @example
|
|
2469
|
+
* ```js
|
|
2470
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
2471
|
+
* ```
|
|
2472
|
+
*/
|
|
1988
2473
|
LiveboardInfo = "pinboardInfo",
|
|
1989
2474
|
/**
|
|
1990
2475
|
* @hidden
|
|
@@ -1995,20 +2480,67 @@ export declare enum Action {
|
|
|
1995
2480
|
*/
|
|
1996
2481
|
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
1997
2482
|
/**
|
|
1998
|
-
* Pin action
|
|
2483
|
+
* The **Pin** menu action on an Answer or
|
|
2484
|
+
* Search results page.
|
|
2485
|
+
*
|
|
2486
|
+
* @example
|
|
2487
|
+
* ```js
|
|
2488
|
+
* disabledActions: [Action.Pin]
|
|
2489
|
+
* ```
|
|
1999
2490
|
*/
|
|
2000
2491
|
Pin = "pin",
|
|
2001
2492
|
/**
|
|
2002
2493
|
* @hidden
|
|
2003
2494
|
*/
|
|
2004
2495
|
AnalysisInfo = "analysisInfo",
|
|
2496
|
+
/**
|
|
2497
|
+
* The **Schedule** menu action on a Liveboard.
|
|
2498
|
+
*
|
|
2499
|
+
* @example
|
|
2500
|
+
* ```js
|
|
2501
|
+
* disabledActions: [Action.Subscription]
|
|
2502
|
+
* ```
|
|
2503
|
+
*/
|
|
2005
2504
|
Subscription = "subscription",
|
|
2006
2505
|
/**
|
|
2007
|
-
* Explore action
|
|
2506
|
+
* The **Explore** action on Liveboard visualizations
|
|
2507
|
+
*
|
|
2508
|
+
* @example
|
|
2509
|
+
* ```js
|
|
2510
|
+
* disabledActions: [Action.Explore]
|
|
2511
|
+
* ```
|
|
2008
2512
|
*/
|
|
2009
2513
|
Explore = "explore",
|
|
2514
|
+
/**
|
|
2515
|
+
* The action to include data points on a drilled-down Answer
|
|
2516
|
+
* or visualization
|
|
2517
|
+
*
|
|
2518
|
+
* @example
|
|
2519
|
+
* ```js
|
|
2520
|
+
* disabledActions: [Action.DrillInclude]
|
|
2521
|
+
* ```
|
|
2522
|
+
*/
|
|
2010
2523
|
DrillInclude = "context-menu-item-include",
|
|
2524
|
+
/**
|
|
2525
|
+
* The action to exclude data points on a drilled-down Answer
|
|
2526
|
+
* or visualization
|
|
2527
|
+
*
|
|
2528
|
+
* @example
|
|
2529
|
+
* ```js
|
|
2530
|
+
* disabledActions: [Action.DrillInclude]
|
|
2531
|
+
* ```
|
|
2532
|
+
*/
|
|
2011
2533
|
DrillExclude = "context-menu-item-exclude",
|
|
2534
|
+
/**
|
|
2535
|
+
* The **Copy to clipboard** menu action on tables in an Answer
|
|
2536
|
+
* or Liveboard.
|
|
2537
|
+
* Copies the selected data point.
|
|
2538
|
+
*
|
|
2539
|
+
* @example
|
|
2540
|
+
* ```js
|
|
2541
|
+
* disabledActions: [Action.CopyToClipboard]
|
|
2542
|
+
* ```
|
|
2543
|
+
*/
|
|
2012
2544
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2013
2545
|
CopyAndEdit = "context-menu-item-copy-and-edit",
|
|
2014
2546
|
/**
|
|
@@ -2017,89 +2549,291 @@ export declare enum Action {
|
|
|
2017
2549
|
DrillEdit = "context-menu-item-edit",
|
|
2018
2550
|
EditMeasure = "context-menu-item-edit-measure",
|
|
2019
2551
|
Separator = "context-menu-item-separator",
|
|
2552
|
+
/**
|
|
2553
|
+
* The **Drill down** menu action on Answers and Liveboard
|
|
2554
|
+
* visualizations.
|
|
2555
|
+
* Allows drilling down to a specific data point on a chart or table.
|
|
2556
|
+
*
|
|
2557
|
+
* @example
|
|
2558
|
+
* ```js
|
|
2559
|
+
* disabledActions: [Action.DrillDown]
|
|
2560
|
+
* ```
|
|
2561
|
+
*/
|
|
2020
2562
|
DrillDown = "DRILL",
|
|
2563
|
+
/**
|
|
2564
|
+
* The request access action on Liveboards.
|
|
2565
|
+
* Allows users with view permissions to request edit access to a Liveboard.
|
|
2566
|
+
*
|
|
2567
|
+
* @example
|
|
2568
|
+
* ```js
|
|
2569
|
+
* disabledActions: [Action.RequestAccess]
|
|
2570
|
+
* ```
|
|
2571
|
+
*/
|
|
2021
2572
|
RequestAccess = "requestAccess",
|
|
2022
|
-
QueryDetailsButtons = "queryDetailsButtons",
|
|
2023
2573
|
/**
|
|
2024
|
-
*
|
|
2574
|
+
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
2575
|
+
* of the Answer page
|
|
2576
|
+
*
|
|
2577
|
+
* @example
|
|
2578
|
+
* ```js
|
|
2579
|
+
* disabledActions: [Action.QueryDetailsButtons]
|
|
2580
|
+
* ```
|
|
2581
|
+
*/
|
|
2582
|
+
QueryDetailsButtons = "QueryDetailsButtons",
|
|
2583
|
+
/**
|
|
2584
|
+
* The **Delete** action for Answers.
|
|
2585
|
+
*
|
|
2586
|
+
* @example
|
|
2587
|
+
* ```js
|
|
2588
|
+
* disabledActions: [Action.AnswerDelete]
|
|
2589
|
+
* ```
|
|
2590
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2025
2591
|
*/
|
|
2026
2592
|
AnswerDelete = "onDeleteAnswer",
|
|
2027
2593
|
/**
|
|
2028
|
-
*
|
|
2594
|
+
* The Chart switcher icon on Answer and visualization pages.
|
|
2595
|
+
*
|
|
2596
|
+
* @example
|
|
2597
|
+
* ```js
|
|
2598
|
+
* disabledActions: [Action.AnswerChartSwitcher]
|
|
2599
|
+
* ```
|
|
2600
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2029
2601
|
*/
|
|
2030
2602
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2031
2603
|
/**
|
|
2032
|
-
*
|
|
2604
|
+
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
2605
|
+
*
|
|
2606
|
+
* @example
|
|
2607
|
+
* ```js
|
|
2608
|
+
* disabledActions: [Action.AddToFavorites]
|
|
2609
|
+
* ```
|
|
2610
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2033
2611
|
*/
|
|
2034
2612
|
AddToFavorites = "addToFavorites",
|
|
2035
2613
|
/**
|
|
2036
|
-
*
|
|
2614
|
+
* The edit icon on Liveboards (Classic experience).
|
|
2615
|
+
*
|
|
2616
|
+
* @example
|
|
2617
|
+
* ```js
|
|
2618
|
+
* disabledActions: [Action.EditDetails]
|
|
2619
|
+
* ```
|
|
2620
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2037
2621
|
*/
|
|
2038
2622
|
EditDetails = "editDetails",
|
|
2039
2623
|
/**
|
|
2040
|
-
*
|
|
2624
|
+
* The Create alert action on KPI charts.
|
|
2625
|
+
*
|
|
2626
|
+
* @example
|
|
2627
|
+
* ```js
|
|
2628
|
+
* disabledActions: [Action.CreateMonitor ]
|
|
2629
|
+
* ```
|
|
2630
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2041
2631
|
*/
|
|
2042
2632
|
CreateMonitor = "createMonitor",
|
|
2043
2633
|
/**
|
|
2044
|
-
* @
|
|
2634
|
+
* @example
|
|
2635
|
+
* ```js
|
|
2636
|
+
* disabledActions: [Action.ReportError]
|
|
2637
|
+
* ```
|
|
2638
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2045
2639
|
*/
|
|
2046
2640
|
ReportError = "reportError",
|
|
2641
|
+
/**
|
|
2642
|
+
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
2643
|
+
* Allows sending data to a Google Sheet.
|
|
2644
|
+
*
|
|
2645
|
+
* @example
|
|
2646
|
+
* ```js
|
|
2647
|
+
* disabledActions: [Action.SyncToSheets]
|
|
2648
|
+
* ```
|
|
2649
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2650
|
+
*/
|
|
2047
2651
|
SyncToSheets = "sync-to-sheets",
|
|
2652
|
+
/**
|
|
2653
|
+
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
2654
|
+
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
2655
|
+
* Microsoft Teams, and so on.
|
|
2656
|
+
*
|
|
2657
|
+
* @example
|
|
2658
|
+
* ```js
|
|
2659
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
2660
|
+
* ```
|
|
2661
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2662
|
+
*/
|
|
2048
2663
|
SyncToOtherApps = "sync-to-other-apps",
|
|
2664
|
+
/**
|
|
2665
|
+
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
2666
|
+
* Allows users to manage data sync pipelines to third-party apps.
|
|
2667
|
+
*
|
|
2668
|
+
* @example
|
|
2669
|
+
* ```js
|
|
2670
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
2671
|
+
* ```
|
|
2672
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2673
|
+
*/
|
|
2049
2674
|
ManagePipelines = "manage-pipeline",
|
|
2050
2675
|
/**
|
|
2676
|
+
* The **Filter** action on Liveboard visualizations.
|
|
2677
|
+
* Allows users to apply cross-filters on a Liveboard.
|
|
2678
|
+
*
|
|
2679
|
+
* @example
|
|
2680
|
+
* ```js
|
|
2681
|
+
* disabledActions: [Action.CrossFilter]
|
|
2682
|
+
* ```
|
|
2051
2683
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2052
2684
|
*/
|
|
2053
2685
|
CrossFilter = "context-menu-item-cross-filter",
|
|
2054
2686
|
/**
|
|
2687
|
+
* The **Remove** action that appears when cross filters are applied
|
|
2688
|
+
* on a Liveboard.
|
|
2689
|
+
* Removes filters applied o a visualization.
|
|
2690
|
+
*
|
|
2691
|
+
* @example
|
|
2692
|
+
* ```js
|
|
2693
|
+
* disabledActions: [Action.RemoveCrossFilter]
|
|
2694
|
+
* ```
|
|
2055
2695
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2056
2696
|
*/
|
|
2057
2697
|
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
2058
2698
|
/**
|
|
2699
|
+
* The **Aggregate** option in the chart axis or the
|
|
2700
|
+
* table column customization menu.
|
|
2701
|
+
* Provides aggregation options to analyze the data on a chart or table.
|
|
2702
|
+
*
|
|
2703
|
+
* @example
|
|
2704
|
+
* ```js
|
|
2705
|
+
* disabledActions: [Action.AxisMenuAggregate]
|
|
2706
|
+
* ```
|
|
2059
2707
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2060
2708
|
*/
|
|
2061
2709
|
AxisMenuAggregate = "axisMenuAggregate",
|
|
2062
2710
|
/**
|
|
2711
|
+
* The **Time bucket** option in the chart axis or table column
|
|
2712
|
+
* customization menu.
|
|
2713
|
+
* Allows defining time metric for date comparison.
|
|
2714
|
+
*
|
|
2715
|
+
* @example
|
|
2716
|
+
* ```js
|
|
2717
|
+
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
2718
|
+
* ```
|
|
2063
2719
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2064
2720
|
*/
|
|
2065
2721
|
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
2066
2722
|
/**
|
|
2723
|
+
* The **Filter** action in the chart axis or table column
|
|
2724
|
+
* customization menu.
|
|
2725
|
+
*
|
|
2726
|
+
* @example
|
|
2727
|
+
* ```js
|
|
2728
|
+
* disabledActions: [Action.AxisMenuFilter]
|
|
2729
|
+
* ```
|
|
2067
2730
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2068
2731
|
*/
|
|
2069
2732
|
AxisMenuFilter = "axisMenuFilter",
|
|
2070
2733
|
/**
|
|
2734
|
+
* The **Conditional formatting** action on chart or table.
|
|
2735
|
+
* Allows adding rules for conditional formatting of data
|
|
2736
|
+
* points on a chart or table.
|
|
2737
|
+
*
|
|
2738
|
+
* @example
|
|
2739
|
+
* ```js
|
|
2740
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
2741
|
+
* ```
|
|
2071
2742
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2072
2743
|
*/
|
|
2073
2744
|
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
2074
2745
|
/**
|
|
2746
|
+
* The **Sort** menu action on a table or chart axis
|
|
2747
|
+
* Sorts data in ascending or descending order.
|
|
2748
|
+
* Allows adding, editing, or removing filters.
|
|
2749
|
+
*
|
|
2750
|
+
* @example
|
|
2751
|
+
* ```js
|
|
2752
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
2753
|
+
* ```
|
|
2075
2754
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2076
2755
|
*/
|
|
2077
2756
|
AxisMenuSort = "axisMenuSort",
|
|
2078
2757
|
/**
|
|
2758
|
+
* The **Group** option in the chart axis or table column
|
|
2759
|
+
* customization menu.
|
|
2760
|
+
* Allows grouping data points if the axes use the same
|
|
2761
|
+
* unit of measurement and a similar scale.
|
|
2762
|
+
*
|
|
2763
|
+
* @example
|
|
2764
|
+
* ```js
|
|
2765
|
+
* disabledActions: [Action.AxisMenuGroup]
|
|
2766
|
+
* ```
|
|
2079
2767
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2080
2768
|
*/
|
|
2081
2769
|
AxisMenuGroup = "axisMenuGroup",
|
|
2082
2770
|
/**
|
|
2771
|
+
* The **Position** option in the axis customization menu.
|
|
2772
|
+
* Allows changing the position of the axis to the
|
|
2773
|
+
* left or right side of the chart.
|
|
2774
|
+
*
|
|
2775
|
+
* @example
|
|
2776
|
+
* ```js
|
|
2777
|
+
* disabledActions: [Action.AxisMenuPosition]
|
|
2778
|
+
* ```
|
|
2083
2779
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2084
2780
|
*/
|
|
2085
2781
|
AxisMenuPosition = "axisMenuPosition",
|
|
2086
2782
|
/**
|
|
2783
|
+
* The **Rename** option in the chart axis or table column customization menu.
|
|
2784
|
+
* Renames the axis label on a chart or the column header on a table.
|
|
2785
|
+
*
|
|
2786
|
+
* @example
|
|
2787
|
+
* ```js
|
|
2788
|
+
* disabledActions: [Action.AxisMenuRename]
|
|
2789
|
+
* ```
|
|
2087
2790
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2088
2791
|
*/
|
|
2089
2792
|
AxisMenuRename = "axisMenuRename",
|
|
2090
2793
|
/**
|
|
2794
|
+
* The **Edit** action in the axis customization menu.
|
|
2795
|
+
* Allows editing the axis name, position, minimum and maximum values,
|
|
2796
|
+
* and format of a column.
|
|
2797
|
+
*
|
|
2798
|
+
* @example
|
|
2799
|
+
* ```js
|
|
2800
|
+
* disabledActions: [Action.AxisMenuEdit]
|
|
2801
|
+
* ```
|
|
2091
2802
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2092
2803
|
*/
|
|
2093
2804
|
AxisMenuEdit = "axisMenuEdit",
|
|
2094
2805
|
/**
|
|
2806
|
+
* The **Number format** action to customize the format of
|
|
2807
|
+
* the data labels on a chart or table.
|
|
2808
|
+
*
|
|
2809
|
+
* @example
|
|
2810
|
+
* ```js
|
|
2811
|
+
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
2812
|
+
* ```
|
|
2095
2813
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2096
2814
|
*/
|
|
2097
2815
|
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
2098
2816
|
/**
|
|
2817
|
+
* The **Text wrapping** action on a table.
|
|
2818
|
+
* Wraps or clips column text on a table.
|
|
2819
|
+
*
|
|
2820
|
+
* @example
|
|
2821
|
+
* ```js
|
|
2822
|
+
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
2823
|
+
* ```
|
|
2099
2824
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2100
2825
|
*/
|
|
2101
2826
|
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
2102
2827
|
/**
|
|
2828
|
+
* The **Remove** action in the chart axis or table column
|
|
2829
|
+
* customization menu.
|
|
2830
|
+
* Removes the data labels from a chart or the column of a
|
|
2831
|
+
* table visualization.
|
|
2832
|
+
*
|
|
2833
|
+
* @example
|
|
2834
|
+
* ```js
|
|
2835
|
+
* disabledActions: [Action.AxisMenuRemove]
|
|
2836
|
+
* ```
|
|
2103
2837
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2104
2838
|
*/
|
|
2105
2839
|
AxisMenuRemove = "axisMenuRemove",
|
|
@@ -2108,9 +2842,48 @@ export declare enum Action {
|
|
|
2108
2842
|
*/
|
|
2109
2843
|
InsertInToSlide = "insertInToSlide",
|
|
2110
2844
|
/**
|
|
2845
|
+
* The **Rename** menu action on Liveboards and visualizations.
|
|
2846
|
+
* Allows renaming a Liveboard or visualization.
|
|
2847
|
+
*
|
|
2848
|
+
* @example
|
|
2849
|
+
* ```js
|
|
2850
|
+
* disabledActions: [Action.RenameModalTitleDescription]
|
|
2851
|
+
* ```
|
|
2111
2852
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2112
2853
|
*/
|
|
2113
|
-
RenameModalTitleDescription = "renameModalTitleDescription"
|
|
2854
|
+
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
2855
|
+
/**
|
|
2856
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2857
|
+
*/
|
|
2858
|
+
RequestVerification = "requestVerification",
|
|
2859
|
+
/**
|
|
2860
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2861
|
+
*/
|
|
2862
|
+
MarkAsVerified = "markAsVerified",
|
|
2863
|
+
/**
|
|
2864
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2865
|
+
*/
|
|
2866
|
+
AddTab = "addTab",
|
|
2867
|
+
/**
|
|
2868
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2869
|
+
*/
|
|
2870
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
2871
|
+
/**
|
|
2872
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2873
|
+
*/
|
|
2874
|
+
ShowSageQuery = "showSageQuery",
|
|
2875
|
+
/**
|
|
2876
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2877
|
+
*/
|
|
2878
|
+
EditSageAnswer = "editSageAnswer",
|
|
2879
|
+
/**
|
|
2880
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2881
|
+
*/
|
|
2882
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
2883
|
+
/**
|
|
2884
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2885
|
+
*/
|
|
2886
|
+
ModifySageAnswer = "modifySageAnswer"
|
|
2114
2887
|
}
|
|
2115
2888
|
export interface SessionInterface {
|
|
2116
2889
|
sessionId: string;
|