@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test
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/config.d.ts +1 -0
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +2 -1
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/css-variables.d.ts +122 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +176 -24
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +86 -38
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +672 -150
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +1 -1
- package/cjs/src/embed/base.js +1 -1
- package/cjs/src/embed/conversation.d.ts +401 -2
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +32 -16
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +346 -17
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +638 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +187 -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 +2 -1
- 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 +236 -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 +81 -13
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +50 -9
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +432 -4
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +15 -1
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +28 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +129 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.d.ts +37 -4
- 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 +16 -8
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +96 -37
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +683 -3
- 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 +3 -3
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +4 -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/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +2 -1
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
- package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
- package/cjs/src/react/all-types-export.parity.spec.js +194 -0
- package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
- package/cjs/src/react/index.d.ts +66 -32
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +5 -3
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +101 -0
- package/cjs/src/react/index.spec.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 +902 -28
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +701 -14
- 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/cjs/src/utils.spec.js +4 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-B5xoN6Cp.js → index-Bivg-mDx.js} +1 -1
- package/dist/src/config.d.ts +1 -0
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +122 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +176 -24
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/conversation.d.ts +401 -2
- 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 +2 -1
- 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 +81 -13
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +15 -1
- package/dist/src/embed/spotter-utils.d.ts.map +1 -1
- package/dist/src/embed/spotter-viz-utils.d.ts +37 -4
- package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +16 -8
- 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 +3 -3
- 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/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
- package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
- package/dist/src/react/index.d.ts +66 -32
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +902 -28
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +1269 -206
- package/dist/tsembed-react.js +1268 -205
- package/dist/tsembed.es.js +1364 -304
- package/dist/tsembed.js +1362 -302
- package/dist/visual-embed-sdk-react-full.d.ts +1867 -157
- package/dist/visual-embed-sdk-react.d.ts +1872 -161
- package/dist/visual-embed-sdk.d.ts +1815 -127
- package/lib/package.json +1 -1
- package/lib/src/config.d.ts +1 -0
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +1 -0
- package/lib/src/config.js.map +1 -1
- package/lib/src/css-variables.d.ts +122 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +176 -24
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +87 -39
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +673 -151
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.js +1 -1
- package/lib/src/embed/conversation.d.ts +401 -2
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +33 -17
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +347 -18
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +638 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +188 -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 +2 -1
- 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 +236 -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 +81 -13
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +50 -9
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +432 -4
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +15 -1
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +25 -0
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +130 -1
- package/lib/src/embed/spotter-utils.spec.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.d.ts +37 -4
- 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 +16 -8
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +96 -37
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +683 -3
- 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 +3 -3
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +3 -3
- 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/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
- package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
- package/lib/src/react/all-types-export.parity.spec.js +191 -0
- package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
- package/lib/src/react/index.d.ts +66 -32
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +5 -3
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +102 -1
- package/lib/src/react/index.spec.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 +902 -28
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +701 -14
- 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/utils.spec.js +4 -0
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +1815 -127
- package/package.json +1 -1
- package/src/config.ts +1 -0
- package/src/css-variables.ts +150 -0
- package/src/embed/app.spec.ts +877 -196
- package/src/embed/app.ts +276 -75
- package/src/embed/base.ts +1 -1
- package/src/embed/conversation.spec.ts +411 -21
- package/src/embed/conversation.ts +441 -18
- package/src/embed/events.spec.ts +761 -1
- package/src/embed/host-events.spec.ts +242 -0
- package/src/embed/hostEventClient/contracts.ts +57 -14
- package/src/embed/hostEventClient/host-event-client.spec.ts +372 -0
- package/src/embed/hostEventClient/host-event-client.ts +18 -2
- package/src/embed/hostEventClient/utils.spec.ts +204 -0
- package/src/embed/hostEventClient/utils.ts +37 -10
- package/src/embed/liveboard.spec.ts +565 -4
- package/src/embed/liveboard.ts +155 -28
- package/src/embed/spotter-utils.spec.ts +140 -1
- package/src/embed/spotter-utils.ts +36 -1
- package/src/embed/spotter-viz-utils.spec.ts +17 -0
- package/src/embed/spotter-viz-utils.ts +37 -4
- package/src/embed/ts-embed.spec.ts +885 -3
- package/src/embed/ts-embed.ts +111 -39
- package/src/errors.ts +1 -0
- package/src/index.ts +45 -2
- package/src/mixpanel-service.ts +4 -0
- package/src/react/all-types-export.parity.spec.ts +208 -0
- package/src/react/all-types-export.ts +22 -0
- package/src/react/index.spec.tsx +158 -0
- package/src/react/index.tsx +70 -33
- package/src/react/util.spec.tsx +255 -0
- package/src/types.ts +904 -24
- package/src/utils/processData.spec.ts +97 -0
- package/src/utils/processTrigger.spec.ts +91 -0
- package/src/utils.spec.ts +5 -0
|
@@ -39,6 +39,42 @@ export interface CustomCssVariables {
|
|
|
39
39
|
* Font color of the top navigation panel.
|
|
40
40
|
*/
|
|
41
41
|
"--ts-var-nav-color"?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Background color of the left navigation panel.
|
|
44
|
+
*/
|
|
45
|
+
"--ts-var-left-nav-background"?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Background color of the active tab in the left navigation panel.
|
|
48
|
+
*/
|
|
49
|
+
"--ts-var-left-nav-active-tab-background"?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Border color of the active tab in the left navigation panel.
|
|
52
|
+
*/
|
|
53
|
+
"--ts-var-left-nav-active-tab-border-color"?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Font color of the section title in the left navigation panel.
|
|
56
|
+
*/
|
|
57
|
+
"--ts-var-left-nav-section-title-color"?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Font color of the items in the left navigation panel.
|
|
60
|
+
*/
|
|
61
|
+
"--ts-var-left-nav-item-color"?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Font color of the selected item in the left navigation panel.
|
|
64
|
+
*/
|
|
65
|
+
"--ts-var-left-nav-item-selection-color"?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Background color of the selected item in the left navigation panel.
|
|
68
|
+
*/
|
|
69
|
+
"--ts-var-left-nav-item-selection-background"?: string;
|
|
70
|
+
/**
|
|
71
|
+
* Color of the active tab icon in the left navigation panel.
|
|
72
|
+
*/
|
|
73
|
+
"--ts-var-left-nav-tab-icon-active-color"?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Color of the inactive tab icon in the left navigation panel.
|
|
76
|
+
*/
|
|
77
|
+
"--ts-var-left-nav-tab-icon-inactive-color"?: string;
|
|
42
78
|
/**
|
|
43
79
|
* Background color of the *Search data* button.
|
|
44
80
|
*/
|
|
@@ -403,6 +439,13 @@ export interface CustomCssVariables {
|
|
|
403
439
|
* Font color of the header in the Liveboard.
|
|
404
440
|
*/
|
|
405
441
|
"--ts-var-liveboard-header-font-color"?: string;
|
|
442
|
+
/**
|
|
443
|
+
* Left and right margin of the header and the tab/filter section of an
|
|
444
|
+
* embedded Liveboard. Use alongside the `liveboardGutter` view config to
|
|
445
|
+
* keep the header aligned with a custom tile-grid gutter.
|
|
446
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
447
|
+
*/
|
|
448
|
+
"--ts-var-liveboard-header-horizontal-margin"?: string;
|
|
406
449
|
/**
|
|
407
450
|
* Border color of the tiles in the Liveboard.
|
|
408
451
|
*/
|
|
@@ -411,6 +454,26 @@ export interface CustomCssVariables {
|
|
|
411
454
|
* Background color of the tiles in the Liveboard.
|
|
412
455
|
*/
|
|
413
456
|
"--ts-var-liveboard-tile-background"?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Font color of the insight tiles in the Liveboard.
|
|
459
|
+
*/
|
|
460
|
+
"--ts-var-liveboard-insight-tile-font-color"?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Background color of the insight tiles in the Liveboard.
|
|
463
|
+
*/
|
|
464
|
+
"--ts-var-liveboard-insight-tile-background"?: string;
|
|
465
|
+
/**
|
|
466
|
+
* Icon color of the insight tiles in the Liveboard.
|
|
467
|
+
*/
|
|
468
|
+
"--ts-var-liveboard-insight-tile-icon-color"?: string;
|
|
469
|
+
/**
|
|
470
|
+
* Font color of the success text in the insight tiles in the Liveboard.
|
|
471
|
+
*/
|
|
472
|
+
"--ts-var-liveboard-insight-tile-success-color"?: string;
|
|
473
|
+
/**
|
|
474
|
+
* Font color of the failure text in the insight tiles in the Liveboard.
|
|
475
|
+
*/
|
|
476
|
+
"--ts-var-liveboard-insight-tile-failure-color"?: string;
|
|
414
477
|
/**
|
|
415
478
|
* Border radius of the tiles in the Liveboard.
|
|
416
479
|
*/
|
|
@@ -631,6 +694,14 @@ export interface CustomCssVariables {
|
|
|
631
694
|
* Font color of the parameter chips in the Liveboard on active.
|
|
632
695
|
*/
|
|
633
696
|
"--ts-var-parameter-chip-active-text-color"?: string;
|
|
697
|
+
/**
|
|
698
|
+
* Color of the dot indicator shown on a filter or parameter chip in the
|
|
699
|
+
* centralized filter modal on a Liveboard. The dot appears when the
|
|
700
|
+
* filter or parameter value has been modified but the changes are not
|
|
701
|
+
* yet applied to the Liveboard.
|
|
702
|
+
* @version SDK: 1.52.0 | ThoughtSpot: 26.10.0.cl
|
|
703
|
+
*/
|
|
704
|
+
"--ts-var-unsaved-filter-indicator-color"?: string;
|
|
634
705
|
/**
|
|
635
706
|
* Background color of the action button in the Liveboard header.
|
|
636
707
|
*/
|
|
@@ -959,6 +1030,10 @@ export interface CustomCssVariables {
|
|
|
959
1030
|
* header underline, left panel border, thinking step connector and dots.
|
|
960
1031
|
*/
|
|
961
1032
|
"--ts-var-spotterviz-border-color"?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Expanded user chat message bubble border color in SpotterViz.
|
|
1035
|
+
*/
|
|
1036
|
+
"--ts-var-spotterviz-expanded-border-color"?: string;
|
|
962
1037
|
/**
|
|
963
1038
|
* Background color of the reference-mode toggle button in the SpotterViz
|
|
964
1039
|
* chat input when it is unselected and the user hovers over it.
|
|
@@ -976,6 +1051,53 @@ export interface CustomCssVariables {
|
|
|
976
1051
|
* on each referenced-entity chip in the chat input.
|
|
977
1052
|
*/
|
|
978
1053
|
"--ts-var-spotterviz-reference-icon-selected-background"?: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* Background color of the shared conversation header (recipient's read-only view).
|
|
1056
|
+
*/
|
|
1057
|
+
"--ts-var-shared-conv-header-background"?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* Border color of the shared conversation header.
|
|
1060
|
+
*/
|
|
1061
|
+
"--ts-var-shared-conv-header-border-color"?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Font color of the title text in the shared conversation header.
|
|
1064
|
+
*/
|
|
1065
|
+
"--ts-var-shared-conv-title-color"?: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* Background gradient color-stop of the share chat header's outer container
|
|
1068
|
+
* (sender's pre-share header). Defaults to transparent.
|
|
1069
|
+
*/
|
|
1070
|
+
"--ts-var-share-chat-header-container-background"?: string;
|
|
1071
|
+
/**
|
|
1072
|
+
* Background color of the share chat header's inner title/actions row.
|
|
1073
|
+
* Defaults to transparent.
|
|
1074
|
+
*/
|
|
1075
|
+
"--ts-var-share-chat-header-background"?: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* Font color of the title text in the share chat header.
|
|
1078
|
+
*/
|
|
1079
|
+
"--ts-var-share-chat-header-title-color"?: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* Font color of the title input field in the share chat header.
|
|
1082
|
+
*/
|
|
1083
|
+
"--ts-var-share-chat-header-input-text-color"?: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* Background color of the title input field in the share chat header.
|
|
1086
|
+
*/
|
|
1087
|
+
"--ts-var-share-chat-header-input-background"?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Border color of the title input field in the share chat header.
|
|
1090
|
+
*/
|
|
1091
|
+
"--ts-var-share-chat-header-input-border-color"?: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* Background color of the shimmer loading effect. Also affects the
|
|
1094
|
+
* saved chats sidebar's new-chat shimmer, which shares the same style.
|
|
1095
|
+
*/
|
|
1096
|
+
"--ts-var-shimmer-background"?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
* Background color of the shimmer sweep animation's gradient mid-stop.
|
|
1099
|
+
*/
|
|
1100
|
+
"--ts-var-shimmer-sweep-background"?: string;
|
|
979
1101
|
}
|
|
980
1102
|
export interface SessionInterface {
|
|
981
1103
|
sessionId: string;
|
|
@@ -1339,7 +1461,9 @@ export declare enum AuthType {
|
|
|
1339
1461
|
}
|
|
1340
1462
|
/**
|
|
1341
1463
|
*
|
|
1342
|
-
* **Note**:
|
|
1464
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1465
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
|
|
1466
|
+
* V4 (Focused) home page experiences.
|
|
1343
1467
|
*
|
|
1344
1468
|
*/
|
|
1345
1469
|
export declare enum HomeLeftNavItem {
|
|
@@ -1405,7 +1529,14 @@ export declare enum HomeLeftNavItem {
|
|
|
1405
1529
|
* Available in the V3 navigation experience.
|
|
1406
1530
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1407
1531
|
*/
|
|
1408
|
-
Favorites = "favorites"
|
|
1532
|
+
Favorites = "favorites",
|
|
1533
|
+
/**
|
|
1534
|
+
* The *Collections* menu option in
|
|
1535
|
+
* the *Insights* left navigation panel.
|
|
1536
|
+
* Shown when collections are enabled on the cluster.
|
|
1537
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1538
|
+
*/
|
|
1539
|
+
Collections = "collections"
|
|
1409
1540
|
}
|
|
1410
1541
|
export type DOMSelector = string | HTMLElement;
|
|
1411
1542
|
/**
|
|
@@ -2021,6 +2152,85 @@ export interface FrameParams {
|
|
|
2021
2152
|
*/
|
|
2022
2153
|
[key: string]: string | number | boolean | undefined;
|
|
2023
2154
|
}
|
|
2155
|
+
/**
|
|
2156
|
+
* Configuration for the pre-render wrapper element.
|
|
2157
|
+
* All properties here mirror the top-level preRender properties on
|
|
2158
|
+
* {@link BaseViewConfig} and take precedence over them when both are set,
|
|
2159
|
+
* so existing top-level usage continues to work without any changes.
|
|
2160
|
+
*
|
|
2161
|
+
* @version SDK: 1.52.0
|
|
2162
|
+
* @example
|
|
2163
|
+
* ```js
|
|
2164
|
+
* init({ thoughtSpotHost: '...', authType: AuthType.None });
|
|
2165
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2166
|
+
* preRenderConfig: {
|
|
2167
|
+
* preRenderId: 'my-liveboard',
|
|
2168
|
+
* preRenderContainer: '#my-scroll-container',
|
|
2169
|
+
* doNotTrackPreRenderSize: false,
|
|
2170
|
+
* zIndex: -10,
|
|
2171
|
+
* },
|
|
2172
|
+
* });
|
|
2173
|
+
* embed.preRender();
|
|
2174
|
+
* embed.showPreRender();
|
|
2175
|
+
* ```
|
|
2176
|
+
*/
|
|
2177
|
+
export interface PreRenderConfig {
|
|
2178
|
+
/**
|
|
2179
|
+
* Pre-render ID to identify the pre-render instance.
|
|
2180
|
+
* Takes precedence over the top-level `preRenderId` when both are set.
|
|
2181
|
+
*
|
|
2182
|
+
* Matches the embed warmed by `preRender()` to the one revealed by
|
|
2183
|
+
* `showPreRender()`. Embeds sharing an ID share one loaded frame: reuse the ID for
|
|
2184
|
+
* the same view, and give unrelated views their own or they will collide.
|
|
2185
|
+
* Required by `preRender()`, `showPreRender()`, and `hidePreRender()`, which log
|
|
2186
|
+
* and do nothing without it.
|
|
2187
|
+
*
|
|
2188
|
+
* @default undefined
|
|
2189
|
+
*/
|
|
2190
|
+
preRenderId?: string;
|
|
2191
|
+
/**
|
|
2192
|
+
* The DOM element or CSS selector string specifying the container into
|
|
2193
|
+
* which the pre-rendered wrapper is inserted.
|
|
2194
|
+
* Takes precedence over the top-level `preRenderContainer` when both are set.
|
|
2195
|
+
*
|
|
2196
|
+
* Set this when your app scrolls inside an element rather than the page (for
|
|
2197
|
+
* example `<body>` has `overflow: hidden`). Point it at the element that actually
|
|
2198
|
+
* scrolls, keep that element mounted while the embed is warm, and prefer a
|
|
2199
|
+
* selector string — it is re-resolved on reposition and so survives a remount,
|
|
2200
|
+
* while a detached element reference cannot be recovered. An invalid selector is
|
|
2201
|
+
* logged and falls back to `document.body`.
|
|
2202
|
+
* See {@link BaseViewConfig.preRenderContainer} for details, including Shadow DOM.
|
|
2203
|
+
*
|
|
2204
|
+
* @default document.body
|
|
2205
|
+
*/
|
|
2206
|
+
preRenderContainer?: string | HTMLElement;
|
|
2207
|
+
/**
|
|
2208
|
+
* Disables the `ResizeObserver` that keeps the wrapper sized to the
|
|
2209
|
+
* placeholder element.
|
|
2210
|
+
* Takes precedence over the top-level `doNotTrackPreRenderSize` when both are set.
|
|
2211
|
+
*
|
|
2212
|
+
* Set this only when you size the embed yourself; you then own alignment and must
|
|
2213
|
+
* call `syncPreRenderStyle()` after any change that moves or resizes it. Tracking
|
|
2214
|
+
* already pauses while hidden, so this is not needed to avoid work then.
|
|
2215
|
+
*
|
|
2216
|
+
* @default false
|
|
2217
|
+
*/
|
|
2218
|
+
doNotTrackPreRenderSize?: boolean;
|
|
2219
|
+
/**
|
|
2220
|
+
* CSS `z-index` value applied to the pre-render wrapper when hidden.
|
|
2221
|
+
* Override this when the host page's stacking context does not reach `-1000`
|
|
2222
|
+
* and the hidden wrapper still appears above other elements.
|
|
2223
|
+
*
|
|
2224
|
+
* A page that creates its own stacking context — a positioned app shell, a
|
|
2225
|
+
* transformed wrapper, a modal layer — can clamp `-1000`, and the hidden wrapper
|
|
2226
|
+
* then shows through or swallows clicks meant for your UI. Reach for this when you
|
|
2227
|
+
* see a faint panel behind your content, or clicks landing on nothing in the
|
|
2228
|
+
* region where the embed will eventually appear.
|
|
2229
|
+
*
|
|
2230
|
+
* @default -1000
|
|
2231
|
+
*/
|
|
2232
|
+
zIndex?: number;
|
|
2233
|
+
}
|
|
2024
2234
|
/**
|
|
2025
2235
|
* The common configuration object for an embedded view.
|
|
2026
2236
|
*/
|
|
@@ -2105,7 +2315,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2105
2315
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2106
2316
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2107
2317
|
* ... // other embed view config
|
|
2108
|
-
* hiddenActions: [Action.Download, Action.
|
|
2318
|
+
* hiddenActions: [Action.Download, Action.ExportTML],
|
|
2109
2319
|
* });
|
|
2110
2320
|
* ```
|
|
2111
2321
|
* @important
|
|
@@ -2127,7 +2337,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2127
2337
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2128
2338
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2129
2339
|
* ... // other embed view config
|
|
2130
|
-
* visibleActions: [Action.Download, Action.
|
|
2340
|
+
* visibleActions: [Action.Download, Action.ExportTML],
|
|
2131
2341
|
* });
|
|
2132
2342
|
* ```
|
|
2133
2343
|
*/
|
|
@@ -2212,6 +2422,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2212
2422
|
*
|
|
2213
2423
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2214
2424
|
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
2425
|
+
* @deprecated Use {@link PreRenderConfig.preRenderId} via `preRenderConfig` instead.
|
|
2215
2426
|
* @example
|
|
2216
2427
|
* ```js
|
|
2217
2428
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
@@ -2231,6 +2442,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2231
2442
|
* @type {boolean}
|
|
2232
2443
|
* @default false
|
|
2233
2444
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.4.0.cl, 9.4.0.sw
|
|
2445
|
+
* @deprecated Use {@link PreRenderConfig.doNotTrackPreRenderSize} via `preRenderConfig` instead.
|
|
2234
2446
|
* @example
|
|
2235
2447
|
* ```js
|
|
2236
2448
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2272,6 +2484,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2272
2484
|
*
|
|
2273
2485
|
* @type {string | HTMLElement}
|
|
2274
2486
|
* @version SDK: 1.49.2 | ThoughtSpot: *
|
|
2487
|
+
* @deprecated Use {@link PreRenderConfig.preRenderContainer} via `preRenderConfig` instead.
|
|
2275
2488
|
* @example
|
|
2276
2489
|
* ```js
|
|
2277
2490
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2282,6 +2495,27 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2282
2495
|
* ```
|
|
2283
2496
|
*/
|
|
2284
2497
|
preRenderContainer?: string | HTMLElement;
|
|
2498
|
+
/**
|
|
2499
|
+
* Configuration for the pre-render wrapper element.
|
|
2500
|
+
* All properties here mirror the top-level preRender properties on
|
|
2501
|
+
* `BaseViewConfig` and take precedence over them when both are set,
|
|
2502
|
+
* so existing top-level usage continues to work without any changes.
|
|
2503
|
+
* See {@link PreRenderConfig} for available options.
|
|
2504
|
+
*
|
|
2505
|
+
* @version SDK: 1.52.0
|
|
2506
|
+
* @example
|
|
2507
|
+
* ```js
|
|
2508
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
2509
|
+
* preRenderConfig: {
|
|
2510
|
+
* preRenderId: 'my-liveboard',
|
|
2511
|
+
* zIndex: -10,
|
|
2512
|
+
* },
|
|
2513
|
+
* });
|
|
2514
|
+
* embed.preRender();
|
|
2515
|
+
* embed.showPreRender();
|
|
2516
|
+
* ```
|
|
2517
|
+
*/
|
|
2518
|
+
preRenderConfig?: PreRenderConfig;
|
|
2285
2519
|
/**
|
|
2286
2520
|
* Enable the V2 shell. This can provide performance benefits
|
|
2287
2521
|
* due to a lighter-weight shell.
|
|
@@ -2352,6 +2586,26 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
2352
2586
|
* ```
|
|
2353
2587
|
*/
|
|
2354
2588
|
overrideOrgId?: number;
|
|
2589
|
+
/**
|
|
2590
|
+
* Overrides the browser history behavior for embedding application users.
|
|
2591
|
+
* This parameter changes standard history navigation (pushState) into a
|
|
2592
|
+
* state replacement (replaceState), preventing users from getting trapped in
|
|
2593
|
+
* back-button loops inside the embedded iframe environment.
|
|
2594
|
+
* The overrideHistoryState setting is honored only if the
|
|
2595
|
+
* application is running within an embedded context.
|
|
2596
|
+
*
|
|
2597
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
2598
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
2599
|
+
* @example
|
|
2600
|
+
* ```js
|
|
2601
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
|
|
2602
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
2603
|
+
* // ... other embed view config
|
|
2604
|
+
* overrideHistoryState: true,
|
|
2605
|
+
* });
|
|
2606
|
+
* ```
|
|
2607
|
+
*/
|
|
2608
|
+
overrideHistoryState?: boolean;
|
|
2355
2609
|
/**
|
|
2356
2610
|
* Flag to override the *Open Link in New Tab* context
|
|
2357
2611
|
* menu option.
|
|
@@ -2700,7 +2954,7 @@ export interface HomePageConfig {
|
|
|
2700
2954
|
*
|
|
2701
2955
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2702
2956
|
* ... //other embed view config
|
|
2703
|
-
* hiddenListColumns : [ListPageColumns.
|
|
2957
|
+
* hiddenListColumns : [ListPageColumns.Favorites,ListPageColumns.Author],
|
|
2704
2958
|
* })
|
|
2705
2959
|
* ```
|
|
2706
2960
|
*/
|
|
@@ -2710,7 +2964,9 @@ export interface HomePageConfig {
|
|
|
2710
2964
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2711
2965
|
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
2712
2966
|
*
|
|
2713
|
-
* **Note**:
|
|
2967
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2968
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2969
|
+
* and V4 (Focused) home page experiences.
|
|
2714
2970
|
*
|
|
2715
2971
|
* Supported embed types: `AppEmbed`
|
|
2716
2972
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2719,7 +2975,7 @@ export interface HomePageConfig {
|
|
|
2719
2975
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
2720
2976
|
*
|
|
2721
2977
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2722
|
-
* ... //
|
|
2978
|
+
* ... // V3 navigation and home page experience attributes
|
|
2723
2979
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2724
2980
|
* //...other embed view configuration attributes
|
|
2725
2981
|
* })
|
|
@@ -2730,8 +2986,11 @@ export interface HomePageConfig {
|
|
|
2730
2986
|
* Reorder home page modules.
|
|
2731
2987
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2732
2988
|
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2733
|
-
* HomepageModule.Watchlist]`
|
|
2734
|
-
*
|
|
2989
|
+
* HomepageModule.Watchlist]`
|
|
2990
|
+
*
|
|
2991
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2992
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2993
|
+
* and V4 (Focused) home page experiences.
|
|
2735
2994
|
*
|
|
2736
2995
|
* Supported embed types: `AppEmbed`
|
|
2737
2996
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2740,7 +2999,7 @@ export interface HomePageConfig {
|
|
|
2740
2999
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
2741
3000
|
*
|
|
2742
3001
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2743
|
-
* ...//
|
|
3002
|
+
* ...//V3 navigation and home page experience attributes
|
|
2744
3003
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
2745
3004
|
* //... other embed view configuration attributes
|
|
2746
3005
|
* })
|
|
@@ -2752,7 +3011,9 @@ export interface HomePageConfig {
|
|
|
2752
3011
|
* on the home page left navigation panel.
|
|
2753
3012
|
* To specify the menu items, import the `HomeLeftNavItem` enum.
|
|
2754
3013
|
*
|
|
2755
|
-
* **Note**:
|
|
3014
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
3015
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
3016
|
+
* and V4 (Focused) home page experiences.
|
|
2756
3017
|
*
|
|
2757
3018
|
* Supported embed types: `AppEmbed`
|
|
2758
3019
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -3006,6 +3267,25 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3006
3267
|
* ```
|
|
3007
3268
|
*/
|
|
3008
3269
|
enable2ColumnLayout?: boolean;
|
|
3270
|
+
/**
|
|
3271
|
+
* This attribute keeps an embedded Liveboard on the 12-column layout at
|
|
3272
|
+
* every width, instead of switching to the two-column or single-column
|
|
3273
|
+
* layout as the container narrows.
|
|
3274
|
+
*
|
|
3275
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3276
|
+
* @type {boolean}
|
|
3277
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
3278
|
+
* @default false
|
|
3279
|
+
* @example
|
|
3280
|
+
* ```js
|
|
3281
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3282
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3283
|
+
* ... // other embed view config
|
|
3284
|
+
* isLiveboardAlwaysOn12ColLayout: true,
|
|
3285
|
+
* })
|
|
3286
|
+
* ```
|
|
3287
|
+
*/
|
|
3288
|
+
isLiveboardAlwaysOn12ColLayout?: boolean;
|
|
3009
3289
|
/**
|
|
3010
3290
|
* This flag can be used to enable the compact header in Liveboard
|
|
3011
3291
|
*
|
|
@@ -3110,6 +3390,26 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3110
3390
|
* ```
|
|
3111
3391
|
*/
|
|
3112
3392
|
coverAndFilterOptionInPDF?: boolean;
|
|
3393
|
+
/**
|
|
3394
|
+
* Sets the gutter space (in pixels) between the visualization tiles of
|
|
3395
|
+
* an embedded Liveboard grid layout and its outer layout padding.
|
|
3396
|
+
* Accepts a non-negative integer; `0` renders the tiles without any gap
|
|
3397
|
+
* and removes the outer padding. When omitted, the gutter saved in the
|
|
3398
|
+
* Liveboard's styling settings (or the ThoughtSpot default) applies.
|
|
3399
|
+
*
|
|
3400
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3401
|
+
* @type {number}
|
|
3402
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
3403
|
+
* @example
|
|
3404
|
+
* ```js
|
|
3405
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3406
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3407
|
+
* ... // other embed view config
|
|
3408
|
+
* liveboardGutter: 8,
|
|
3409
|
+
* })
|
|
3410
|
+
* ```
|
|
3411
|
+
*/
|
|
3412
|
+
liveboardGutter?: number;
|
|
3113
3413
|
/**
|
|
3114
3414
|
* This flag is used to enable or disable the new centralized Liveboard filter UX
|
|
3115
3415
|
* (v2). When enabled, a unified modal is used to manage and update multiple filters
|
|
@@ -3128,6 +3428,24 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3128
3428
|
* ```
|
|
3129
3429
|
*/
|
|
3130
3430
|
isCentralizedLiveboardFilterUXEnabled?: boolean;
|
|
3431
|
+
/**
|
|
3432
|
+
* This flag is used to enable or disable scoped Liveboard filtering.
|
|
3433
|
+
* When enabled, filters and parameters can be scoped to a group of
|
|
3434
|
+
* visualizations on a Liveboard, in addition to the Liveboard and
|
|
3435
|
+
* tab levels.
|
|
3436
|
+
*
|
|
3437
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3438
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
3439
|
+
* @example
|
|
3440
|
+
* ```js
|
|
3441
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3442
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3443
|
+
* ... // other embed view config
|
|
3444
|
+
* isScopedLiveboardFilteringEnabled: true,
|
|
3445
|
+
* })
|
|
3446
|
+
* ```
|
|
3447
|
+
*/
|
|
3448
|
+
isScopedLiveboardFilteringEnabled?: boolean;
|
|
3131
3449
|
/**
|
|
3132
3450
|
* This flag is used to enable or disable the link parameters in liveboard.
|
|
3133
3451
|
*
|
|
@@ -3311,7 +3629,9 @@ export declare enum RuntimeFilterOp {
|
|
|
3311
3629
|
* via `hiddenHomepageModules` and reordered via
|
|
3312
3630
|
* `reorderedHomepageModules`.
|
|
3313
3631
|
*
|
|
3314
|
-
* **Note**:
|
|
3632
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
3633
|
+
* deprecated. These modules apply to V3 (ModularWithStylingChanges) and
|
|
3634
|
+
* V4 (Focused) home page experiences.
|
|
3315
3635
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3316
3636
|
*/
|
|
3317
3637
|
export declare enum HomepageModule {
|
|
@@ -3520,7 +3840,7 @@ export declare enum EmbedEvent {
|
|
|
3520
3840
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
3521
3841
|
* @example
|
|
3522
3842
|
* ```js
|
|
3523
|
-
* searchEmbed.on(EmbedEvent.
|
|
3843
|
+
* searchEmbed.on(EmbedEvent.Drilldown, {
|
|
3524
3844
|
* points: {
|
|
3525
3845
|
* clickedPoint,
|
|
3526
3846
|
* selectedPoints: selectedPoint
|
|
@@ -3581,7 +3901,7 @@ export declare enum EmbedEvent {
|
|
|
3581
3901
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3582
3902
|
* @example
|
|
3583
3903
|
* ```js
|
|
3584
|
-
* appEmbed.on(EmbedEvent.
|
|
3904
|
+
* appEmbed.on(EmbedEvent.CustomAction, payload => {
|
|
3585
3905
|
* const data = payload.data;
|
|
3586
3906
|
* if (data.id === 'insert Custom Action ID here') {
|
|
3587
3907
|
* console.log('Custom Action event:', data.embedAnswerData);
|
|
@@ -3847,8 +4167,8 @@ export declare enum EmbedEvent {
|
|
|
3847
4167
|
*
|
|
3848
4168
|
* **Note**: This event is deprecated in v1.21.0.
|
|
3849
4169
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3850
|
-
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.
|
|
3851
|
-
* `EmbedEvent.
|
|
4170
|
+
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
|
|
4171
|
+
* `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
|
|
3852
4172
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3853
4173
|
* @example
|
|
3854
4174
|
* ```js
|
|
@@ -3898,10 +4218,10 @@ export declare enum EmbedEvent {
|
|
|
3898
4218
|
* @example
|
|
3899
4219
|
* ```js
|
|
3900
4220
|
* //emit when action starts
|
|
3901
|
-
* searchEmbed.on(EmbedEvent.
|
|
4221
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
3902
4222
|
* console.log('download CSV', payload)}, {start: true })
|
|
3903
4223
|
* //emit when action ends
|
|
3904
|
-
* searchEmbed.on(EmbedEvent.
|
|
4224
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
3905
4225
|
* console.log('download CSV', payload)})
|
|
3906
4226
|
* ```
|
|
3907
4227
|
*/
|
|
@@ -4300,11 +4620,19 @@ export declare enum EmbedEvent {
|
|
|
4300
4620
|
* Emitted when a user changes any filter on a Liveboard.
|
|
4301
4621
|
* Returns filter type and name, column name and ID, and runtime
|
|
4302
4622
|
* filter details.
|
|
4623
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
4624
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
4625
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
4626
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
4627
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
4628
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4629
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
4303
4630
|
* @example
|
|
4304
4631
|
*
|
|
4305
4632
|
* ```js
|
|
4306
4633
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
4307
4634
|
* console.log('payload', payload);
|
|
4635
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
4308
4636
|
* })
|
|
4309
4637
|
* ```
|
|
4310
4638
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -4496,9 +4824,17 @@ export declare enum EmbedEvent {
|
|
|
4496
4824
|
/**
|
|
4497
4825
|
* Emitted when parameter changes in an Answer
|
|
4498
4826
|
* or Liveboard.
|
|
4827
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
4828
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
4829
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
4830
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
4831
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
4832
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4833
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
4499
4834
|
* ```js
|
|
4500
4835
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4501
4836
|
* console.log('payload', payload);
|
|
4837
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
4502
4838
|
* })
|
|
4503
4839
|
* ```
|
|
4504
4840
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -4800,6 +5136,158 @@ export declare enum EmbedEvent {
|
|
|
4800
5136
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4801
5137
|
*/
|
|
4802
5138
|
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
5139
|
+
/**
|
|
5140
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
5141
|
+
* to bracket the interaction. App→host counterpart of the
|
|
5142
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
5143
|
+
* @example
|
|
5144
|
+
* ```js
|
|
5145
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
5146
|
+
* // payload: { convId: string }
|
|
5147
|
+
* })
|
|
5148
|
+
* ```
|
|
5149
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5150
|
+
*/
|
|
5151
|
+
SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
|
|
5152
|
+
/**
|
|
5153
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
5154
|
+
* to bracket the interaction.
|
|
5155
|
+
* @example
|
|
5156
|
+
* ```js
|
|
5157
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
5158
|
+
* // payload: { convId: string }
|
|
5159
|
+
* })
|
|
5160
|
+
* ```
|
|
5161
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5162
|
+
*/
|
|
5163
|
+
SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
|
|
5164
|
+
/**
|
|
5165
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
5166
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
5167
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
5168
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
5169
|
+
* the save resolves.
|
|
5170
|
+
* @example
|
|
5171
|
+
* ```js
|
|
5172
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
5173
|
+
* // payload: { convId: string, shareId: string,
|
|
5174
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
5175
|
+
* })
|
|
5176
|
+
* ```
|
|
5177
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5178
|
+
*/
|
|
5179
|
+
SpotterConversationShared = "spotterConversationShared",
|
|
5180
|
+
/**
|
|
5181
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
5182
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
5183
|
+
* and the share is deleted entirely.
|
|
5184
|
+
* @example
|
|
5185
|
+
* ```js
|
|
5186
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
5187
|
+
* // payload: { convId: string, shareId: string,
|
|
5188
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
5189
|
+
* })
|
|
5190
|
+
* ```
|
|
5191
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5192
|
+
*/
|
|
5193
|
+
SpotterConversationShareRevoked = "spotterConversationShareRevoked",
|
|
5194
|
+
/**
|
|
5195
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
5196
|
+
* view). No shareId available viewer-side.
|
|
5197
|
+
* @example
|
|
5198
|
+
* ```js
|
|
5199
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
5200
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
5201
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
5202
|
+
* })
|
|
5203
|
+
* ```
|
|
5204
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5205
|
+
*/
|
|
5206
|
+
SpotterSharedConversationViewed = "spotterSharedConversationViewed",
|
|
5207
|
+
/**
|
|
5208
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
5209
|
+
* last shared version" checkbox.
|
|
5210
|
+
* @example
|
|
5211
|
+
* ```js
|
|
5212
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
5213
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
5214
|
+
* })
|
|
5215
|
+
* ```
|
|
5216
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5217
|
+
*/
|
|
5218
|
+
SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
|
|
5219
|
+
/**
|
|
5220
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
5221
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
5222
|
+
* @example
|
|
5223
|
+
* ```js
|
|
5224
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
5225
|
+
* // payload: { convId: string }
|
|
5226
|
+
* })
|
|
5227
|
+
* ```
|
|
5228
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5229
|
+
*/
|
|
5230
|
+
SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
|
|
5231
|
+
/**
|
|
5232
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
5233
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
5234
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
5235
|
+
* @example
|
|
5236
|
+
* ```js
|
|
5237
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
5238
|
+
* // payload: { convId: string }
|
|
5239
|
+
* })
|
|
5240
|
+
* ```
|
|
5241
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5242
|
+
*/
|
|
5243
|
+
SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
|
|
5244
|
+
/**
|
|
5245
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
5246
|
+
* @example
|
|
5247
|
+
* ```js
|
|
5248
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
5249
|
+
* // payload: { convId: string }
|
|
5250
|
+
* })
|
|
5251
|
+
* ```
|
|
5252
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5253
|
+
*/
|
|
5254
|
+
SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
|
|
5255
|
+
/**
|
|
5256
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
5257
|
+
* button.
|
|
5258
|
+
* @example
|
|
5259
|
+
* ```js
|
|
5260
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
5261
|
+
* // payload: { convId: string }
|
|
5262
|
+
* })
|
|
5263
|
+
* ```
|
|
5264
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5265
|
+
*/
|
|
5266
|
+
SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
|
|
5267
|
+
/**
|
|
5268
|
+
* Emitted when a Spotter conversation is pinned.
|
|
5269
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5270
|
+
* @example
|
|
5271
|
+
* ```js
|
|
5272
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
5273
|
+
* console.log('Conversation pinned', payload);
|
|
5274
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
5275
|
+
* })
|
|
5276
|
+
* ```
|
|
5277
|
+
*/
|
|
5278
|
+
SpotterConversationPinned = "spotterConversationPinned",
|
|
5279
|
+
/**
|
|
5280
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
5281
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5282
|
+
* @example
|
|
5283
|
+
* ```js
|
|
5284
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
5285
|
+
* console.log('Conversation unpinned', payload);
|
|
5286
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
5287
|
+
* })
|
|
5288
|
+
* ```
|
|
5289
|
+
*/
|
|
5290
|
+
SpotterConversationUnpinned = "spotterConversationUnpinned",
|
|
4803
5291
|
/**
|
|
4804
5292
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
4805
5293
|
* @example
|
|
@@ -4812,6 +5300,30 @@ export declare enum EmbedEvent {
|
|
|
4812
5300
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4813
5301
|
*/
|
|
4814
5302
|
SpotterConversationSelected = "spotterConversationSelected",
|
|
5303
|
+
/**
|
|
5304
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
5305
|
+
* Includes the conversation and message identifiers so the host app can
|
|
5306
|
+
* fetch the full conversation history via the REST API if needed.
|
|
5307
|
+
*
|
|
5308
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
5309
|
+
*
|
|
5310
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
5311
|
+
* inside the full application).
|
|
5312
|
+
* @example
|
|
5313
|
+
* ```js
|
|
5314
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
5315
|
+
* console.log('Spotter response complete', payload);
|
|
5316
|
+
* })
|
|
5317
|
+
* ```
|
|
5318
|
+
* @example
|
|
5319
|
+
* ```js
|
|
5320
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
5321
|
+
* console.log('Spotter response complete', payload);
|
|
5322
|
+
* })
|
|
5323
|
+
* ```
|
|
5324
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5325
|
+
*/
|
|
5326
|
+
SpotterResponseComplete = "spotterResponseComplete",
|
|
4815
5327
|
/**
|
|
4816
5328
|
* @hidden
|
|
4817
5329
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -5165,6 +5677,7 @@ export declare enum HostEvent {
|
|
|
5165
5677
|
* const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
|
|
5166
5678
|
* console.log("iFrameURL", url);
|
|
5167
5679
|
* ```
|
|
5680
|
+
* @returns iframeUrl - The URL currently loaded in the embedded iframe.
|
|
5168
5681
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
5169
5682
|
*/
|
|
5170
5683
|
GetIframeUrl = "GetIframeUrl",
|
|
@@ -5291,6 +5804,17 @@ export declare enum HostEvent {
|
|
|
5291
5804
|
* name: string,
|
|
5292
5805
|
* type: ATTRIBUTE/MEASURE,
|
|
5293
5806
|
* dataType: INT64/CHAR/DATE }
|
|
5807
|
+
*
|
|
5808
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
5809
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
5810
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
5811
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5812
|
+
*
|
|
5813
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5814
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5815
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5816
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
5817
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
5294
5818
|
* @example
|
|
5295
5819
|
* ```js
|
|
5296
5820
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -5303,6 +5827,14 @@ export declare enum HostEvent {
|
|
|
5303
5827
|
* ```
|
|
5304
5828
|
* @example
|
|
5305
5829
|
* ```js
|
|
5830
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
5831
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
5832
|
+
* column: { columnId: '<column-GUID>' },
|
|
5833
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
5834
|
+
* });
|
|
5835
|
+
* ```
|
|
5836
|
+
* @example
|
|
5837
|
+
* ```js
|
|
5306
5838
|
* // Open filter from search context
|
|
5307
5839
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5308
5840
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -5313,29 +5845,96 @@ export declare enum HostEvent {
|
|
|
5313
5845
|
*/
|
|
5314
5846
|
OpenFilter = "openFilter",
|
|
5315
5847
|
/**
|
|
5316
|
-
*
|
|
5317
|
-
*
|
|
5848
|
+
* Open the add-filter modal of a Liveboard, the same dialog that the
|
|
5849
|
+
* *Add filter* button in the Liveboard edit header opens, so the host
|
|
5850
|
+
* app can start the add-filter flow from its own UI.
|
|
5851
|
+
*
|
|
5852
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
5853
|
+
* Hiding the *Add filter* button with `hiddenActions:
|
|
5854
|
+
* [Action.AddFilter]` does not block this event, but disabling it with
|
|
5855
|
+
* `disabledActions` does.
|
|
5856
|
+
*
|
|
5857
|
+
* Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
|
|
5858
|
+
* existing filter, this event starts the creation of a new filter.
|
|
5859
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5318
5860
|
* @example
|
|
5319
5861
|
* ```js
|
|
5320
|
-
*
|
|
5862
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
|
|
5321
5863
|
* ```
|
|
5864
|
+
*/
|
|
5865
|
+
OpenAddFilterModal = "openAddFilterModal",
|
|
5866
|
+
/**
|
|
5867
|
+
* Open the add-parameter panel of a Liveboard, the same panel that the
|
|
5868
|
+
* *Add parameter* button in the Liveboard edit header opens.
|
|
5869
|
+
* Mirrors {@link HostEvent.OpenAddFilterModal} for parameters.
|
|
5870
|
+
*
|
|
5871
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
5872
|
+
* Hiding the *Add parameter* button with `hiddenActions:
|
|
5873
|
+
* [Action.AddParameter]` does not block this event, but disabling it
|
|
5874
|
+
* with `disabledActions` does.
|
|
5875
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5322
5876
|
* @example
|
|
5323
5877
|
* ```js
|
|
5324
|
-
*
|
|
5325
|
-
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5326
|
-
* searchEmbed.trigger(HostEvent.AddColumns, {
|
|
5327
|
-
* columnIds: ['col-guid-1', 'col-guid-2']
|
|
5328
|
-
* }, ContextType.Search);
|
|
5878
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
|
|
5329
5879
|
* ```
|
|
5330
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5331
5880
|
*/
|
|
5332
|
-
|
|
5881
|
+
OpenAddParameterModal = "openAddParameterModal",
|
|
5333
5882
|
/**
|
|
5334
|
-
*
|
|
5335
|
-
*
|
|
5883
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
5884
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
5885
|
+
* @param - Includes the following keys:
|
|
5886
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
5887
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
5888
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
5889
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
5890
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
5891
|
+
*
|
|
5892
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5893
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5894
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5895
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
5896
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
5336
5897
|
* @example
|
|
5337
5898
|
* ```js
|
|
5338
|
-
*
|
|
5899
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
5900
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
5901
|
+
* });
|
|
5902
|
+
* ```
|
|
5903
|
+
* @example
|
|
5904
|
+
* ```js
|
|
5905
|
+
* // Open a parameter scoped to a specific group
|
|
5906
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
5907
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
5908
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
5909
|
+
* });
|
|
5910
|
+
* ```
|
|
5911
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
5912
|
+
*/
|
|
5913
|
+
OpenParameter = "openParameter",
|
|
5914
|
+
/**
|
|
5915
|
+
* Add columns to the current search query.
|
|
5916
|
+
* @param - { columnIds: string[] }
|
|
5917
|
+
* @example
|
|
5918
|
+
* ```js
|
|
5919
|
+
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
|
|
5920
|
+
* ```
|
|
5921
|
+
* @example
|
|
5922
|
+
* ```js
|
|
5923
|
+
* // Add columns from search context
|
|
5924
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5925
|
+
* searchEmbed.trigger(HostEvent.AddColumns, {
|
|
5926
|
+
* columnIds: ['col-guid-1', 'col-guid-2']
|
|
5927
|
+
* }, ContextType.Search);
|
|
5928
|
+
* ```
|
|
5929
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5930
|
+
*/
|
|
5931
|
+
AddColumns = "addColumns",
|
|
5932
|
+
/**
|
|
5933
|
+
* Remove a column from the current search query.
|
|
5934
|
+
* @param - { columnId: string }
|
|
5935
|
+
* @example
|
|
5936
|
+
* ```js
|
|
5937
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
|
|
5339
5938
|
* ```
|
|
5340
5939
|
* @example
|
|
5341
5940
|
* ```js
|
|
@@ -5361,6 +5960,10 @@ export declare enum HostEvent {
|
|
|
5361
5960
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
|
|
5362
5961
|
* data=>console.log(data))
|
|
5363
5962
|
* ```
|
|
5963
|
+
* @returns data - Object with a `v2Content` string: the export request
|
|
5964
|
+
* payload for the current Liveboard.
|
|
5965
|
+
* @returns type - The passthrough event name,
|
|
5966
|
+
* `getExportRequestForCurrentPinboard`.
|
|
5364
5967
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
5365
5968
|
*/
|
|
5366
5969
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
@@ -5463,6 +6066,9 @@ export declare enum HostEvent {
|
|
|
5463
6066
|
* }, ContextType.Spotter);
|
|
5464
6067
|
* ```
|
|
5465
6068
|
*
|
|
6069
|
+
* @returns liveboardId - GUID of the Liveboard the Answer was pinned to.
|
|
6070
|
+
* @returns tabId - GUID of the tab within that Liveboard.
|
|
6071
|
+
* @returns vizId - GUID of the newly created visualization.
|
|
5466
6072
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5467
6073
|
*/
|
|
5468
6074
|
Pin = "pin",
|
|
@@ -5501,13 +6107,13 @@ export declare enum HostEvent {
|
|
|
5501
6107
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
5502
6108
|
* @example
|
|
5503
6109
|
* ```js
|
|
5504
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
6110
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList)
|
|
5505
6111
|
* ```
|
|
5506
6112
|
* @example
|
|
5507
6113
|
* ```js
|
|
5508
6114
|
* // Manage schedules from liveboard context
|
|
5509
6115
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5510
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
6116
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
|
|
5511
6117
|
* ```
|
|
5512
6118
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
5513
6119
|
*/
|
|
@@ -5952,6 +6558,7 @@ export declare enum HostEvent {
|
|
|
5952
6558
|
* console.log(tml.answer);
|
|
5953
6559
|
* });
|
|
5954
6560
|
* ```
|
|
6561
|
+
* @returns The TML representation of the current Answer, as an object.
|
|
5955
6562
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5956
6563
|
* @important
|
|
5957
6564
|
*/
|
|
@@ -6375,6 +6982,14 @@ export declare enum HostEvent {
|
|
|
6375
6982
|
/**
|
|
6376
6983
|
* Get details of filters applied on the Liveboard.
|
|
6377
6984
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
6985
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
6986
|
+
* indicating the scope of the filter. It contains a `level`
|
|
6987
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
6988
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
6989
|
+
* level there is no `targetId`, since the filter applies to the
|
|
6990
|
+
* whole Liveboard.
|
|
6991
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
6992
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
6378
6993
|
* @example
|
|
6379
6994
|
* ```js
|
|
6380
6995
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -6387,6 +7002,8 @@ export declare enum HostEvent {
|
|
|
6387
7002
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
|
|
6388
7003
|
* console.log('filters', data);
|
|
6389
7004
|
* ```
|
|
7005
|
+
* @returns liveboardFilters - Filters applied on the Liveboard.
|
|
7006
|
+
* @returns runtimeFilters - Runtime filters applied on the Liveboard.
|
|
6390
7007
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
6391
7008
|
*/
|
|
6392
7009
|
GetFilters = "getFilters",
|
|
@@ -6414,6 +7031,16 @@ export declare enum HostEvent {
|
|
|
6414
7031
|
*
|
|
6415
7032
|
* `type` - To update filters for date time, specify the date format type.
|
|
6416
7033
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
7034
|
+
*
|
|
7035
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
7036
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
7037
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
7038
|
+
*
|
|
7039
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
7040
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
7041
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
7042
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
7043
|
+
* Liveboard.
|
|
6417
7044
|
* @example
|
|
6418
7045
|
* ```js
|
|
6419
7046
|
*
|
|
@@ -6490,6 +7117,21 @@ export declare enum HostEvent {
|
|
|
6490
7117
|
* }
|
|
6491
7118
|
* }, ContextType.Liveboard);
|
|
6492
7119
|
* ```
|
|
7120
|
+
* @example
|
|
7121
|
+
* ```js
|
|
7122
|
+
* // Scope the filter to a specific Liveboard tab
|
|
7123
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
7124
|
+
* filter: {
|
|
7125
|
+
* column: "item type",
|
|
7126
|
+
* oper: "IN",
|
|
7127
|
+
* values: ["bags", "shirts"],
|
|
7128
|
+
* applicability: {
|
|
7129
|
+
* level: "TAB",
|
|
7130
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
7131
|
+
* }
|
|
7132
|
+
* }
|
|
7133
|
+
* });
|
|
7134
|
+
* ```
|
|
6493
7135
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
6494
7136
|
*/
|
|
6495
7137
|
UpdateFilters = "updateFilters",
|
|
@@ -6511,9 +7153,37 @@ export declare enum HostEvent {
|
|
|
6511
7153
|
* console.log('tabs', tabDetails);
|
|
6512
7154
|
* });
|
|
6513
7155
|
* ```
|
|
7156
|
+
* @returns orderedTabIds - Tab GUIDs in the order they appear.
|
|
7157
|
+
* @returns numberOfTabs - Total number of tabs on the Liveboard.
|
|
7158
|
+
* @returns Tabs - Tab details, each with at least `id` and `name`.
|
|
6514
7159
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
6515
7160
|
*/
|
|
6516
7161
|
GetTabs = "getTabs",
|
|
7162
|
+
/**
|
|
7163
|
+
* Get group details for the current Liveboard.
|
|
7164
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
7165
|
+
* @example
|
|
7166
|
+
* ```js
|
|
7167
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
7168
|
+
* console.log(
|
|
7169
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
7170
|
+
* );
|
|
7171
|
+
* })
|
|
7172
|
+
* ```
|
|
7173
|
+
* @example
|
|
7174
|
+
* ```js
|
|
7175
|
+
* // Get groups from liveboard context
|
|
7176
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
7177
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
7178
|
+
* console.log('groups', groupDetails);
|
|
7179
|
+
* });
|
|
7180
|
+
* ```
|
|
7181
|
+
* @returns orderedGroupIds - Group GUIDs in the order they appear.
|
|
7182
|
+
* @returns numberOfGroups - Total number of groups on the Liveboard.
|
|
7183
|
+
* @returns Groups - Group details, each with at least `id` and `name`.
|
|
7184
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
7185
|
+
*/
|
|
7186
|
+
GetGroups = "getGroups",
|
|
6517
7187
|
/**
|
|
6518
7188
|
* Set the visible tabs on a Liveboard.
|
|
6519
7189
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -6585,6 +7255,9 @@ export declare enum HostEvent {
|
|
|
6585
7255
|
* // Alternative direct usage (not recommended)
|
|
6586
7256
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
6587
7257
|
* ```
|
|
7258
|
+
* @returns session - Session identifier for the Answer, for use with the
|
|
7259
|
+
* `AnswerService`.
|
|
7260
|
+
* @returns embedAnswerData - Data backing the Answer, when available.
|
|
6588
7261
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
6589
7262
|
*/
|
|
6590
7263
|
GetAnswerSession = "getAnswerSession",
|
|
@@ -6641,6 +7314,15 @@ export declare enum HostEvent {
|
|
|
6641
7314
|
* - `name`: Name of the parameter.
|
|
6642
7315
|
* - `value`: The value to set for the parameter.
|
|
6643
7316
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
7317
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
7318
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
7319
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
7320
|
+
*
|
|
7321
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
7322
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
7323
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
7324
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
7325
|
+
* Liveboard.
|
|
6644
7326
|
*
|
|
6645
7327
|
* @example
|
|
6646
7328
|
* ```js
|
|
@@ -6652,6 +7334,18 @@ export declare enum HostEvent {
|
|
|
6652
7334
|
* ```
|
|
6653
7335
|
* @example
|
|
6654
7336
|
* ```js
|
|
7337
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
7338
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
7339
|
+
* name: "Integer Range Param",
|
|
7340
|
+
* value: 10,
|
|
7341
|
+
* applicability: {
|
|
7342
|
+
* level: "TAB",
|
|
7343
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
7344
|
+
* }
|
|
7345
|
+
* }])
|
|
7346
|
+
* ```
|
|
7347
|
+
* @example
|
|
7348
|
+
* ```js
|
|
6655
7349
|
* // Update parameters from liveboard context
|
|
6656
7350
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
6657
7351
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -6665,6 +7359,14 @@ export declare enum HostEvent {
|
|
|
6665
7359
|
UpdateParameters = "UpdateParameters",
|
|
6666
7360
|
/**
|
|
6667
7361
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
7362
|
+
* Each parameter includes an optional `applicability` attribute
|
|
7363
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
7364
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
7365
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
7366
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
7367
|
+
* whole Liveboard.
|
|
7368
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
7369
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
6668
7370
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6669
7371
|
* ```js
|
|
6670
7372
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -6689,12 +7391,16 @@ export declare enum HostEvent {
|
|
|
6689
7391
|
* console.log('parameters', parameters);
|
|
6690
7392
|
* });
|
|
6691
7393
|
* ```
|
|
7394
|
+
* @returns parameters - Parameters currently applied on the Liveboard.
|
|
6692
7395
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
6693
7396
|
*/
|
|
6694
7397
|
GetParameters = "GetParameters",
|
|
6695
7398
|
/**
|
|
6696
7399
|
* Triggers an event to update a personalized view of a Liveboard.
|
|
6697
|
-
* This event is deprecated. Use {@link HostEvent.
|
|
7400
|
+
* This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
|
|
7401
|
+
* which additionally accepts a `viewName`, resets to the original view when
|
|
7402
|
+
* called with an empty payload, and reports an error when a named view
|
|
7403
|
+
* cannot be found.
|
|
6698
7404
|
* ```js
|
|
6699
7405
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
6700
7406
|
* ```
|
|
@@ -6712,10 +7418,15 @@ export declare enum HostEvent {
|
|
|
6712
7418
|
UpdatePersonalisedView = "UpdatePersonalisedView",
|
|
6713
7419
|
/**
|
|
6714
7420
|
* Triggers an event to update a personalized view of a Liveboard.
|
|
7421
|
+
* This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
|
|
7422
|
+
* which additionally accepts a `viewName`, resets to the original view when
|
|
7423
|
+
* called with an empty payload, and reports an error when a named view
|
|
7424
|
+
* cannot be found.
|
|
6715
7425
|
* ```js
|
|
6716
7426
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
6717
7427
|
* ```
|
|
6718
7428
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
7429
|
+
* @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
6719
7430
|
*/
|
|
6720
7431
|
UpdatePersonalizedView = "UpdatePersonalisedView",
|
|
6721
7432
|
/**
|
|
@@ -6818,6 +7529,10 @@ export declare enum HostEvent {
|
|
|
6818
7529
|
* description: "Generated from Spotter"
|
|
6819
7530
|
* }, ContextType.Spotter);
|
|
6820
7531
|
* ```
|
|
7532
|
+
* @returns answerId - GUID of the saved Answer.
|
|
7533
|
+
* @returns saveResponse - Raw response from the save operation.
|
|
7534
|
+
* @returns shareResponse - Raw response from the share operation, when the
|
|
7535
|
+
* Answer was also made discoverable.
|
|
6821
7536
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
6822
7537
|
*/
|
|
6823
7538
|
SaveAnswer = "saveAnswer",
|
|
@@ -6931,6 +7646,36 @@ export declare enum HostEvent {
|
|
|
6931
7646
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
6932
7647
|
*/
|
|
6933
7648
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
7649
|
+
/**
|
|
7650
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
7651
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
7652
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
7653
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
7654
|
+
* @example
|
|
7655
|
+
* ```js
|
|
7656
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
7657
|
+
* ```
|
|
7658
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7659
|
+
*/
|
|
7660
|
+
ShareSpotterConversation = "ShareSpotterConversation",
|
|
7661
|
+
/**
|
|
7662
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
7663
|
+
* @example
|
|
7664
|
+
* ```js
|
|
7665
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
7666
|
+
* ```
|
|
7667
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7668
|
+
*/
|
|
7669
|
+
CloseSpotterShareConversation = "CloseSpotterShareConversation",
|
|
7670
|
+
/**
|
|
7671
|
+
* Exits the read-only shared-conversation view.
|
|
7672
|
+
* @example
|
|
7673
|
+
* ```js
|
|
7674
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
7675
|
+
* ```
|
|
7676
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7677
|
+
*/
|
|
7678
|
+
ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
|
|
6934
7679
|
/**
|
|
6935
7680
|
* Deletes the last prompt in spotter embed.
|
|
6936
7681
|
* @example
|
|
@@ -7026,6 +7771,41 @@ export declare enum HostEvent {
|
|
|
7026
7771
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
7027
7772
|
*/
|
|
7028
7773
|
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
7774
|
+
/**
|
|
7775
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
7776
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
7777
|
+
* required.
|
|
7778
|
+
*
|
|
7779
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
7780
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
7781
|
+
* instance.
|
|
7782
|
+
*
|
|
7783
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7784
|
+
* @example
|
|
7785
|
+
* ```js
|
|
7786
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
7787
|
+
* conversationId: '<conversation-id>',
|
|
7788
|
+
* });
|
|
7789
|
+
* ```
|
|
7790
|
+
*/
|
|
7791
|
+
PinSpotterConversation = "PinSpotterConversation",
|
|
7792
|
+
/**
|
|
7793
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
7794
|
+
* conversation to unpin is required.
|
|
7795
|
+
*
|
|
7796
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
7797
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
7798
|
+
* instance.
|
|
7799
|
+
*
|
|
7800
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7801
|
+
* @example
|
|
7802
|
+
* ```js
|
|
7803
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
7804
|
+
* conversationId: '<conversation-id>',
|
|
7805
|
+
* });
|
|
7806
|
+
* ```
|
|
7807
|
+
*/
|
|
7808
|
+
UnpinSpotterConversation = "UnpinSpotterConversation",
|
|
7029
7809
|
/**
|
|
7030
7810
|
* @hidden
|
|
7031
7811
|
* Get the current context of the embedded page.
|
|
@@ -7136,9 +7916,10 @@ export type SpotterFileUploadFileTypes = {
|
|
|
7136
7916
|
* ThoughtSpot application pages include actions and menu commands
|
|
7137
7917
|
* for various user-initiated operations. These actions are represented
|
|
7138
7918
|
* as enumeration members in the SDK. To control actions in the embedded view:
|
|
7139
|
-
* - disabledActions — the action is grayed out and still visible, but non-interactive
|
|
7140
|
-
* - hiddenActions — the action is completely removed from
|
|
7141
|
-
* - visibleActions — allowlist, only these actions
|
|
7919
|
+
* - disabledActions — the action is grayed out and still visible, but non-interactive
|
|
7920
|
+
* (user can see but not click). - hiddenActions — the action is completely removed from
|
|
7921
|
+
* the UI (user cannot see it at all). - visibleActions — allowlist, only these actions
|
|
7922
|
+
* are shown; all others are hidden.
|
|
7142
7923
|
*
|
|
7143
7924
|
* Use disabledActions to disable (gray out) an action.
|
|
7144
7925
|
* Use hiddenActions to hide (fully remove) an action.
|
|
@@ -7191,6 +7972,17 @@ export declare enum Action {
|
|
|
7191
7972
|
* ```
|
|
7192
7973
|
*/
|
|
7193
7974
|
SaveAsView = "saveAsView",
|
|
7975
|
+
/**
|
|
7976
|
+
* The **EditInputTable** action on a Liveboard
|
|
7977
|
+
* page. Allows users to edit an input table used in an Answer directly from
|
|
7978
|
+
* a Liveboard.
|
|
7979
|
+
* @example
|
|
7980
|
+
* ```js
|
|
7981
|
+
* disabledActions: [Action.EditInputTable]
|
|
7982
|
+
* ```
|
|
7983
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7984
|
+
*/
|
|
7985
|
+
EditInputTable = "editInputTable",
|
|
7194
7986
|
/**
|
|
7195
7987
|
* The **Make a copy** action on a Liveboard or Answer
|
|
7196
7988
|
* page. Creates a copy of the Liveboard.
|
|
@@ -8392,6 +9184,19 @@ export declare enum Action {
|
|
|
8392
9184
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
8393
9185
|
*/
|
|
8394
9186
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
9187
|
+
/**
|
|
9188
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
9189
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
9190
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
9191
|
+
*
|
|
9192
|
+
* @example
|
|
9193
|
+
* ```js
|
|
9194
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
9195
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
9196
|
+
* ```
|
|
9197
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
9198
|
+
*/
|
|
9199
|
+
AllLiveboardFilters = "allLiveboardFilters",
|
|
8395
9200
|
/**
|
|
8396
9201
|
* The **Data model instructions** button on the Spotter interface.
|
|
8397
9202
|
* Allows opening the data model instructions modal.
|
|
@@ -8493,6 +9298,10 @@ export declare enum Action {
|
|
|
8493
9298
|
* The **Add to Coaching** feature allows adding reference questions and
|
|
8494
9299
|
* business terms to improve Spotter’s responses. This feature is generally available
|
|
8495
9300
|
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
9301
|
+
*
|
|
9302
|
+
* This action governs both the answer-card **Add to memory** CTA and its
|
|
9303
|
+
* Spotter 3 successor, the response-footer **Remember this** CTA
|
|
9304
|
+
* (they are mutually exclusive).
|
|
8496
9305
|
* @example
|
|
8497
9306
|
* ```js
|
|
8498
9307
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -8727,6 +9536,89 @@ export declare enum Action {
|
|
|
8727
9536
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8728
9537
|
*/
|
|
8729
9538
|
SpotterChatRename = "spotterChatRename",
|
|
9539
|
+
/**
|
|
9540
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
9541
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
9542
|
+
* (enableShareConversation on).
|
|
9543
|
+
* @example
|
|
9544
|
+
* ```js
|
|
9545
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
9546
|
+
* ```
|
|
9547
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9548
|
+
*/
|
|
9549
|
+
SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
|
|
9550
|
+
/**
|
|
9551
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
9552
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
9553
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
9554
|
+
* @example
|
|
9555
|
+
* ```js
|
|
9556
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
9557
|
+
* ```
|
|
9558
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9559
|
+
*/
|
|
9560
|
+
SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
|
|
9561
|
+
/**
|
|
9562
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
9563
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
9564
|
+
* @example
|
|
9565
|
+
* ```js
|
|
9566
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
9567
|
+
* ```
|
|
9568
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9569
|
+
*/
|
|
9570
|
+
SpotterSharedConversationBanner = "spotterSharedConversationBanner",
|
|
9571
|
+
/**
|
|
9572
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
9573
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
9574
|
+
* @example
|
|
9575
|
+
* ```js
|
|
9576
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
9577
|
+
* ```
|
|
9578
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9579
|
+
*/
|
|
9580
|
+
SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
|
|
9581
|
+
/**
|
|
9582
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
9583
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
9584
|
+
* host event.
|
|
9585
|
+
* @example
|
|
9586
|
+
* ```js
|
|
9587
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
9588
|
+
* ```
|
|
9589
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9590
|
+
*/
|
|
9591
|
+
SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
|
|
9592
|
+
/**
|
|
9593
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
9594
|
+
* to the current moment…"). Hide-only.
|
|
9595
|
+
* @example
|
|
9596
|
+
* ```js
|
|
9597
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
9598
|
+
* ```
|
|
9599
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9600
|
+
*/
|
|
9601
|
+
SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
|
|
9602
|
+
/**
|
|
9603
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
9604
|
+
* messages since last shared version" checkbox.
|
|
9605
|
+
* @example
|
|
9606
|
+
* ```js
|
|
9607
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
9608
|
+
* ```
|
|
9609
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9610
|
+
*/
|
|
9611
|
+
SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
|
|
9612
|
+
/**
|
|
9613
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
9614
|
+
* stale-snapshot info banner.
|
|
9615
|
+
* @example
|
|
9616
|
+
* ```js
|
|
9617
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
9618
|
+
* ```
|
|
9619
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9620
|
+
*/
|
|
9621
|
+
SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
|
|
8730
9622
|
/**
|
|
8731
9623
|
* Controls visibility and disable state of the delete action
|
|
8732
9624
|
* in the Spotter conversation edit menu.
|
|
@@ -8737,6 +9629,16 @@ export declare enum Action {
|
|
|
8737
9629
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8738
9630
|
*/
|
|
8739
9631
|
SpotterChatDelete = "spotterChatDelete",
|
|
9632
|
+
/**
|
|
9633
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
9634
|
+
* in the Spotter conversation edit menu.
|
|
9635
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
9636
|
+
* @example
|
|
9637
|
+
* ```js
|
|
9638
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
9639
|
+
* ```
|
|
9640
|
+
*/
|
|
9641
|
+
SpotterChatPin = "spotterChatPin",
|
|
8740
9642
|
/**
|
|
8741
9643
|
* Controls visibility and disable state of the documentation/best practices
|
|
8742
9644
|
* link in the Spotter sidebar footer.
|
|
@@ -8780,6 +9682,56 @@ export declare enum Action {
|
|
|
8780
9682
|
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
8781
9683
|
*/
|
|
8782
9684
|
SpotterChatModeSwitcher = "spotterChatModeSwitcher",
|
|
9685
|
+
/**
|
|
9686
|
+
* The **Basic Search** starter prompt pill.
|
|
9687
|
+
*
|
|
9688
|
+
* Starter prompt pills are the row of category buttons shown above the
|
|
9689
|
+
* Spotter chat input before a conversation starts. They give a new user
|
|
9690
|
+
* ready-made questions to click instead of typing one from scratch, and
|
|
9691
|
+
* disappear once the conversation begins. There are three, one per action
|
|
9692
|
+
* below.
|
|
9693
|
+
*
|
|
9694
|
+
* Clicking this pill opens a card of suggested simple questions; picking one
|
|
9695
|
+
* submits it to Spotter right away. Visible by default, and hidden along
|
|
9696
|
+
* with the other pills when the surface itself is off (see
|
|
9697
|
+
* {@link SpotterChatViewConfig.starterPrompts}).
|
|
9698
|
+
* @example
|
|
9699
|
+
* ```js
|
|
9700
|
+
* hiddenActions: [Action.QuickSearchPill]
|
|
9701
|
+
* ```
|
|
9702
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9703
|
+
*/
|
|
9704
|
+
QuickSearchPill = "quickSearchPill",
|
|
9705
|
+
/**
|
|
9706
|
+
* The **Deep Analysis** starter prompt pill, next to
|
|
9707
|
+
* {@link Action.QuickSearchPill} above the Spotter chat input.
|
|
9708
|
+
*
|
|
9709
|
+
* Clicking it opens a card of suggested investigative questions ("why did
|
|
9710
|
+
* revenue drop?"). Picking one fills the chat input in Deep Analysis mode
|
|
9711
|
+
* rather than submitting immediately, so the user can edit it first.
|
|
9712
|
+
* Visible by default.
|
|
9713
|
+
* @example
|
|
9714
|
+
* ```js
|
|
9715
|
+
* hiddenActions: [Action.DeepAnalysisPill]
|
|
9716
|
+
* ```
|
|
9717
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9718
|
+
*/
|
|
9719
|
+
DeepAnalysisPill = "deepAnalysisPill",
|
|
9720
|
+
/**
|
|
9721
|
+
* The **Data Literacy** starter prompt pill, next to
|
|
9722
|
+
* {@link Action.QuickSearchPill} above the Spotter chat input.
|
|
9723
|
+
*
|
|
9724
|
+
* Unlike the other two pills it opens no card: clicking it submits a prompt
|
|
9725
|
+
* that describes the data the model can answer over, helping a user who does
|
|
9726
|
+
* not yet know what is in the data source. The prompt text always comes from
|
|
9727
|
+
* ThoughtSpot, so only its label is customizable. Visible by default.
|
|
9728
|
+
* @example
|
|
9729
|
+
* ```js
|
|
9730
|
+
* hiddenActions: [Action.DataLiteracyPill]
|
|
9731
|
+
* ```
|
|
9732
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9733
|
+
*/
|
|
9734
|
+
DataLiteracyPill = "dataLiteracyPill",
|
|
8783
9735
|
/**
|
|
8784
9736
|
* The **Include current period** checkbox for date filters.
|
|
8785
9737
|
* Controls the visibility and availability of the option to include
|
|
@@ -8927,7 +9879,39 @@ export declare enum Action {
|
|
|
8927
9879
|
* disabledActions: [Action.SpotterAnalystSidebar]
|
|
8928
9880
|
* ```
|
|
8929
9881
|
*/
|
|
8930
|
-
SpotterAnalystSidebar = "spotterAnalystSidebar"
|
|
9882
|
+
SpotterAnalystSidebar = "spotterAnalystSidebar",
|
|
9883
|
+
/**
|
|
9884
|
+
* Controls visibility and disable state of the analyst list
|
|
9885
|
+
* ("Show all") in the Spotter Analyst interface.
|
|
9886
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
9887
|
+
* @example
|
|
9888
|
+
* ```js
|
|
9889
|
+
* hiddenActions: [Action.SpotterAnalystList]
|
|
9890
|
+
* disabledActions: [Action.SpotterAnalystList]
|
|
9891
|
+
* ```
|
|
9892
|
+
*/
|
|
9893
|
+
SpotterAnalystList = "spotterAnalystList",
|
|
9894
|
+
/**
|
|
9895
|
+
* Controls visibility and disable state of the default Spotter analyst
|
|
9896
|
+
* entry in the Spotter Analyst interface.
|
|
9897
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
9898
|
+
* @example
|
|
9899
|
+
* ```js
|
|
9900
|
+
* hiddenActions: [Action.SpotterDefaultAnalyst]
|
|
9901
|
+
* disabledActions: [Action.SpotterDefaultAnalyst]
|
|
9902
|
+
* ```
|
|
9903
|
+
*/
|
|
9904
|
+
SpotterDefaultAnalyst = "spotterDefaultAnalyst",
|
|
9905
|
+
/**
|
|
9906
|
+
* The **Spotter** button in the Liveboard header.
|
|
9907
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
9908
|
+
* @example
|
|
9909
|
+
* ```js
|
|
9910
|
+
* hiddenActions: [Action.SpotterOnLiveboard]
|
|
9911
|
+
* disabledActions: [Action.SpotterOnLiveboard]
|
|
9912
|
+
* ```
|
|
9913
|
+
*/
|
|
9914
|
+
SpotterOnLiveboard = "spotterOnLiveboard"
|
|
8931
9915
|
}
|
|
8932
9916
|
export declare enum PrefetchFeatures {
|
|
8933
9917
|
FullApp = "FullApp",
|
|
@@ -9265,7 +10249,9 @@ export declare enum EmbedErrorCodes {
|
|
|
9265
10249
|
/** UpdateFilters payload is invalid - missing or malformed filter/filters */
|
|
9266
10250
|
UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
|
|
9267
10251
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
9268
|
-
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
|
|
10252
|
+
DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD",
|
|
10253
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
10254
|
+
UPDATEPARAMETERS_INVALID_PAYLOAD = "UPDATEPARAMETERS_INVALID_PAYLOAD"
|
|
9269
10255
|
}
|
|
9270
10256
|
/**
|
|
9271
10257
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -9418,7 +10404,7 @@ export type ApiInterceptFlags = {
|
|
|
9418
10404
|
* const embed = new LiveboardEmbed('#embed', {
|
|
9419
10405
|
* ...viewConfig,
|
|
9420
10406
|
* enableApiIntercept: true,
|
|
9421
|
-
* interceptUrls: [InterceptedApiType.
|
|
10407
|
+
* interceptUrls: [InterceptedApiType.LiveboardData],
|
|
9422
10408
|
* })
|
|
9423
10409
|
* ```
|
|
9424
10410
|
*
|
|
@@ -9911,6 +10897,43 @@ export interface LiveboardTab {
|
|
|
9911
10897
|
name: string;
|
|
9912
10898
|
[key: string]: any;
|
|
9913
10899
|
}
|
|
10900
|
+
export interface LiveboardGroup {
|
|
10901
|
+
id: string;
|
|
10902
|
+
name: string;
|
|
10903
|
+
[key: string]: any;
|
|
10904
|
+
}
|
|
10905
|
+
/**
|
|
10906
|
+
* Levels at which a filter or parameter can be applied.
|
|
10907
|
+
*/
|
|
10908
|
+
export declare enum ApplicabilityLevel {
|
|
10909
|
+
Liveboard = "LIVEBOARD",
|
|
10910
|
+
Tab = "TAB",
|
|
10911
|
+
Group = "GROUP"
|
|
10912
|
+
}
|
|
10913
|
+
/**
|
|
10914
|
+
* Scopes a filter or parameter to a specific target.
|
|
10915
|
+
* At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
|
|
10916
|
+
* is not required.
|
|
10917
|
+
*/
|
|
10918
|
+
export interface Applicability {
|
|
10919
|
+
level: ApplicabilityLevel;
|
|
10920
|
+
targetId?: string;
|
|
10921
|
+
}
|
|
10922
|
+
export interface FilterUpdate {
|
|
10923
|
+
column: string;
|
|
10924
|
+
oper: string;
|
|
10925
|
+
values: string[];
|
|
10926
|
+
type?: string;
|
|
10927
|
+
applicability?: Applicability;
|
|
10928
|
+
}
|
|
10929
|
+
export interface LiveboardFilter {
|
|
10930
|
+
applicability?: Applicability;
|
|
10931
|
+
[key: string]: any;
|
|
10932
|
+
}
|
|
10933
|
+
export interface LiveboardParameter {
|
|
10934
|
+
applicability?: Applicability;
|
|
10935
|
+
[key: string]: any;
|
|
10936
|
+
}
|
|
9914
10937
|
export declare enum UIPassthroughEvent {
|
|
9915
10938
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
9916
10939
|
SaveAnswer = "saveAnswer",
|
|
@@ -9927,6 +10950,7 @@ export declare enum UIPassthroughEvent {
|
|
|
9927
10950
|
GetParameters = "getParameters",
|
|
9928
10951
|
GetTML = "getTML",
|
|
9929
10952
|
GetTabs = "getTabs",
|
|
10953
|
+
GetGroups = "getGroups",
|
|
9930
10954
|
GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
|
|
9931
10955
|
}
|
|
9932
10956
|
export type UIPassthroughContractBase = {
|
|
@@ -10005,7 +11029,7 @@ export type UIPassthroughContractBase = {
|
|
|
10005
11029
|
vizId?: string;
|
|
10006
11030
|
};
|
|
10007
11031
|
response: {
|
|
10008
|
-
liveboardFilters:
|
|
11032
|
+
liveboardFilters: LiveboardFilter[];
|
|
10009
11033
|
runtimeFilters: RuntimeFilter[];
|
|
10010
11034
|
};
|
|
10011
11035
|
};
|
|
@@ -10018,7 +11042,7 @@ export type UIPassthroughContractBase = {
|
|
|
10018
11042
|
[UIPassthroughEvent.GetParameters]: {
|
|
10019
11043
|
request: Record<string, never>;
|
|
10020
11044
|
response: {
|
|
10021
|
-
parameters:
|
|
11045
|
+
parameters: LiveboardParameter[];
|
|
10022
11046
|
};
|
|
10023
11047
|
};
|
|
10024
11048
|
[UIPassthroughEvent.GetTML]: {
|
|
@@ -10036,6 +11060,14 @@ export type UIPassthroughContractBase = {
|
|
|
10036
11060
|
Tabs: LiveboardTab[];
|
|
10037
11061
|
};
|
|
10038
11062
|
};
|
|
11063
|
+
[UIPassthroughEvent.GetGroups]: {
|
|
11064
|
+
request: Record<string, never>;
|
|
11065
|
+
response: {
|
|
11066
|
+
orderedGroupIds: string[];
|
|
11067
|
+
numberOfGroups: number;
|
|
11068
|
+
Groups: LiveboardGroup[];
|
|
11069
|
+
};
|
|
11070
|
+
};
|
|
10039
11071
|
[UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
|
|
10040
11072
|
request: Record<string, never>;
|
|
10041
11073
|
response: {
|
|
@@ -10047,18 +11079,8 @@ export type UIPassthroughContractBase = {
|
|
|
10047
11079
|
};
|
|
10048
11080
|
[UIPassthroughEvent.UpdateFilters]: {
|
|
10049
11081
|
request: {
|
|
10050
|
-
filter?:
|
|
10051
|
-
|
|
10052
|
-
oper: string;
|
|
10053
|
-
values: string[];
|
|
10054
|
-
type?: string;
|
|
10055
|
-
};
|
|
10056
|
-
filters?: {
|
|
10057
|
-
column: string;
|
|
10058
|
-
oper: string;
|
|
10059
|
-
values: string[];
|
|
10060
|
-
type?: string;
|
|
10061
|
-
}[];
|
|
11082
|
+
filter?: FilterUpdate;
|
|
11083
|
+
filters?: FilterUpdate[];
|
|
10062
11084
|
};
|
|
10063
11085
|
response: unknown;
|
|
10064
11086
|
};
|
|
@@ -10091,6 +11113,7 @@ export type EmbedApiHostEventMapping = {
|
|
|
10091
11113
|
[HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
|
|
10092
11114
|
[HostEvent.GetTML]: UIPassthroughEvent.GetTML;
|
|
10093
11115
|
[HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
|
|
11116
|
+
[HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
|
|
10094
11117
|
[HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
|
|
10095
11118
|
};
|
|
10096
11119
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
@@ -10135,6 +11158,7 @@ declare class HostEventClient {
|
|
|
10135
11158
|
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
10136
11159
|
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
10137
11160
|
protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
|
|
11161
|
+
protected handleUpdateParametersEvent(payload: HostEventRequest<HostEvent.UpdateParameters>, context?: ContextType): Promise<any>;
|
|
10138
11162
|
protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
|
|
10139
11163
|
/**
|
|
10140
11164
|
* Dispatches a host event using the appropriate channel:
|
|
@@ -10145,7 +11169,7 @@ declare class HostEventClient {
|
|
|
10145
11169
|
* @param payload - Optional payload for the event
|
|
10146
11170
|
* @param context - Optional context (e.g. vizId) for scoped operations
|
|
10147
11171
|
*/
|
|
10148
|
-
triggerHostEvent<HostEventT extends HostEvent, PayloadT
|
|
11172
|
+
triggerHostEvent<HostEventT extends HostEvent, PayloadT = HostEventRequest<HostEventT>, ContextT extends ContextType = ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
10149
11173
|
}
|
|
10150
11174
|
declare class TsEmbed {
|
|
10151
11175
|
/**
|
|
@@ -10350,6 +11374,12 @@ declare class TsEmbed {
|
|
|
10350
11374
|
protected getEmbedParamsObject(): Record<any, any>;
|
|
10351
11375
|
protected getRootIframeSrc(): string;
|
|
10352
11376
|
protected createIframeEl(frameSrc: string): HTMLIFrameElement;
|
|
11377
|
+
/**
|
|
11378
|
+
* Returns a merged {@link PreRenderConfig} object where each shared key
|
|
11379
|
+
* prefers `preRenderConfig.key` over the top-level `viewConfig.key` for
|
|
11380
|
+
* backward compatibility.
|
|
11381
|
+
*/
|
|
11382
|
+
protected getPreRenderConfig(): PreRenderConfig;
|
|
10353
11383
|
/**
|
|
10354
11384
|
* Returns true if this embed instance is configured for pre-rendering.
|
|
10355
11385
|
*/
|
|
@@ -10388,12 +11418,14 @@ declare class TsEmbed {
|
|
|
10388
11418
|
* fresh element; an element passed directly cannot be re-resolved.
|
|
10389
11419
|
*/
|
|
10390
11420
|
private resolvePreRenderContainerTarget;
|
|
11421
|
+
private inheritPreRenderContainer;
|
|
11422
|
+
private getCustomPreRenderContainer;
|
|
10391
11423
|
/**
|
|
10392
|
-
* Makes the container a positioning context for the absolutely
|
|
10393
|
-
* wrapper, stashing the original inline `position` on the element
|
|
10394
|
-
* destroy() can restore it exactly, leaving no trace. Recording it
|
|
10395
|
-
* element rather than per-instance lets the override be reverted even
|
|
10396
|
-
* embeds share the same container.
|
|
11424
|
+
* Makes the resolved container a positioning context for the absolutely
|
|
11425
|
+
* positioned wrapper, stashing the original inline `position` on the element
|
|
11426
|
+
* (once) so destroy() can restore it exactly, leaving no trace. Recording it
|
|
11427
|
+
* on the element rather than per-instance lets the override be reverted even
|
|
11428
|
+
* when embeds share the same container.
|
|
10397
11429
|
*/
|
|
10398
11430
|
private applyPreRenderContainerPositioning;
|
|
10399
11431
|
/**
|
|
@@ -10541,7 +11573,7 @@ declare class TsEmbed {
|
|
|
10541
11573
|
* ```
|
|
10542
11574
|
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl (for context parameter)
|
|
10543
11575
|
*/
|
|
10544
|
-
trigger<HostEventT extends HostEvent, PayloadT
|
|
11576
|
+
trigger<HostEventT extends HostEvent, PayloadT = HostEventRequest<HostEventT>, ContextT extends ContextType = ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
10545
11577
|
/**
|
|
10546
11578
|
* Triggers an event to the embedded app, skipping the UI flow.
|
|
10547
11579
|
* @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
|
|
@@ -10737,6 +11769,45 @@ export interface SearchOptions {
|
|
|
10737
11769
|
*/
|
|
10738
11770
|
searchQuery: string;
|
|
10739
11771
|
}
|
|
11772
|
+
/**
|
|
11773
|
+
* The query mode Spotter uses when answering a question.
|
|
11774
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11775
|
+
*/
|
|
11776
|
+
export declare enum SpotterQueryMode {
|
|
11777
|
+
FAST_SEARCH = "fastSearch",
|
|
11778
|
+
RESEARCH = "research"
|
|
11779
|
+
}
|
|
11780
|
+
/**
|
|
11781
|
+
* Configuration for the pin/unpin conversation feature in the Spotter sidebar.
|
|
11782
|
+
* Grouped into one object because pin exposes several related settings
|
|
11783
|
+
* (enable + label overrides), unlike single-item actions like rename or
|
|
11784
|
+
* delete.
|
|
11785
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11786
|
+
*/
|
|
11787
|
+
export interface SpotterChatPinConfig {
|
|
11788
|
+
/**
|
|
11789
|
+
* Enables the pin/unpin conversation feature in embedded Spotter. Disabled
|
|
11790
|
+
* by default — hosts must opt in. When off, the Pin/Unpin menu entry and
|
|
11791
|
+
* the pin glyph are hidden and the PinSpotterConversation /
|
|
11792
|
+
* UnpinSpotterConversation host events are no-ops. Native (non-embedded)
|
|
11793
|
+
* Spotter is unaffected and ships pin enabled.
|
|
11794
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11795
|
+
* @default false
|
|
11796
|
+
*/
|
|
11797
|
+
enabled?: boolean;
|
|
11798
|
+
/**
|
|
11799
|
+
* Custom label text for the pin action in the conversation edit menu.
|
|
11800
|
+
* Defaults to translated "Pin" text.
|
|
11801
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11802
|
+
*/
|
|
11803
|
+
pinLabel?: string;
|
|
11804
|
+
/**
|
|
11805
|
+
* Custom label text for the unpin action in the conversation edit menu.
|
|
11806
|
+
* Defaults to translated "Unpin" text.
|
|
11807
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11808
|
+
*/
|
|
11809
|
+
unpinLabel?: string;
|
|
11810
|
+
}
|
|
10740
11811
|
/**
|
|
10741
11812
|
* Configuration for the Spotter sidebar.
|
|
10742
11813
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
@@ -10774,6 +11845,12 @@ export interface SpotterSidebarViewConfig {
|
|
|
10774
11845
|
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
10775
11846
|
*/
|
|
10776
11847
|
spotterChatDeleteLabel?: string;
|
|
11848
|
+
/**
|
|
11849
|
+
* Pin/unpin conversation feature config (enable + label overrides).
|
|
11850
|
+
* Off by default in embed — hosts opt in via `enabled`.
|
|
11851
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11852
|
+
*/
|
|
11853
|
+
spotterChatPinConfig?: SpotterChatPinConfig;
|
|
10777
11854
|
/**
|
|
10778
11855
|
* Custom title text for the delete conversation confirmation modal.
|
|
10779
11856
|
* Defaults to translated "Delete chat" text.
|
|
@@ -10825,50 +11902,281 @@ export interface SpotterSidebarViewConfig {
|
|
|
10825
11902
|
spotterAnalystsLabel?: string;
|
|
10826
11903
|
}
|
|
10827
11904
|
/**
|
|
10828
|
-
* Configuration for
|
|
10829
|
-
*
|
|
11905
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
11906
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
11907
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
10830
11908
|
* @group Embed components
|
|
10831
11909
|
*/
|
|
10832
|
-
export interface
|
|
11910
|
+
export interface SpotterShareConversationConfig {
|
|
10833
11911
|
/**
|
|
10834
|
-
*
|
|
10835
|
-
*
|
|
10836
|
-
* separately via `toolResponseCardBrandingLabel`.
|
|
10837
|
-
* External MCP tool branding is not affected.
|
|
11912
|
+
* Enables sharing of the conversation.
|
|
11913
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
10838
11914
|
* @default false
|
|
10839
11915
|
*/
|
|
10840
|
-
|
|
11916
|
+
enableShareConversation?: boolean;
|
|
10841
11917
|
/**
|
|
10842
|
-
*
|
|
10843
|
-
*
|
|
10844
|
-
*
|
|
10845
|
-
* independently of `hideToolResponseCardBranding`.
|
|
10846
|
-
* External MCP tool branding is not affected.
|
|
11918
|
+
* Header Share button + sidebar Share item label.
|
|
11919
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11920
|
+
* @default "Share"
|
|
10847
11921
|
*/
|
|
10848
|
-
|
|
11922
|
+
spotterShareLabel?: string;
|
|
10849
11923
|
/**
|
|
10850
|
-
*
|
|
10851
|
-
*
|
|
10852
|
-
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
10853
|
-
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
10854
|
-
* @default false
|
|
11924
|
+
* Share modal title.
|
|
11925
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
10855
11926
|
*/
|
|
10856
|
-
|
|
11927
|
+
spotterShareModalTitle?: string;
|
|
10857
11928
|
/**
|
|
10858
|
-
*
|
|
10859
|
-
*
|
|
10860
|
-
*
|
|
10861
|
-
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
11929
|
+
* Modal confirm button label.
|
|
11930
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11931
|
+
* @default "Share"
|
|
10862
11932
|
*/
|
|
10863
|
-
|
|
11933
|
+
spotterShareConfirmLabel?: string;
|
|
11934
|
+
/**
|
|
11935
|
+
* Modal cancel button label.
|
|
11936
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11937
|
+
* @default "Cancel"
|
|
11938
|
+
*/
|
|
11939
|
+
spotterShareCancelLabel?: string;
|
|
11940
|
+
/**
|
|
11941
|
+
* "Add users or groups" label.
|
|
11942
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11943
|
+
*/
|
|
11944
|
+
spotterShareAddUsersLabel?: string;
|
|
11945
|
+
/**
|
|
11946
|
+
* Empty-state title ("No users added yet").
|
|
11947
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11948
|
+
*/
|
|
11949
|
+
spotterShareEmptyTitle?: string;
|
|
11950
|
+
/**
|
|
11951
|
+
* Empty-state subtitle ("Not shared with any user").
|
|
11952
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11953
|
+
*/
|
|
11954
|
+
spotterShareEmptySubtitle?: string;
|
|
11955
|
+
/**
|
|
11956
|
+
* "Include new messages since last shared version" checkbox label.
|
|
11957
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11958
|
+
*/
|
|
11959
|
+
spotterShareIncludeNewMessagesLabel?: string;
|
|
11960
|
+
/**
|
|
11961
|
+
* Footer note when the snapshot is current ("…up to the current moment…").
|
|
11962
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11963
|
+
*/
|
|
11964
|
+
spotterShareUpToCurrentLabel?: string;
|
|
11965
|
+
/**
|
|
11966
|
+
* Stale-snapshot info banner text ("All added users and groups will receive…").
|
|
11967
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11968
|
+
*/
|
|
11969
|
+
spotterShareStaleInfoLabel?: string;
|
|
11970
|
+
/**
|
|
11971
|
+
* Read-only shared-view data-access banner message.
|
|
11972
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11973
|
+
*/
|
|
11974
|
+
spotterSharedConversationBannerMessage?: string;
|
|
11975
|
+
/**
|
|
11976
|
+
* Read-only shared-view Exit button label.
|
|
11977
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11978
|
+
* @default "Exit"
|
|
11979
|
+
*/
|
|
11980
|
+
spotterSharedConversationExitLabel?: string;
|
|
11981
|
+
}
|
|
11982
|
+
/**
|
|
11983
|
+
* A single starter prompt question shown under a category pill.
|
|
11984
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11985
|
+
* @group Embed components
|
|
11986
|
+
*/
|
|
11987
|
+
export interface StarterPromptQuestion {
|
|
11988
|
+
/**
|
|
11989
|
+
* Short label shown as a clickable suggestion. Falls back to `prompt` when
|
|
11990
|
+
* omitted. ThoughtSpot truncates it beyond 80 characters.
|
|
11991
|
+
*/
|
|
11992
|
+
label?: string;
|
|
11993
|
+
/**
|
|
11994
|
+
* Prompt text sent to Spotter on click. ThoughtSpot truncates it beyond
|
|
11995
|
+
* 300 characters.
|
|
11996
|
+
*/
|
|
11997
|
+
prompt: string;
|
|
11998
|
+
}
|
|
11999
|
+
/**
|
|
12000
|
+
* Configuration for a starter prompt category with questions
|
|
12001
|
+
* (`quick` and `research`).
|
|
12002
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12003
|
+
* @group Embed components
|
|
12004
|
+
*/
|
|
12005
|
+
export interface StarterPromptCategory {
|
|
12006
|
+
/**
|
|
12007
|
+
* Overrides the default category pill label. ThoughtSpot truncates it
|
|
12008
|
+
* beyond 30 characters.
|
|
12009
|
+
*/
|
|
12010
|
+
label?: string;
|
|
12011
|
+
/**
|
|
12012
|
+
* Replaces the backend-generated prompts. ThoughtSpot renders the first 4
|
|
12013
|
+
* and drops any entry without a `prompt`.
|
|
12014
|
+
*/
|
|
12015
|
+
questions?: StarterPromptQuestion[];
|
|
12016
|
+
}
|
|
12017
|
+
/**
|
|
12018
|
+
* Configuration for the Data Literacy starter prompt category.
|
|
12019
|
+
* Only the label is customizable; the prompt text comes from the backend.
|
|
12020
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12021
|
+
* @group Embed components
|
|
12022
|
+
*/
|
|
12023
|
+
export interface StarterPreviewDataCategory {
|
|
12024
|
+
/**
|
|
12025
|
+
* Overrides the default category pill label. ThoughtSpot truncates it
|
|
12026
|
+
* beyond 30 characters.
|
|
12027
|
+
*/
|
|
12028
|
+
label?: string;
|
|
12029
|
+
}
|
|
12030
|
+
/**
|
|
12031
|
+
* Content configuration for the Spotter starter prompts.
|
|
12032
|
+
* Keys are fixed: `quick` (Basic Search), `research` (Deep Analysis),
|
|
12033
|
+
* `previewData` (Data Literacy) and `liveboard` (Liveboard chat panel).
|
|
12034
|
+
*
|
|
12035
|
+
* Note: this controls the Spotter chat interface only. The starter prompts on
|
|
12036
|
+
* the Liveboard SpotterViz surface are configured separately through
|
|
12037
|
+
* {@link SpotterVizConfig.customStarterPrompts}.
|
|
12038
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12039
|
+
* @group Embed components
|
|
12040
|
+
*/
|
|
12041
|
+
export interface StarterPromptsConfig {
|
|
12042
|
+
/**
|
|
12043
|
+
* Turns the starter prompts surface on. Must be set explicitly, an
|
|
12044
|
+
* unset flag leaves the surface off.
|
|
12045
|
+
*
|
|
12046
|
+
* Either this or `enableStarterPrompts` turns the surface on, so `false`
|
|
12047
|
+
* here does not switch it off while `enableStarterPrompts` is `true`.
|
|
12048
|
+
* @default false
|
|
12049
|
+
*/
|
|
12050
|
+
enable?: boolean;
|
|
12051
|
+
/** Basic Search category configuration. */
|
|
12052
|
+
quick?: StarterPromptCategory;
|
|
12053
|
+
/** Deep Analysis category configuration. */
|
|
12054
|
+
research?: StarterPromptCategory;
|
|
12055
|
+
/** Data Literacy category configuration. */
|
|
12056
|
+
previewData?: StarterPreviewDataCategory;
|
|
12057
|
+
/**
|
|
12058
|
+
* Starter prompts for the Spotter chat panel on a Liveboard.
|
|
12059
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
12060
|
+
*/
|
|
12061
|
+
liveboard?: StarterPromptQuestion[];
|
|
12062
|
+
}
|
|
12063
|
+
/**
|
|
12064
|
+
* Configuration for customizing Spotter chat UI branding.
|
|
12065
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
12066
|
+
* @group Embed components
|
|
12067
|
+
*/
|
|
12068
|
+
export interface SpotterChatViewConfig {
|
|
12069
|
+
/**
|
|
12070
|
+
* Hides the ThoughtSpot logo/icon in tool response
|
|
12071
|
+
* cards. The branding label prefix is controlled
|
|
12072
|
+
* separately via `toolResponseCardBrandingLabel`.
|
|
12073
|
+
* External MCP tool branding is not affected.
|
|
12074
|
+
* @default false
|
|
12075
|
+
*/
|
|
12076
|
+
hideToolResponseCardBranding?: boolean;
|
|
12077
|
+
/**
|
|
12078
|
+
* Custom label to replace the "ThoughtSpot" prefix
|
|
12079
|
+
* in tool response cards. Set to an empty string
|
|
12080
|
+
* `''` to hide the prefix entirely. Works
|
|
12081
|
+
* independently of `hideToolResponseCardBranding`.
|
|
12082
|
+
* External MCP tool branding is not affected.
|
|
12083
|
+
*/
|
|
12084
|
+
toolResponseCardBrandingLabel?: string;
|
|
12085
|
+
/**
|
|
12086
|
+
* Enables file upload in the Spotter chat interface.
|
|
12087
|
+
*
|
|
12088
|
+
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
12089
|
+
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
12090
|
+
* @default false
|
|
12091
|
+
*/
|
|
12092
|
+
spotterFileUploadEnabled?: boolean;
|
|
12093
|
+
/**
|
|
12094
|
+
* Restricts the allowed file types for Spotter file upload.
|
|
12095
|
+
*
|
|
12096
|
+
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
12097
|
+
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
12098
|
+
*/
|
|
12099
|
+
spotterFileUploadFileTypes?: SpotterFileUploadFileTypes;
|
|
10864
12100
|
/**
|
|
10865
12101
|
* Enables starter prompts in the Spotter chat interface.
|
|
10866
12102
|
*
|
|
10867
|
-
*
|
|
12103
|
+
* Either this or `starterPrompts.enable` turns the surface on, so it stays
|
|
12104
|
+
* on while this is `true` even if `starterPrompts.enable` is `false`.
|
|
12105
|
+
*
|
|
12106
|
+
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
10868
12107
|
* @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
|
|
10869
12108
|
* @default false
|
|
10870
12109
|
*/
|
|
10871
12110
|
enableStarterPrompts?: boolean;
|
|
12111
|
+
/**
|
|
12112
|
+
* Customizes the labels and questions of the Spotter starter prompts.
|
|
12113
|
+
* Individual pills are hidden or shown with `hiddenActions` /
|
|
12114
|
+
* `visibleActions` using `Action.QuickSearchPill`,
|
|
12115
|
+
* `Action.DeepAnalysisPill` and `Action.DataLiteracyPill`.
|
|
12116
|
+
*
|
|
12117
|
+
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
12118
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12119
|
+
* @example
|
|
12120
|
+
* ```js
|
|
12121
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12122
|
+
* worksheetId: 'worksheet-id',
|
|
12123
|
+
* hiddenActions: [Action.DeepAnalysisPill],
|
|
12124
|
+
* spotterChatConfig: {
|
|
12125
|
+
* starterPrompts: {
|
|
12126
|
+
* enable: true,
|
|
12127
|
+
* quick: {
|
|
12128
|
+
* label: 'Quick questions',
|
|
12129
|
+
* questions: [
|
|
12130
|
+
* { label: 'Top products', prompt: 'What are the top products by revenue?' },
|
|
12131
|
+
* ],
|
|
12132
|
+
* },
|
|
12133
|
+
* previewData: { label: 'Explore your data' },
|
|
12134
|
+
* },
|
|
12135
|
+
* },
|
|
12136
|
+
* })
|
|
12137
|
+
* ```
|
|
12138
|
+
*/
|
|
12139
|
+
starterPrompts?: StarterPromptsConfig;
|
|
12140
|
+
/**
|
|
12141
|
+
* Opens the Spotter chat panel when the Liveboard loads.
|
|
12142
|
+
*
|
|
12143
|
+
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
12144
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
12145
|
+
* @default true
|
|
12146
|
+
* @example
|
|
12147
|
+
* ```js
|
|
12148
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
12149
|
+
* liveboardId: 'liveboard-id',
|
|
12150
|
+
* spotterChatConfig: {
|
|
12151
|
+
* openSpotterOnLiveboardByDefault: false,
|
|
12152
|
+
* },
|
|
12153
|
+
* })
|
|
12154
|
+
* ```
|
|
12155
|
+
*/
|
|
12156
|
+
openSpotterOnLiveboardByDefault?: boolean;
|
|
12157
|
+
}
|
|
12158
|
+
/**
|
|
12159
|
+
* Configuration for the Spotter Analyst experience.
|
|
12160
|
+
* Can be used in SpotterEmbed.
|
|
12161
|
+
* @group Embed components
|
|
12162
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
12163
|
+
* @example
|
|
12164
|
+
* ```js
|
|
12165
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12166
|
+
* ... //other embed view config
|
|
12167
|
+
* spotterAnalystConfig: {
|
|
12168
|
+
* analystId: 'analyst-id-1234',
|
|
12169
|
+
* },
|
|
12170
|
+
* })
|
|
12171
|
+
* ```
|
|
12172
|
+
*/
|
|
12173
|
+
export interface SpotterAnalystConfig {
|
|
12174
|
+
/**
|
|
12175
|
+
* Pins the embed to a single spotter analyst. Implies no default Spotter
|
|
12176
|
+
* and no "Show all".
|
|
12177
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
12178
|
+
*/
|
|
12179
|
+
analystId?: string;
|
|
10872
12180
|
}
|
|
10873
12181
|
/**
|
|
10874
12182
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -10878,8 +12186,43 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
10878
12186
|
/**
|
|
10879
12187
|
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
10880
12188
|
* this object to query data and generate Answers.
|
|
12189
|
+
* This field is optional. If not provided, Spotter loads using the
|
|
12190
|
+
* previously selected user data source.
|
|
10881
12191
|
*/
|
|
10882
|
-
worksheetId
|
|
12192
|
+
worksheetId?: string;
|
|
12193
|
+
/**
|
|
12194
|
+
* The array of data source GUIDs to set on load. Spotter uses
|
|
12195
|
+
* these GUIDs to query data and generate Answers.
|
|
12196
|
+
* dataSources is preferred over worksheetId if both are provided.
|
|
12197
|
+
* The feature is currently behind a feature flag.
|
|
12198
|
+
*
|
|
12199
|
+
* Supported embed types: `SpotterEmbed`
|
|
12200
|
+
* @example
|
|
12201
|
+
* ```js
|
|
12202
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12203
|
+
* // ...other embed view config
|
|
12204
|
+
* dataSources: ['id-2345', 'id-2345'],
|
|
12205
|
+
* });
|
|
12206
|
+
* ```
|
|
12207
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12208
|
+
*/
|
|
12209
|
+
dataSources?: string[];
|
|
12210
|
+
/**
|
|
12211
|
+
* Configuration for the Spotter Analyst experience.
|
|
12212
|
+
*
|
|
12213
|
+
* Supported embed types: `SpotterEmbed`
|
|
12214
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
12215
|
+
* @example
|
|
12216
|
+
* ```js
|
|
12217
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12218
|
+
* ... //other embed view config
|
|
12219
|
+
* spotterAnalystConfig: {
|
|
12220
|
+
* analystId: 'analyst-id-1234',
|
|
12221
|
+
* },
|
|
12222
|
+
* })
|
|
12223
|
+
* ```
|
|
12224
|
+
*/
|
|
12225
|
+
spotterAnalystConfig?: SpotterAnalystConfig;
|
|
10883
12226
|
/**
|
|
10884
12227
|
* Ability to pass a starting search query to the conversation.
|
|
10885
12228
|
*/
|
|
@@ -11039,6 +12382,39 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11039
12382
|
* ```
|
|
11040
12383
|
*/
|
|
11041
12384
|
updatedSpotterChatPrompt?: boolean;
|
|
12385
|
+
/**
|
|
12386
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
12387
|
+
*
|
|
12388
|
+
* Supported embed types: `SpotterEmbed`
|
|
12389
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12390
|
+
* @default false
|
|
12391
|
+
* @example
|
|
12392
|
+
* ```js
|
|
12393
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12394
|
+
* ... //other embed view config
|
|
12395
|
+
* showSpotterRadiance : true,
|
|
12396
|
+
* })
|
|
12397
|
+
* ```
|
|
12398
|
+
*/
|
|
12399
|
+
showSpotterRadiance?: boolean;
|
|
12400
|
+
/**
|
|
12401
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
12402
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
12403
|
+
* instance only; it does not persist as a user preference and does
|
|
12404
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
12405
|
+
*
|
|
12406
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
12407
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12408
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
12409
|
+
* @example
|
|
12410
|
+
* ```js
|
|
12411
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12412
|
+
* ... //other embed view config
|
|
12413
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
12414
|
+
* })
|
|
12415
|
+
* ```
|
|
12416
|
+
*/
|
|
12417
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
11042
12418
|
/**
|
|
11043
12419
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
11044
12420
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -11097,6 +12473,59 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11097
12473
|
* ```
|
|
11098
12474
|
*/
|
|
11099
12475
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
12476
|
+
/**
|
|
12477
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
12478
|
+
*
|
|
12479
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
12480
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12481
|
+
* @example
|
|
12482
|
+
* ```js
|
|
12483
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12484
|
+
* ... //other embed view config
|
|
12485
|
+
* spotterShareConversationConfig: {
|
|
12486
|
+
* enableShareConversation: true,
|
|
12487
|
+
* },
|
|
12488
|
+
* })
|
|
12489
|
+
* ```
|
|
12490
|
+
*/
|
|
12491
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
12492
|
+
/**
|
|
12493
|
+
* The ID of a shared Spotter conversation to open directly in the read-only
|
|
12494
|
+
* reader view. Use this to land a share recipient in the shared conversation
|
|
12495
|
+
* when they open a host-configured `CONVERSATION_URL` share link: read the
|
|
12496
|
+
* `{conversation-id}` from your page URL and pass it here.
|
|
12497
|
+
*
|
|
12498
|
+
* Requires the Spotter conversation-sharing feature to be enabled
|
|
12499
|
+
* (`spotterShareConversationConfig.enableShareConversation`). The recipient
|
|
12500
|
+
* must be an authorized sharee — the server returns access-denied otherwise.
|
|
12501
|
+
*
|
|
12502
|
+
* Supported embed types: `SpotterEmbed`
|
|
12503
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12504
|
+
* @example
|
|
12505
|
+
* ```js
|
|
12506
|
+
* const convId = new URLSearchParams(window.location.search).get('conversation-id');
|
|
12507
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12508
|
+
* ... //other embed view config
|
|
12509
|
+
* sharedConversationId: convId,
|
|
12510
|
+
* })
|
|
12511
|
+
* ```
|
|
12512
|
+
*/
|
|
12513
|
+
sharedConversationId?: string;
|
|
12514
|
+
/**
|
|
12515
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
12516
|
+
*
|
|
12517
|
+
* Supported embed types: `SpotterEmbed`
|
|
12518
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12519
|
+
* @default false
|
|
12520
|
+
* @example
|
|
12521
|
+
* ```js
|
|
12522
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12523
|
+
* ... //other embed view config
|
|
12524
|
+
* updatedSpotterExperience : true,
|
|
12525
|
+
* })
|
|
12526
|
+
* ```
|
|
12527
|
+
*/
|
|
12528
|
+
updatedSpotterExperience?: boolean;
|
|
11100
12529
|
}
|
|
11101
12530
|
/**
|
|
11102
12531
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -11113,7 +12542,9 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
11113
12542
|
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
11114
12543
|
embedParams?: {
|
|
11115
12544
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
12545
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
11116
12546
|
visualOverridesParams?: VisualizationOverrides | null;
|
|
12547
|
+
starterPrompts?: StarterPromptsConfig;
|
|
11117
12548
|
};
|
|
11118
12549
|
}
|
|
11119
12550
|
/**
|
|
@@ -11203,12 +12634,17 @@ export interface SpotterVizStarterPrompt {
|
|
|
11203
12634
|
* customStarterPrompts: [
|
|
11204
12635
|
* { id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }
|
|
11205
12636
|
* ],
|
|
11206
|
-
* //
|
|
12637
|
+
* // The options below require SDK: 1.51.0
|
|
11207
12638
|
* loaderHeadline: 'Crunching the numbers...',
|
|
11208
12639
|
* loaderTips: [
|
|
11209
12640
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
11210
12641
|
* { label: 'Tip', text: 'use natural language' },
|
|
11211
12642
|
* ],
|
|
12643
|
+
* liveboardBrandName: 'Reports',
|
|
12644
|
+
* spotterBrandName: 'Analyst',
|
|
12645
|
+
* insightTileBrandName: 'Insight card',
|
|
12646
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
12647
|
+
* insightTileLoaderText: 'Generating insight',
|
|
11212
12648
|
* },
|
|
11213
12649
|
* })
|
|
11214
12650
|
* ```
|
|
@@ -11256,19 +12692,47 @@ export interface SpotterVizConfig {
|
|
|
11256
12692
|
/**
|
|
11257
12693
|
* Custom headline text shown in the SpotterViz loading state.
|
|
11258
12694
|
* Replaces the default loading headline.
|
|
11259
|
-
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.
|
|
12695
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
11260
12696
|
*/
|
|
11261
12697
|
loaderHeadline?: string;
|
|
11262
12698
|
/**
|
|
11263
12699
|
* Custom tips shown in the SpotterViz loading state.
|
|
11264
12700
|
* Replaces the default loading tips with the provided list.
|
|
11265
|
-
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.
|
|
12701
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
11266
12702
|
*/
|
|
11267
12703
|
loaderTips?: SpotterVizLoaderTip[];
|
|
12704
|
+
/**
|
|
12705
|
+
* Custom term used to replace "Liveboard" in the agent's responses.
|
|
12706
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
12707
|
+
* @default ''
|
|
12708
|
+
*/
|
|
12709
|
+
liveboardBrandName?: string;
|
|
12710
|
+
/**
|
|
12711
|
+
* Custom term used to replace "Spotter" in the agent's responses.
|
|
12712
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
12713
|
+
* @default ''
|
|
12714
|
+
*/
|
|
12715
|
+
spotterBrandName?: string;
|
|
12716
|
+
/**
|
|
12717
|
+
* Custom term used to replace "Insight tile" in the UI and in the agent's responses.
|
|
12718
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
12719
|
+
* @default ''
|
|
12720
|
+
*/
|
|
12721
|
+
insightTileBrandName?: string;
|
|
12722
|
+
/**
|
|
12723
|
+
* Custom term used to replace "View plan" in the insight tile menu.
|
|
12724
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
12725
|
+
*/
|
|
12726
|
+
insightTileViewPlanLabel?: string;
|
|
12727
|
+
/**
|
|
12728
|
+
* Custom loader text shown on the insight tile.
|
|
12729
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
12730
|
+
*/
|
|
12731
|
+
insightTileLoaderText?: string;
|
|
11268
12732
|
}
|
|
11269
12733
|
/**
|
|
11270
12734
|
* A single tip shown in the SpotterViz loading state.
|
|
11271
|
-
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.
|
|
12735
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.7.0.cl
|
|
11272
12736
|
* @group Embed components
|
|
11273
12737
|
*/
|
|
11274
12738
|
export interface SpotterVizLoaderTip {
|
|
@@ -11312,7 +12776,15 @@ export declare enum Page {
|
|
|
11312
12776
|
/**
|
|
11313
12777
|
* Monitor Alerts Page
|
|
11314
12778
|
*/
|
|
11315
|
-
Monitor = "monitor"
|
|
12779
|
+
Monitor = "monitor",
|
|
12780
|
+
/**
|
|
12781
|
+
* Collections listing page
|
|
12782
|
+
*/
|
|
12783
|
+
Collections = "collections",
|
|
12784
|
+
/**
|
|
12785
|
+
* Liveboard schedules listing page
|
|
12786
|
+
*/
|
|
12787
|
+
LiveboardSchedules = "liveboard-schedules"
|
|
11316
12788
|
}
|
|
11317
12789
|
/**
|
|
11318
12790
|
* Define the initial state of column custom group accordions
|
|
@@ -11357,6 +12829,9 @@ export declare enum HomePage {
|
|
|
11357
12829
|
/**
|
|
11358
12830
|
* Modular (v2) introduces the updated Modular Home Experience.
|
|
11359
12831
|
* It serves as the foundational version of the home page.
|
|
12832
|
+
* Use {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
12833
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
12834
|
+
* @deprecated V1 and V2 home page experiences are deprecated.
|
|
11360
12835
|
*/
|
|
11361
12836
|
Modular = "v2",
|
|
11362
12837
|
/**
|
|
@@ -11430,13 +12905,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11430
12905
|
showPrimaryNavbar?: boolean;
|
|
11431
12906
|
/**
|
|
11432
12907
|
* Control the visibility of the left navigation panel on the home page
|
|
11433
|
-
* in the
|
|
12908
|
+
* in the V3 and V4 navigation and home page experience.
|
|
11434
12909
|
* If `showPrimaryNavbar` is true, that is, if the Global and Homepage
|
|
11435
12910
|
* navigation bars are visible, this flag will only hide the left navigation bar
|
|
11436
12911
|
* on the home page.
|
|
11437
12912
|
* The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
|
|
11438
12913
|
*
|
|
11439
|
-
* **Note**:
|
|
12914
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
12915
|
+
* deprecated. This attribute applies to V3 and V4 home page experiences.
|
|
11440
12916
|
*
|
|
11441
12917
|
* Supported embed types: `AppEmbed`
|
|
11442
12918
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11502,11 +12978,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11502
12978
|
hideHamburger?: boolean;
|
|
11503
12979
|
/**
|
|
11504
12980
|
* Control the visibility of the object search
|
|
11505
|
-
* on the top navigation bar in the
|
|
11506
|
-
* V2 and V3 navigation experience.
|
|
12981
|
+
* on the top navigation bar in the V3 navigation experience.
|
|
11507
12982
|
*
|
|
11508
|
-
* **Note**:
|
|
11509
|
-
*
|
|
12983
|
+
* **Note**: The classic (V1) and V2 navigation experiences are
|
|
12984
|
+
* deprecated. This attribute applies to the V3 navigation experience.
|
|
11510
12985
|
*
|
|
11511
12986
|
* Supported embed types: `AppEmbed`
|
|
11512
12987
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -11524,8 +12999,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11524
12999
|
* Control the visibility of the notification icon
|
|
11525
13000
|
* on the top navigation bar in V3 navigation experience.
|
|
11526
13001
|
*
|
|
11527
|
-
* **Note**:
|
|
11528
|
-
*
|
|
13002
|
+
* **Note**: The classic (V1) and V2 experience modes are deprecated.
|
|
13003
|
+
* This attribute applies to the V3 experience.
|
|
11529
13004
|
*
|
|
11530
13005
|
* Supported embed types: `AppEmbed`
|
|
11531
13006
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -11540,14 +13015,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11540
13015
|
*/
|
|
11541
13016
|
hideNotification?: boolean;
|
|
11542
13017
|
/**
|
|
11543
|
-
* Control the visibility of the application selection menu
|
|
11544
|
-
* in the top navigation bar in the V2 experience.
|
|
13018
|
+
* Control the visibility of the application selection menu.
|
|
11545
13019
|
* In the V3 experience, it shows or hides application selection
|
|
11546
13020
|
* icons on the left navigation panel.
|
|
11547
13021
|
* By default, the application selection menu and icons are
|
|
11548
13022
|
* shown in the UI.
|
|
11549
13023
|
*
|
|
11550
|
-
* **Note**:
|
|
13024
|
+
* **Note**: The classic (V1) and V2 experiences are deprecated.
|
|
13025
|
+
* This attribute applies to the V3 experience.
|
|
11551
13026
|
*
|
|
11552
13027
|
* Supported embed types: `AppEmbed`
|
|
11553
13028
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11565,7 +13040,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11565
13040
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
11566
13041
|
* By default, the Org switcher button is shown.
|
|
11567
13042
|
*
|
|
11568
|
-
* **Note**:
|
|
13043
|
+
* **Note**: The classic (V1) experience is deprecated. This attribute
|
|
13044
|
+
* applies to V2 (deprecated), V3 and V4 experiences.
|
|
11569
13045
|
*
|
|
11570
13046
|
* Supported embed types: `AppEmbed`
|
|
11571
13047
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11706,6 +13182,11 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11706
13182
|
* `false` fetches visualizations incrementally as
|
|
11707
13183
|
* users scroll the page to view the charts and tables.
|
|
11708
13184
|
*
|
|
13185
|
+
* From SDK 1.52.0, enabling `fullHeight` also turns on
|
|
13186
|
+
* {@link lazyLoadingForFullHeight} and
|
|
13187
|
+
* {@link enableScrollableContainerLazyLoading}, so visualizations load as
|
|
13188
|
+
* they scroll into view. Set either flag to `false` to opt out.
|
|
13189
|
+
*
|
|
11709
13190
|
* Supported embed types: `AppEmbed`
|
|
11710
13191
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
11711
13192
|
* @example
|
|
@@ -11724,6 +13205,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11724
13205
|
* Supported embed types: `AppEmbed`
|
|
11725
13206
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
11726
13207
|
* @default false
|
|
13208
|
+
* Use the discoveryExperience.homePage option with
|
|
13209
|
+
* {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
13210
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
13211
|
+
* @deprecated The V1 and V2 home page experiences are deprecated.
|
|
11727
13212
|
* @example
|
|
11728
13213
|
* ```js
|
|
11729
13214
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -11855,11 +13340,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11855
13340
|
/**
|
|
11856
13341
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
11857
13342
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
11858
|
-
* This feature is GA from version
|
|
13343
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
11859
13344
|
*
|
|
11860
13345
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
11861
13346
|
* @type {boolean}
|
|
11862
13347
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
13348
|
+
* @default true
|
|
11863
13349
|
* @example
|
|
11864
13350
|
* ```js
|
|
11865
13351
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -11872,10 +13358,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11872
13358
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
11873
13359
|
/**
|
|
11874
13360
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
13361
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
11875
13362
|
*
|
|
11876
13363
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
11877
13364
|
* @type {boolean}
|
|
11878
13365
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
13366
|
+
* @default true
|
|
11879
13367
|
* @example
|
|
11880
13368
|
* ```js
|
|
11881
13369
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -11888,10 +13376,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11888
13376
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
11889
13377
|
/**
|
|
11890
13378
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
13379
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
11891
13380
|
*
|
|
11892
13381
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
11893
13382
|
* @type {boolean}
|
|
11894
13383
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
13384
|
+
* @default true
|
|
11895
13385
|
* @example
|
|
11896
13386
|
* ```js
|
|
11897
13387
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -11903,11 +13393,17 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11903
13393
|
*/
|
|
11904
13394
|
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
11905
13395
|
/**
|
|
11906
|
-
*
|
|
13396
|
+
* Loads visualizations only as they scroll into the viewport, instead of
|
|
13397
|
+
* loading the whole full-height Liveboard at once.
|
|
13398
|
+
*
|
|
13399
|
+
* From SDK 1.52.0 this is enabled automatically whenever `fullHeight` is
|
|
13400
|
+
* `true`. On SDK 1.51.0 and earlier it defaulted to `false` and had to be
|
|
13401
|
+
* set explicitly. Set it to `false` to load every visualization upfront.
|
|
13402
|
+
* The flag has no effect unless `fullHeight` is enabled.
|
|
11907
13403
|
*
|
|
11908
13404
|
* @type {boolean}
|
|
11909
13405
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
11910
|
-
* @default
|
|
13406
|
+
* @default true when `fullHeight` is enabled, from SDK 1.52.0
|
|
11911
13407
|
* @example
|
|
11912
13408
|
* ```js
|
|
11913
13409
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -11919,27 +13415,43 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11919
13415
|
*/
|
|
11920
13416
|
lazyLoadingForFullHeight?: boolean;
|
|
11921
13417
|
/**
|
|
11922
|
-
*
|
|
13418
|
+
* Computes the visible region of the embed against its scrollable and
|
|
13419
|
+
* clipping ancestors, instead of treating the browser window as the only
|
|
13420
|
+
* viewport, and tracks scroll and resize on those ancestors.
|
|
11923
13421
|
*
|
|
11924
|
-
*
|
|
11925
|
-
*
|
|
13422
|
+
* From SDK 1.52.0 this is enabled automatically whenever `fullHeight` is
|
|
13423
|
+
* `true`. On SDK 1.51.0 and earlier it defaulted to `false` and had to be
|
|
13424
|
+
* set explicitly. Set it to `false` when the page scrolls with the window
|
|
13425
|
+
* and the embed has no clipping ancestor, to skip the extra ancestor
|
|
13426
|
+
* tracking.
|
|
11926
13427
|
*
|
|
11927
13428
|
* @type {boolean}
|
|
11928
|
-
* @default
|
|
13429
|
+
* @default true when `fullHeight` is enabled, from SDK 1.52.0
|
|
11929
13430
|
* @hidden
|
|
11930
13431
|
*/
|
|
11931
13432
|
enableScrollableContainerLazyLoading?: boolean;
|
|
11932
13433
|
/**
|
|
11933
|
-
*
|
|
13434
|
+
* How far outside the viewport a visualization starts loading, when
|
|
13435
|
+
* {@link lazyLoadingForFullHeight} is enabled.
|
|
11934
13436
|
*
|
|
11935
13437
|
* For example, if the margin is set to '10px',
|
|
11936
13438
|
* the visualization will be loaded 10px before its top edge is visible in the
|
|
11937
13439
|
* viewport.
|
|
11938
13440
|
*
|
|
11939
|
-
* The format is similar to CSS margin
|
|
13441
|
+
* The format is similar to CSS margin, so `'500px 0px'` extends the
|
|
13442
|
+
* prefetch 500px above and below the viewport and not sideways. Accepted
|
|
13443
|
+
* units are `px`, `em`, `rem`, `%`, `vh` and `vw`, plus bare `0` and
|
|
13444
|
+
* `auto`; an invalid value is logged and ignored.
|
|
13445
|
+
*
|
|
13446
|
+
* From SDK 1.52.0 this defaults to `'500px 0px'` — roughly one
|
|
13447
|
+
* visualization ahead of the scroll position, so a chart has usually
|
|
13448
|
+
* finished loading by the time it scrolls into view. Use a smaller margin
|
|
13449
|
+
* to cut warehouse queries further, or `'0px'` to load a visualization
|
|
13450
|
+
* only once it is actually visible.
|
|
11940
13451
|
*
|
|
11941
13452
|
* @type {string}
|
|
11942
13453
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
13454
|
+
* @default '500px 0px' when `fullHeight` is enabled, from SDK 1.52.0
|
|
11943
13455
|
* @example
|
|
11944
13456
|
* ```js
|
|
11945
13457
|
* const embed = new AppEmbed('#embed-container', {
|
|
@@ -11967,6 +13479,40 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11967
13479
|
* ```
|
|
11968
13480
|
*/
|
|
11969
13481
|
updatedSpotterChatPrompt?: boolean;
|
|
13482
|
+
/**
|
|
13483
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
13484
|
+
*
|
|
13485
|
+
* Supported embed types: `AppEmbed`
|
|
13486
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13487
|
+
* @default false
|
|
13488
|
+
* @example
|
|
13489
|
+
* ```js
|
|
13490
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13491
|
+
* ... //other embed view config
|
|
13492
|
+
* showSpotterRadiance : true,
|
|
13493
|
+
* })
|
|
13494
|
+
* ```
|
|
13495
|
+
*/
|
|
13496
|
+
showSpotterRadiance?: boolean;
|
|
13497
|
+
/**
|
|
13498
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
13499
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
13500
|
+
* instance only; it does not persist as a user preference and does
|
|
13501
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
13502
|
+
* Only applicable when navigating to Spotter within the app.
|
|
13503
|
+
*
|
|
13504
|
+
* Supported embed types: `AppEmbed`
|
|
13505
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13506
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
13507
|
+
* @example
|
|
13508
|
+
* ```js
|
|
13509
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13510
|
+
* ... //other embed view config
|
|
13511
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
13512
|
+
* })
|
|
13513
|
+
* ```
|
|
13514
|
+
*/
|
|
13515
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
11970
13516
|
/**
|
|
11971
13517
|
* Controls the visibility of the past conversations sidebar.
|
|
11972
13518
|
*
|
|
@@ -11992,6 +13538,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11992
13538
|
* spotterSidebarConfig: {
|
|
11993
13539
|
* enablePastConversationsSidebar: true,
|
|
11994
13540
|
* spotterSidebarTitle: 'My Conversations',
|
|
13541
|
+
* // Opt in to pin/unpin conversations in embedded Spotter
|
|
13542
|
+
* spotterChatPinConfig: {
|
|
13543
|
+
* enabled: true,
|
|
13544
|
+
* },
|
|
11995
13545
|
* },
|
|
11996
13546
|
* })
|
|
11997
13547
|
* ```
|
|
@@ -12015,6 +13565,49 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12015
13565
|
* ```
|
|
12016
13566
|
*/
|
|
12017
13567
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
13568
|
+
/**
|
|
13569
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
13570
|
+
*
|
|
13571
|
+
* Supported embed types: `AppEmbed`
|
|
13572
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13573
|
+
* @example
|
|
13574
|
+
* ```js
|
|
13575
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13576
|
+
* ... //other embed view config
|
|
13577
|
+
* spotterShareConversationConfig: {
|
|
13578
|
+
* enableShareConversation: true,
|
|
13579
|
+
* },
|
|
13580
|
+
* })
|
|
13581
|
+
* ```
|
|
13582
|
+
*/
|
|
13583
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
13584
|
+
/**
|
|
13585
|
+
* Sets the default data sources (Models) for the Spotter experience shown on
|
|
13586
|
+
* the home page of the full app embed. Accepts a list of Model GUIDs to
|
|
13587
|
+
* preselect the data sources available to Spotter, or the literal
|
|
13588
|
+
* `'auto_mode'` sentinel to load Spotter with the "Auto" model selected by
|
|
13589
|
+
* default. This is consistent with how `worksheetId: 'auto_mode'` enables
|
|
13590
|
+
* Auto mode in `SpotterEmbed`.
|
|
13591
|
+
*
|
|
13592
|
+
* **Note**: If `'auto_mode'` is included alongside one or more Model GUIDs,
|
|
13593
|
+
* `'auto_mode'` takes precedence and is selected by default.
|
|
13594
|
+
*
|
|
13595
|
+
* **Note**: `'auto_mode'` requires the Spotter 3 experience with data source
|
|
13596
|
+
* discovery enabled on your instance, and a Spotter-enabled home page (for
|
|
13597
|
+
* example, `discoveryExperience.homePage: HomePage.Focused`).
|
|
13598
|
+
*
|
|
13599
|
+
* Supported embed types: `AppEmbed`
|
|
13600
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
13601
|
+
* @example
|
|
13602
|
+
* ```js
|
|
13603
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13604
|
+
* ... // other embed view config
|
|
13605
|
+
* discoveryExperience: { homePage: HomePage.Focused },
|
|
13606
|
+
* spotterDataSources: ['model-guid-1', 'model-guid-2'], // or ['auto_mode']
|
|
13607
|
+
* })
|
|
13608
|
+
* ```
|
|
13609
|
+
*/
|
|
13610
|
+
spotterDataSources?: string[];
|
|
12018
13611
|
/**
|
|
12019
13612
|
* Configuration for the SpotterViz interface shown on the Liveboard.
|
|
12020
13613
|
* Customize the brand name, description, chat input placeholder,
|
|
@@ -12033,12 +13626,17 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12033
13626
|
* inputChatPlaceholder: 'Ask a question...',
|
|
12034
13627
|
* hideStarterPrompts: false,
|
|
12035
13628
|
* customStarterPrompts: [{ id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }],
|
|
12036
|
-
* //
|
|
13629
|
+
* // The options below require SDK: 1.51.0
|
|
12037
13630
|
* loaderHeadline: 'Crunching the numbers...',
|
|
12038
13631
|
* loaderTips: [
|
|
12039
13632
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
12040
13633
|
* { label: 'Tip', text: 'use natural language' },
|
|
12041
13634
|
* ],
|
|
13635
|
+
* liveboardBrandName: 'Reports',
|
|
13636
|
+
* spotterBrandName: 'Analyst',
|
|
13637
|
+
* insightTileBrandName: 'Insight card',
|
|
13638
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
13639
|
+
* insightTileLoaderText: 'Generating insight',
|
|
12042
13640
|
* },
|
|
12043
13641
|
* })
|
|
12044
13642
|
* ```
|
|
@@ -12104,6 +13702,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12104
13702
|
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
12105
13703
|
*/
|
|
12106
13704
|
visualOverrides?: VisualizationOverrides;
|
|
13705
|
+
/**
|
|
13706
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
13707
|
+
*
|
|
13708
|
+
* Supported embed types: `AppEmbed`
|
|
13709
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13710
|
+
* @default false
|
|
13711
|
+
* @example
|
|
13712
|
+
* ```js
|
|
13713
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13714
|
+
* ... //other embed view config
|
|
13715
|
+
* updatedSpotterExperience : true,
|
|
13716
|
+
* })
|
|
13717
|
+
* ```
|
|
13718
|
+
*/
|
|
13719
|
+
updatedSpotterExperience?: boolean;
|
|
12107
13720
|
}
|
|
12108
13721
|
/**
|
|
12109
13722
|
* APP_INIT data shape for AppEmbed.
|
|
@@ -12113,6 +13726,8 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
|
12113
13726
|
embedParams?: {
|
|
12114
13727
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
12115
13728
|
spotterVizConfig?: SpotterVizConfig;
|
|
13729
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
13730
|
+
starterPrompts?: StarterPromptsConfig;
|
|
12116
13731
|
};
|
|
12117
13732
|
}
|
|
12118
13733
|
/**
|
|
@@ -12143,6 +13758,7 @@ export declare class AppEmbed extends V1Embed {
|
|
|
12143
13758
|
* embedded Liveboard or visualization.
|
|
12144
13759
|
*/
|
|
12145
13760
|
protected getEmbedParams(): string;
|
|
13761
|
+
protected getEmbedParamsObject(): any;
|
|
12146
13762
|
private sendFullHeightLazyLoadData;
|
|
12147
13763
|
/**
|
|
12148
13764
|
* This is a handler for the RequestVisibleEmbedCoordinates event.
|
|
@@ -12394,7 +14010,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
|
|
|
12394
14010
|
/**
|
|
12395
14011
|
* Initializes the Visual Embed SDK globally and perform
|
|
12396
14012
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
12397
|
-
* component like Liveboard etc can be embedded. But need not wait for
|
|
14013
|
+
* component like Liveboard etc can be embedded. But need not wait for AuthStatus.SUCCESS
|
|
12398
14014
|
* to actually embed. That is handled internally.
|
|
12399
14015
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
12400
14016
|
* authentication mechanism and so on.
|
|
@@ -12493,6 +14109,7 @@ export declare const reloadIframe: (iFrame: HTMLIFrameElement) => void;
|
|
|
12493
14109
|
export interface LiveboardEmbedAppInitData extends DefaultAppInitData {
|
|
12494
14110
|
embedParams?: {
|
|
12495
14111
|
spotterVizConfig?: SpotterVizConfig;
|
|
14112
|
+
starterPrompts?: StarterPromptsConfig;
|
|
12496
14113
|
};
|
|
12497
14114
|
}
|
|
12498
14115
|
/**
|
|
@@ -12511,6 +14128,11 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12511
14128
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
12512
14129
|
* incrementally as users scroll the page to view the charts and tables.
|
|
12513
14130
|
*
|
|
14131
|
+
* From SDK 1.52.0, enabling `fullHeight` also turns on
|
|
14132
|
+
* {@link lazyLoadingForFullHeight} and
|
|
14133
|
+
* {@link enableScrollableContainerLazyLoading}, so visualizations load as
|
|
14134
|
+
* they scroll into view. Set either flag to `false` to opt out.
|
|
14135
|
+
*
|
|
12514
14136
|
*
|
|
12515
14137
|
* Supported embed types: `LiveboardEmbed`
|
|
12516
14138
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
@@ -12850,11 +14472,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12850
14472
|
/**
|
|
12851
14473
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
12852
14474
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
12853
|
-
* This feature is GA from version
|
|
14475
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
12854
14476
|
*
|
|
12855
14477
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12856
14478
|
* @type {boolean}
|
|
12857
14479
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
14480
|
+
* @default true
|
|
12858
14481
|
* @example
|
|
12859
14482
|
* ```js
|
|
12860
14483
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12867,10 +14490,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12867
14490
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
12868
14491
|
/**
|
|
12869
14492
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
14493
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
|
|
12870
14494
|
*
|
|
12871
14495
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12872
14496
|
* @type {boolean}
|
|
12873
14497
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
14498
|
+
* @default true
|
|
12874
14499
|
* @example
|
|
12875
14500
|
* ```js
|
|
12876
14501
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12883,10 +14508,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12883
14508
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
12884
14509
|
/**
|
|
12885
14510
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
14511
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
|
|
12886
14512
|
*
|
|
12887
14513
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12888
14514
|
* @type {boolean}
|
|
12889
14515
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
14516
|
+
* @default true
|
|
12890
14517
|
* @example
|
|
12891
14518
|
* ```js
|
|
12892
14519
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12898,11 +14525,17 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12898
14525
|
*/
|
|
12899
14526
|
isGranularXLSXCSVSchedulesEnabled?: boolean;
|
|
12900
14527
|
/**
|
|
12901
|
-
*
|
|
14528
|
+
* Loads visualizations only as they scroll into the viewport, instead of
|
|
14529
|
+
* loading the whole full-height Liveboard at once.
|
|
14530
|
+
*
|
|
14531
|
+
* From SDK 1.52.0 this is enabled automatically whenever `fullHeight` is
|
|
14532
|
+
* `true`. On SDK 1.51.0 and earlier it defaulted to `false` and had to be
|
|
14533
|
+
* set explicitly. Set it to `false` to load every visualization upfront.
|
|
14534
|
+
* The flag has no effect unless `fullHeight` is enabled.
|
|
12902
14535
|
*
|
|
12903
14536
|
* @type {boolean}
|
|
12904
14537
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
12905
|
-
* @default
|
|
14538
|
+
* @default true when `fullHeight` is enabled, from SDK 1.52.0
|
|
12906
14539
|
* @example
|
|
12907
14540
|
* ```js
|
|
12908
14541
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -12914,26 +14547,42 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12914
14547
|
*/
|
|
12915
14548
|
lazyLoadingForFullHeight?: boolean;
|
|
12916
14549
|
/**
|
|
12917
|
-
*
|
|
14550
|
+
* Computes the visible region of the embed against its scrollable and
|
|
14551
|
+
* clipping ancestors, instead of treating the browser window as the only
|
|
14552
|
+
* viewport, and tracks scroll and resize on those ancestors.
|
|
12918
14553
|
*
|
|
12919
|
-
*
|
|
12920
|
-
*
|
|
14554
|
+
* From SDK 1.52.0 this is enabled automatically whenever `fullHeight` is
|
|
14555
|
+
* `true`. On SDK 1.51.0 and earlier it defaulted to `false` and had to be
|
|
14556
|
+
* set explicitly. Set it to `false` when the page scrolls with the window
|
|
14557
|
+
* and the embed has no clipping ancestor, to skip the extra ancestor
|
|
14558
|
+
* tracking.
|
|
12921
14559
|
*
|
|
12922
14560
|
* @type {boolean}
|
|
12923
|
-
* @default
|
|
14561
|
+
* @default true when `fullHeight` is enabled, from SDK 1.52.0
|
|
12924
14562
|
*/
|
|
12925
14563
|
enableScrollableContainerLazyLoading?: boolean;
|
|
12926
14564
|
/**
|
|
12927
|
-
*
|
|
14565
|
+
* How far outside the viewport a visualization starts loading, when
|
|
14566
|
+
* {@link lazyLoadingForFullHeight} is enabled.
|
|
12928
14567
|
*
|
|
12929
14568
|
* For example, if the margin is set to '10px',
|
|
12930
14569
|
* the visualization will be loaded 10px before its top edge is visible in the
|
|
12931
14570
|
* viewport.
|
|
12932
14571
|
*
|
|
12933
|
-
* The format is similar to CSS margin
|
|
14572
|
+
* The format is similar to CSS margin, so `'500px 0px'` extends the
|
|
14573
|
+
* prefetch 500px above and below the viewport and not sideways. Accepted
|
|
14574
|
+
* units are `px`, `em`, `rem`, `%`, `vh` and `vw`, plus bare `0` and
|
|
14575
|
+
* `auto`; an invalid value is logged and ignored.
|
|
14576
|
+
*
|
|
14577
|
+
* From SDK 1.52.0 this defaults to `'500px 0px'` — roughly one
|
|
14578
|
+
* visualization ahead of the scroll position, so a chart has usually
|
|
14579
|
+
* finished loading by the time it scrolls into view. Use a smaller margin
|
|
14580
|
+
* to cut warehouse queries further, or `'0px'` to load a visualization
|
|
14581
|
+
* only once it is actually visible.
|
|
12934
14582
|
*
|
|
12935
14583
|
* @type {string}
|
|
12936
14584
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
14585
|
+
* @default '500px 0px' when `fullHeight` is enabled, from SDK 1.52.0
|
|
12937
14586
|
* @example
|
|
12938
14587
|
* ```js
|
|
12939
14588
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -12977,6 +14626,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
12977
14626
|
* ```
|
|
12978
14627
|
*/
|
|
12979
14628
|
updatedSpotterChatPrompt?: boolean;
|
|
14629
|
+
/**
|
|
14630
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
14631
|
+
*
|
|
14632
|
+
* Supported embed types: `LiveboardEmbed`
|
|
14633
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14634
|
+
* @default false
|
|
14635
|
+
* @example
|
|
14636
|
+
* ```js
|
|
14637
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
14638
|
+
* ... //other embed view config
|
|
14639
|
+
* showSpotterRadiance : true,
|
|
14640
|
+
* })
|
|
14641
|
+
* ```
|
|
14642
|
+
*/
|
|
14643
|
+
showSpotterRadiance?: boolean;
|
|
12980
14644
|
/**
|
|
12981
14645
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
12982
14646
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -13022,12 +14686,17 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13022
14686
|
* inputChatPlaceholder: 'Ask a question...',
|
|
13023
14687
|
* hideStarterPrompts: false,
|
|
13024
14688
|
* customStarterPrompts: [{ id: '1', displayText: 'Top products', fullPrompt: 'What are the top products by revenue?' }],
|
|
13025
|
-
* //
|
|
14689
|
+
* // The options below require SDK: 1.51.0
|
|
13026
14690
|
* loaderHeadline: 'Crunching the numbers...',
|
|
13027
14691
|
* loaderTips: [
|
|
13028
14692
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
13029
14693
|
* { label: 'Tip', text: 'use natural language' },
|
|
13030
14694
|
* ],
|
|
14695
|
+
* liveboardBrandName: 'Reports',
|
|
14696
|
+
* spotterBrandName: 'Analyst',
|
|
14697
|
+
* insightTileBrandName: 'Insight card',
|
|
14698
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
14699
|
+
* insightTileLoaderText: 'Generating insight',
|
|
13031
14700
|
* },
|
|
13032
14701
|
* })
|
|
13033
14702
|
* ```
|
|
@@ -13046,6 +14715,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13046
14715
|
* ```
|
|
13047
14716
|
*/
|
|
13048
14717
|
enableLiveboardDataCache?: boolean;
|
|
14718
|
+
/**
|
|
14719
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
14720
|
+
*
|
|
14721
|
+
* Supported embed types: `LiveboardEmbed`
|
|
14722
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14723
|
+
* @default false
|
|
14724
|
+
* @example
|
|
14725
|
+
* ```js
|
|
14726
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
14727
|
+
* ... //other embed view config
|
|
14728
|
+
* updatedSpotterExperience : true,
|
|
14729
|
+
* })
|
|
14730
|
+
* ```
|
|
14731
|
+
*/
|
|
14732
|
+
updatedSpotterExperience?: boolean;
|
|
13049
14733
|
}
|
|
13050
14734
|
/**
|
|
13051
14735
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -13118,7 +14802,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
13118
14802
|
* @param {any} data The payload to send with the message
|
|
13119
14803
|
* @returns A promise that resolves with the response from the embedded app
|
|
13120
14804
|
*/
|
|
13121
|
-
trigger<HostEventT extends HostEvent, PayloadT
|
|
14805
|
+
trigger<HostEventT extends HostEvent, PayloadT = HostEventRequest<HostEventT>, ContextT extends ContextType = ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
13122
14806
|
/**
|
|
13123
14807
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
13124
14808
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
@@ -13806,6 +15490,10 @@ export declare const MIXPANEL_EVENT: {
|
|
|
13806
15490
|
VISUAL_SDK_IFRAME_LOAD_PERFORMANCE: string;
|
|
13807
15491
|
VISUAL_SDK_EMBED_CREATE: string;
|
|
13808
15492
|
VERCEL_INTEGRATION_COMPLETED: string;
|
|
15493
|
+
VISUAL_SDK_RENDER_CALLED: string;
|
|
15494
|
+
VISUAL_SDK_PRE_RENDER: string;
|
|
15495
|
+
VISUAL_SDK_SHOW_PRE_RENDER: string;
|
|
15496
|
+
VISUAL_SDK_HIDE_PRE_RENDER: string;
|
|
13809
15497
|
};
|
|
13810
15498
|
/**
|
|
13811
15499
|
* Pushes the event with its Property key-value map to mixpanel.
|