@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0
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/css-variables.d.ts +95 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +136 -15
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +59 -37
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +419 -149
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +230 -1
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +30 -16
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +221 -17
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +635 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +151 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +11 -1
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +9 -0
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +218 -0
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.d.ts +2 -0
- package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.js +32 -2
- package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.spec.js +178 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +42 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +26 -6
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +83 -2
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +8 -1
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +14 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +61 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.d.ts +34 -0
- package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.spec.js +17 -0
- package/cjs/src/embed/spotter-viz-utils.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +29 -7
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +146 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +1 -0
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +1 -0
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +3 -2
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +4 -0
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +4 -0
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/util.spec.js +251 -0
- package/cjs/src/react/util.spec.js.map +1 -1
- package/cjs/src/types.d.ts +573 -11
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +519 -2
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +93 -0
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.spec.js +61 -0
- package/cjs/src/utils/processTrigger.spec.js.map +1 -1
- package/dist/{index-B5xoN6Cp.js → index-aBzH5ZwF.js} +1 -1
- package/dist/src/css-variables.d.ts +95 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +136 -15
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +230 -1
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/utils.d.ts +2 -0
- package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +42 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +8 -1
- package/dist/src/embed/spotter-utils.d.ts.map +1 -1
- package/dist/src/embed/spotter-viz-utils.d.ts +34 -0
- package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/errors.d.ts +1 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +4 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/types.d.ts +573 -11
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +936 -142
- package/dist/tsembed-react.js +935 -141
- package/dist/tsembed.es.js +935 -142
- package/dist/tsembed.js +933 -140
- package/dist/visual-embed-sdk-react-full.d.ts +1147 -44
- package/dist/visual-embed-sdk-react.d.ts +1153 -46
- package/dist/visual-embed-sdk.d.ts +1161 -46
- package/lib/package.json +1 -1
- package/lib/src/css-variables.d.ts +95 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +136 -15
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +60 -38
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +420 -150
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +230 -1
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +31 -17
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +222 -18
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +635 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +152 -1
- package/lib/src/embed/host-events.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +10 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +10 -1
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +218 -0
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.d.ts +2 -0
- package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/utils.js +28 -1
- package/lib/src/embed/hostEventClient/utils.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.spec.js +179 -1
- package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +42 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +26 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +83 -2
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +8 -1
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +12 -0
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +62 -1
- package/lib/src/embed/spotter-utils.spec.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.d.ts +34 -0
- package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-viz-utils.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.spec.js +17 -0
- package/lib/src/embed/spotter-viz-utils.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +29 -7
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +146 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +1 -0
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +1 -0
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +4 -0
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +4 -0
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/util.spec.js +251 -0
- package/lib/src/react/util.spec.js.map +1 -1
- package/lib/src/types.d.ts +573 -11
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +519 -2
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/processData.spec.js +93 -0
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js +61 -0
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +1161 -46
- package/package.json +1 -1
- package/src/css-variables.ts +118 -0
- package/src/embed/app.spec.ts +530 -183
- package/src/embed/app.ts +209 -66
- package/src/embed/conversation.spec.ts +275 -21
- package/src/embed/conversation.ts +262 -17
- package/src/embed/events.spec.ts +757 -1
- package/src/embed/host-events.spec.ts +194 -0
- package/src/embed/hostEventClient/contracts.ts +57 -14
- package/src/embed/hostEventClient/host-event-client.spec.ts +338 -0
- package/src/embed/hostEventClient/host-event-client.ts +16 -0
- package/src/embed/hostEventClient/utils.spec.ts +204 -0
- package/src/embed/hostEventClient/utils.ts +37 -10
- package/src/embed/liveboard.spec.ts +108 -2
- package/src/embed/liveboard.ts +82 -14
- package/src/embed/spotter-utils.spec.ts +68 -1
- package/src/embed/spotter-utils.ts +16 -1
- package/src/embed/spotter-viz-utils.spec.ts +17 -0
- package/src/embed/spotter-viz-utils.ts +34 -0
- package/src/embed/ts-embed.spec.ts +186 -0
- package/src/embed/ts-embed.ts +30 -4
- package/src/errors.ts +1 -0
- package/src/index.ts +3 -1
- package/src/mixpanel-service.ts +4 -0
- package/src/react/util.spec.tsx +255 -0
- package/src/types.ts +575 -8
- package/src/utils/processData.spec.ts +97 -0
- package/src/utils/processTrigger.spec.ts +91 -0
|
@@ -41,6 +41,42 @@ export interface CustomCssVariables {
|
|
|
41
41
|
* Font color of the top navigation panel.
|
|
42
42
|
*/
|
|
43
43
|
"--ts-var-nav-color"?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Background color of the left navigation panel.
|
|
46
|
+
*/
|
|
47
|
+
"--ts-var-left-nav-background"?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Background color of the active tab in the left navigation panel.
|
|
50
|
+
*/
|
|
51
|
+
"--ts-var-left-nav-active-tab-background"?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Border color of the active tab in the left navigation panel.
|
|
54
|
+
*/
|
|
55
|
+
"--ts-var-left-nav-active-tab-border-color"?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Font color of the section title in the left navigation panel.
|
|
58
|
+
*/
|
|
59
|
+
"--ts-var-left-nav-section-title-color"?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Font color of the items in the left navigation panel.
|
|
62
|
+
*/
|
|
63
|
+
"--ts-var-left-nav-item-color"?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Font color of the selected item in the left navigation panel.
|
|
66
|
+
*/
|
|
67
|
+
"--ts-var-left-nav-item-selection-color"?: string;
|
|
68
|
+
/**
|
|
69
|
+
* Background color of the selected item in the left navigation panel.
|
|
70
|
+
*/
|
|
71
|
+
"--ts-var-left-nav-item-selection-background"?: string;
|
|
72
|
+
/**
|
|
73
|
+
* Color of the active tab icon in the left navigation panel.
|
|
74
|
+
*/
|
|
75
|
+
"--ts-var-left-nav-tab-icon-active-color"?: string;
|
|
76
|
+
/**
|
|
77
|
+
* Color of the inactive tab icon in the left navigation panel.
|
|
78
|
+
*/
|
|
79
|
+
"--ts-var-left-nav-tab-icon-inactive-color"?: string;
|
|
44
80
|
/**
|
|
45
81
|
* Background color of the *Search data* button.
|
|
46
82
|
*/
|
|
@@ -413,6 +449,14 @@ export interface CustomCssVariables {
|
|
|
413
449
|
* Background color of the tiles in the Liveboard.
|
|
414
450
|
*/
|
|
415
451
|
"--ts-var-liveboard-tile-background"?: string;
|
|
452
|
+
/**
|
|
453
|
+
* Font color of the insight tiles in the Liveboard.
|
|
454
|
+
*/
|
|
455
|
+
"--ts-var-liveboard-insight-tile-font-color"?: string;
|
|
456
|
+
/**
|
|
457
|
+
* Background color of the insight tiles in the Liveboard.
|
|
458
|
+
*/
|
|
459
|
+
"--ts-var-liveboard-insight-tile-background"?: string;
|
|
416
460
|
/**
|
|
417
461
|
* Border radius of the tiles in the Liveboard.
|
|
418
462
|
*/
|
|
@@ -961,6 +1005,10 @@ export interface CustomCssVariables {
|
|
|
961
1005
|
* header underline, left panel border, thinking step connector and dots.
|
|
962
1006
|
*/
|
|
963
1007
|
"--ts-var-spotterviz-border-color"?: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* Expanded user chat message bubble border color in SpotterViz.
|
|
1010
|
+
*/
|
|
1011
|
+
"--ts-var-spotterviz-expanded-border-color"?: string;
|
|
964
1012
|
/**
|
|
965
1013
|
* Background color of the reference-mode toggle button in the SpotterViz
|
|
966
1014
|
* chat input when it is unselected and the user hovers over it.
|
|
@@ -978,6 +1026,53 @@ export interface CustomCssVariables {
|
|
|
978
1026
|
* on each referenced-entity chip in the chat input.
|
|
979
1027
|
*/
|
|
980
1028
|
"--ts-var-spotterviz-reference-icon-selected-background"?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Background color of the shared conversation header (recipient's read-only view).
|
|
1031
|
+
*/
|
|
1032
|
+
"--ts-var-shared-conv-header-background"?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Border color of the shared conversation header.
|
|
1035
|
+
*/
|
|
1036
|
+
"--ts-var-shared-conv-header-border-color"?: string;
|
|
1037
|
+
/**
|
|
1038
|
+
* Font color of the title text in the shared conversation header.
|
|
1039
|
+
*/
|
|
1040
|
+
"--ts-var-shared-conv-title-color"?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* Background gradient color-stop of the share chat header's outer container
|
|
1043
|
+
* (sender's pre-share header). Defaults to transparent.
|
|
1044
|
+
*/
|
|
1045
|
+
"--ts-var-share-chat-header-container-background"?: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* Background color of the share chat header's inner title/actions row.
|
|
1048
|
+
* Defaults to transparent.
|
|
1049
|
+
*/
|
|
1050
|
+
"--ts-var-share-chat-header-background"?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* Font color of the title text in the share chat header.
|
|
1053
|
+
*/
|
|
1054
|
+
"--ts-var-share-chat-header-title-color"?: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* Font color of the title input field in the share chat header.
|
|
1057
|
+
*/
|
|
1058
|
+
"--ts-var-share-chat-header-input-text-color"?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Background color of the title input field in the share chat header.
|
|
1061
|
+
*/
|
|
1062
|
+
"--ts-var-share-chat-header-input-background"?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* Border color of the title input field in the share chat header.
|
|
1065
|
+
*/
|
|
1066
|
+
"--ts-var-share-chat-header-input-border-color"?: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* Background color of the shimmer loading effect. Also affects the
|
|
1069
|
+
* saved chats sidebar's new-chat shimmer, which shares the same style.
|
|
1070
|
+
*/
|
|
1071
|
+
"--ts-var-shimmer-background"?: string;
|
|
1072
|
+
/**
|
|
1073
|
+
* Background color of the shimmer sweep animation's gradient mid-stop.
|
|
1074
|
+
*/
|
|
1075
|
+
"--ts-var-shimmer-sweep-background"?: string;
|
|
981
1076
|
}
|
|
982
1077
|
export interface SessionInterface {
|
|
983
1078
|
sessionId: string;
|
|
@@ -1351,7 +1446,14 @@ declare enum HomeLeftNavItem {
|
|
|
1351
1446
|
* Available in the V3 navigation experience.
|
|
1352
1447
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1353
1448
|
*/
|
|
1354
|
-
Favorites = "favorites"
|
|
1449
|
+
Favorites = "favorites",
|
|
1450
|
+
/**
|
|
1451
|
+
* The *Collections* menu option in
|
|
1452
|
+
* the *Insights* left navigation panel.
|
|
1453
|
+
* Shown when collections are enabled on the cluster.
|
|
1454
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1455
|
+
*/
|
|
1456
|
+
Collections = "collections"
|
|
1355
1457
|
}
|
|
1356
1458
|
export type DOMSelector = string | HTMLElement;
|
|
1357
1459
|
/**
|
|
@@ -2298,6 +2400,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2298
2400
|
* ```
|
|
2299
2401
|
*/
|
|
2300
2402
|
overrideOrgId?: number;
|
|
2403
|
+
/**
|
|
2404
|
+
* Overrides the browser history behavior for embedding application users.
|
|
2405
|
+
* This parameter changes standard history navigation (pushState) into a
|
|
2406
|
+
* state replacement (replaceState), preventing users from getting trapped in
|
|
2407
|
+
* back-button loops inside the embedded iframe environment.
|
|
2408
|
+
* The overrideHistoryState setting is honored only if the
|
|
2409
|
+
* application is running within an embedded context.
|
|
2410
|
+
*
|
|
2411
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2412
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
2413
|
+
* @example
|
|
2414
|
+
* ```js
|
|
2415
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2416
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2417
|
+
* // ... other embed view config
|
|
2418
|
+
* overrideHistoryState: true,
|
|
2419
|
+
* });
|
|
2420
|
+
* ```
|
|
2421
|
+
*/
|
|
2422
|
+
overrideHistoryState?: boolean;
|
|
2301
2423
|
/**
|
|
2302
2424
|
* Flag to override the *Open Link in New Tab* context
|
|
2303
2425
|
* menu option.
|
|
@@ -2641,7 +2763,9 @@ export interface HomePageConfig {
|
|
|
2641
2763
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2642
2764
|
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
2643
2765
|
*
|
|
2644
|
-
* **Note**:
|
|
2766
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2767
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2768
|
+
* and V4 (Focused) home page experiences.
|
|
2645
2769
|
*
|
|
2646
2770
|
* Supported embed types: `AppEmbed`
|
|
2647
2771
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2650,7 +2774,7 @@ export interface HomePageConfig {
|
|
|
2650
2774
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
2651
2775
|
*
|
|
2652
2776
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2653
|
-
* ... //
|
|
2777
|
+
* ... // V3 navigation and home page experience attributes
|
|
2654
2778
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2655
2779
|
* //...other embed view configuration attributes
|
|
2656
2780
|
* })
|
|
@@ -2661,8 +2785,11 @@ export interface HomePageConfig {
|
|
|
2661
2785
|
* Reorder home page modules.
|
|
2662
2786
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2663
2787
|
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2664
|
-
* HomepageModule.Watchlist]`
|
|
2665
|
-
*
|
|
2788
|
+
* HomepageModule.Watchlist]`
|
|
2789
|
+
*
|
|
2790
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2791
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2792
|
+
* and V4 (Focused) home page experiences.
|
|
2666
2793
|
*
|
|
2667
2794
|
* Supported embed types: `AppEmbed`
|
|
2668
2795
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2671,7 +2798,7 @@ export interface HomePageConfig {
|
|
|
2671
2798
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
2672
2799
|
*
|
|
2673
2800
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2674
|
-
* ...//
|
|
2801
|
+
* ...//V3 navigation and home page experience attributes
|
|
2675
2802
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
2676
2803
|
* //... other embed view configuration attributes
|
|
2677
2804
|
* })
|
|
@@ -2683,7 +2810,9 @@ export interface HomePageConfig {
|
|
|
2683
2810
|
* on the home page left navigation panel.
|
|
2684
2811
|
* To specify the menu items, import the `HomeLeftNavItem` enum.
|
|
2685
2812
|
*
|
|
2686
|
-
* **Note**:
|
|
2813
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2814
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2815
|
+
* and V4 (Focused) home page experiences.
|
|
2687
2816
|
*
|
|
2688
2817
|
* Supported embed types: `AppEmbed`
|
|
2689
2818
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -3059,6 +3188,24 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3059
3188
|
* ```
|
|
3060
3189
|
*/
|
|
3061
3190
|
isCentralizedLiveboardFilterUXEnabled?: boolean;
|
|
3191
|
+
/**
|
|
3192
|
+
* This flag is used to enable or disable scoped Liveboard filtering.
|
|
3193
|
+
* When enabled, filters and parameters can be scoped to a group of
|
|
3194
|
+
* visualizations on a Liveboard, in addition to the Liveboard and
|
|
3195
|
+
* tab levels.
|
|
3196
|
+
*
|
|
3197
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3198
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
3199
|
+
* @example
|
|
3200
|
+
* ```js
|
|
3201
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3202
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3203
|
+
* ... // other embed view config
|
|
3204
|
+
* isScopedLiveboardFilteringEnabled: true,
|
|
3205
|
+
* })
|
|
3206
|
+
* ```
|
|
3207
|
+
*/
|
|
3208
|
+
isScopedLiveboardFilteringEnabled?: boolean;
|
|
3062
3209
|
/**
|
|
3063
3210
|
* This flag is used to enable or disable the link parameters in liveboard.
|
|
3064
3211
|
*
|
|
@@ -4218,11 +4365,19 @@ export declare enum EmbedEvent {
|
|
|
4218
4365
|
* Emitted when a user changes any filter on a Liveboard.
|
|
4219
4366
|
* Returns filter type and name, column name and ID, and runtime
|
|
4220
4367
|
* filter details.
|
|
4368
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
4369
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
4370
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
4371
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
4372
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
4373
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4374
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
4221
4375
|
* @example
|
|
4222
4376
|
*
|
|
4223
4377
|
* ```js
|
|
4224
4378
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
4225
4379
|
* console.log('payload', payload);
|
|
4380
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
4226
4381
|
* })
|
|
4227
4382
|
* ```
|
|
4228
4383
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -4414,9 +4569,17 @@ export declare enum EmbedEvent {
|
|
|
4414
4569
|
/**
|
|
4415
4570
|
* Emitted when parameter changes in an Answer
|
|
4416
4571
|
* or Liveboard.
|
|
4572
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
4573
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
4574
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
4575
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
4576
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
4577
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4578
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
4417
4579
|
* ```js
|
|
4418
4580
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4419
4581
|
* console.log('payload', payload);
|
|
4582
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
4420
4583
|
* })
|
|
4421
4584
|
* ```
|
|
4422
4585
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -4718,6 +4881,158 @@ export declare enum EmbedEvent {
|
|
|
4718
4881
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4719
4882
|
*/
|
|
4720
4883
|
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
4884
|
+
/**
|
|
4885
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
4886
|
+
* to bracket the interaction. App→host counterpart of the
|
|
4887
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
4888
|
+
* @example
|
|
4889
|
+
* ```js
|
|
4890
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
4891
|
+
* // payload: { convId: string }
|
|
4892
|
+
* })
|
|
4893
|
+
* ```
|
|
4894
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4895
|
+
*/
|
|
4896
|
+
SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
|
|
4897
|
+
/**
|
|
4898
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
4899
|
+
* to bracket the interaction.
|
|
4900
|
+
* @example
|
|
4901
|
+
* ```js
|
|
4902
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
4903
|
+
* // payload: { convId: string }
|
|
4904
|
+
* })
|
|
4905
|
+
* ```
|
|
4906
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4907
|
+
*/
|
|
4908
|
+
SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
|
|
4909
|
+
/**
|
|
4910
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
4911
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
4912
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
4913
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
4914
|
+
* the save resolves.
|
|
4915
|
+
* @example
|
|
4916
|
+
* ```js
|
|
4917
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
4918
|
+
* // payload: { convId: string, shareId: string,
|
|
4919
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
4920
|
+
* })
|
|
4921
|
+
* ```
|
|
4922
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4923
|
+
*/
|
|
4924
|
+
SpotterConversationShared = "spotterConversationShared",
|
|
4925
|
+
/**
|
|
4926
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
4927
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
4928
|
+
* and the share is deleted entirely.
|
|
4929
|
+
* @example
|
|
4930
|
+
* ```js
|
|
4931
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
4932
|
+
* // payload: { convId: string, shareId: string,
|
|
4933
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
4934
|
+
* })
|
|
4935
|
+
* ```
|
|
4936
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4937
|
+
*/
|
|
4938
|
+
SpotterConversationShareRevoked = "spotterConversationShareRevoked",
|
|
4939
|
+
/**
|
|
4940
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
4941
|
+
* view). No shareId available viewer-side.
|
|
4942
|
+
* @example
|
|
4943
|
+
* ```js
|
|
4944
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
4945
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
4946
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
4947
|
+
* })
|
|
4948
|
+
* ```
|
|
4949
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4950
|
+
*/
|
|
4951
|
+
SpotterSharedConversationViewed = "spotterSharedConversationViewed",
|
|
4952
|
+
/**
|
|
4953
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
4954
|
+
* last shared version" checkbox.
|
|
4955
|
+
* @example
|
|
4956
|
+
* ```js
|
|
4957
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
4958
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
4959
|
+
* })
|
|
4960
|
+
* ```
|
|
4961
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4962
|
+
*/
|
|
4963
|
+
SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
|
|
4964
|
+
/**
|
|
4965
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
4966
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
4967
|
+
* @example
|
|
4968
|
+
* ```js
|
|
4969
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
4970
|
+
* // payload: { convId: string }
|
|
4971
|
+
* })
|
|
4972
|
+
* ```
|
|
4973
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4974
|
+
*/
|
|
4975
|
+
SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
|
|
4976
|
+
/**
|
|
4977
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
4978
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
4979
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
4980
|
+
* @example
|
|
4981
|
+
* ```js
|
|
4982
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
4983
|
+
* // payload: { convId: string }
|
|
4984
|
+
* })
|
|
4985
|
+
* ```
|
|
4986
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4987
|
+
*/
|
|
4988
|
+
SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
|
|
4989
|
+
/**
|
|
4990
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
4991
|
+
* @example
|
|
4992
|
+
* ```js
|
|
4993
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
4994
|
+
* // payload: { convId: string }
|
|
4995
|
+
* })
|
|
4996
|
+
* ```
|
|
4997
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4998
|
+
*/
|
|
4999
|
+
SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
|
|
5000
|
+
/**
|
|
5001
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
5002
|
+
* button.
|
|
5003
|
+
* @example
|
|
5004
|
+
* ```js
|
|
5005
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
5006
|
+
* // payload: { convId: string }
|
|
5007
|
+
* })
|
|
5008
|
+
* ```
|
|
5009
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5010
|
+
*/
|
|
5011
|
+
SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
|
|
5012
|
+
/**
|
|
5013
|
+
* Emitted when a Spotter conversation is pinned.
|
|
5014
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5015
|
+
* @example
|
|
5016
|
+
* ```js
|
|
5017
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
5018
|
+
* console.log('Conversation pinned', payload);
|
|
5019
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
5020
|
+
* })
|
|
5021
|
+
* ```
|
|
5022
|
+
*/
|
|
5023
|
+
SpotterConversationPinned = "spotterConversationPinned",
|
|
5024
|
+
/**
|
|
5025
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
5026
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5027
|
+
* @example
|
|
5028
|
+
* ```js
|
|
5029
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
5030
|
+
* console.log('Conversation unpinned', payload);
|
|
5031
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
5032
|
+
* })
|
|
5033
|
+
* ```
|
|
5034
|
+
*/
|
|
5035
|
+
SpotterConversationUnpinned = "spotterConversationUnpinned",
|
|
4721
5036
|
/**
|
|
4722
5037
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
4723
5038
|
* @example
|
|
@@ -4730,6 +5045,30 @@ export declare enum EmbedEvent {
|
|
|
4730
5045
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4731
5046
|
*/
|
|
4732
5047
|
SpotterConversationSelected = "spotterConversationSelected",
|
|
5048
|
+
/**
|
|
5049
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
5050
|
+
* Includes the conversation and message identifiers so the host app can
|
|
5051
|
+
* fetch the full conversation history via the REST API if needed.
|
|
5052
|
+
*
|
|
5053
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
5054
|
+
*
|
|
5055
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
5056
|
+
* inside the full application).
|
|
5057
|
+
* @example
|
|
5058
|
+
* ```js
|
|
5059
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
5060
|
+
* console.log('Spotter response complete', payload);
|
|
5061
|
+
* })
|
|
5062
|
+
* ```
|
|
5063
|
+
* @example
|
|
5064
|
+
* ```js
|
|
5065
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
5066
|
+
* console.log('Spotter response complete', payload);
|
|
5067
|
+
* })
|
|
5068
|
+
* ```
|
|
5069
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5070
|
+
*/
|
|
5071
|
+
SpotterResponseComplete = "spotterResponseComplete",
|
|
4733
5072
|
/**
|
|
4734
5073
|
* @hidden
|
|
4735
5074
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -5209,6 +5548,17 @@ export declare enum HostEvent {
|
|
|
5209
5548
|
* name: string,
|
|
5210
5549
|
* type: ATTRIBUTE/MEASURE,
|
|
5211
5550
|
* dataType: INT64/CHAR/DATE }
|
|
5551
|
+
*
|
|
5552
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
5553
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
5554
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
5555
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5556
|
+
*
|
|
5557
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5558
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5559
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5560
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
5561
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
5212
5562
|
* @example
|
|
5213
5563
|
* ```js
|
|
5214
5564
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -5221,6 +5571,14 @@ export declare enum HostEvent {
|
|
|
5221
5571
|
* ```
|
|
5222
5572
|
* @example
|
|
5223
5573
|
* ```js
|
|
5574
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
5575
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
5576
|
+
* column: { columnId: '<column-GUID>' },
|
|
5577
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
5578
|
+
* });
|
|
5579
|
+
* ```
|
|
5580
|
+
* @example
|
|
5581
|
+
* ```js
|
|
5224
5582
|
* // Open filter from search context
|
|
5225
5583
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5226
5584
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -5230,6 +5588,38 @@ export declare enum HostEvent {
|
|
|
5230
5588
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5231
5589
|
*/
|
|
5232
5590
|
OpenFilter = "openFilter",
|
|
5591
|
+
/**
|
|
5592
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
5593
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
5594
|
+
* @param - Includes the following keys:
|
|
5595
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
5596
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
5597
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
5598
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
5599
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
5600
|
+
*
|
|
5601
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5602
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5603
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5604
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
5605
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
5606
|
+
* @example
|
|
5607
|
+
* ```js
|
|
5608
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
5609
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
5610
|
+
* });
|
|
5611
|
+
* ```
|
|
5612
|
+
* @example
|
|
5613
|
+
* ```js
|
|
5614
|
+
* // Open a parameter scoped to a specific group
|
|
5615
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
5616
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
5617
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
5618
|
+
* });
|
|
5619
|
+
* ```
|
|
5620
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
5621
|
+
*/
|
|
5622
|
+
OpenParameter = "openParameter",
|
|
5233
5623
|
/**
|
|
5234
5624
|
* Add columns to the current search query.
|
|
5235
5625
|
* @param - { columnIds: string[] }
|
|
@@ -6293,6 +6683,14 @@ export declare enum HostEvent {
|
|
|
6293
6683
|
/**
|
|
6294
6684
|
* Get details of filters applied on the Liveboard.
|
|
6295
6685
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
6686
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
6687
|
+
* indicating the scope of the filter. It contains a `level`
|
|
6688
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
6689
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
6690
|
+
* level there is no `targetId`, since the filter applies to the
|
|
6691
|
+
* whole Liveboard.
|
|
6692
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
6693
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
6296
6694
|
* @example
|
|
6297
6695
|
* ```js
|
|
6298
6696
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -6332,6 +6730,16 @@ export declare enum HostEvent {
|
|
|
6332
6730
|
*
|
|
6333
6731
|
* `type` - To update filters for date time, specify the date format type.
|
|
6334
6732
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
6733
|
+
*
|
|
6734
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
6735
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
6736
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
6737
|
+
*
|
|
6738
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
6739
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
6740
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
6741
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
6742
|
+
* Liveboard.
|
|
6335
6743
|
* @example
|
|
6336
6744
|
* ```js
|
|
6337
6745
|
*
|
|
@@ -6408,6 +6816,21 @@ export declare enum HostEvent {
|
|
|
6408
6816
|
* }
|
|
6409
6817
|
* }, ContextType.Liveboard);
|
|
6410
6818
|
* ```
|
|
6819
|
+
* @example
|
|
6820
|
+
* ```js
|
|
6821
|
+
* // Scope the filter to a specific Liveboard tab
|
|
6822
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
6823
|
+
* filter: {
|
|
6824
|
+
* column: "item type",
|
|
6825
|
+
* oper: "IN",
|
|
6826
|
+
* values: ["bags", "shirts"],
|
|
6827
|
+
* applicability: {
|
|
6828
|
+
* level: "TAB",
|
|
6829
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
6830
|
+
* }
|
|
6831
|
+
* }
|
|
6832
|
+
* });
|
|
6833
|
+
* ```
|
|
6411
6834
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
6412
6835
|
*/
|
|
6413
6836
|
UpdateFilters = "updateFilters",
|
|
@@ -6432,6 +6855,28 @@ export declare enum HostEvent {
|
|
|
6432
6855
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
6433
6856
|
*/
|
|
6434
6857
|
GetTabs = "getTabs",
|
|
6858
|
+
/**
|
|
6859
|
+
* Get group details for the current Liveboard.
|
|
6860
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
6861
|
+
* @example
|
|
6862
|
+
* ```js
|
|
6863
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
6864
|
+
* console.log(
|
|
6865
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
6866
|
+
* );
|
|
6867
|
+
* })
|
|
6868
|
+
* ```
|
|
6869
|
+
* @example
|
|
6870
|
+
* ```js
|
|
6871
|
+
* // Get groups from liveboard context
|
|
6872
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
6873
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
6874
|
+
* console.log('groups', groupDetails);
|
|
6875
|
+
* });
|
|
6876
|
+
* ```
|
|
6877
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
6878
|
+
*/
|
|
6879
|
+
GetGroups = "getGroups",
|
|
6435
6880
|
/**
|
|
6436
6881
|
* Set the visible tabs on a Liveboard.
|
|
6437
6882
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -6559,6 +7004,15 @@ export declare enum HostEvent {
|
|
|
6559
7004
|
* - `name`: Name of the parameter.
|
|
6560
7005
|
* - `value`: The value to set for the parameter.
|
|
6561
7006
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
7007
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
7008
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
7009
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
7010
|
+
*
|
|
7011
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
7012
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
7013
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
7014
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
7015
|
+
* Liveboard.
|
|
6562
7016
|
*
|
|
6563
7017
|
* @example
|
|
6564
7018
|
* ```js
|
|
@@ -6570,6 +7024,18 @@ export declare enum HostEvent {
|
|
|
6570
7024
|
* ```
|
|
6571
7025
|
* @example
|
|
6572
7026
|
* ```js
|
|
7027
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
7028
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
7029
|
+
* name: "Integer Range Param",
|
|
7030
|
+
* value: 10,
|
|
7031
|
+
* applicability: {
|
|
7032
|
+
* level: "TAB",
|
|
7033
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
7034
|
+
* }
|
|
7035
|
+
* }])
|
|
7036
|
+
* ```
|
|
7037
|
+
* @example
|
|
7038
|
+
* ```js
|
|
6573
7039
|
* // Update parameters from liveboard context
|
|
6574
7040
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
6575
7041
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -6583,6 +7049,14 @@ export declare enum HostEvent {
|
|
|
6583
7049
|
UpdateParameters = "UpdateParameters",
|
|
6584
7050
|
/**
|
|
6585
7051
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
7052
|
+
* Each parameter includes an optional `applicability` attribute
|
|
7053
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
7054
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
7055
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
7056
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
7057
|
+
* whole Liveboard.
|
|
7058
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
7059
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
6586
7060
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6587
7061
|
* ```js
|
|
6588
7062
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -6849,6 +7323,36 @@ export declare enum HostEvent {
|
|
|
6849
7323
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6850
7324
|
*/
|
|
6851
7325
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
7326
|
+
/**
|
|
7327
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
7328
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
7329
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
7330
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
7331
|
+
* @example
|
|
7332
|
+
* ```js
|
|
7333
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
7334
|
+
* ```
|
|
7335
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7336
|
+
*/
|
|
7337
|
+
ShareSpotterConversation = "ShareSpotterConversation",
|
|
7338
|
+
/**
|
|
7339
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
7340
|
+
* @example
|
|
7341
|
+
* ```js
|
|
7342
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
7343
|
+
* ```
|
|
7344
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7345
|
+
*/
|
|
7346
|
+
CloseSpotterShareConversation = "CloseSpotterShareConversation",
|
|
7347
|
+
/**
|
|
7348
|
+
* Exits the read-only shared-conversation view.
|
|
7349
|
+
* @example
|
|
7350
|
+
* ```js
|
|
7351
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
7352
|
+
* ```
|
|
7353
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7354
|
+
*/
|
|
7355
|
+
ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
|
|
6852
7356
|
/**
|
|
6853
7357
|
* Deletes the last prompt in spotter embed.
|
|
6854
7358
|
* @example
|
|
@@ -6944,6 +7448,41 @@ export declare enum HostEvent {
|
|
|
6944
7448
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
6945
7449
|
*/
|
|
6946
7450
|
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
7451
|
+
/**
|
|
7452
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
7453
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
7454
|
+
* required.
|
|
7455
|
+
*
|
|
7456
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
7457
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
7458
|
+
* instance.
|
|
7459
|
+
*
|
|
7460
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7461
|
+
* @example
|
|
7462
|
+
* ```js
|
|
7463
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
7464
|
+
* conversationId: '<conversation-id>',
|
|
7465
|
+
* });
|
|
7466
|
+
* ```
|
|
7467
|
+
*/
|
|
7468
|
+
PinSpotterConversation = "PinSpotterConversation",
|
|
7469
|
+
/**
|
|
7470
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
7471
|
+
* conversation to unpin is required.
|
|
7472
|
+
*
|
|
7473
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
7474
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
7475
|
+
* instance.
|
|
7476
|
+
*
|
|
7477
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7478
|
+
* @example
|
|
7479
|
+
* ```js
|
|
7480
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
7481
|
+
* conversationId: '<conversation-id>',
|
|
7482
|
+
* });
|
|
7483
|
+
* ```
|
|
7484
|
+
*/
|
|
7485
|
+
UnpinSpotterConversation = "UnpinSpotterConversation",
|
|
6947
7486
|
/**
|
|
6948
7487
|
* @hidden
|
|
6949
7488
|
* Get the current context of the embedded page.
|
|
@@ -8310,6 +8849,19 @@ export declare enum Action {
|
|
|
8310
8849
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
8311
8850
|
*/
|
|
8312
8851
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
8852
|
+
/**
|
|
8853
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
8854
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
8855
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
8856
|
+
*
|
|
8857
|
+
* @example
|
|
8858
|
+
* ```js
|
|
8859
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
8860
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
8861
|
+
* ```
|
|
8862
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
8863
|
+
*/
|
|
8864
|
+
AllLiveboardFilters = "allLiveboardFilters",
|
|
8313
8865
|
/**
|
|
8314
8866
|
* The **Data model instructions** button on the Spotter interface.
|
|
8315
8867
|
* Allows opening the data model instructions modal.
|
|
@@ -8646,17 +9198,110 @@ export declare enum Action {
|
|
|
8646
9198
|
*/
|
|
8647
9199
|
SpotterChatRename = "spotterChatRename",
|
|
8648
9200
|
/**
|
|
8649
|
-
* Controls visibility and disable state of the
|
|
8650
|
-
* in the
|
|
9201
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
9202
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
9203
|
+
* (enableShareConversation on).
|
|
8651
9204
|
* @example
|
|
8652
9205
|
* ```js
|
|
8653
|
-
* disabledActions: [Action.
|
|
9206
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
8654
9207
|
* ```
|
|
8655
|
-
* @version SDK: 1.
|
|
9208
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
8656
9209
|
*/
|
|
8657
|
-
|
|
9210
|
+
SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
|
|
8658
9211
|
/**
|
|
8659
|
-
* Controls visibility and disable state of the
|
|
9212
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
9213
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
9214
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
9215
|
+
* @example
|
|
9216
|
+
* ```js
|
|
9217
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
9218
|
+
* ```
|
|
9219
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9220
|
+
*/
|
|
9221
|
+
SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
|
|
9222
|
+
/**
|
|
9223
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
9224
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
9225
|
+
* @example
|
|
9226
|
+
* ```js
|
|
9227
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
9228
|
+
* ```
|
|
9229
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9230
|
+
*/
|
|
9231
|
+
SpotterSharedConversationBanner = "spotterSharedConversationBanner",
|
|
9232
|
+
/**
|
|
9233
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
9234
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
9235
|
+
* @example
|
|
9236
|
+
* ```js
|
|
9237
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
9238
|
+
* ```
|
|
9239
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9240
|
+
*/
|
|
9241
|
+
SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
|
|
9242
|
+
/**
|
|
9243
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
9244
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
9245
|
+
* host event.
|
|
9246
|
+
* @example
|
|
9247
|
+
* ```js
|
|
9248
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
9249
|
+
* ```
|
|
9250
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9251
|
+
*/
|
|
9252
|
+
SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
|
|
9253
|
+
/**
|
|
9254
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
9255
|
+
* to the current moment…"). Hide-only.
|
|
9256
|
+
* @example
|
|
9257
|
+
* ```js
|
|
9258
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
9259
|
+
* ```
|
|
9260
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9261
|
+
*/
|
|
9262
|
+
SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
|
|
9263
|
+
/**
|
|
9264
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
9265
|
+
* messages since last shared version" checkbox.
|
|
9266
|
+
* @example
|
|
9267
|
+
* ```js
|
|
9268
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
9269
|
+
* ```
|
|
9270
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9271
|
+
*/
|
|
9272
|
+
SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
|
|
9273
|
+
/**
|
|
9274
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
9275
|
+
* stale-snapshot info banner.
|
|
9276
|
+
* @example
|
|
9277
|
+
* ```js
|
|
9278
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
9279
|
+
* ```
|
|
9280
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9281
|
+
*/
|
|
9282
|
+
SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
|
|
9283
|
+
/**
|
|
9284
|
+
* Controls visibility and disable state of the delete action
|
|
9285
|
+
* in the Spotter conversation edit menu.
|
|
9286
|
+
* @example
|
|
9287
|
+
* ```js
|
|
9288
|
+
* disabledActions: [Action.SpotterChatDelete]
|
|
9289
|
+
* ```
|
|
9290
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
9291
|
+
*/
|
|
9292
|
+
SpotterChatDelete = "spotterChatDelete",
|
|
9293
|
+
/**
|
|
9294
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
9295
|
+
* in the Spotter conversation edit menu.
|
|
9296
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
9297
|
+
* @example
|
|
9298
|
+
* ```js
|
|
9299
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
9300
|
+
* ```
|
|
9301
|
+
*/
|
|
9302
|
+
SpotterChatPin = "spotterChatPin",
|
|
9303
|
+
/**
|
|
9304
|
+
* Controls visibility and disable state of the documentation/best practices
|
|
8660
9305
|
* link in the Spotter sidebar footer.
|
|
8661
9306
|
* @example
|
|
8662
9307
|
* ```js
|
|
@@ -9090,7 +9735,9 @@ declare enum EmbedErrorCodes {
|
|
|
9090
9735
|
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
9091
9736
|
UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
|
|
9092
9737
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
9093
|
-
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
|
|
9738
|
+
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD",
|
|
9739
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
9740
|
+
UPDATEPARAMETERS_INVALID_PAYLOAD = "UPDATEPARAMETERS_INVALID_PAYLOAD"
|
|
9094
9741
|
}
|
|
9095
9742
|
/**
|
|
9096
9743
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -9853,6 +10500,40 @@ export interface LiveboardTab {
|
|
|
9853
10500
|
name: string;
|
|
9854
10501
|
[key: string]: any;
|
|
9855
10502
|
}
|
|
10503
|
+
export interface LiveboardGroup {
|
|
10504
|
+
id: string;
|
|
10505
|
+
name: string;
|
|
10506
|
+
[key: string]: any;
|
|
10507
|
+
}
|
|
10508
|
+
declare enum ApplicabilityLevel {
|
|
10509
|
+
Liveboard = "LIVEBOARD",
|
|
10510
|
+
Tab = "TAB",
|
|
10511
|
+
Group = "GROUP"
|
|
10512
|
+
}
|
|
10513
|
+
/**
|
|
10514
|
+
* Scopes a filter or parameter to a specific target.
|
|
10515
|
+
* At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
|
|
10516
|
+
* is not required.
|
|
10517
|
+
*/
|
|
10518
|
+
export interface Applicability {
|
|
10519
|
+
level: ApplicabilityLevel;
|
|
10520
|
+
targetId?: string;
|
|
10521
|
+
}
|
|
10522
|
+
export interface FilterUpdate {
|
|
10523
|
+
column: string;
|
|
10524
|
+
oper: string;
|
|
10525
|
+
values: string[];
|
|
10526
|
+
type?: string;
|
|
10527
|
+
applicability?: Applicability;
|
|
10528
|
+
}
|
|
10529
|
+
export interface LiveboardFilter {
|
|
10530
|
+
applicability?: Applicability;
|
|
10531
|
+
[key: string]: any;
|
|
10532
|
+
}
|
|
10533
|
+
export interface LiveboardParameter {
|
|
10534
|
+
applicability?: Applicability;
|
|
10535
|
+
[key: string]: any;
|
|
10536
|
+
}
|
|
9856
10537
|
export declare enum UIPassthroughEvent {
|
|
9857
10538
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
9858
10539
|
SaveAnswer = "saveAnswer",
|
|
@@ -9869,6 +10550,7 @@ export declare enum UIPassthroughEvent {
|
|
|
9869
10550
|
GetParameters = "getParameters",
|
|
9870
10551
|
GetTML = "getTML",
|
|
9871
10552
|
GetTabs = "getTabs",
|
|
10553
|
+
GetGroups = "getGroups",
|
|
9872
10554
|
GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
|
|
9873
10555
|
}
|
|
9874
10556
|
export type UIPassthroughContractBase = {
|
|
@@ -9947,7 +10629,7 @@ export type UIPassthroughContractBase = {
|
|
|
9947
10629
|
vizId?: string;
|
|
9948
10630
|
};
|
|
9949
10631
|
response: {
|
|
9950
|
-
liveboardFilters:
|
|
10632
|
+
liveboardFilters: LiveboardFilter[];
|
|
9951
10633
|
runtimeFilters: RuntimeFilter[];
|
|
9952
10634
|
};
|
|
9953
10635
|
};
|
|
@@ -9960,7 +10642,7 @@ export type UIPassthroughContractBase = {
|
|
|
9960
10642
|
[UIPassthroughEvent.GetParameters]: {
|
|
9961
10643
|
request: Record<string, never>;
|
|
9962
10644
|
response: {
|
|
9963
|
-
parameters:
|
|
10645
|
+
parameters: LiveboardParameter[];
|
|
9964
10646
|
};
|
|
9965
10647
|
};
|
|
9966
10648
|
[UIPassthroughEvent.GetTML]: {
|
|
@@ -9978,6 +10660,14 @@ export type UIPassthroughContractBase = {
|
|
|
9978
10660
|
Tabs: LiveboardTab[];
|
|
9979
10661
|
};
|
|
9980
10662
|
};
|
|
10663
|
+
[UIPassthroughEvent.GetGroups]: {
|
|
10664
|
+
request: Record<string, never>;
|
|
10665
|
+
response: {
|
|
10666
|
+
orderedGroupIds: string[];
|
|
10667
|
+
numberOfGroups: number;
|
|
10668
|
+
Groups: LiveboardGroup[];
|
|
10669
|
+
};
|
|
10670
|
+
};
|
|
9981
10671
|
[UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
|
|
9982
10672
|
request: Record<string, never>;
|
|
9983
10673
|
response: {
|
|
@@ -9989,18 +10679,8 @@ export type UIPassthroughContractBase = {
|
|
|
9989
10679
|
};
|
|
9990
10680
|
[UIPassthroughEvent.UpdateFilters]: {
|
|
9991
10681
|
request: {
|
|
9992
|
-
filter?:
|
|
9993
|
-
|
|
9994
|
-
oper: string;
|
|
9995
|
-
values: string[];
|
|
9996
|
-
type?: string;
|
|
9997
|
-
};
|
|
9998
|
-
filters?: {
|
|
9999
|
-
column: string;
|
|
10000
|
-
oper: string;
|
|
10001
|
-
values: string[];
|
|
10002
|
-
type?: string;
|
|
10003
|
-
}[];
|
|
10682
|
+
filter?: FilterUpdate;
|
|
10683
|
+
filters?: FilterUpdate[];
|
|
10004
10684
|
};
|
|
10005
10685
|
response: unknown;
|
|
10006
10686
|
};
|
|
@@ -10033,6 +10713,7 @@ export type EmbedApiHostEventMapping = {
|
|
|
10033
10713
|
[HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
|
|
10034
10714
|
[HostEvent.GetTML]: UIPassthroughEvent.GetTML;
|
|
10035
10715
|
[HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
|
|
10716
|
+
[HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
|
|
10036
10717
|
[HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
|
|
10037
10718
|
};
|
|
10038
10719
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
@@ -10077,6 +10758,7 @@ declare class HostEventClient {
|
|
|
10077
10758
|
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
10078
10759
|
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
10079
10760
|
protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
|
|
10761
|
+
protected handleUpdateParametersEvent(payload: HostEventRequest<HostEvent.UpdateParameters>, context?: ContextType): Promise<any>;
|
|
10080
10762
|
protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
|
|
10081
10763
|
/**
|
|
10082
10764
|
* Dispatches a host event using the appropriate channel:
|
|
@@ -11133,6 +11815,41 @@ interface SearchOptions$1 {
|
|
|
11133
11815
|
*/
|
|
11134
11816
|
searchQuery: string;
|
|
11135
11817
|
}
|
|
11818
|
+
declare enum SpotterQueryMode {
|
|
11819
|
+
FAST_SEARCH = "fastSearch",
|
|
11820
|
+
RESEARCH = "research"
|
|
11821
|
+
}
|
|
11822
|
+
/**
|
|
11823
|
+
* Configuration for the pin/unpin conversation feature in the Spotter sidebar.
|
|
11824
|
+
* Grouped into one object because pin exposes several related settings
|
|
11825
|
+
* (enable + label overrides), unlike single-item actions like rename or
|
|
11826
|
+
* delete.
|
|
11827
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11828
|
+
*/
|
|
11829
|
+
export interface SpotterChatPinConfig {
|
|
11830
|
+
/**
|
|
11831
|
+
* Enables the pin/unpin conversation feature in embedded Spotter. Disabled
|
|
11832
|
+
* by default — hosts must opt in. When off, the Pin/Unpin menu entry and
|
|
11833
|
+
* the pin glyph are hidden and the PinSpotterConversation /
|
|
11834
|
+
* UnpinSpotterConversation host events are no-ops. Native (non-embedded)
|
|
11835
|
+
* Spotter is unaffected and ships pin enabled.
|
|
11836
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11837
|
+
* @default false
|
|
11838
|
+
*/
|
|
11839
|
+
enabled?: boolean;
|
|
11840
|
+
/**
|
|
11841
|
+
* Custom label text for the pin action in the conversation edit menu.
|
|
11842
|
+
* Defaults to translated "Pin" text.
|
|
11843
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11844
|
+
*/
|
|
11845
|
+
pinLabel?: string;
|
|
11846
|
+
/**
|
|
11847
|
+
* Custom label text for the unpin action in the conversation edit menu.
|
|
11848
|
+
* Defaults to translated "Unpin" text.
|
|
11849
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11850
|
+
*/
|
|
11851
|
+
unpinLabel?: string;
|
|
11852
|
+
}
|
|
11136
11853
|
/**
|
|
11137
11854
|
* Configuration for the Spotter sidebar.
|
|
11138
11855
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
@@ -11170,6 +11887,12 @@ export interface SpotterSidebarViewConfig {
|
|
|
11170
11887
|
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
11171
11888
|
*/
|
|
11172
11889
|
spotterChatDeleteLabel?: string;
|
|
11890
|
+
/**
|
|
11891
|
+
* Pin/unpin conversation feature config (enable + label overrides).
|
|
11892
|
+
* Off by default in embed — hosts opt in via `enabled`.
|
|
11893
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11894
|
+
*/
|
|
11895
|
+
spotterChatPinConfig?: SpotterChatPinConfig;
|
|
11173
11896
|
/**
|
|
11174
11897
|
* Custom title text for the delete conversation confirmation modal.
|
|
11175
11898
|
* Defaults to translated "Delete chat" text.
|
|
@@ -11220,6 +11943,84 @@ export interface SpotterSidebarViewConfig {
|
|
|
11220
11943
|
*/
|
|
11221
11944
|
spotterAnalystsLabel?: string;
|
|
11222
11945
|
}
|
|
11946
|
+
/**
|
|
11947
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
11948
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
11949
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11950
|
+
* @group Embed components
|
|
11951
|
+
*/
|
|
11952
|
+
export interface SpotterShareConversationConfig {
|
|
11953
|
+
/**
|
|
11954
|
+
* Enables sharing of the conversation.
|
|
11955
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11956
|
+
* @default false
|
|
11957
|
+
*/
|
|
11958
|
+
enableShareConversation?: boolean;
|
|
11959
|
+
/**
|
|
11960
|
+
* Header Share button + sidebar Share item label.
|
|
11961
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11962
|
+
* @default "Share"
|
|
11963
|
+
*/
|
|
11964
|
+
spotterShareLabel?: string;
|
|
11965
|
+
/**
|
|
11966
|
+
* Share modal title.
|
|
11967
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11968
|
+
*/
|
|
11969
|
+
spotterShareModalTitle?: string;
|
|
11970
|
+
/**
|
|
11971
|
+
* Modal confirm button label.
|
|
11972
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11973
|
+
* @default "Share"
|
|
11974
|
+
*/
|
|
11975
|
+
spotterShareConfirmLabel?: string;
|
|
11976
|
+
/**
|
|
11977
|
+
* Modal cancel button label.
|
|
11978
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11979
|
+
* @default "Cancel"
|
|
11980
|
+
*/
|
|
11981
|
+
spotterShareCancelLabel?: string;
|
|
11982
|
+
/**
|
|
11983
|
+
* "Add users or groups" label.
|
|
11984
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11985
|
+
*/
|
|
11986
|
+
spotterShareAddUsersLabel?: string;
|
|
11987
|
+
/**
|
|
11988
|
+
* Empty-state title ("No users added yet").
|
|
11989
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11990
|
+
*/
|
|
11991
|
+
spotterShareEmptyTitle?: string;
|
|
11992
|
+
/**
|
|
11993
|
+
* Empty-state subtitle ("Not shared with any user").
|
|
11994
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11995
|
+
*/
|
|
11996
|
+
spotterShareEmptySubtitle?: string;
|
|
11997
|
+
/**
|
|
11998
|
+
* "Include new messages since last shared version" checkbox label.
|
|
11999
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12000
|
+
*/
|
|
12001
|
+
spotterShareIncludeNewMessagesLabel?: string;
|
|
12002
|
+
/**
|
|
12003
|
+
* Footer note when the snapshot is current ("…up to the current moment…").
|
|
12004
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12005
|
+
*/
|
|
12006
|
+
spotterShareUpToCurrentLabel?: string;
|
|
12007
|
+
/**
|
|
12008
|
+
* Stale-snapshot info banner text ("All added users and groups will receive…").
|
|
12009
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12010
|
+
*/
|
|
12011
|
+
spotterShareStaleInfoLabel?: string;
|
|
12012
|
+
/**
|
|
12013
|
+
* Read-only shared-view data-access banner message.
|
|
12014
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12015
|
+
*/
|
|
12016
|
+
spotterSharedConversationBannerMessage?: string;
|
|
12017
|
+
/**
|
|
12018
|
+
* Read-only shared-view Exit button label.
|
|
12019
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12020
|
+
* @default "Exit"
|
|
12021
|
+
*/
|
|
12022
|
+
spotterSharedConversationExitLabel?: string;
|
|
12023
|
+
}
|
|
11223
12024
|
/**
|
|
11224
12025
|
* Configuration for customizing Spotter chat UI branding.
|
|
11225
12026
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
@@ -11274,8 +12075,27 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11274
12075
|
/**
|
|
11275
12076
|
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
11276
12077
|
* this object to query data and generate Answers.
|
|
12078
|
+
* This field is optional. If not provided, Spotter loads using the
|
|
12079
|
+
* previously selected user data source.
|
|
11277
12080
|
*/
|
|
11278
|
-
worksheetId
|
|
12081
|
+
worksheetId?: string;
|
|
12082
|
+
/**
|
|
12083
|
+
* The array of data source GUIDs to set on load. Spotter uses
|
|
12084
|
+
* these GUIDs to query data and generate Answers.
|
|
12085
|
+
* dataSources is preferred over worksheetId if both are provided.
|
|
12086
|
+
* The feature is currently behind a feature flag.
|
|
12087
|
+
*
|
|
12088
|
+
* Supported embed types: `SpotterEmbed`
|
|
12089
|
+
* @example
|
|
12090
|
+
* ```js
|
|
12091
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12092
|
+
* // ...other embed view config
|
|
12093
|
+
* dataSources: ['id-2345', 'id-2345'],
|
|
12094
|
+
* });
|
|
12095
|
+
* ```
|
|
12096
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12097
|
+
*/
|
|
12098
|
+
dataSources?: string[];
|
|
11279
12099
|
/**
|
|
11280
12100
|
* Ability to pass a starting search query to the conversation.
|
|
11281
12101
|
*/
|
|
@@ -11435,6 +12255,39 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11435
12255
|
* ```
|
|
11436
12256
|
*/
|
|
11437
12257
|
updatedSpotterChatPrompt?: boolean;
|
|
12258
|
+
/**
|
|
12259
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
12260
|
+
*
|
|
12261
|
+
* Supported embed types: `SpotterEmbed`
|
|
12262
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12263
|
+
* @default false
|
|
12264
|
+
* @example
|
|
12265
|
+
* ```js
|
|
12266
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12267
|
+
* ... //other embed view config
|
|
12268
|
+
* showSpotterRadiance : true,
|
|
12269
|
+
* })
|
|
12270
|
+
* ```
|
|
12271
|
+
*/
|
|
12272
|
+
showSpotterRadiance?: boolean;
|
|
12273
|
+
/**
|
|
12274
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
12275
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
12276
|
+
* instance only; it does not persist as a user preference and does
|
|
12277
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
12278
|
+
*
|
|
12279
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
12280
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12281
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
12282
|
+
* @example
|
|
12283
|
+
* ```js
|
|
12284
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12285
|
+
* ... //other embed view config
|
|
12286
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
12287
|
+
* })
|
|
12288
|
+
* ```
|
|
12289
|
+
*/
|
|
12290
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
11438
12291
|
/**
|
|
11439
12292
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
11440
12293
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -11493,6 +12346,59 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11493
12346
|
* ```
|
|
11494
12347
|
*/
|
|
11495
12348
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
12349
|
+
/**
|
|
12350
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
12351
|
+
*
|
|
12352
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
12353
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12354
|
+
* @example
|
|
12355
|
+
* ```js
|
|
12356
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12357
|
+
* ... //other embed view config
|
|
12358
|
+
* spotterShareConversationConfig: {
|
|
12359
|
+
* enableShareConversation: true,
|
|
12360
|
+
* },
|
|
12361
|
+
* })
|
|
12362
|
+
* ```
|
|
12363
|
+
*/
|
|
12364
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
12365
|
+
/**
|
|
12366
|
+
* The ID of a shared Spotter conversation to open directly in the read-only
|
|
12367
|
+
* reader view. Use this to land a share recipient in the shared conversation
|
|
12368
|
+
* when they open a host-configured `CONVERSATION_URL` share link: read the
|
|
12369
|
+
* `{conversation-id}` from your page URL and pass it here.
|
|
12370
|
+
*
|
|
12371
|
+
* Requires the Spotter conversation-sharing feature to be enabled
|
|
12372
|
+
* (`spotterShareConversationConfig.enableShareConversation`). The recipient
|
|
12373
|
+
* must be an authorized sharee — the server returns access-denied otherwise.
|
|
12374
|
+
*
|
|
12375
|
+
* Supported embed types: `SpotterEmbed`
|
|
12376
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12377
|
+
* @example
|
|
12378
|
+
* ```js
|
|
12379
|
+
* const convId = new URLSearchParams(window.location.search).get('conversation-id');
|
|
12380
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12381
|
+
* ... //other embed view config
|
|
12382
|
+
* sharedConversationId: convId,
|
|
12383
|
+
* })
|
|
12384
|
+
* ```
|
|
12385
|
+
*/
|
|
12386
|
+
sharedConversationId?: string;
|
|
12387
|
+
/**
|
|
12388
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
12389
|
+
*
|
|
12390
|
+
* Supported embed types: `SpotterEmbed`
|
|
12391
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12392
|
+
* @default false
|
|
12393
|
+
* @example
|
|
12394
|
+
* ```js
|
|
12395
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12396
|
+
* ... //other embed view config
|
|
12397
|
+
* updatedSpotterExperience : true,
|
|
12398
|
+
* })
|
|
12399
|
+
* ```
|
|
12400
|
+
*/
|
|
12401
|
+
updatedSpotterExperience?: boolean;
|
|
11496
12402
|
}
|
|
11497
12403
|
/**
|
|
11498
12404
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -11509,6 +12415,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
11509
12415
|
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
11510
12416
|
embedParams?: {
|
|
11511
12417
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
12418
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
11512
12419
|
visualOverridesParams?: VisualizationOverrides | null;
|
|
11513
12420
|
};
|
|
11514
12421
|
}
|
|
@@ -11573,6 +12480,12 @@ export interface SpotterVizStarterPrompt {
|
|
|
11573
12480
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
11574
12481
|
* { label: 'Tip', text: 'use natural language' },
|
|
11575
12482
|
* ],
|
|
12483
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12484
|
+
* liveboardBrandName: 'Reports',
|
|
12485
|
+
* spotterBrandName: 'Analyst',
|
|
12486
|
+
* insightTileBrandName: 'Insight card',
|
|
12487
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
12488
|
+
* insightTileLoaderText: 'Generating insight',
|
|
11576
12489
|
* },
|
|
11577
12490
|
* })
|
|
11578
12491
|
* ```
|
|
@@ -11629,6 +12542,34 @@ export interface SpotterVizConfig {
|
|
|
11629
12542
|
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
|
|
11630
12543
|
*/
|
|
11631
12544
|
loaderTips?: SpotterVizLoaderTip[];
|
|
12545
|
+
/**
|
|
12546
|
+
* Custom term used to replace "Liveboard" in the agent's responses.
|
|
12547
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12548
|
+
* @default ''
|
|
12549
|
+
*/
|
|
12550
|
+
liveboardBrandName?: string;
|
|
12551
|
+
/**
|
|
12552
|
+
* Custom term used to replace "Spotter" in the agent's responses.
|
|
12553
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12554
|
+
* @default ''
|
|
12555
|
+
*/
|
|
12556
|
+
spotterBrandName?: string;
|
|
12557
|
+
/**
|
|
12558
|
+
* Custom term used to replace "Insight tile" in the UI and in the agent's responses.
|
|
12559
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12560
|
+
* @default ''
|
|
12561
|
+
*/
|
|
12562
|
+
insightTileBrandName?: string;
|
|
12563
|
+
/**
|
|
12564
|
+
* Custom term used to replace "View plan" in the insight tile menu.
|
|
12565
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12566
|
+
*/
|
|
12567
|
+
insightTileViewPlanLabel?: string;
|
|
12568
|
+
/**
|
|
12569
|
+
* Custom loader text shown on the insight tile.
|
|
12570
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12571
|
+
*/
|
|
12572
|
+
insightTileLoaderText?: string;
|
|
11632
12573
|
}
|
|
11633
12574
|
/**
|
|
11634
12575
|
* A single tip shown in the SpotterViz loading state.
|
|
@@ -11676,7 +12617,11 @@ export declare enum Page {
|
|
|
11676
12617
|
/**
|
|
11677
12618
|
* Monitor Alerts Page
|
|
11678
12619
|
*/
|
|
11679
|
-
Monitor = "monitor"
|
|
12620
|
+
Monitor = "monitor",
|
|
12621
|
+
/**
|
|
12622
|
+
* Collections listing page
|
|
12623
|
+
*/
|
|
12624
|
+
Collections = "collections"
|
|
11680
12625
|
}
|
|
11681
12626
|
/**
|
|
11682
12627
|
* Define the initial state of column custom group accordions
|
|
@@ -11713,6 +12658,9 @@ declare enum HomePage {
|
|
|
11713
12658
|
/**
|
|
11714
12659
|
* Modular (v2) introduces the updated Modular Home Experience.
|
|
11715
12660
|
* It serves as the foundational version of the home page.
|
|
12661
|
+
* Use {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
12662
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
12663
|
+
* @deprecated V1 and V2 home page experiences are deprecated.
|
|
11716
12664
|
*/
|
|
11717
12665
|
Modular = "v2",
|
|
11718
12666
|
/**
|
|
@@ -11782,13 +12730,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11782
12730
|
showPrimaryNavbar?: boolean;
|
|
11783
12731
|
/**
|
|
11784
12732
|
* Control the visibility of the left navigation panel on the home page
|
|
11785
|
-
* in the
|
|
12733
|
+
* in the V3 and V4 navigation and home page experience.
|
|
11786
12734
|
* If `showPrimaryNavbar` is true, that is, if the Global and Homepage
|
|
11787
12735
|
* navigation bars are visible, this flag will only hide the left navigation bar
|
|
11788
12736
|
* on the home page.
|
|
11789
12737
|
* The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
|
|
11790
12738
|
*
|
|
11791
|
-
* **Note**:
|
|
12739
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
12740
|
+
* deprecated. This attribute applies to V3 and V4 home page experiences.
|
|
11792
12741
|
*
|
|
11793
12742
|
* Supported embed types: `AppEmbed`
|
|
11794
12743
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11854,11 +12803,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11854
12803
|
hideHamburger?: boolean;
|
|
11855
12804
|
/**
|
|
11856
12805
|
* Control the visibility of the object search
|
|
11857
|
-
* on the top navigation bar in the
|
|
11858
|
-
* V2 and V3 navigation experience.
|
|
12806
|
+
* on the top navigation bar in the V3 navigation experience.
|
|
11859
12807
|
*
|
|
11860
|
-
* **Note**:
|
|
11861
|
-
*
|
|
12808
|
+
* **Note**: The classic (V1) and V2 navigation experiences are
|
|
12809
|
+
* deprecated. This attribute applies to the V3 navigation experience.
|
|
11862
12810
|
*
|
|
11863
12811
|
* Supported embed types: `AppEmbed`
|
|
11864
12812
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -11876,8 +12824,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11876
12824
|
* Control the visibility of the notification icon
|
|
11877
12825
|
* on the top navigation bar in V3 navigation experience.
|
|
11878
12826
|
*
|
|
11879
|
-
* **Note**:
|
|
11880
|
-
*
|
|
12827
|
+
* **Note**: The classic (V1) and V2 experience modes are deprecated.
|
|
12828
|
+
* This attribute applies to the V3 experience.
|
|
11881
12829
|
*
|
|
11882
12830
|
* Supported embed types: `AppEmbed`
|
|
11883
12831
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -11892,14 +12840,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11892
12840
|
*/
|
|
11893
12841
|
hideNotification?: boolean;
|
|
11894
12842
|
/**
|
|
11895
|
-
* Control the visibility of the application selection menu
|
|
11896
|
-
* in the top navigation bar in the V2 experience.
|
|
12843
|
+
* Control the visibility of the application selection menu.
|
|
11897
12844
|
* In the V3 experience, it shows or hides application selection
|
|
11898
12845
|
* icons on the left navigation panel.
|
|
11899
12846
|
* By default, the application selection menu and icons are
|
|
11900
12847
|
* shown in the UI.
|
|
11901
12848
|
*
|
|
11902
|
-
* **Note**:
|
|
12849
|
+
* **Note**: The classic (V1) and V2 experiences are deprecated.
|
|
12850
|
+
* This attribute applies to the V3 experience.
|
|
11903
12851
|
*
|
|
11904
12852
|
* Supported embed types: `AppEmbed`
|
|
11905
12853
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11917,7 +12865,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11917
12865
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
11918
12866
|
* By default, the Org switcher button is shown.
|
|
11919
12867
|
*
|
|
11920
|
-
* **Note**:
|
|
12868
|
+
* **Note**: The classic (V1) experience is deprecated. This attribute
|
|
12869
|
+
* applies to V2 (deprecated), V3 and V4 experiences.
|
|
11921
12870
|
*
|
|
11922
12871
|
* Supported embed types: `AppEmbed`
|
|
11923
12872
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -12076,6 +13025,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12076
13025
|
* Supported embed types: `AppEmbed`
|
|
12077
13026
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
12078
13027
|
* @default false
|
|
13028
|
+
* Use the discoveryExperience.homePage option with
|
|
13029
|
+
* {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
13030
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
13031
|
+
* @deprecated The V1 and V2 home page experiences are deprecated.
|
|
12079
13032
|
* @example
|
|
12080
13033
|
* ```js
|
|
12081
13034
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -12207,11 +13160,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12207
13160
|
/**
|
|
12208
13161
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
12209
13162
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
12210
|
-
* This feature is GA from version
|
|
13163
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
12211
13164
|
*
|
|
12212
13165
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12213
13166
|
* @type {boolean}
|
|
12214
13167
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
13168
|
+
* @default true
|
|
12215
13169
|
* @example
|
|
12216
13170
|
* ```js
|
|
12217
13171
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12224,10 +13178,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12224
13178
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
12225
13179
|
/**
|
|
12226
13180
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
13181
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
12227
13182
|
*
|
|
12228
13183
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12229
13184
|
* @type {boolean}
|
|
12230
13185
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
13186
|
+
* @default true
|
|
12231
13187
|
* @example
|
|
12232
13188
|
* ```js
|
|
12233
13189
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12240,10 +13196,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12240
13196
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
12241
13197
|
/**
|
|
12242
13198
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
13199
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
12243
13200
|
*
|
|
12244
13201
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12245
13202
|
* @type {boolean}
|
|
12246
13203
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
13204
|
+
* @default true
|
|
12247
13205
|
* @example
|
|
12248
13206
|
* ```js
|
|
12249
13207
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12319,6 +13277,40 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12319
13277
|
* ```
|
|
12320
13278
|
*/
|
|
12321
13279
|
updatedSpotterChatPrompt?: boolean;
|
|
13280
|
+
/**
|
|
13281
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
13282
|
+
*
|
|
13283
|
+
* Supported embed types: `AppEmbed`
|
|
13284
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13285
|
+
* @default false
|
|
13286
|
+
* @example
|
|
13287
|
+
* ```js
|
|
13288
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13289
|
+
* ... //other embed view config
|
|
13290
|
+
* showSpotterRadiance : true,
|
|
13291
|
+
* })
|
|
13292
|
+
* ```
|
|
13293
|
+
*/
|
|
13294
|
+
showSpotterRadiance?: boolean;
|
|
13295
|
+
/**
|
|
13296
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
13297
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
13298
|
+
* instance only; it does not persist as a user preference and does
|
|
13299
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
13300
|
+
* Only applicable when navigating to Spotter within the app.
|
|
13301
|
+
*
|
|
13302
|
+
* Supported embed types: `AppEmbed`
|
|
13303
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13304
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
13305
|
+
* @example
|
|
13306
|
+
* ```js
|
|
13307
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13308
|
+
* ... //other embed view config
|
|
13309
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
13310
|
+
* })
|
|
13311
|
+
* ```
|
|
13312
|
+
*/
|
|
13313
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
12322
13314
|
/**
|
|
12323
13315
|
* Controls the visibility of the past conversations sidebar.
|
|
12324
13316
|
*
|
|
@@ -12344,6 +13336,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12344
13336
|
* spotterSidebarConfig: {
|
|
12345
13337
|
* enablePastConversationsSidebar: true,
|
|
12346
13338
|
* spotterSidebarTitle: 'My Conversations',
|
|
13339
|
+
* // Opt in to pin/unpin conversations in embedded Spotter
|
|
13340
|
+
* spotterChatPinConfig: {
|
|
13341
|
+
* enabled: true,
|
|
13342
|
+
* },
|
|
12347
13343
|
* },
|
|
12348
13344
|
* })
|
|
12349
13345
|
* ```
|
|
@@ -12367,6 +13363,49 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12367
13363
|
* ```
|
|
12368
13364
|
*/
|
|
12369
13365
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
13366
|
+
/**
|
|
13367
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
13368
|
+
*
|
|
13369
|
+
* Supported embed types: `AppEmbed`
|
|
13370
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13371
|
+
* @example
|
|
13372
|
+
* ```js
|
|
13373
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13374
|
+
* ... //other embed view config
|
|
13375
|
+
* spotterShareConversationConfig: {
|
|
13376
|
+
* enableShareConversation: true,
|
|
13377
|
+
* },
|
|
13378
|
+
* })
|
|
13379
|
+
* ```
|
|
13380
|
+
*/
|
|
13381
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
13382
|
+
/**
|
|
13383
|
+
* Sets the default data sources (Models) for the Spotter experience shown on
|
|
13384
|
+
* the home page of the full app embed. Accepts a list of Model GUIDs to
|
|
13385
|
+
* preselect the data sources available to Spotter, or the literal
|
|
13386
|
+
* `'auto_mode'` sentinel to load Spotter with the "Auto" model selected by
|
|
13387
|
+
* default. This is consistent with how `worksheetId: 'auto_mode'` enables
|
|
13388
|
+
* Auto mode in `SpotterEmbed`.
|
|
13389
|
+
*
|
|
13390
|
+
* **Note**: If `'auto_mode'` is included alongside one or more Model GUIDs,
|
|
13391
|
+
* `'auto_mode'` takes precedence and is selected by default.
|
|
13392
|
+
*
|
|
13393
|
+
* **Note**: `'auto_mode'` requires the Spotter 3 experience with data source
|
|
13394
|
+
* discovery enabled on your instance, and a Spotter-enabled home page (for
|
|
13395
|
+
* example, `discoveryExperience.homePage: HomePage.Focused`).
|
|
13396
|
+
*
|
|
13397
|
+
* Supported embed types: `AppEmbed`
|
|
13398
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
13399
|
+
* @example
|
|
13400
|
+
* ```js
|
|
13401
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13402
|
+
* ... // other embed view config
|
|
13403
|
+
* discoveryExperience: { homePage: HomePage.Focused },
|
|
13404
|
+
* spotterDataSources: ['model-guid-1', 'model-guid-2'], // or ['auto_mode']
|
|
13405
|
+
* })
|
|
13406
|
+
* ```
|
|
13407
|
+
*/
|
|
13408
|
+
spotterDataSources?: string[];
|
|
12370
13409
|
/**
|
|
12371
13410
|
* Configuration for the SpotterViz interface shown on the Liveboard.
|
|
12372
13411
|
* Customize the brand name, description, chat input placeholder,
|
|
@@ -12391,6 +13430,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12391
13430
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
12392
13431
|
* { label: 'Tip', text: 'use natural language' },
|
|
12393
13432
|
* ],
|
|
13433
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13434
|
+
* liveboardBrandName: 'Reports',
|
|
13435
|
+
* spotterBrandName: 'Analyst',
|
|
13436
|
+
* insightTileBrandName: 'Insight card',
|
|
13437
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
13438
|
+
* insightTileLoaderText: 'Generating insight',
|
|
12394
13439
|
* },
|
|
12395
13440
|
* })
|
|
12396
13441
|
* ```
|
|
@@ -12456,6 +13501,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12456
13501
|
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
12457
13502
|
*/
|
|
12458
13503
|
visualOverrides?: VisualizationOverrides;
|
|
13504
|
+
/**
|
|
13505
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
13506
|
+
*
|
|
13507
|
+
* Supported embed types: `AppEmbed`
|
|
13508
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13509
|
+
* @default false
|
|
13510
|
+
* @example
|
|
13511
|
+
* ```js
|
|
13512
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13513
|
+
* ... //other embed view config
|
|
13514
|
+
* updatedSpotterExperience : true,
|
|
13515
|
+
* })
|
|
13516
|
+
* ```
|
|
13517
|
+
*/
|
|
13518
|
+
updatedSpotterExperience?: boolean;
|
|
12459
13519
|
}
|
|
12460
13520
|
/**
|
|
12461
13521
|
* APP_INIT data shape for AppEmbed.
|
|
@@ -12465,6 +13525,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
|
12465
13525
|
embedParams?: {
|
|
12466
13526
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
12467
13527
|
spotterVizConfig?: SpotterVizConfig;
|
|
13528
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
12468
13529
|
};
|
|
12469
13530
|
}
|
|
12470
13531
|
declare class AppEmbed extends V1Embed {
|
|
@@ -12491,6 +13552,7 @@ declare class AppEmbed extends V1Embed {
|
|
|
12491
13552
|
* embedded Liveboard or visualization.
|
|
12492
13553
|
*/
|
|
12493
13554
|
protected getEmbedParams(): string;
|
|
13555
|
+
protected getEmbedParamsObject(): any;
|
|
12494
13556
|
private sendFullHeightLazyLoadData;
|
|
12495
13557
|
/**
|
|
12496
13558
|
* This is a handler for the RequestVisibleEmbedCoordinates event.
|
|
@@ -12915,11 +13977,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12915
13977
|
/**
|
|
12916
13978
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
12917
13979
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
12918
|
-
* This feature is GA from version
|
|
13980
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
12919
13981
|
*
|
|
12920
13982
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12921
13983
|
* @type {boolean}
|
|
12922
13984
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
13985
|
+
* @default true
|
|
12923
13986
|
* @example
|
|
12924
13987
|
* ```js
|
|
12925
13988
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12932,10 +13995,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12932
13995
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
12933
13996
|
/**
|
|
12934
13997
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
13998
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
|
|
12935
13999
|
*
|
|
12936
14000
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12937
14001
|
* @type {boolean}
|
|
12938
14002
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
14003
|
+
* @default true
|
|
12939
14004
|
* @example
|
|
12940
14005
|
* ```js
|
|
12941
14006
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12948,10 +14013,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12948
14013
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
12949
14014
|
/**
|
|
12950
14015
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
14016
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
|
|
12951
14017
|
*
|
|
12952
14018
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12953
14019
|
* @type {boolean}
|
|
12954
14020
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
14021
|
+
* @default true
|
|
12955
14022
|
* @example
|
|
12956
14023
|
* ```js
|
|
12957
14024
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -13042,6 +14109,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13042
14109
|
* ```
|
|
13043
14110
|
*/
|
|
13044
14111
|
updatedSpotterChatPrompt?: boolean;
|
|
14112
|
+
/**
|
|
14113
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
14114
|
+
*
|
|
14115
|
+
* Supported embed types: `LiveboardEmbed`
|
|
14116
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14117
|
+
* @default false
|
|
14118
|
+
* @example
|
|
14119
|
+
* ```js
|
|
14120
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
14121
|
+
* ... //other embed view config
|
|
14122
|
+
* showSpotterRadiance : true,
|
|
14123
|
+
* })
|
|
14124
|
+
* ```
|
|
14125
|
+
*/
|
|
14126
|
+
showSpotterRadiance?: boolean;
|
|
13045
14127
|
/**
|
|
13046
14128
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
13047
14129
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -13093,6 +14175,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13093
14175
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
13094
14176
|
* { label: 'Tip', text: 'use natural language' },
|
|
13095
14177
|
* ],
|
|
14178
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14179
|
+
* liveboardBrandName: 'Reports',
|
|
14180
|
+
* spotterBrandName: 'Analyst',
|
|
14181
|
+
* insightTileBrandName: 'Insight card',
|
|
14182
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
14183
|
+
* insightTileLoaderText: 'Generating insight',
|
|
13096
14184
|
* },
|
|
13097
14185
|
* })
|
|
13098
14186
|
* ```
|
|
@@ -13111,6 +14199,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13111
14199
|
* ```
|
|
13112
14200
|
*/
|
|
13113
14201
|
enableLiveboardDataCache?: boolean;
|
|
14202
|
+
/**
|
|
14203
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
14204
|
+
*
|
|
14205
|
+
* Supported embed types: `LiveboardEmbed`
|
|
14206
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14207
|
+
* @default false
|
|
14208
|
+
* @example
|
|
14209
|
+
* ```js
|
|
14210
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
14211
|
+
* ... //other embed view config
|
|
14212
|
+
* updatedSpotterExperience : true,
|
|
14213
|
+
* })
|
|
14214
|
+
* ```
|
|
14215
|
+
*/
|
|
14216
|
+
updatedSpotterExperience?: boolean;
|
|
13114
14217
|
}
|
|
13115
14218
|
declare class LiveboardEmbed extends V1Embed {
|
|
13116
14219
|
protected viewConfig: LiveboardViewConfig;
|