@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
package/cjs/src/types.js
CHANGED
|
@@ -175,7 +175,9 @@ var AuthType;
|
|
|
175
175
|
})(AuthType = exports.AuthType || (exports.AuthType = {}));
|
|
176
176
|
/**
|
|
177
177
|
*
|
|
178
|
-
* **Note**:
|
|
178
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
179
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
|
|
180
|
+
* V4 (Focused) home page experiences.
|
|
179
181
|
*
|
|
180
182
|
*/
|
|
181
183
|
var HomeLeftNavItem;
|
|
@@ -243,6 +245,13 @@ var HomeLeftNavItem;
|
|
|
243
245
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
244
246
|
*/
|
|
245
247
|
HomeLeftNavItem["Favorites"] = "favorites";
|
|
248
|
+
/**
|
|
249
|
+
* The *Collections* menu option in
|
|
250
|
+
* the *Insights* left navigation panel.
|
|
251
|
+
* Shown when collections are enabled on the cluster.
|
|
252
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
253
|
+
*/
|
|
254
|
+
HomeLeftNavItem["Collections"] = "collections";
|
|
246
255
|
})(HomeLeftNavItem = exports.HomeLeftNavItem || (exports.HomeLeftNavItem = {}));
|
|
247
256
|
/**
|
|
248
257
|
* A map of the supported runtime filter operations
|
|
@@ -315,7 +324,9 @@ var RuntimeFilterOp;
|
|
|
315
324
|
* via `hiddenHomepageModules` and reordered via
|
|
316
325
|
* `reorderedHomepageModules`.
|
|
317
326
|
*
|
|
318
|
-
* **Note**:
|
|
327
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
328
|
+
* deprecated. These modules apply to V3 (ModularWithStylingChanges) and
|
|
329
|
+
* V4 (Focused) home page experiences.
|
|
319
330
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
320
331
|
*/
|
|
321
332
|
var HomepageModule;
|
|
@@ -493,7 +504,7 @@ var EmbedEvent;
|
|
|
493
504
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
494
505
|
* @example
|
|
495
506
|
* ```js
|
|
496
|
-
* searchEmbed.on(EmbedEvent.
|
|
507
|
+
* searchEmbed.on(EmbedEvent.Drilldown, {
|
|
497
508
|
* points: {
|
|
498
509
|
* clickedPoint,
|
|
499
510
|
* selectedPoints: selectedPoint
|
|
@@ -554,7 +565,7 @@ var EmbedEvent;
|
|
|
554
565
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
555
566
|
* @example
|
|
556
567
|
* ```js
|
|
557
|
-
* appEmbed.on(EmbedEvent.
|
|
568
|
+
* appEmbed.on(EmbedEvent.CustomAction, payload => {
|
|
558
569
|
* const data = payload.data;
|
|
559
570
|
* if (data.id === 'insert Custom Action ID here') {
|
|
560
571
|
* console.log('Custom Action event:', data.embedAnswerData);
|
|
@@ -820,8 +831,8 @@ var EmbedEvent;
|
|
|
820
831
|
*
|
|
821
832
|
* **Note**: This event is deprecated in v1.21.0.
|
|
822
833
|
* To fire an event when a download action is initiated on a chart or table,
|
|
823
|
-
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.
|
|
824
|
-
* `EmbedEvent.
|
|
834
|
+
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPdf`,
|
|
835
|
+
* `EmbedEvent.DownloadAsCsv`, or `EmbedEvent.DownloadAsXlsx`
|
|
825
836
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
826
837
|
* @example
|
|
827
838
|
* ```js
|
|
@@ -871,10 +882,10 @@ var EmbedEvent;
|
|
|
871
882
|
* @example
|
|
872
883
|
* ```js
|
|
873
884
|
* //emit when action starts
|
|
874
|
-
* searchEmbed.on(EmbedEvent.
|
|
885
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
875
886
|
* console.log('download CSV', payload)}, {start: true })
|
|
876
887
|
* //emit when action ends
|
|
877
|
-
* searchEmbed.on(EmbedEvent.
|
|
888
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
|
|
878
889
|
* console.log('download CSV', payload)})
|
|
879
890
|
* ```
|
|
880
891
|
*/
|
|
@@ -1273,11 +1284,19 @@ var EmbedEvent;
|
|
|
1273
1284
|
* Emitted when a user changes any filter on a Liveboard.
|
|
1274
1285
|
* Returns filter type and name, column name and ID, and runtime
|
|
1275
1286
|
* filter details.
|
|
1287
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
1288
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
1289
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
1290
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
1291
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
1292
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
1293
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
1276
1294
|
* @example
|
|
1277
1295
|
*
|
|
1278
1296
|
* ```js
|
|
1279
1297
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1280
1298
|
* console.log('payload', payload);
|
|
1299
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
1281
1300
|
* })
|
|
1282
1301
|
* ```
|
|
1283
1302
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -1469,9 +1488,17 @@ var EmbedEvent;
|
|
|
1469
1488
|
/**
|
|
1470
1489
|
* Emitted when parameter changes in an Answer
|
|
1471
1490
|
* or Liveboard.
|
|
1491
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
1492
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
1493
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
1494
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
1495
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
1496
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
1497
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
1472
1498
|
* ```js
|
|
1473
1499
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1474
1500
|
* console.log('payload', payload);
|
|
1501
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
1475
1502
|
* })
|
|
1476
1503
|
* ```
|
|
1477
1504
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -1773,6 +1800,158 @@ var EmbedEvent;
|
|
|
1773
1800
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1774
1801
|
*/
|
|
1775
1802
|
EmbedEvent["SpotterConversationDeleted"] = "spotterConversationDeleted";
|
|
1803
|
+
/**
|
|
1804
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
1805
|
+
* to bracket the interaction. App→host counterpart of the
|
|
1806
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
1807
|
+
* @example
|
|
1808
|
+
* ```js
|
|
1809
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
1810
|
+
* // payload: { convId: string }
|
|
1811
|
+
* })
|
|
1812
|
+
* ```
|
|
1813
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1814
|
+
*/
|
|
1815
|
+
EmbedEvent["SpotterShareConversationButtonHeaderClicked"] = "spotterShareConversationButtonHeaderClicked";
|
|
1816
|
+
/**
|
|
1817
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
1818
|
+
* to bracket the interaction.
|
|
1819
|
+
* @example
|
|
1820
|
+
* ```js
|
|
1821
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
1822
|
+
* // payload: { convId: string }
|
|
1823
|
+
* })
|
|
1824
|
+
* ```
|
|
1825
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1826
|
+
*/
|
|
1827
|
+
EmbedEvent["SpotterShareConversationMenuItemSidebarClicked"] = "spotterShareConversationMenuItemSidebarClicked";
|
|
1828
|
+
/**
|
|
1829
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
1830
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
1831
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
1832
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
1833
|
+
* the save resolves.
|
|
1834
|
+
* @example
|
|
1835
|
+
* ```js
|
|
1836
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
1837
|
+
* // payload: { convId: string, shareId: string,
|
|
1838
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
1839
|
+
* })
|
|
1840
|
+
* ```
|
|
1841
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1842
|
+
*/
|
|
1843
|
+
EmbedEvent["SpotterConversationShared"] = "spotterConversationShared";
|
|
1844
|
+
/**
|
|
1845
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
1846
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
1847
|
+
* and the share is deleted entirely.
|
|
1848
|
+
* @example
|
|
1849
|
+
* ```js
|
|
1850
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
1851
|
+
* // payload: { convId: string, shareId: string,
|
|
1852
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
1853
|
+
* })
|
|
1854
|
+
* ```
|
|
1855
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1856
|
+
*/
|
|
1857
|
+
EmbedEvent["SpotterConversationShareRevoked"] = "spotterConversationShareRevoked";
|
|
1858
|
+
/**
|
|
1859
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
1860
|
+
* view). No shareId available viewer-side.
|
|
1861
|
+
* @example
|
|
1862
|
+
* ```js
|
|
1863
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
1864
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
1865
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
1866
|
+
* })
|
|
1867
|
+
* ```
|
|
1868
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1869
|
+
*/
|
|
1870
|
+
EmbedEvent["SpotterSharedConversationViewed"] = "spotterSharedConversationViewed";
|
|
1871
|
+
/**
|
|
1872
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
1873
|
+
* last shared version" checkbox.
|
|
1874
|
+
* @example
|
|
1875
|
+
* ```js
|
|
1876
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
1877
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
1878
|
+
* })
|
|
1879
|
+
* ```
|
|
1880
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1881
|
+
*/
|
|
1882
|
+
EmbedEvent["SpotterShareIncludeNewMessagesCheckboxToggled"] = "spotterShareIncludeNewMessagesCheckboxToggled";
|
|
1883
|
+
/**
|
|
1884
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
1885
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
1886
|
+
* @example
|
|
1887
|
+
* ```js
|
|
1888
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
1889
|
+
* // payload: { convId: string }
|
|
1890
|
+
* })
|
|
1891
|
+
* ```
|
|
1892
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1893
|
+
*/
|
|
1894
|
+
EmbedEvent["SpotterShareStaleInfoBannerDismissed"] = "spotterShareStaleInfoBannerDismissed";
|
|
1895
|
+
/**
|
|
1896
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
1897
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
1898
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
1899
|
+
* @example
|
|
1900
|
+
* ```js
|
|
1901
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
1902
|
+
* // payload: { convId: string }
|
|
1903
|
+
* })
|
|
1904
|
+
* ```
|
|
1905
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1906
|
+
*/
|
|
1907
|
+
EmbedEvent["SpotterShareModalConfirmButtonClicked"] = "spotterShareModalConfirmButtonClicked";
|
|
1908
|
+
/**
|
|
1909
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
1910
|
+
* @example
|
|
1911
|
+
* ```js
|
|
1912
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
1913
|
+
* // payload: { convId: string }
|
|
1914
|
+
* })
|
|
1915
|
+
* ```
|
|
1916
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1917
|
+
*/
|
|
1918
|
+
EmbedEvent["SpotterShareModalCancelButtonClicked"] = "spotterShareModalCancelButtonClicked";
|
|
1919
|
+
/**
|
|
1920
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
1921
|
+
* button.
|
|
1922
|
+
* @example
|
|
1923
|
+
* ```js
|
|
1924
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
1925
|
+
* // payload: { convId: string }
|
|
1926
|
+
* })
|
|
1927
|
+
* ```
|
|
1928
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1929
|
+
*/
|
|
1930
|
+
EmbedEvent["SpotterSharedConversationExitButtonClicked"] = "spotterSharedConversationExitButtonClicked";
|
|
1931
|
+
/**
|
|
1932
|
+
* Emitted when a Spotter conversation is pinned.
|
|
1933
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
1934
|
+
* @example
|
|
1935
|
+
* ```js
|
|
1936
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
1937
|
+
* console.log('Conversation pinned', payload);
|
|
1938
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
1939
|
+
* })
|
|
1940
|
+
* ```
|
|
1941
|
+
*/
|
|
1942
|
+
EmbedEvent["SpotterConversationPinned"] = "spotterConversationPinned";
|
|
1943
|
+
/**
|
|
1944
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
1945
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
1946
|
+
* @example
|
|
1947
|
+
* ```js
|
|
1948
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
1949
|
+
* console.log('Conversation unpinned', payload);
|
|
1950
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
1951
|
+
* })
|
|
1952
|
+
* ```
|
|
1953
|
+
*/
|
|
1954
|
+
EmbedEvent["SpotterConversationUnpinned"] = "spotterConversationUnpinned";
|
|
1776
1955
|
/**
|
|
1777
1956
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
1778
1957
|
* @example
|
|
@@ -1785,6 +1964,30 @@ var EmbedEvent;
|
|
|
1785
1964
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
1786
1965
|
*/
|
|
1787
1966
|
EmbedEvent["SpotterConversationSelected"] = "spotterConversationSelected";
|
|
1967
|
+
/**
|
|
1968
|
+
* Emitted when the Spotter agent finishes streaming/rendering a response.
|
|
1969
|
+
* Includes the conversation and message identifiers so the host app can
|
|
1970
|
+
* fetch the full conversation history via the REST API if needed.
|
|
1971
|
+
*
|
|
1972
|
+
* The payload data has the shape `{ convId: string, messageId: string }`.
|
|
1973
|
+
*
|
|
1974
|
+
* Works with SpotterEmbed as well as AppEmbed (when Spotter is reached
|
|
1975
|
+
* inside the full application).
|
|
1976
|
+
* @example
|
|
1977
|
+
* ```js
|
|
1978
|
+
* spotterEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
1979
|
+
* console.log('Spotter response complete', payload);
|
|
1980
|
+
* })
|
|
1981
|
+
* ```
|
|
1982
|
+
* @example
|
|
1983
|
+
* ```js
|
|
1984
|
+
* appEmbed.on(EmbedEvent.SpotterResponseComplete, (payload) => {
|
|
1985
|
+
* console.log('Spotter response complete', payload);
|
|
1986
|
+
* })
|
|
1987
|
+
* ```
|
|
1988
|
+
* @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
1989
|
+
*/
|
|
1990
|
+
EmbedEvent["SpotterResponseComplete"] = "spotterResponseComplete";
|
|
1788
1991
|
/**
|
|
1789
1992
|
* @hidden
|
|
1790
1993
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -2139,6 +2342,7 @@ var HostEvent;
|
|
|
2139
2342
|
* const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
|
|
2140
2343
|
* console.log("iFrameURL", url);
|
|
2141
2344
|
* ```
|
|
2345
|
+
* @returns iframeUrl - The URL currently loaded in the embedded iframe.
|
|
2142
2346
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
|
|
2143
2347
|
*/
|
|
2144
2348
|
HostEvent["GetIframeUrl"] = "GetIframeUrl";
|
|
@@ -2265,6 +2469,17 @@ var HostEvent;
|
|
|
2265
2469
|
* name: string,
|
|
2266
2470
|
* type: ATTRIBUTE/MEASURE,
|
|
2267
2471
|
* dataType: INT64/CHAR/DATE }
|
|
2472
|
+
*
|
|
2473
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
2474
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
2475
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
2476
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
2477
|
+
*
|
|
2478
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
2479
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
2480
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
2481
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
2482
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
2268
2483
|
* @example
|
|
2269
2484
|
* ```js
|
|
2270
2485
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -2277,6 +2492,14 @@ var HostEvent;
|
|
|
2277
2492
|
* ```
|
|
2278
2493
|
* @example
|
|
2279
2494
|
* ```js
|
|
2495
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
2496
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
2497
|
+
* column: { columnId: '<column-GUID>' },
|
|
2498
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
2499
|
+
* });
|
|
2500
|
+
* ```
|
|
2501
|
+
* @example
|
|
2502
|
+
* ```js
|
|
2280
2503
|
* // Open filter from search context
|
|
2281
2504
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2282
2505
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -2286,6 +2509,73 @@ var HostEvent;
|
|
|
2286
2509
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2287
2510
|
*/
|
|
2288
2511
|
HostEvent["OpenFilter"] = "openFilter";
|
|
2512
|
+
/**
|
|
2513
|
+
* Open the add-filter modal of a Liveboard, the same dialog that the
|
|
2514
|
+
* *Add filter* button in the Liveboard edit header opens, so the host
|
|
2515
|
+
* app can start the add-filter flow from its own UI.
|
|
2516
|
+
*
|
|
2517
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
2518
|
+
* Hiding the *Add filter* button with `hiddenActions:
|
|
2519
|
+
* [Action.AddFilter]` does not block this event, but disabling it with
|
|
2520
|
+
* `disabledActions` does.
|
|
2521
|
+
*
|
|
2522
|
+
* Unlike {@link HostEvent.OpenFilter}, which opens the panel of an
|
|
2523
|
+
* existing filter, this event starts the creation of a new filter.
|
|
2524
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
2525
|
+
* @example
|
|
2526
|
+
* ```js
|
|
2527
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddFilterModal);
|
|
2528
|
+
* ```
|
|
2529
|
+
*/
|
|
2530
|
+
HostEvent["OpenAddFilterModal"] = "openAddFilterModal";
|
|
2531
|
+
/**
|
|
2532
|
+
* Open the add-parameter panel of a Liveboard, the same panel that the
|
|
2533
|
+
* *Add parameter* button in the Liveboard edit header opens.
|
|
2534
|
+
* Mirrors {@link HostEvent.OpenAddFilterModal} for parameters.
|
|
2535
|
+
*
|
|
2536
|
+
* The Liveboard must be in edit mode; the event is ignored otherwise.
|
|
2537
|
+
* Hiding the *Add parameter* button with `hiddenActions:
|
|
2538
|
+
* [Action.AddParameter]` does not block this event, but disabling it
|
|
2539
|
+
* with `disabledActions` does.
|
|
2540
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
2541
|
+
* @example
|
|
2542
|
+
* ```js
|
|
2543
|
+
* liveboardEmbed.trigger(HostEvent.OpenAddParameterModal);
|
|
2544
|
+
* ```
|
|
2545
|
+
*/
|
|
2546
|
+
HostEvent["OpenAddParameterModal"] = "openAddParameterModal";
|
|
2547
|
+
/**
|
|
2548
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
2549
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
2550
|
+
* @param - Includes the following keys:
|
|
2551
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
2552
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
2553
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
2554
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
2555
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
2556
|
+
*
|
|
2557
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
2558
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
2559
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
2560
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
2561
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
2562
|
+
* @example
|
|
2563
|
+
* ```js
|
|
2564
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
2565
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
2566
|
+
* });
|
|
2567
|
+
* ```
|
|
2568
|
+
* @example
|
|
2569
|
+
* ```js
|
|
2570
|
+
* // Open a parameter scoped to a specific group
|
|
2571
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
2572
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
2573
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
2574
|
+
* });
|
|
2575
|
+
* ```
|
|
2576
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
2577
|
+
*/
|
|
2578
|
+
HostEvent["OpenParameter"] = "openParameter";
|
|
2289
2579
|
/**
|
|
2290
2580
|
* Add columns to the current search query.
|
|
2291
2581
|
* @param - { columnIds: string[] }
|
|
@@ -2335,6 +2625,10 @@ var HostEvent;
|
|
|
2335
2625
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
|
|
2336
2626
|
* data=>console.log(data))
|
|
2337
2627
|
* ```
|
|
2628
|
+
* @returns data - Object with a `v2Content` string: the export request
|
|
2629
|
+
* payload for the current Liveboard.
|
|
2630
|
+
* @returns type - The passthrough event name,
|
|
2631
|
+
* `getExportRequestForCurrentPinboard`.
|
|
2338
2632
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
2339
2633
|
*/
|
|
2340
2634
|
HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
|
|
@@ -2437,6 +2731,9 @@ var HostEvent;
|
|
|
2437
2731
|
* }, ContextType.Spotter);
|
|
2438
2732
|
* ```
|
|
2439
2733
|
*
|
|
2734
|
+
* @returns liveboardId - GUID of the Liveboard the Answer was pinned to.
|
|
2735
|
+
* @returns tabId - GUID of the tab within that Liveboard.
|
|
2736
|
+
* @returns vizId - GUID of the newly created visualization.
|
|
2440
2737
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2441
2738
|
*/
|
|
2442
2739
|
HostEvent["Pin"] = "pin";
|
|
@@ -2475,13 +2772,13 @@ var HostEvent;
|
|
|
2475
2772
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2476
2773
|
* @example
|
|
2477
2774
|
* ```js
|
|
2478
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
2775
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList)
|
|
2479
2776
|
* ```
|
|
2480
2777
|
* @example
|
|
2481
2778
|
* ```js
|
|
2482
2779
|
* // Manage schedules from liveboard context
|
|
2483
2780
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
2484
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
2781
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList, {}, ContextType.Liveboard);
|
|
2485
2782
|
* ```
|
|
2486
2783
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2487
2784
|
*/
|
|
@@ -2926,6 +3223,7 @@ var HostEvent;
|
|
|
2926
3223
|
* console.log(tml.answer);
|
|
2927
3224
|
* });
|
|
2928
3225
|
* ```
|
|
3226
|
+
* @returns The TML representation of the current Answer, as an object.
|
|
2929
3227
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2930
3228
|
* @important
|
|
2931
3229
|
*/
|
|
@@ -3350,6 +3648,14 @@ var HostEvent;
|
|
|
3350
3648
|
/**
|
|
3351
3649
|
* Get details of filters applied on the Liveboard.
|
|
3352
3650
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
3651
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
3652
|
+
* indicating the scope of the filter. It contains a `level`
|
|
3653
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
3654
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
3655
|
+
* level there is no `targetId`, since the filter applies to the
|
|
3656
|
+
* whole Liveboard.
|
|
3657
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
3658
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3353
3659
|
* @example
|
|
3354
3660
|
* ```js
|
|
3355
3661
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
@@ -3362,6 +3668,8 @@ var HostEvent;
|
|
|
3362
3668
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
|
|
3363
3669
|
* console.log('filters', data);
|
|
3364
3670
|
* ```
|
|
3671
|
+
* @returns liveboardFilters - Filters applied on the Liveboard.
|
|
3672
|
+
* @returns runtimeFilters - Runtime filters applied on the Liveboard.
|
|
3365
3673
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3366
3674
|
*/
|
|
3367
3675
|
HostEvent["GetFilters"] = "getFilters";
|
|
@@ -3389,6 +3697,16 @@ var HostEvent;
|
|
|
3389
3697
|
*
|
|
3390
3698
|
* `type` - To update filters for date time, specify the date format type.
|
|
3391
3699
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
3700
|
+
*
|
|
3701
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
3702
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
3703
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
3704
|
+
*
|
|
3705
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
3706
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
3707
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
3708
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
3709
|
+
* Liveboard.
|
|
3392
3710
|
* @example
|
|
3393
3711
|
* ```js
|
|
3394
3712
|
*
|
|
@@ -3465,6 +3783,21 @@ var HostEvent;
|
|
|
3465
3783
|
* }
|
|
3466
3784
|
* }, ContextType.Liveboard);
|
|
3467
3785
|
* ```
|
|
3786
|
+
* @example
|
|
3787
|
+
* ```js
|
|
3788
|
+
* // Scope the filter to a specific Liveboard tab
|
|
3789
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
3790
|
+
* filter: {
|
|
3791
|
+
* column: "item type",
|
|
3792
|
+
* oper: "IN",
|
|
3793
|
+
* values: ["bags", "shirts"],
|
|
3794
|
+
* applicability: {
|
|
3795
|
+
* level: "TAB",
|
|
3796
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
3797
|
+
* }
|
|
3798
|
+
* }
|
|
3799
|
+
* });
|
|
3800
|
+
* ```
|
|
3468
3801
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3469
3802
|
*/
|
|
3470
3803
|
HostEvent["UpdateFilters"] = "updateFilters";
|
|
@@ -3486,9 +3819,37 @@ var HostEvent;
|
|
|
3486
3819
|
* console.log('tabs', tabDetails);
|
|
3487
3820
|
* });
|
|
3488
3821
|
* ```
|
|
3822
|
+
* @returns orderedTabIds - Tab GUIDs in the order they appear.
|
|
3823
|
+
* @returns numberOfTabs - Total number of tabs on the Liveboard.
|
|
3824
|
+
* @returns Tabs - Tab details, each with at least `id` and `name`.
|
|
3489
3825
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
3490
3826
|
*/
|
|
3491
3827
|
HostEvent["GetTabs"] = "getTabs";
|
|
3828
|
+
/**
|
|
3829
|
+
* Get group details for the current Liveboard.
|
|
3830
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
3831
|
+
* @example
|
|
3832
|
+
* ```js
|
|
3833
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
3834
|
+
* console.log(
|
|
3835
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
3836
|
+
* );
|
|
3837
|
+
* })
|
|
3838
|
+
* ```
|
|
3839
|
+
* @example
|
|
3840
|
+
* ```js
|
|
3841
|
+
* // Get groups from liveboard context
|
|
3842
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3843
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
3844
|
+
* console.log('groups', groupDetails);
|
|
3845
|
+
* });
|
|
3846
|
+
* ```
|
|
3847
|
+
* @returns orderedGroupIds - Group GUIDs in the order they appear.
|
|
3848
|
+
* @returns numberOfGroups - Total number of groups on the Liveboard.
|
|
3849
|
+
* @returns Groups - Group details, each with at least `id` and `name`.
|
|
3850
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
3851
|
+
*/
|
|
3852
|
+
HostEvent["GetGroups"] = "getGroups";
|
|
3492
3853
|
/**
|
|
3493
3854
|
* Set the visible tabs on a Liveboard.
|
|
3494
3855
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -3560,6 +3921,9 @@ var HostEvent;
|
|
|
3560
3921
|
* // Alternative direct usage (not recommended)
|
|
3561
3922
|
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
3562
3923
|
* ```
|
|
3924
|
+
* @returns session - Session identifier for the Answer, for use with the
|
|
3925
|
+
* `AnswerService`.
|
|
3926
|
+
* @returns embedAnswerData - Data backing the Answer, when available.
|
|
3563
3927
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw
|
|
3564
3928
|
*/
|
|
3565
3929
|
HostEvent["GetAnswerSession"] = "getAnswerSession";
|
|
@@ -3616,6 +3980,15 @@ var HostEvent;
|
|
|
3616
3980
|
* - `name`: Name of the parameter.
|
|
3617
3981
|
* - `value`: The value to set for the parameter.
|
|
3618
3982
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
3983
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
3984
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
3985
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
3986
|
+
*
|
|
3987
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
3988
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
3989
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
3990
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
3991
|
+
* Liveboard.
|
|
3619
3992
|
*
|
|
3620
3993
|
* @example
|
|
3621
3994
|
* ```js
|
|
@@ -3627,6 +4000,18 @@ var HostEvent;
|
|
|
3627
4000
|
* ```
|
|
3628
4001
|
* @example
|
|
3629
4002
|
* ```js
|
|
4003
|
+
* // Scope the parameter to a specific Liveboard tab
|
|
4004
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
4005
|
+
* name: "Integer Range Param",
|
|
4006
|
+
* value: 10,
|
|
4007
|
+
* applicability: {
|
|
4008
|
+
* level: "TAB",
|
|
4009
|
+
* targetId: "e0836cad-4fdf-42d4-bd97-567a6b2a6058"
|
|
4010
|
+
* }
|
|
4011
|
+
* }])
|
|
4012
|
+
* ```
|
|
4013
|
+
* @example
|
|
4014
|
+
* ```js
|
|
3630
4015
|
* // Update parameters from liveboard context
|
|
3631
4016
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
3632
4017
|
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
@@ -3640,6 +4025,14 @@ var HostEvent;
|
|
|
3640
4025
|
HostEvent["UpdateParameters"] = "UpdateParameters";
|
|
3641
4026
|
/**
|
|
3642
4027
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
4028
|
+
* Each parameter includes an optional `applicability` attribute
|
|
4029
|
+
* indicating the scope of the parameter. It contains a `level`
|
|
4030
|
+
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
4031
|
+
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
4032
|
+
* level there is no `targetId`, since the parameter applies to the
|
|
4033
|
+
* whole Liveboard.
|
|
4034
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4035
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
3643
4036
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
3644
4037
|
* ```js
|
|
3645
4038
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
@@ -3664,12 +4057,16 @@ var HostEvent;
|
|
|
3664
4057
|
* console.log('parameters', parameters);
|
|
3665
4058
|
* });
|
|
3666
4059
|
* ```
|
|
4060
|
+
* @returns parameters - Parameters currently applied on the Liveboard.
|
|
3667
4061
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
3668
4062
|
*/
|
|
3669
4063
|
HostEvent["GetParameters"] = "GetParameters";
|
|
3670
4064
|
/**
|
|
3671
4065
|
* Triggers an event to update a personalized view of a Liveboard.
|
|
3672
|
-
* This event is deprecated. Use {@link HostEvent.
|
|
4066
|
+
* This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
|
|
4067
|
+
* which additionally accepts a `viewName`, resets to the original view when
|
|
4068
|
+
* called with an empty payload, and reports an error when a named view
|
|
4069
|
+
* cannot be found.
|
|
3673
4070
|
* ```js
|
|
3674
4071
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
3675
4072
|
* ```
|
|
@@ -3687,10 +4084,15 @@ var HostEvent;
|
|
|
3687
4084
|
HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
|
|
3688
4085
|
/**
|
|
3689
4086
|
* Triggers an event to update a personalized view of a Liveboard.
|
|
4087
|
+
* This event is deprecated. Use {@link HostEvent.SelectPersonalizedView} instead,
|
|
4088
|
+
* which additionally accepts a `viewName`, resets to the original view when
|
|
4089
|
+
* called with an empty payload, and reports an error when a named view
|
|
4090
|
+
* cannot be found.
|
|
3690
4091
|
* ```js
|
|
3691
4092
|
* liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
|
|
3692
4093
|
* ```
|
|
3693
4094
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
4095
|
+
* @deprecated SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
3694
4096
|
*/
|
|
3695
4097
|
HostEvent["UpdatePersonalizedView"] = "UpdatePersonalisedView";
|
|
3696
4098
|
/**
|
|
@@ -3793,6 +4195,10 @@ var HostEvent;
|
|
|
3793
4195
|
* description: "Generated from Spotter"
|
|
3794
4196
|
* }, ContextType.Spotter);
|
|
3795
4197
|
* ```
|
|
4198
|
+
* @returns answerId - GUID of the saved Answer.
|
|
4199
|
+
* @returns saveResponse - Raw response from the save operation.
|
|
4200
|
+
* @returns shareResponse - Raw response from the share operation, when the
|
|
4201
|
+
* Answer was also made discoverable.
|
|
3796
4202
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
3797
4203
|
*/
|
|
3798
4204
|
HostEvent["SaveAnswer"] = "saveAnswer";
|
|
@@ -3906,6 +4312,36 @@ var HostEvent;
|
|
|
3906
4312
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3907
4313
|
*/
|
|
3908
4314
|
HostEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
4315
|
+
/**
|
|
4316
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
4317
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
4318
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
4319
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
4320
|
+
* @example
|
|
4321
|
+
* ```js
|
|
4322
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
4323
|
+
* ```
|
|
4324
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4325
|
+
*/
|
|
4326
|
+
HostEvent["ShareSpotterConversation"] = "ShareSpotterConversation";
|
|
4327
|
+
/**
|
|
4328
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
4329
|
+
* @example
|
|
4330
|
+
* ```js
|
|
4331
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
4332
|
+
* ```
|
|
4333
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4334
|
+
*/
|
|
4335
|
+
HostEvent["CloseSpotterShareConversation"] = "CloseSpotterShareConversation";
|
|
4336
|
+
/**
|
|
4337
|
+
* Exits the read-only shared-conversation view.
|
|
4338
|
+
* @example
|
|
4339
|
+
* ```js
|
|
4340
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
4341
|
+
* ```
|
|
4342
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4343
|
+
*/
|
|
4344
|
+
HostEvent["ExitSpotterSharedConversation"] = "ExitSpotterSharedConversation";
|
|
3909
4345
|
/**
|
|
3910
4346
|
* Deletes the last prompt in spotter embed.
|
|
3911
4347
|
* @example
|
|
@@ -4001,6 +4437,41 @@ var HostEvent;
|
|
|
4001
4437
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
4002
4438
|
*/
|
|
4003
4439
|
HostEvent["StartNewSpotterConversation"] = "StartNewSpotterConversation";
|
|
4440
|
+
/**
|
|
4441
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
4442
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
4443
|
+
* required.
|
|
4444
|
+
*
|
|
4445
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4446
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4447
|
+
* instance.
|
|
4448
|
+
*
|
|
4449
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
4450
|
+
* @example
|
|
4451
|
+
* ```js
|
|
4452
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
4453
|
+
* conversationId: '<conversation-id>',
|
|
4454
|
+
* });
|
|
4455
|
+
* ```
|
|
4456
|
+
*/
|
|
4457
|
+
HostEvent["PinSpotterConversation"] = "PinSpotterConversation";
|
|
4458
|
+
/**
|
|
4459
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
4460
|
+
* conversation to unpin is required.
|
|
4461
|
+
*
|
|
4462
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
4463
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
4464
|
+
* instance.
|
|
4465
|
+
*
|
|
4466
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
4467
|
+
* @example
|
|
4468
|
+
* ```js
|
|
4469
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
4470
|
+
* conversationId: '<conversation-id>',
|
|
4471
|
+
* });
|
|
4472
|
+
* ```
|
|
4473
|
+
*/
|
|
4474
|
+
HostEvent["UnpinSpotterConversation"] = "UnpinSpotterConversation";
|
|
4004
4475
|
/**
|
|
4005
4476
|
* @hidden
|
|
4006
4477
|
* Get the current context of the embedded page.
|
|
@@ -4209,6 +4680,7 @@ var Param;
|
|
|
4209
4680
|
Param["NumberFormatLocale"] = "numberFormatLocale";
|
|
4210
4681
|
Param["CurrencyFormat"] = "currencyFormat";
|
|
4211
4682
|
Param["Enable2ColumnLayout"] = "enable2ColumnLayout";
|
|
4683
|
+
Param["IsLiveboardAlwaysOn12ColLayout"] = "isLiveboardAlwaysOn12ColLayout";
|
|
4212
4684
|
Param["IsFullAppEmbed"] = "isFullAppEmbed";
|
|
4213
4685
|
Param["IsOnBeforeGetVizDataInterceptEnabled"] = "isOnBeforeGetVizDataInterceptEnabled";
|
|
4214
4686
|
Param["FocusSearchBarOnRender"] = "focusSearchBarOnRender";
|
|
@@ -4222,6 +4694,7 @@ var Param;
|
|
|
4222
4694
|
Param["SpotterEnabled"] = "isSpotterExperienceEnabled";
|
|
4223
4695
|
Param["IsUnifiedSearchExperienceEnabled"] = "isUnifiedSearchExperienceEnabled";
|
|
4224
4696
|
Param["OverrideOrgId"] = "orgId";
|
|
4697
|
+
Param["OverrideHistoryState"] = "overrideHistoryState";
|
|
4225
4698
|
Param["OauthPollingInterval"] = "oAuthPollingInterval";
|
|
4226
4699
|
Param["IsForceRedirect"] = "isForceRedirect";
|
|
4227
4700
|
Param["DataSourceId"] = "dataSourceId";
|
|
@@ -4231,6 +4704,7 @@ var Param;
|
|
|
4231
4704
|
Param["PrimaryAction"] = "primaryAction";
|
|
4232
4705
|
Param["isSpotterAgentEmbed"] = "isSpotterAgentEmbed";
|
|
4233
4706
|
Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
|
|
4707
|
+
Param["LiveboardGutter"] = "liveboardGutter";
|
|
4234
4708
|
Param["IsLazyLoadingForEmbedEnabled"] = "isLazyLoadingForEmbedEnabled";
|
|
4235
4709
|
Param["RootMarginForLazyLoad"] = "rootMarginForLazyLoad";
|
|
4236
4710
|
Param["isPNGInScheduledEmailsEnabled"] = "isPNGInScheduledEmailsEnabled";
|
|
@@ -4239,9 +4713,12 @@ var Param;
|
|
|
4239
4713
|
Param["isGranularXLSXCSVSchedulesEnabled"] = "isGranularXLSXCSVSchedulesEnabled";
|
|
4240
4714
|
Param["isSendNowLiveboardSchedulingEnabled"] = "isSendNowLiveboardSchedulingEnabled";
|
|
4241
4715
|
Param["isCentralizedLiveboardFilterUXEnabled"] = "isCentralizedLiveboardFilterUXEnabled";
|
|
4716
|
+
Param["isScopedLiveboardFilteringEnabled"] = "isScopedLiveboardFilteringEnabled";
|
|
4242
4717
|
Param["isLinkParametersEnabled"] = "isLinkParametersEnabled";
|
|
4243
4718
|
Param["EnablePastConversationsSidebar"] = "enablePastConversationsSidebar";
|
|
4244
4719
|
Param["UpdatedSpotterChatPrompt"] = "updatedSpotterChatPrompt";
|
|
4720
|
+
Param["ShowSpotterRadiance"] = "showSpotterRadiance";
|
|
4721
|
+
Param["DefaultQueryMode"] = "defaultQueryMode";
|
|
4245
4722
|
Param["EnableStopAnswerGenerationEmbed"] = "enableStopAnswerGenerationEmbed";
|
|
4246
4723
|
Param["SpotterSidebarTitle"] = "spotterSidebarTitle";
|
|
4247
4724
|
Param["SpotterSidebarDefaultExpanded"] = "spotterSidebarDefaultExpanded";
|
|
@@ -4261,14 +4738,19 @@ var Param;
|
|
|
4261
4738
|
Param["SpotterFileUploadEnabled"] = "spotterFileUploadEnabled";
|
|
4262
4739
|
Param["SpotterFileUploadFileTypes"] = "spotterFileUploadFileTypes";
|
|
4263
4740
|
Param["IsStarterPromptsEnabled"] = "enableStarterPrompts";
|
|
4741
|
+
Param["UpdatedSpotterExperience"] = "updatedSpotterExperience";
|
|
4742
|
+
Param["SpotterDataSources"] = "spotterDataSources";
|
|
4743
|
+
Param["AnalystId"] = "analystId";
|
|
4744
|
+
Param["OpenSpotterOnLiveboardByDefault"] = "openSpotterOnLiveboardByDefault";
|
|
4264
4745
|
})(Param = exports.Param || (exports.Param = {}));
|
|
4265
4746
|
/**
|
|
4266
4747
|
* ThoughtSpot application pages include actions and menu commands
|
|
4267
4748
|
* for various user-initiated operations. These actions are represented
|
|
4268
4749
|
* as enumeration members in the SDK. To control actions in the embedded view:
|
|
4269
|
-
* - disabledActions — the action is grayed out and still visible, but non-interactive
|
|
4270
|
-
* - hiddenActions — the action is completely removed from
|
|
4271
|
-
* - visibleActions — allowlist, only these actions
|
|
4750
|
+
* - disabledActions — the action is grayed out and still visible, but non-interactive
|
|
4751
|
+
* (user can see but not click). - hiddenActions — the action is completely removed from
|
|
4752
|
+
* the UI (user cannot see it at all). - visibleActions — allowlist, only these actions
|
|
4753
|
+
* are shown; all others are hidden.
|
|
4272
4754
|
*
|
|
4273
4755
|
* Use disabledActions to disable (gray out) an action.
|
|
4274
4756
|
* Use hiddenActions to hide (fully remove) an action.
|
|
@@ -4322,6 +4804,17 @@ var Action;
|
|
|
4322
4804
|
* ```
|
|
4323
4805
|
*/
|
|
4324
4806
|
Action["SaveAsView"] = "saveAsView";
|
|
4807
|
+
/**
|
|
4808
|
+
* The **EditInputTable** action on a Liveboard
|
|
4809
|
+
* page. Allows users to edit an input table used in an Answer directly from
|
|
4810
|
+
* a Liveboard.
|
|
4811
|
+
* @example
|
|
4812
|
+
* ```js
|
|
4813
|
+
* disabledActions: [Action.EditInputTable]
|
|
4814
|
+
* ```
|
|
4815
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
4816
|
+
*/
|
|
4817
|
+
Action["EditInputTable"] = "editInputTable";
|
|
4325
4818
|
/**
|
|
4326
4819
|
* The **Make a copy** action on a Liveboard or Answer
|
|
4327
4820
|
* page. Creates a copy of the Liveboard.
|
|
@@ -5525,6 +6018,19 @@ var Action;
|
|
|
5525
6018
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
5526
6019
|
*/
|
|
5527
6020
|
Action["ChangeFilterVisibilityInTab"] = "changeFilterVisibilityInTab";
|
|
6021
|
+
/**
|
|
6022
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
6023
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
6024
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
6025
|
+
*
|
|
6026
|
+
* @example
|
|
6027
|
+
* ```js
|
|
6028
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
6029
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
6030
|
+
* ```
|
|
6031
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
6032
|
+
*/
|
|
6033
|
+
Action["AllLiveboardFilters"] = "allLiveboardFilters";
|
|
5528
6034
|
/**
|
|
5529
6035
|
* The **Data model instructions** button on the Spotter interface.
|
|
5530
6036
|
* Allows opening the data model instructions modal.
|
|
@@ -5626,6 +6132,10 @@ var Action;
|
|
|
5626
6132
|
* The **Add to Coaching** feature allows adding reference questions and
|
|
5627
6133
|
* business terms to improve Spotter’s responses. This feature is generally available
|
|
5628
6134
|
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
6135
|
+
*
|
|
6136
|
+
* This action governs both the answer-card **Add to memory** CTA and its
|
|
6137
|
+
* Spotter 3 successor, the response-footer **Remember this** CTA
|
|
6138
|
+
* (they are mutually exclusive).
|
|
5629
6139
|
* @example
|
|
5630
6140
|
* ```js
|
|
5631
6141
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -5860,6 +6370,89 @@ var Action;
|
|
|
5860
6370
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
5861
6371
|
*/
|
|
5862
6372
|
Action["SpotterChatRename"] = "spotterChatRename";
|
|
6373
|
+
/**
|
|
6374
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
6375
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
6376
|
+
* (enableShareConversation on).
|
|
6377
|
+
* @example
|
|
6378
|
+
* ```js
|
|
6379
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
6380
|
+
* ```
|
|
6381
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6382
|
+
*/
|
|
6383
|
+
Action["SpotterShareConversationButtonHeader"] = "spotterShareConversationButtonHeader";
|
|
6384
|
+
/**
|
|
6385
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
6386
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
6387
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
6388
|
+
* @example
|
|
6389
|
+
* ```js
|
|
6390
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
6391
|
+
* ```
|
|
6392
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6393
|
+
*/
|
|
6394
|
+
Action["SpotterShareConversationMenuItemSidebar"] = "spotterShareConversationMenuItemSidebar";
|
|
6395
|
+
/**
|
|
6396
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
6397
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
6398
|
+
* @example
|
|
6399
|
+
* ```js
|
|
6400
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
6401
|
+
* ```
|
|
6402
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6403
|
+
*/
|
|
6404
|
+
Action["SpotterSharedConversationBanner"] = "spotterSharedConversationBanner";
|
|
6405
|
+
/**
|
|
6406
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
6407
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
6408
|
+
* @example
|
|
6409
|
+
* ```js
|
|
6410
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
6411
|
+
* ```
|
|
6412
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6413
|
+
*/
|
|
6414
|
+
Action["SpotterSharedConversationBannerDismissButton"] = "spotterSharedConversationBannerDismissButton";
|
|
6415
|
+
/**
|
|
6416
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
6417
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
6418
|
+
* host event.
|
|
6419
|
+
* @example
|
|
6420
|
+
* ```js
|
|
6421
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
6422
|
+
* ```
|
|
6423
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6424
|
+
*/
|
|
6425
|
+
Action["SpotterSharedConversationExitButton"] = "spotterSharedConversationExitButton";
|
|
6426
|
+
/**
|
|
6427
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
6428
|
+
* to the current moment…"). Hide-only.
|
|
6429
|
+
* @example
|
|
6430
|
+
* ```js
|
|
6431
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
6432
|
+
* ```
|
|
6433
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6434
|
+
*/
|
|
6435
|
+
Action["SpotterShareUpToCurrentInfo"] = "spotterShareUpToCurrentInfo";
|
|
6436
|
+
/**
|
|
6437
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
6438
|
+
* messages since last shared version" checkbox.
|
|
6439
|
+
* @example
|
|
6440
|
+
* ```js
|
|
6441
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
6442
|
+
* ```
|
|
6443
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6444
|
+
*/
|
|
6445
|
+
Action["SpotterShareIncludeNewMessagesCheckbox"] = "spotterShareIncludeNewMessagesCheckbox";
|
|
6446
|
+
/**
|
|
6447
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
6448
|
+
* stale-snapshot info banner.
|
|
6449
|
+
* @example
|
|
6450
|
+
* ```js
|
|
6451
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
6452
|
+
* ```
|
|
6453
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6454
|
+
*/
|
|
6455
|
+
Action["SpotterShareStaleInfoBannerDismissButton"] = "spotterShareStaleInfoBannerDismissButton";
|
|
5863
6456
|
/**
|
|
5864
6457
|
* Controls visibility and disable state of the delete action
|
|
5865
6458
|
* in the Spotter conversation edit menu.
|
|
@@ -5870,6 +6463,16 @@ var Action;
|
|
|
5870
6463
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
5871
6464
|
*/
|
|
5872
6465
|
Action["SpotterChatDelete"] = "spotterChatDelete";
|
|
6466
|
+
/**
|
|
6467
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
6468
|
+
* in the Spotter conversation edit menu.
|
|
6469
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6470
|
+
* @example
|
|
6471
|
+
* ```js
|
|
6472
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
6473
|
+
* ```
|
|
6474
|
+
*/
|
|
6475
|
+
Action["SpotterChatPin"] = "spotterChatPin";
|
|
5873
6476
|
/**
|
|
5874
6477
|
* Controls visibility and disable state of the documentation/best practices
|
|
5875
6478
|
* link in the Spotter sidebar footer.
|
|
@@ -5913,6 +6516,56 @@ var Action;
|
|
|
5913
6516
|
* @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
|
|
5914
6517
|
*/
|
|
5915
6518
|
Action["SpotterChatModeSwitcher"] = "spotterChatModeSwitcher";
|
|
6519
|
+
/**
|
|
6520
|
+
* The **Basic Search** starter prompt pill.
|
|
6521
|
+
*
|
|
6522
|
+
* Starter prompt pills are the row of category buttons shown above the
|
|
6523
|
+
* Spotter chat input before a conversation starts. They give a new user
|
|
6524
|
+
* ready-made questions to click instead of typing one from scratch, and
|
|
6525
|
+
* disappear once the conversation begins. There are three, one per action
|
|
6526
|
+
* below.
|
|
6527
|
+
*
|
|
6528
|
+
* Clicking this pill opens a card of suggested simple questions; picking one
|
|
6529
|
+
* submits it to Spotter right away. Visible by default, and hidden along
|
|
6530
|
+
* with the other pills when the surface itself is off (see
|
|
6531
|
+
* {@link SpotterChatViewConfig.starterPrompts}).
|
|
6532
|
+
* @example
|
|
6533
|
+
* ```js
|
|
6534
|
+
* hiddenActions: [Action.QuickSearchPill]
|
|
6535
|
+
* ```
|
|
6536
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6537
|
+
*/
|
|
6538
|
+
Action["QuickSearchPill"] = "quickSearchPill";
|
|
6539
|
+
/**
|
|
6540
|
+
* The **Deep Analysis** starter prompt pill, next to
|
|
6541
|
+
* {@link Action.QuickSearchPill} above the Spotter chat input.
|
|
6542
|
+
*
|
|
6543
|
+
* Clicking it opens a card of suggested investigative questions ("why did
|
|
6544
|
+
* revenue drop?"). Picking one fills the chat input in Deep Analysis mode
|
|
6545
|
+
* rather than submitting immediately, so the user can edit it first.
|
|
6546
|
+
* Visible by default.
|
|
6547
|
+
* @example
|
|
6548
|
+
* ```js
|
|
6549
|
+
* hiddenActions: [Action.DeepAnalysisPill]
|
|
6550
|
+
* ```
|
|
6551
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6552
|
+
*/
|
|
6553
|
+
Action["DeepAnalysisPill"] = "deepAnalysisPill";
|
|
6554
|
+
/**
|
|
6555
|
+
* The **Data Literacy** starter prompt pill, next to
|
|
6556
|
+
* {@link Action.QuickSearchPill} above the Spotter chat input.
|
|
6557
|
+
*
|
|
6558
|
+
* Unlike the other two pills it opens no card: clicking it submits a prompt
|
|
6559
|
+
* that describes the data the model can answer over, helping a user who does
|
|
6560
|
+
* not yet know what is in the data source. The prompt text always comes from
|
|
6561
|
+
* ThoughtSpot, so only its label is customizable. Visible by default.
|
|
6562
|
+
* @example
|
|
6563
|
+
* ```js
|
|
6564
|
+
* hiddenActions: [Action.DataLiteracyPill]
|
|
6565
|
+
* ```
|
|
6566
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
6567
|
+
*/
|
|
6568
|
+
Action["DataLiteracyPill"] = "dataLiteracyPill";
|
|
5916
6569
|
/**
|
|
5917
6570
|
* The **Include current period** checkbox for date filters.
|
|
5918
6571
|
* Controls the visibility and availability of the option to include
|
|
@@ -6061,6 +6714,38 @@ var Action;
|
|
|
6061
6714
|
* ```
|
|
6062
6715
|
*/
|
|
6063
6716
|
Action["SpotterAnalystSidebar"] = "spotterAnalystSidebar";
|
|
6717
|
+
/**
|
|
6718
|
+
* Controls visibility and disable state of the analyst list
|
|
6719
|
+
* ("Show all") in the Spotter Analyst interface.
|
|
6720
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6721
|
+
* @example
|
|
6722
|
+
* ```js
|
|
6723
|
+
* hiddenActions: [Action.SpotterAnalystList]
|
|
6724
|
+
* disabledActions: [Action.SpotterAnalystList]
|
|
6725
|
+
* ```
|
|
6726
|
+
*/
|
|
6727
|
+
Action["SpotterAnalystList"] = "spotterAnalystList";
|
|
6728
|
+
/**
|
|
6729
|
+
* Controls visibility and disable state of the default Spotter analyst
|
|
6730
|
+
* entry in the Spotter Analyst interface.
|
|
6731
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6732
|
+
* @example
|
|
6733
|
+
* ```js
|
|
6734
|
+
* hiddenActions: [Action.SpotterDefaultAnalyst]
|
|
6735
|
+
* disabledActions: [Action.SpotterDefaultAnalyst]
|
|
6736
|
+
* ```
|
|
6737
|
+
*/
|
|
6738
|
+
Action["SpotterDefaultAnalyst"] = "spotterDefaultAnalyst";
|
|
6739
|
+
/**
|
|
6740
|
+
* The **Spotter** button in the Liveboard header.
|
|
6741
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
6742
|
+
* @example
|
|
6743
|
+
* ```js
|
|
6744
|
+
* hiddenActions: [Action.SpotterOnLiveboard]
|
|
6745
|
+
* disabledActions: [Action.SpotterOnLiveboard]
|
|
6746
|
+
* ```
|
|
6747
|
+
*/
|
|
6748
|
+
Action["SpotterOnLiveboard"] = "spotterOnLiveboard";
|
|
6064
6749
|
})(Action = exports.Action || (exports.Action = {}));
|
|
6065
6750
|
var PrefetchFeatures;
|
|
6066
6751
|
(function (PrefetchFeatures) {
|
|
@@ -6348,6 +7033,8 @@ var EmbedErrorCodes;
|
|
|
6348
7033
|
EmbedErrorCodes["UPDATEFILTERS_INVALID_PAYLOAD"] = "UPDATEFILTERS_INVALID_PAYLOAD";
|
|
6349
7034
|
/** DrillDown payload is invalid - missing or malformed points */
|
|
6350
7035
|
EmbedErrorCodes["DRILLDOWN_INVALID_PAYLOAD"] = "DRILLDOWN_INVALID_PAYLOAD";
|
|
7036
|
+
/** UpdateParameters payload is invalid - malformed applicability */
|
|
7037
|
+
EmbedErrorCodes["UPDATEPARAMETERS_INVALID_PAYLOAD"] = "UPDATEPARAMETERS_INVALID_PAYLOAD";
|
|
6351
7038
|
})(EmbedErrorCodes = exports.EmbedErrorCodes || (exports.EmbedErrorCodes = {}));
|
|
6352
7039
|
/**
|
|
6353
7040
|
* Context types for specifying the page context when triggering host events.
|