@thoughtspot/visual-embed-sdk 1.46.5 → 1.47.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +9 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +7 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +22 -2
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +10 -1
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +2 -1
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.js +7 -1
- package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.spec.js +80 -5
- package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +9 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +12 -4
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +28 -67
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +0 -1
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +0 -1
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +1 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -4
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +2 -2
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +1 -3
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -36
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -34
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/types.d.ts +42 -74
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +18 -46
- package/cjs/src/types.js.map +1 -1
- package/dist/{index-ChNydfIz.js → index-CUgxBnPm.js} +1 -1
- package/dist/src/embed/app.d.ts +9 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +10 -1
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +9 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/dist/src/errors.d.ts +0 -1
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +1 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +2 -2
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -36
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +42 -74
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +72 -200
- package/dist/tsembed-react.js +60 -190
- package/dist/tsembed.es.js +87 -181
- package/dist/tsembed.js +30812 -30907
- package/dist/visual-embed-sdk-react-full.d.ts +71 -255
- package/dist/visual-embed-sdk-react.d.ts +71 -255
- package/dist/visual-embed-sdk.d.ts +69 -225
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +9 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +7 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +22 -2
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +10 -1
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +2 -1
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/utils.js +7 -1
- package/lib/src/embed/hostEventClient/utils.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.spec.js +80 -5
- package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +9 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +12 -4
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +30 -69
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +0 -1
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +0 -1
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +1 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +2 -2
- 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/index.d.ts +1 -36
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +0 -33
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/types.d.ts +42 -74
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +18 -46
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +69 -225
- package/package.json +1 -1
- package/src/embed/app.spec.ts +33 -3
- package/src/embed/app.ts +18 -3
- package/src/embed/conversation.ts +15 -4
- package/src/embed/hostEventClient/utils.spec.ts +94 -6
- package/src/embed/hostEventClient/utils.ts +15 -2
- package/src/embed/liveboard.ts +13 -0
- package/src/embed/ts-embed.spec.ts +56 -108
- package/src/embed/ts-embed.ts +10 -3
- package/src/errors.ts +0 -1
- package/src/index.ts +2 -5
- package/src/react/all-types-export.ts +0 -3
- package/src/react/index.tsx +15 -59
- package/src/types.ts +103 -137
- package/cjs/src/embed/sage.d.ts +0 -164
- package/cjs/src/embed/sage.d.ts.map +0 -1
- package/cjs/src/embed/sage.js +0 -88
- package/cjs/src/embed/sage.js.map +0 -1
- package/cjs/src/embed/sage.spec.d.ts +0 -2
- package/cjs/src/embed/sage.spec.d.ts.map +0 -1
- package/cjs/src/embed/sage.spec.js +0 -151
- package/cjs/src/embed/sage.spec.js.map +0 -1
- package/dist/index-DGV_zh53.js +0 -7371
- package/dist/index-DW2wEHqy.js +0 -7371
- package/dist/src/embed/sage.d.ts +0 -164
- package/dist/src/embed/sage.d.ts.map +0 -1
- package/dist/src/embed/sage.spec.d.ts +0 -2
- package/dist/src/embed/sage.spec.d.ts.map +0 -1
- package/lib/src/embed/sage.d.ts +0 -164
- package/lib/src/embed/sage.d.ts.map +0 -1
- package/lib/src/embed/sage.js +0 -84
- package/lib/src/embed/sage.js.map +0 -1
- package/lib/src/embed/sage.spec.d.ts +0 -2
- package/lib/src/embed/sage.spec.d.ts.map +0 -1
- package/lib/src/embed/sage.spec.js +0 -148
- package/lib/src/embed/sage.spec.js.map +0 -1
- package/src/embed/sage.spec.ts +0 -206
- package/src/embed/sage.ts +0 -231
package/src/react/index.tsx
CHANGED
|
@@ -5,7 +5,6 @@ import useDeepCompareEffect from 'use-deep-compare-effect';
|
|
|
5
5
|
import { AuthEventEmitter } from '../auth';
|
|
6
6
|
import { deepMerge } from '../utils';
|
|
7
7
|
import { SearchBarEmbed as _SearchBarEmbed, SearchBarViewConfig } from '../embed/search-bar';
|
|
8
|
-
import { SageEmbed as _SageEmbed, SageViewConfig } from '../embed/sage';
|
|
9
8
|
import { SearchEmbed as _SearchEmbed, SearchViewConfig } from '../embed/search';
|
|
10
9
|
import { AppEmbed as _AppEmbed, AppViewConfig } from '../embed/app';
|
|
11
10
|
import { LiveboardEmbed as _LiveboardEmbed, LiveboardViewConfig } from '../embed/liveboard';
|
|
@@ -299,48 +298,6 @@ export const PreRenderedSearchBarEmbed = componentFactory<
|
|
|
299
298
|
SearchBarViewConfig
|
|
300
299
|
>(_SearchBarEmbed, true);
|
|
301
300
|
|
|
302
|
-
interface SageEmbedProps extends EmbedProps, SageViewConfig { }
|
|
303
|
-
|
|
304
|
-
/**
|
|
305
|
-
* React component for LLM based search Sage embed.
|
|
306
|
-
* @example
|
|
307
|
-
* ```tsx
|
|
308
|
-
* function Sage() {
|
|
309
|
-
* return <SageEmbed
|
|
310
|
-
* showObjectResults={true}
|
|
311
|
-
* ... other view config props or event listeners.
|
|
312
|
-
* />
|
|
313
|
-
* }
|
|
314
|
-
* ```
|
|
315
|
-
*/
|
|
316
|
-
export const SageEmbed = componentFactory<typeof _SageEmbed, SageEmbedProps, SageViewConfig>(
|
|
317
|
-
_SageEmbed,
|
|
318
|
-
);
|
|
319
|
-
|
|
320
|
-
/**
|
|
321
|
-
* React component for PreRendered Sage embed.
|
|
322
|
-
*
|
|
323
|
-
* PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
|
|
324
|
-
* default.
|
|
325
|
-
*
|
|
326
|
-
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
327
|
-
* @example
|
|
328
|
-
* ```tsx
|
|
329
|
-
* function LandingPageComponent() {
|
|
330
|
-
* return <PreRenderedSageEmbed preRenderId="someId" showObjectResults={true} />
|
|
331
|
-
* }
|
|
332
|
-
* ```
|
|
333
|
-
* function MyComponent() {
|
|
334
|
-
* return <SageEmbed preRenderId="someId" showObjectResults={true} />
|
|
335
|
-
* }
|
|
336
|
-
* ```
|
|
337
|
-
*/
|
|
338
|
-
export const PreRenderedSageEmbed = componentFactory<
|
|
339
|
-
typeof _SageEmbed,
|
|
340
|
-
SageEmbedProps & PreRenderProps,
|
|
341
|
-
SageViewConfig
|
|
342
|
-
>(_SageEmbed, true);
|
|
343
|
-
|
|
344
301
|
interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig { }
|
|
345
302
|
interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig { }
|
|
346
303
|
|
|
@@ -409,24 +366,24 @@ type SpotterMessageProps = {
|
|
|
409
366
|
|
|
410
367
|
/**
|
|
411
368
|
* React component for displaying individual conversation messages from SpotterAgent.
|
|
412
|
-
*
|
|
369
|
+
*
|
|
413
370
|
* This component renders a single message response from your ThoughtSpot conversation,
|
|
414
371
|
* showing charts, visualizations, or text responses based on the user's query.
|
|
415
|
-
*
|
|
372
|
+
*
|
|
416
373
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
417
374
|
* @example
|
|
418
375
|
* ```tsx
|
|
419
376
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
420
377
|
* const result = await sendMessage('show me sales by region');
|
|
421
|
-
*
|
|
378
|
+
*
|
|
422
379
|
* if (!result.error) {
|
|
423
380
|
* // Simple usage - just pass the message data
|
|
424
381
|
* <SpotterMessage message={result.message} />
|
|
425
|
-
*
|
|
382
|
+
*
|
|
426
383
|
* // With optional query for context
|
|
427
|
-
* <SpotterMessage
|
|
428
|
-
* message={result.message}
|
|
429
|
-
* query={result.query}
|
|
384
|
+
* <SpotterMessage
|
|
385
|
+
* message={result.message}
|
|
386
|
+
* query={result.query}
|
|
430
387
|
* />
|
|
431
388
|
* }
|
|
432
389
|
* ```
|
|
@@ -436,7 +393,7 @@ export const SpotterMessage = React.forwardRef<
|
|
|
436
393
|
SpotterMessageProps
|
|
437
394
|
>((props, ref) => {
|
|
438
395
|
const { message, query: _, ...otherProps } = props;
|
|
439
|
-
|
|
396
|
+
|
|
440
397
|
return (
|
|
441
398
|
<ConversationMessage
|
|
442
399
|
ref={ref}
|
|
@@ -475,7 +432,6 @@ type EmbedComponent = typeof SearchEmbed
|
|
|
475
432
|
| typeof AppEmbed
|
|
476
433
|
| typeof LiveboardEmbed
|
|
477
434
|
| typeof SearchBarEmbed
|
|
478
|
-
| typeof SageEmbed
|
|
479
435
|
| typeof ConversationMessage
|
|
480
436
|
| typeof SpotterMessage
|
|
481
437
|
| typeof SpotterEmbed
|
|
@@ -527,20 +483,20 @@ export function useInit(config: EmbedConfig) {
|
|
|
527
483
|
|
|
528
484
|
/**
|
|
529
485
|
* React hook for interacting with SpotterAgent AI conversations.
|
|
530
|
-
*
|
|
486
|
+
*
|
|
531
487
|
* This hook provides a sendMessage function that allows you to send natural language
|
|
532
488
|
* queries to your data and get back AI-generated responses with visualizations.
|
|
533
|
-
*
|
|
489
|
+
*
|
|
534
490
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
|
|
535
491
|
* @param config - Configuration object containing worksheetId and other options
|
|
536
492
|
* @returns Object with sendMessage function that returns conversation results
|
|
537
493
|
* @example
|
|
538
494
|
* ```tsx
|
|
539
495
|
* const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
|
|
540
|
-
*
|
|
496
|
+
*
|
|
541
497
|
* const handleQuery = async () => {
|
|
542
498
|
* const result = await sendMessage('show me sales by region');
|
|
543
|
-
*
|
|
499
|
+
*
|
|
544
500
|
* if (!result.error) {
|
|
545
501
|
* // Display the message response
|
|
546
502
|
* <SpotterMessage message={result.message} />
|
|
@@ -552,14 +508,14 @@ export function useInit(config: EmbedConfig) {
|
|
|
552
508
|
*/
|
|
553
509
|
export function useSpotterAgent(config: SpotterAgentEmbedViewConfig) {
|
|
554
510
|
const serviceRef = useRef<_SpotterAgentEmbed | null>(null);
|
|
555
|
-
|
|
511
|
+
|
|
556
512
|
useDeepCompareEffect(() => {
|
|
557
513
|
if (serviceRef.current) {
|
|
558
514
|
serviceRef.current = null;
|
|
559
515
|
}
|
|
560
|
-
|
|
516
|
+
|
|
561
517
|
serviceRef.current = new _SpotterAgentEmbed(config);
|
|
562
|
-
|
|
518
|
+
|
|
563
519
|
return () => {
|
|
564
520
|
serviceRef.current = null;
|
|
565
521
|
};
|
package/src/types.ts
CHANGED
|
@@ -505,11 +505,6 @@ export interface EmbedConfig {
|
|
|
505
505
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
506
506
|
*/
|
|
507
507
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
508
|
-
/**
|
|
509
|
-
* Hide `beta` alert warning message for SageEmbed.
|
|
510
|
-
*
|
|
511
|
-
*/
|
|
512
|
-
suppressSageEmbedBetaWarning?: boolean;
|
|
513
508
|
/**
|
|
514
509
|
* Custom style params for embed Config.
|
|
515
510
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
@@ -595,6 +590,7 @@ export interface EmbedConfig {
|
|
|
595
590
|
/**
|
|
596
591
|
* Disables the Mixpanel tracking from the SDK.
|
|
597
592
|
* @version SDK: 1.27.9
|
|
593
|
+
* @hidden
|
|
598
594
|
*/
|
|
599
595
|
disableSDKTracking?: boolean;
|
|
600
596
|
/**
|
|
@@ -904,7 +900,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
904
900
|
* The width and height dimensions to render an embedded
|
|
905
901
|
* object inside your app. Specify the values in pixels or percentage.
|
|
906
902
|
*
|
|
907
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
903
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
908
904
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
909
905
|
* @example
|
|
910
906
|
* ```js
|
|
@@ -934,7 +930,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
934
930
|
* for the user.
|
|
935
931
|
* Use this to disable actions.
|
|
936
932
|
*
|
|
937
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
933
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
938
934
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
939
935
|
* @example
|
|
940
936
|
* ```js
|
|
@@ -949,7 +945,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
949
945
|
/**
|
|
950
946
|
* The tooltip to display for disabled actions.
|
|
951
947
|
*
|
|
952
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
948
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
953
949
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
954
950
|
* @example
|
|
955
951
|
* ```js
|
|
@@ -967,7 +963,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
967
963
|
* These actions will be hidden from the user.
|
|
968
964
|
* Use this to hide an action.
|
|
969
965
|
*
|
|
970
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
966
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
971
967
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
972
968
|
* @example
|
|
973
969
|
* ```js
|
|
@@ -988,7 +984,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
988
984
|
*
|
|
989
985
|
* Use either this or hiddenActions.
|
|
990
986
|
*
|
|
991
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
987
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
992
988
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
993
989
|
* @important
|
|
994
990
|
* @example
|
|
@@ -1004,7 +1000,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1004
1000
|
/**
|
|
1005
1001
|
* The locale settings to apply to the embedded view.
|
|
1006
1002
|
*
|
|
1007
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1003
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1008
1004
|
* @version SDK: 1.9.4 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1009
1005
|
* @example
|
|
1010
1006
|
* ```js
|
|
@@ -1025,7 +1021,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1025
1021
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1026
1022
|
* list of supported keys and values associated with each.
|
|
1027
1023
|
*
|
|
1028
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1024
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1029
1025
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1030
1026
|
* @example
|
|
1031
1027
|
* ```js
|
|
@@ -1051,7 +1047,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1051
1047
|
* Insert as a sibling of the target container, instead of appending to a
|
|
1052
1048
|
* child inside it.
|
|
1053
1049
|
*
|
|
1054
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1050
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1055
1051
|
* @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
|
|
1056
1052
|
* @example
|
|
1057
1053
|
* ```js
|
|
@@ -1077,7 +1073,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1077
1073
|
* Use PreRender to render the embed in the background and then
|
|
1078
1074
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
1079
1075
|
*
|
|
1080
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1076
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1081
1077
|
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1082
1078
|
* @example
|
|
1083
1079
|
* ```js
|
|
@@ -1115,7 +1111,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1115
1111
|
* Enable the V2 shell. This can provide performance benefits
|
|
1116
1112
|
* due to a lighter-weight shell.
|
|
1117
1113
|
*
|
|
1118
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1114
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1119
1115
|
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
1120
1116
|
* @example
|
|
1121
1117
|
* ```js
|
|
@@ -1143,7 +1139,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1143
1139
|
* This flag can be used to disable links inside the embedded app,
|
|
1144
1140
|
* and disable redirection of links in a new tab.
|
|
1145
1141
|
*
|
|
1146
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1142
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1147
1143
|
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1148
1144
|
* @example
|
|
1149
1145
|
* ```js
|
|
@@ -1162,7 +1158,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1162
1158
|
* The `overrideOrgId` setting is honoured only if the
|
|
1163
1159
|
* Per Org URL feature is enabled on your ThoughtSpot instance.
|
|
1164
1160
|
*
|
|
1165
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1161
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
|
|
1166
1162
|
* @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
|
|
1167
1163
|
* @example
|
|
1168
1164
|
* ```js
|
|
@@ -1182,7 +1178,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1182
1178
|
* {@link enableLinkOverridesV2} instead.
|
|
1183
1179
|
*
|
|
1184
1180
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1185
|
-
* `
|
|
1181
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1186
1182
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1187
1183
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1188
1184
|
* @example
|
|
@@ -1206,7 +1202,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1206
1202
|
* older ThoughtSpot versions.
|
|
1207
1203
|
*
|
|
1208
1204
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`,
|
|
1209
|
-
* `
|
|
1205
|
+
* `SearchEmbed`, `SpotterAgentEmbed`,
|
|
1210
1206
|
* `SpotterEmbed`, `SearchBarEmbed`
|
|
1211
1207
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.2.0.cl
|
|
1212
1208
|
* @example
|
|
@@ -1265,7 +1261,7 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1265
1261
|
* external app, calling an API, or opening a modal — based on the data context of
|
|
1266
1262
|
* what they clicked can be used to trigger custom logic when the action is clicked.
|
|
1267
1263
|
*
|
|
1268
|
-
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `
|
|
1264
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`, `SpotterEmbed`
|
|
1269
1265
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl
|
|
1270
1266
|
* @example
|
|
1271
1267
|
* ```ts
|
|
@@ -1438,7 +1434,6 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1438
1434
|
*/
|
|
1439
1435
|
customActions?: CustomAction[];
|
|
1440
1436
|
|
|
1441
|
-
|
|
1442
1437
|
/**
|
|
1443
1438
|
* Refresh the auth token when the token is near expiry.
|
|
1444
1439
|
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
@@ -1625,11 +1620,11 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1625
1620
|
/**
|
|
1626
1621
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
1627
1622
|
*
|
|
1628
|
-
* Supported embed types: `AppEmbed`, `
|
|
1623
|
+
* Supported embed types: `AppEmbed`, `SearchEmbed`
|
|
1629
1624
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1630
1625
|
* @example
|
|
1631
1626
|
* ```js
|
|
1632
|
-
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed,
|
|
1627
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchEmbed
|
|
1633
1628
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1634
1629
|
* ... // other embed view config
|
|
1635
1630
|
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
@@ -1666,12 +1661,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1666
1661
|
/**
|
|
1667
1662
|
* To set the initial state of the search bar in case of saved Answers.
|
|
1668
1663
|
*
|
|
1669
|
-
* Supported embed types: `
|
|
1664
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`
|
|
1670
1665
|
* @default true
|
|
1671
1666
|
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
1672
1667
|
* @example
|
|
1673
1668
|
* ```js
|
|
1674
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
1669
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
1675
1670
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1676
1671
|
* ... // other embed view config
|
|
1677
1672
|
* collapseSearchBar: true,
|
|
@@ -1682,12 +1677,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1682
1677
|
/**
|
|
1683
1678
|
* Flag to control Data panel experience
|
|
1684
1679
|
*
|
|
1685
|
-
* Supported embed types: `
|
|
1680
|
+
* Supported embed types: `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1686
1681
|
* @deprecated from SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
1687
1682
|
* @default true
|
|
1688
1683
|
* @example
|
|
1689
1684
|
* ```js
|
|
1690
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
1685
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed, or SearchBarEmbed
|
|
1691
1686
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1692
1687
|
* ... // other embed view config
|
|
1693
1688
|
* dataPanelV2: true,
|
|
@@ -1698,12 +1693,12 @@ export interface SearchLiveboardCommonViewConfig {
|
|
|
1698
1693
|
/**
|
|
1699
1694
|
* To enable custom column groups in data panel v2
|
|
1700
1695
|
*
|
|
1701
|
-
* Supported embed types: `
|
|
1696
|
+
* Supported embed types: `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
1702
1697
|
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
|
|
1703
1698
|
* @default false
|
|
1704
1699
|
* @example
|
|
1705
1700
|
* ```js
|
|
1706
|
-
* // Replace <EmbedComponent> with embed component name. For example,
|
|
1701
|
+
* // Replace <EmbedComponent> with embed component name. For example, SearchBarEmbed, or LiveboardEmbed
|
|
1707
1702
|
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
1708
1703
|
* ... // other embed view config
|
|
1709
1704
|
* enableCustomColumnGroups: true,
|
|
@@ -3126,19 +3121,6 @@ export enum EmbedEvent {
|
|
|
3126
3121
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3127
3122
|
*/
|
|
3128
3123
|
FilterChanged = 'filterChanged',
|
|
3129
|
-
/**
|
|
3130
|
-
* Emitted when a user clicks the **Go** button to initiate
|
|
3131
|
-
* a Natural Language Search query
|
|
3132
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3133
|
-
*/
|
|
3134
|
-
SageEmbedQuery = 'sageEmbedQuery',
|
|
3135
|
-
/**
|
|
3136
|
-
* Emitted when a user selects a data source on the embedded
|
|
3137
|
-
* Natural Language Search interface.
|
|
3138
|
-
*
|
|
3139
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
3140
|
-
*/
|
|
3141
|
-
SageWorksheetUpdated = 'sageWorksheetUpdated',
|
|
3142
3124
|
/**
|
|
3143
3125
|
* Emitted when a user updates a connection on the **Data** page
|
|
3144
3126
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
@@ -3265,7 +3247,7 @@ export enum EmbedEvent {
|
|
|
3265
3247
|
* **Prerequisite**: Set`isOnBeforeGetVizDataInterceptEnabled` to `true`
|
|
3266
3248
|
* to ensure that `EmbedEvent.OnBeforeGetVizDataIntercept` is emitted
|
|
3267
3249
|
* when the embedding application user tries to run a search query.
|
|
3268
|
-
*
|
|
3250
|
+
*
|
|
3269
3251
|
* This framework applies only to `AppEmbed` and `SearchEmbed`.
|
|
3270
3252
|
* @param - Includes the following parameters:
|
|
3271
3253
|
* - `payload`: The payload received from the embed related to the Data API call.
|
|
@@ -3641,7 +3623,7 @@ export enum EmbedEvent {
|
|
|
3641
3623
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
3642
3624
|
*/
|
|
3643
3625
|
SpotterConversationSelected = 'spotterConversationSelected',
|
|
3644
|
-
|
|
3626
|
+
|
|
3645
3627
|
/**
|
|
3646
3628
|
* @hidden
|
|
3647
3629
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -4604,7 +4586,7 @@ export enum HostEvent {
|
|
|
4604
4586
|
* tml.answer.search_query // TML representation of the search query
|
|
4605
4587
|
* );
|
|
4606
4588
|
* })
|
|
4607
|
-
|
|
4589
|
+
* ```
|
|
4608
4590
|
* @example
|
|
4609
4591
|
* ```js
|
|
4610
4592
|
* // Get TML from search context
|
|
@@ -4725,9 +4707,9 @@ export enum HostEvent {
|
|
|
4725
4707
|
* Trigger the **Download** action on charts in
|
|
4726
4708
|
* the embedded view.
|
|
4727
4709
|
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
4728
|
-
*
|
|
4710
|
+
*
|
|
4729
4711
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
4730
|
-
*
|
|
4712
|
+
*
|
|
4731
4713
|
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
4732
4714
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
4733
4715
|
* @example
|
|
@@ -5228,21 +5210,6 @@ export enum HostEvent {
|
|
|
5228
5210
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
5229
5211
|
*/
|
|
5230
5212
|
SetHiddenTabs = 'SetPinboardHiddenTabs',
|
|
5231
|
-
/**
|
|
5232
|
-
* Updates the search query string for Natural Language Search operations.
|
|
5233
|
-
* @param - Includes the following keys:
|
|
5234
|
-
* - `queryString`: Text string in Natural Language format.
|
|
5235
|
-
* - `executeSearch`: Boolean to execute search and update search query.
|
|
5236
|
-
* @example
|
|
5237
|
-
* ```js
|
|
5238
|
-
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
5239
|
-
* queryString: 'revenue per year',
|
|
5240
|
-
* executeSearch: true,
|
|
5241
|
-
* })
|
|
5242
|
-
* ```
|
|
5243
|
-
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
5244
|
-
*/
|
|
5245
|
-
UpdateSageQuery = 'updateSageQuery',
|
|
5246
5213
|
/**
|
|
5247
5214
|
* Get the Answer session for a Search or
|
|
5248
5215
|
* Liveboard visualization.
|
|
@@ -5401,7 +5368,7 @@ export enum HostEvent {
|
|
|
5401
5368
|
* ```
|
|
5402
5369
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
5403
5370
|
*/
|
|
5404
|
-
UpdatePersonalizedView = UpdatePersonalisedView,
|
|
5371
|
+
UpdatePersonalizedView = UpdatePersonalisedView,
|
|
5405
5372
|
/**
|
|
5406
5373
|
* Triggers selection of a specific Personalized View on a
|
|
5407
5374
|
* Liveboard without reloading the embed. Pass either a
|
|
@@ -5715,7 +5682,7 @@ export enum HostEvent {
|
|
|
5715
5682
|
/**
|
|
5716
5683
|
* @hidden
|
|
5717
5684
|
* Get the current context of the embedded page.
|
|
5718
|
-
*
|
|
5685
|
+
*
|
|
5719
5686
|
* @example
|
|
5720
5687
|
* ```js
|
|
5721
5688
|
* const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
|
|
@@ -5812,7 +5779,6 @@ export enum Param {
|
|
|
5812
5779
|
HideNotification = 'hideNotification',
|
|
5813
5780
|
HideApplicationSwitcher = 'applicationSwitcherHidden',
|
|
5814
5781
|
HideOrgSwitcher = 'orgSwitcherHidden',
|
|
5815
|
-
IsSageEmbed = 'isSageEmbed',
|
|
5816
5782
|
HideWorksheetSelector = 'hideWorksheetSelector',
|
|
5817
5783
|
DisableWorksheetChange = 'disableWorksheetChange',
|
|
5818
5784
|
HideSourceSelection = 'hideSourceSelection',
|
|
@@ -5884,6 +5850,7 @@ export enum Param {
|
|
|
5884
5850
|
isLinkParametersEnabled = 'isLinkParametersEnabled',
|
|
5885
5851
|
EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
|
|
5886
5852
|
UpdatedSpotterChatPrompt = 'updatedSpotterChatPrompt',
|
|
5853
|
+
EnableStopAnswerGenerationEmbed = 'enableStopAnswerGenerationEmbed',
|
|
5887
5854
|
SpotterSidebarTitle = 'spotterSidebarTitle',
|
|
5888
5855
|
SpotterSidebarDefaultExpanded = 'spotterSidebarDefaultExpanded',
|
|
5889
5856
|
SpotterChatRenameLabel = 'spotterChatRenameLabel',
|
|
@@ -6887,7 +6854,7 @@ export enum Action {
|
|
|
6887
6854
|
* ```
|
|
6888
6855
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
6889
6856
|
*/
|
|
6890
|
-
PersonalizedViewsDropdown = PersonalisedViewsDropdown,
|
|
6857
|
+
PersonalizedViewsDropdown = PersonalisedViewsDropdown,
|
|
6891
6858
|
/**
|
|
6892
6859
|
* Action ID for show or hide the user details on a
|
|
6893
6860
|
* Liveboard (Recently visited / social proof)
|
|
@@ -7210,11 +7177,11 @@ export enum Action {
|
|
|
7210
7177
|
*/
|
|
7211
7178
|
CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
|
|
7212
7179
|
/**
|
|
7213
|
-
|
|
7214
|
-
|
|
7215
|
-
|
|
7216
|
-
|
|
7217
|
-
|
|
7180
|
+
* Action ID to hide or disable the Coaching workflow in Spotter conversations.
|
|
7181
|
+
* When disabled, users cannot access **Add to Coaching** workflow in conversation.
|
|
7182
|
+
* The **Add to Coaching** feature allows adding reference questions and
|
|
7183
|
+
* business terms to improve Spotter’s responses. This feature is generally available
|
|
7184
|
+
* (GA) from version 26.2.0.cl and enabled by default on embed deployments.
|
|
7218
7185
|
* @example
|
|
7219
7186
|
* ```js
|
|
7220
7187
|
* hiddenAction: [Action.InConversationTraining]
|
|
@@ -7290,7 +7257,7 @@ export enum Action {
|
|
|
7290
7257
|
* @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.15.0.cl
|
|
7291
7258
|
*/
|
|
7292
7259
|
LiveboardStylePanel = 'liveboardStylePanel',
|
|
7293
|
-
|
|
7260
|
+
/**
|
|
7294
7261
|
* The **Publish** action for Liveboards, Answers and Models.
|
|
7295
7262
|
* Opens the publishing modal. It's a parent action for the
|
|
7296
7263
|
* **Manage Publishing** and **Unpublish** actions if the object
|
|
@@ -7302,43 +7269,43 @@ export enum Action {
|
|
|
7302
7269
|
* ```
|
|
7303
7270
|
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7304
7271
|
*/
|
|
7305
|
-
|
|
7306
|
-
|
|
7307
|
-
|
|
7308
|
-
|
|
7309
|
-
|
|
7310
|
-
|
|
7311
|
-
|
|
7312
|
-
|
|
7313
|
-
|
|
7314
|
-
|
|
7315
|
-
|
|
7316
|
-
|
|
7317
|
-
|
|
7318
|
-
|
|
7319
|
-
|
|
7320
|
-
|
|
7321
|
-
|
|
7322
|
-
|
|
7323
|
-
|
|
7324
|
-
|
|
7325
|
-
|
|
7326
|
-
|
|
7327
|
-
|
|
7328
|
-
|
|
7329
|
-
|
|
7330
|
-
|
|
7331
|
-
|
|
7332
|
-
|
|
7333
|
-
|
|
7334
|
-
|
|
7335
|
-
|
|
7336
|
-
|
|
7337
|
-
|
|
7338
|
-
|
|
7339
|
-
|
|
7340
|
-
|
|
7341
|
-
|
|
7272
|
+
Publish = 'publish',
|
|
7273
|
+
/**
|
|
7274
|
+
* The **Manage Publishing** action for Liveboards, Answers and Models.
|
|
7275
|
+
* Opens the same publishing modal as the **Publish** action.
|
|
7276
|
+
* Appears as a child action to the **Publish** action if the
|
|
7277
|
+
* object is already published.
|
|
7278
|
+
* @example
|
|
7279
|
+
* ```js
|
|
7280
|
+
* hiddenActions: [Action.ManagePublishing]
|
|
7281
|
+
* disabledActions: [Action.ManagePublishing]
|
|
7282
|
+
* ```
|
|
7283
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7284
|
+
*/
|
|
7285
|
+
ManagePublishing = 'managePublishing',
|
|
7286
|
+
/**
|
|
7287
|
+
* The **Unpublish** action for Liveboards, Answers and Models.
|
|
7288
|
+
* Opens the unpublishing modal. Appears as a child action to
|
|
7289
|
+
* the **Publish** action if the object is already published.
|
|
7290
|
+
* @example
|
|
7291
|
+
* ```js
|
|
7292
|
+
* hiddenActions: [Action.Unpublish]
|
|
7293
|
+
* disabledActions: [Action.Unpublish]
|
|
7294
|
+
* ```
|
|
7295
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7296
|
+
*/
|
|
7297
|
+
Unpublish = 'unpublish',
|
|
7298
|
+
/**
|
|
7299
|
+
* The **Parameterize** action for Tables and Connections.
|
|
7300
|
+
* Opens the parameterization modal.
|
|
7301
|
+
* @example
|
|
7302
|
+
* ```js
|
|
7303
|
+
* hiddenActions: [Action.Parameterize]
|
|
7304
|
+
* disabledActions: [Action.Parameterize]
|
|
7305
|
+
* ```
|
|
7306
|
+
* @version SDK: 1.45.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
7307
|
+
*/
|
|
7308
|
+
Parameterize = 'parameterise',
|
|
7342
7309
|
/**
|
|
7343
7310
|
* The **Move to Group** menu action on a Liveboard.
|
|
7344
7311
|
* Allows moving a visualization to a different group.
|
|
@@ -7774,11 +7741,11 @@ export enum LogLevel {
|
|
|
7774
7741
|
* Error types emitted by embedded components.
|
|
7775
7742
|
*
|
|
7776
7743
|
* These enum values categorize different types of errors that can occur during
|
|
7777
|
-
* the lifecycle of an embedded ThoughtSpot component.
|
|
7744
|
+
* the lifecycle of an embedded ThoughtSpot component.
|
|
7778
7745
|
* Use {@link EmbedErrorDetailsEvent} and {@link EmbedErrorCodes} to handle specific errors.
|
|
7779
7746
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
7780
7747
|
* @group Error Handling
|
|
7781
|
-
*
|
|
7748
|
+
*
|
|
7782
7749
|
* @example
|
|
7783
7750
|
* Handle specific error types
|
|
7784
7751
|
* ```js
|
|
@@ -7915,7 +7882,7 @@ export enum EmbedErrorCodes {
|
|
|
7915
7882
|
*
|
|
7916
7883
|
* @example
|
|
7917
7884
|
* Handle specific error types
|
|
7918
|
-
*
|
|
7885
|
+
*
|
|
7919
7886
|
* ```js
|
|
7920
7887
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7921
7888
|
* switch (error.code) {
|
|
@@ -7929,7 +7896,7 @@ export enum EmbedErrorCodes {
|
|
|
7929
7896
|
* ```
|
|
7930
7897
|
* @example
|
|
7931
7898
|
* Handle multiple error messages
|
|
7932
|
-
*
|
|
7899
|
+
*
|
|
7933
7900
|
* ```js
|
|
7934
7901
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7935
7902
|
* const messages = Array.isArray(error.message)
|
|
@@ -8095,34 +8062,33 @@ export interface ObjectIds {
|
|
|
8095
8062
|
modalTitle?: string;
|
|
8096
8063
|
}
|
|
8097
8064
|
|
|
8098
|
-
|
|
8099
8065
|
export interface ContextObject {
|
|
8100
8066
|
/**
|
|
8101
8067
|
* Stack of context objects.
|
|
8102
8068
|
*/
|
|
8103
|
-
|
|
8104
|
-
|
|
8105
|
-
|
|
8106
|
-
|
|
8107
|
-
|
|
8108
|
-
|
|
8109
|
-
|
|
8110
|
-
|
|
8111
|
-
|
|
8112
|
-
|
|
8113
|
-
|
|
8114
|
-
|
|
8115
|
-
|
|
8116
|
-
|
|
8117
|
-
/**
|
|
8118
|
-
* Current context object.
|
|
8119
|
-
*/
|
|
8120
|
-
currentContext: {
|
|
8069
|
+
stack: Array<{
|
|
8070
|
+
/**
|
|
8071
|
+
* Name of the context object.
|
|
8072
|
+
*/
|
|
8073
|
+
name: string;
|
|
8074
|
+
/**
|
|
8075
|
+
* Type of the context object.
|
|
8076
|
+
*/
|
|
8077
|
+
type: ContextType;
|
|
8078
|
+
/**
|
|
8079
|
+
* Object IDs of the context object.
|
|
8080
|
+
*/
|
|
8081
|
+
objectIds: ObjectIds;
|
|
8082
|
+
}>;
|
|
8121
8083
|
/**
|
|
8122
|
-
*
|
|
8084
|
+
* Current context object.
|
|
8123
8085
|
*/
|
|
8124
|
-
|
|
8125
|
-
|
|
8126
|
-
|
|
8127
|
-
|
|
8086
|
+
currentContext: {
|
|
8087
|
+
/**
|
|
8088
|
+
* Name of the current context object.
|
|
8089
|
+
*/
|
|
8090
|
+
name: string;
|
|
8091
|
+
type: ContextType;
|
|
8092
|
+
objectIds: ObjectIds;
|
|
8093
|
+
};
|
|
8128
8094
|
}
|