@thoughtspot/visual-embed-sdk 1.50.1 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/css-variables.d.ts +36 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +106 -14
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +47 -36
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +318 -149
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +204 -1
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +19 -15
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +198 -17
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +42 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +45 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +15 -0
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +1 -0
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +1 -0
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +9 -0
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +36 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +26 -6
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +83 -2
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +8 -1
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +14 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +61 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +15 -0
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js.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/types.d.ts +460 -15
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +428 -8
- package/cjs/src/types.js.map +1 -1
- package/dist/{index-fCne7kmU.js → index-aBzH5ZwF.js} +1 -1
- package/dist/src/css-variables.d.ts +36 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +106 -14
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +204 -1
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +15 -0
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +36 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +8 -1
- package/dist/src/embed/spotter-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +4 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/types.d.ts +460 -15
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +558 -69
- package/dist/tsembed-react.js +557 -68
- package/dist/tsembed.es.js +556 -68
- package/dist/tsembed.js +555 -67
- package/dist/visual-embed-sdk-react-full.d.ts +845 -27
- package/dist/visual-embed-sdk-react.d.ts +851 -29
- package/dist/visual-embed-sdk.d.ts +855 -29
- package/lib/package.json +1 -1
- package/lib/src/css-variables.d.ts +36 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +106 -14
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +48 -37
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +319 -150
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +204 -1
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +21 -17
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +198 -17
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +42 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +45 -0
- package/lib/src/embed/host-events.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +15 -0
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +1 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +1 -0
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +9 -0
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +36 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +26 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +83 -2
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +8 -1
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +12 -0
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +62 -1
- package/lib/src/embed/spotter-utils.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +15 -0
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js.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/types.d.ts +460 -15
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +428 -8
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +855 -29
- package/package.json +1 -1
- package/src/css-variables.ts +45 -0
- package/src/embed/app.spec.ts +390 -183
- package/src/embed/app.ts +172 -65
- package/src/embed/conversation.spec.ts +243 -20
- package/src/embed/conversation.ts +233 -17
- package/src/embed/events.spec.ts +52 -0
- package/src/embed/host-events.spec.ts +70 -0
- package/src/embed/hostEventClient/contracts.ts +16 -0
- package/src/embed/hostEventClient/host-event-client.spec.ts +12 -0
- package/src/embed/hostEventClient/host-event-client.ts +1 -0
- package/src/embed/liveboard.spec.ts +108 -2
- package/src/embed/liveboard.ts +76 -14
- package/src/embed/spotter-utils.spec.ts +68 -1
- package/src/embed/spotter-utils.ts +16 -1
- package/src/embed/ts-embed.ts +18 -0
- package/src/index.ts +2 -1
- package/src/mixpanel-service.ts +4 -0
- package/src/types.ts +462 -14
|
@@ -39,6 +39,42 @@ export interface CustomCssVariables {
|
|
|
39
39
|
* Font color of the top navigation panel.
|
|
40
40
|
*/
|
|
41
41
|
"--ts-var-nav-color"?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Background color of the left navigation panel.
|
|
44
|
+
*/
|
|
45
|
+
"--ts-var-left-nav-background"?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Background color of the active tab in the left navigation panel.
|
|
48
|
+
*/
|
|
49
|
+
"--ts-var-left-nav-active-tab-background"?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Border color of the active tab in the left navigation panel.
|
|
52
|
+
*/
|
|
53
|
+
"--ts-var-left-nav-active-tab-border-color"?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Font color of the section title in the left navigation panel.
|
|
56
|
+
*/
|
|
57
|
+
"--ts-var-left-nav-section-title-color"?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Font color of the items in the left navigation panel.
|
|
60
|
+
*/
|
|
61
|
+
"--ts-var-left-nav-item-color"?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Font color of the selected item in the left navigation panel.
|
|
64
|
+
*/
|
|
65
|
+
"--ts-var-left-nav-item-selection-color"?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Background color of the selected item in the left navigation panel.
|
|
68
|
+
*/
|
|
69
|
+
"--ts-var-left-nav-item-selection-background"?: string;
|
|
70
|
+
/**
|
|
71
|
+
* Color of the active tab icon in the left navigation panel.
|
|
72
|
+
*/
|
|
73
|
+
"--ts-var-left-nav-tab-icon-active-color"?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Color of the inactive tab icon in the left navigation panel.
|
|
76
|
+
*/
|
|
77
|
+
"--ts-var-left-nav-tab-icon-inactive-color"?: string;
|
|
42
78
|
/**
|
|
43
79
|
* Background color of the *Search data* button.
|
|
44
80
|
*/
|
|
@@ -1398,7 +1434,9 @@ export declare enum AuthType {
|
|
|
1398
1434
|
}
|
|
1399
1435
|
/**
|
|
1400
1436
|
*
|
|
1401
|
-
* **Note**:
|
|
1437
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
1438
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges) and
|
|
1439
|
+
* V4 (Focused) home page experiences.
|
|
1402
1440
|
*
|
|
1403
1441
|
*/
|
|
1404
1442
|
export declare enum HomeLeftNavItem {
|
|
@@ -2796,7 +2834,9 @@ export interface HomePageConfig {
|
|
|
2796
2834
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2797
2835
|
* For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
|
|
2798
2836
|
*
|
|
2799
|
-
* **Note**:
|
|
2837
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2838
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2839
|
+
* and V4 (Focused) home page experiences.
|
|
2800
2840
|
*
|
|
2801
2841
|
* Supported embed types: `AppEmbed`
|
|
2802
2842
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2805,7 +2845,7 @@ export interface HomePageConfig {
|
|
|
2805
2845
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
2806
2846
|
*
|
|
2807
2847
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2808
|
-
* ... //
|
|
2848
|
+
* ... // V3 navigation and home page experience attributes
|
|
2809
2849
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2810
2850
|
* //...other embed view configuration attributes
|
|
2811
2851
|
* })
|
|
@@ -2816,8 +2856,11 @@ export interface HomePageConfig {
|
|
|
2816
2856
|
* Reorder home page modules.
|
|
2817
2857
|
* To specify the modules, import the `HomepageModule` enum.
|
|
2818
2858
|
* For example: `reorderedHomepageModules = [HomepageModule.MyLibrary,
|
|
2819
|
-
* HomepageModule.Watchlist]`
|
|
2820
|
-
*
|
|
2859
|
+
* HomepageModule.Watchlist]`
|
|
2860
|
+
*
|
|
2861
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2862
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2863
|
+
* and V4 (Focused) home page experiences.
|
|
2821
2864
|
*
|
|
2822
2865
|
* Supported embed types: `AppEmbed`
|
|
2823
2866
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -2826,7 +2869,7 @@ export interface HomePageConfig {
|
|
|
2826
2869
|
* import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
|
|
2827
2870
|
*
|
|
2828
2871
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2829
|
-
* ...//
|
|
2872
|
+
* ...//V3 navigation and home page experience attributes
|
|
2830
2873
|
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
|
|
2831
2874
|
* //... other embed view configuration attributes
|
|
2832
2875
|
* })
|
|
@@ -2838,7 +2881,9 @@ export interface HomePageConfig {
|
|
|
2838
2881
|
* on the home page left navigation panel.
|
|
2839
2882
|
* To specify the menu items, import the `HomeLeftNavItem` enum.
|
|
2840
2883
|
*
|
|
2841
|
-
* **Note**:
|
|
2884
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
2885
|
+
* deprecated. This attribute applies to V3 (ModularWithStylingChanges)
|
|
2886
|
+
* and V4 (Focused) home page experiences.
|
|
2842
2887
|
*
|
|
2843
2888
|
* Supported embed types: `AppEmbed`
|
|
2844
2889
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
@@ -3214,6 +3259,24 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3214
3259
|
* ```
|
|
3215
3260
|
*/
|
|
3216
3261
|
isCentralizedLiveboardFilterUXEnabled?: boolean;
|
|
3262
|
+
/**
|
|
3263
|
+
* This flag is used to enable or disable scoped Liveboard filtering.
|
|
3264
|
+
* When enabled, filters and parameters can be scoped to a group of
|
|
3265
|
+
* visualizations on a Liveboard, in addition to the Liveboard and
|
|
3266
|
+
* tab levels.
|
|
3267
|
+
*
|
|
3268
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3269
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
3270
|
+
* @example
|
|
3271
|
+
* ```js
|
|
3272
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3273
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3274
|
+
* ... // other embed view config
|
|
3275
|
+
* isScopedLiveboardFilteringEnabled: true,
|
|
3276
|
+
* })
|
|
3277
|
+
* ```
|
|
3278
|
+
*/
|
|
3279
|
+
isScopedLiveboardFilteringEnabled?: boolean;
|
|
3217
3280
|
/**
|
|
3218
3281
|
* This flag is used to enable or disable the link parameters in liveboard.
|
|
3219
3282
|
*
|
|
@@ -3397,7 +3460,9 @@ export declare enum RuntimeFilterOp {
|
|
|
3397
3460
|
* via `hiddenHomepageModules` and reordered via
|
|
3398
3461
|
* `reorderedHomepageModules`.
|
|
3399
3462
|
*
|
|
3400
|
-
* **Note**:
|
|
3463
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
3464
|
+
* deprecated. These modules apply to V3 (ModularWithStylingChanges) and
|
|
3465
|
+
* V4 (Focused) home page experiences.
|
|
3401
3466
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
|
|
3402
3467
|
*/
|
|
3403
3468
|
export declare enum HomepageModule {
|
|
@@ -4386,11 +4451,19 @@ export declare enum EmbedEvent {
|
|
|
4386
4451
|
* Emitted when a user changes any filter on a Liveboard.
|
|
4387
4452
|
* Returns filter type and name, column name and ID, and runtime
|
|
4388
4453
|
* filter details.
|
|
4454
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
4455
|
+
* scope of the changed filter. It contains a `level` (`LIVEBOARD`,
|
|
4456
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
4457
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
4458
|
+
* is no `targetId`, since the filter applies to the whole Liveboard.
|
|
4459
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4460
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
4389
4461
|
* @example
|
|
4390
4462
|
*
|
|
4391
4463
|
* ```js
|
|
4392
4464
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
4393
4465
|
* console.log('payload', payload);
|
|
4466
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
4394
4467
|
* })
|
|
4395
4468
|
* ```
|
|
4396
4469
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
@@ -4582,9 +4655,17 @@ export declare enum EmbedEvent {
|
|
|
4582
4655
|
/**
|
|
4583
4656
|
* Emitted when parameter changes in an Answer
|
|
4584
4657
|
* or Liveboard.
|
|
4658
|
+
* The payload includes an optional `applicability` attribute indicating the
|
|
4659
|
+
* scope of the changed parameter. It contains a `level` (`LIVEBOARD`,
|
|
4660
|
+
* `TAB`, or `GROUP`) and, when `level` is `TAB` or `GROUP`, a
|
|
4661
|
+
* `targetId` with the GUID of the target. At `LIVEBOARD` level there
|
|
4662
|
+
* is no `targetId`, since the parameter applies to the whole Liveboard.
|
|
4663
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
4664
|
+
* ThoughtSpot: 26.10.0.cl.
|
|
4585
4665
|
* ```js
|
|
4586
4666
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4587
4667
|
* console.log('payload', payload);
|
|
4668
|
+
* // payload.data optionally includes applicability: { level, targetId }
|
|
4588
4669
|
* })
|
|
4589
4670
|
* ```
|
|
4590
4671
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
@@ -4886,6 +4967,158 @@ export declare enum EmbedEvent {
|
|
|
4886
4967
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4887
4968
|
*/
|
|
4888
4969
|
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
4970
|
+
/**
|
|
4971
|
+
* Emitted when the header Share button is clicked. Fires `Start` then `End`
|
|
4972
|
+
* to bracket the interaction. App→host counterpart of the
|
|
4973
|
+
* `ShareSpotterConversation` host event (user-driven vs programmatic open).
|
|
4974
|
+
* @example
|
|
4975
|
+
* ```js
|
|
4976
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationButtonHeaderClicked, (payload) => {
|
|
4977
|
+
* // payload: { convId: string }
|
|
4978
|
+
* })
|
|
4979
|
+
* ```
|
|
4980
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4981
|
+
*/
|
|
4982
|
+
SpotterShareConversationButtonHeaderClicked = "spotterShareConversationButtonHeaderClicked",
|
|
4983
|
+
/**
|
|
4984
|
+
* Emitted when the sidebar Share item is clicked. Fires `Start` then `End`
|
|
4985
|
+
* to bracket the interaction.
|
|
4986
|
+
* @example
|
|
4987
|
+
* ```js
|
|
4988
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareConversationMenuItemSidebarClicked, (payload) => {
|
|
4989
|
+
* // payload: { convId: string }
|
|
4990
|
+
* })
|
|
4991
|
+
* ```
|
|
4992
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
4993
|
+
*/
|
|
4994
|
+
SpotterShareConversationMenuItemSidebarClicked = "spotterShareConversationMenuItemSidebarClicked",
|
|
4995
|
+
/**
|
|
4996
|
+
* Emitted when a Spotter conversation is shared (recipients added, or a new
|
|
4997
|
+
* share created). The host builds its own link from shareId/convId + its
|
|
4998
|
+
* configured CONVERSATION_URL — no link string is sent. Distinct from
|
|
4999
|
+
* `SpotterShareModalConfirmButtonClicked`, which fires at click time before
|
|
5000
|
+
* the save resolves.
|
|
5001
|
+
* @example
|
|
5002
|
+
* ```js
|
|
5003
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShared, (payload) => {
|
|
5004
|
+
* // payload: { convId: string, shareId: string,
|
|
5005
|
+
* // recipientsAdded: string[], recipientsRemoved: string[] }
|
|
5006
|
+
* })
|
|
5007
|
+
* ```
|
|
5008
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5009
|
+
*/
|
|
5010
|
+
SpotterConversationShared = "spotterConversationShared",
|
|
5011
|
+
/**
|
|
5012
|
+
* Emitted when access to a shared Spotter conversation is revoked
|
|
5013
|
+
* (recipients removed). `fullyRevoked` is true when the last sharee is removed
|
|
5014
|
+
* and the share is deleted entirely.
|
|
5015
|
+
* @example
|
|
5016
|
+
* ```js
|
|
5017
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationShareRevoked, (payload) => {
|
|
5018
|
+
* // payload: { convId: string, shareId: string,
|
|
5019
|
+
* // recipientsRemoved: string[], fullyRevoked: boolean }
|
|
5020
|
+
* })
|
|
5021
|
+
* ```
|
|
5022
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5023
|
+
*/
|
|
5024
|
+
SpotterConversationShareRevoked = "spotterConversationShareRevoked",
|
|
5025
|
+
/**
|
|
5026
|
+
* Emitted when a recipient opens a shared Spotter conversation (read-only
|
|
5027
|
+
* view). No shareId available viewer-side.
|
|
5028
|
+
* @example
|
|
5029
|
+
* ```js
|
|
5030
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationViewed, (payload) => {
|
|
5031
|
+
* // payload: { convId: string, sourceConvId: string }
|
|
5032
|
+
* // convId = resolved snapshot conv id; sourceConvId = the shared URL id
|
|
5033
|
+
* })
|
|
5034
|
+
* ```
|
|
5035
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5036
|
+
*/
|
|
5037
|
+
SpotterSharedConversationViewed = "spotterSharedConversationViewed",
|
|
5038
|
+
/**
|
|
5039
|
+
* Emitted when the user toggles the share-modal "include new messages since
|
|
5040
|
+
* last shared version" checkbox.
|
|
5041
|
+
* @example
|
|
5042
|
+
* ```js
|
|
5043
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareIncludeNewMessagesCheckboxToggled, (payload) => {
|
|
5044
|
+
* // payload: { convId: string, includeNewMessages: boolean }
|
|
5045
|
+
* })
|
|
5046
|
+
* ```
|
|
5047
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5048
|
+
*/
|
|
5049
|
+
SpotterShareIncludeNewMessagesCheckboxToggled = "spotterShareIncludeNewMessagesCheckboxToggled",
|
|
5050
|
+
/**
|
|
5051
|
+
* Emitted when the user dismisses the stale-snapshot info banner via its
|
|
5052
|
+
* cross (distinct from the include-new-messages checkbox toggle).
|
|
5053
|
+
* @example
|
|
5054
|
+
* ```js
|
|
5055
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareStaleInfoBannerDismissed, (payload) => {
|
|
5056
|
+
* // payload: { convId: string }
|
|
5057
|
+
* })
|
|
5058
|
+
* ```
|
|
5059
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5060
|
+
*/
|
|
5061
|
+
SpotterShareStaleInfoBannerDismissed = "spotterShareStaleInfoBannerDismissed",
|
|
5062
|
+
/**
|
|
5063
|
+
* Emitted when the modal Share (confirm) button is clicked — fires at click
|
|
5064
|
+
* time, before the save resolves. Distinct from the `SpotterConversationShared`
|
|
5065
|
+
* / `SpotterConversationShareRevoked` result events.
|
|
5066
|
+
* @example
|
|
5067
|
+
* ```js
|
|
5068
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalConfirmButtonClicked, (payload) => {
|
|
5069
|
+
* // payload: { convId: string }
|
|
5070
|
+
* })
|
|
5071
|
+
* ```
|
|
5072
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5073
|
+
*/
|
|
5074
|
+
SpotterShareModalConfirmButtonClicked = "spotterShareModalConfirmButtonClicked",
|
|
5075
|
+
/**
|
|
5076
|
+
* Emitted when the share modal is dismissed via the Cancel button.
|
|
5077
|
+
* @example
|
|
5078
|
+
* ```js
|
|
5079
|
+
* spotterEmbed.on(EmbedEvent.SpotterShareModalCancelButtonClicked, (payload) => {
|
|
5080
|
+
* // payload: { convId: string }
|
|
5081
|
+
* })
|
|
5082
|
+
* ```
|
|
5083
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5084
|
+
*/
|
|
5085
|
+
SpotterShareModalCancelButtonClicked = "spotterShareModalCancelButtonClicked",
|
|
5086
|
+
/**
|
|
5087
|
+
* Emitted when a recipient leaves the read-only shared view via the Exit
|
|
5088
|
+
* button.
|
|
5089
|
+
* @example
|
|
5090
|
+
* ```js
|
|
5091
|
+
* spotterEmbed.on(EmbedEvent.SpotterSharedConversationExitButtonClicked, (payload) => {
|
|
5092
|
+
* // payload: { convId: string }
|
|
5093
|
+
* })
|
|
5094
|
+
* ```
|
|
5095
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
5096
|
+
*/
|
|
5097
|
+
SpotterSharedConversationExitButtonClicked = "spotterSharedConversationExitButtonClicked",
|
|
5098
|
+
/**
|
|
5099
|
+
* Emitted when a Spotter conversation is pinned.
|
|
5100
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5101
|
+
* @example
|
|
5102
|
+
* ```js
|
|
5103
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationPinned, (payload) => {
|
|
5104
|
+
* console.log('Conversation pinned', payload);
|
|
5105
|
+
* // payload: { conversationId: string, pinnedAt: string (ISO 8601) }
|
|
5106
|
+
* })
|
|
5107
|
+
* ```
|
|
5108
|
+
*/
|
|
5109
|
+
SpotterConversationPinned = "spotterConversationPinned",
|
|
5110
|
+
/**
|
|
5111
|
+
* Emitted when a Spotter conversation is unpinned.
|
|
5112
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
5113
|
+
* @example
|
|
5114
|
+
* ```js
|
|
5115
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationUnpinned, (payload) => {
|
|
5116
|
+
* console.log('Conversation unpinned', payload);
|
|
5117
|
+
* // payload: { conversationId: string, unpinnedAt: string (ISO 8601) }
|
|
5118
|
+
* })
|
|
5119
|
+
* ```
|
|
5120
|
+
*/
|
|
5121
|
+
SpotterConversationUnpinned = "spotterConversationUnpinned",
|
|
4889
5122
|
/**
|
|
4890
5123
|
* Emitted when a Spotter conversation is selected/clicked.
|
|
4891
5124
|
* @example
|
|
@@ -5401,6 +5634,17 @@ export declare enum HostEvent {
|
|
|
5401
5634
|
* name: string,
|
|
5402
5635
|
* type: ATTRIBUTE/MEASURE,
|
|
5403
5636
|
* dataType: INT64/CHAR/DATE }
|
|
5637
|
+
*
|
|
5638
|
+
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
5639
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
5640
|
+
* scoped filter is opened. Available from SDK: 1.53.0 |
|
|
5641
|
+
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
5642
|
+
*
|
|
5643
|
+
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5644
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5645
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5646
|
+
* `level` is `LIVEBOARD`, since the filter applies to the whole
|
|
5647
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
5404
5648
|
* @example
|
|
5405
5649
|
* ```js
|
|
5406
5650
|
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
@@ -5413,6 +5657,14 @@ export declare enum HostEvent {
|
|
|
5413
5657
|
* ```
|
|
5414
5658
|
* @example
|
|
5415
5659
|
* ```js
|
|
5660
|
+
* // Open a filter scoped to a specific Liveboard tab
|
|
5661
|
+
* liveboardEmbed.trigger(HostEvent.OpenFilter, {
|
|
5662
|
+
* column: { columnId: '<column-GUID>' },
|
|
5663
|
+
* applicability: { level: 'TAB', targetId: '<tab-GUID>' }
|
|
5664
|
+
* });
|
|
5665
|
+
* ```
|
|
5666
|
+
* @example
|
|
5667
|
+
* ```js
|
|
5416
5668
|
* // Open filter from search context
|
|
5417
5669
|
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
5418
5670
|
* searchEmbed.trigger(HostEvent.OpenFilter, {
|
|
@@ -5422,6 +5674,38 @@ export declare enum HostEvent {
|
|
|
5422
5674
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
5423
5675
|
*/
|
|
5424
5676
|
OpenFilter = "openFilter",
|
|
5677
|
+
/**
|
|
5678
|
+
* Open the parameter panel for a particular parameter on a Liveboard.
|
|
5679
|
+
* Mirrors {@link HostEvent.OpenFilter} for parameters.
|
|
5680
|
+
* @param - Includes the following keys:
|
|
5681
|
+
* - `parameter`: An object identifying the parameter to open, for
|
|
5682
|
+
* example, `{ parameterId: '<parameter-GUID>' }`.
|
|
5683
|
+
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
5684
|
+
* for example, a single Liveboard tab, so the panel for the correct
|
|
5685
|
+
* scoped parameter is opened. Includes the following attributes:
|
|
5686
|
+
*
|
|
5687
|
+
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
5688
|
+
* - `targetId`: The GUID of the target, for example, the tab GUID.
|
|
5689
|
+
* Required when `level` is `TAB` or `GROUP`. Do not pass it when
|
|
5690
|
+
* `level` is `LIVEBOARD`, since the parameter applies to the whole
|
|
5691
|
+
* Liveboard. Omitting `applicability` targets the `LIVEBOARD` level.
|
|
5692
|
+
* @example
|
|
5693
|
+
* ```js
|
|
5694
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
5695
|
+
* parameter: { parameterId: '<parameter-GUID>' }
|
|
5696
|
+
* });
|
|
5697
|
+
* ```
|
|
5698
|
+
* @example
|
|
5699
|
+
* ```js
|
|
5700
|
+
* // Open a parameter scoped to a specific group
|
|
5701
|
+
* liveboardEmbed.trigger(HostEvent.OpenParameter, {
|
|
5702
|
+
* parameter: { parameterId: '<parameter-GUID>' },
|
|
5703
|
+
* applicability: { level: 'GROUP', targetId: '<group-GUID>' }
|
|
5704
|
+
* });
|
|
5705
|
+
* ```
|
|
5706
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
5707
|
+
*/
|
|
5708
|
+
OpenParameter = "openParameter",
|
|
5425
5709
|
/**
|
|
5426
5710
|
* Add columns to the current search query.
|
|
5427
5711
|
* @param - { columnIds: string[] }
|
|
@@ -6485,13 +6769,13 @@ export declare enum HostEvent {
|
|
|
6485
6769
|
/**
|
|
6486
6770
|
* Get details of filters applied on the Liveboard.
|
|
6487
6771
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
6488
|
-
* Each Liveboard filter
|
|
6772
|
+
* Each Liveboard filter includes an optional `applicability` attribute
|
|
6489
6773
|
* indicating the scope of the filter. It contains a `level`
|
|
6490
6774
|
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
6491
6775
|
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
6492
6776
|
* level there is no `targetId`, since the filter applies to the
|
|
6493
6777
|
* whole Liveboard.
|
|
6494
|
-
* The `applicability` attribute is available from SDK: 1.
|
|
6778
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
6495
6779
|
* ThoughtSpot: 26.10.0.cl.
|
|
6496
6780
|
* @example
|
|
6497
6781
|
* ```js
|
|
@@ -6534,7 +6818,7 @@ export declare enum HostEvent {
|
|
|
6534
6818
|
* For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
|
|
6535
6819
|
*
|
|
6536
6820
|
* `applicability` - Optional. Scopes the filter to a specific target,
|
|
6537
|
-
* for example, a single Liveboard tab. Available from SDK: 1.
|
|
6821
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
6538
6822
|
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
6539
6823
|
*
|
|
6540
6824
|
* - `level`: The scope of the filter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
@@ -6657,6 +6941,28 @@ export declare enum HostEvent {
|
|
|
6657
6941
|
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
6658
6942
|
*/
|
|
6659
6943
|
GetTabs = "getTabs",
|
|
6944
|
+
/**
|
|
6945
|
+
* Get group details for the current Liveboard.
|
|
6946
|
+
* Mirrors {@link HostEvent.GetTabs} for filter/parameter groups.
|
|
6947
|
+
* @example
|
|
6948
|
+
* ```js
|
|
6949
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups).then((groupDetails) => {
|
|
6950
|
+
* console.log(
|
|
6951
|
+
* groupDetails // GroupDetails of current Liveboard
|
|
6952
|
+
* );
|
|
6953
|
+
* })
|
|
6954
|
+
* ```
|
|
6955
|
+
* @example
|
|
6956
|
+
* ```js
|
|
6957
|
+
* // Get groups from liveboard context
|
|
6958
|
+
* import { ContextType } from '@thoughtspot/visual-embed-sdk';
|
|
6959
|
+
* liveboardEmbed.trigger(HostEvent.GetGroups, {}, ContextType.Liveboard).then((groupDetails) => {
|
|
6960
|
+
* console.log('groups', groupDetails);
|
|
6961
|
+
* });
|
|
6962
|
+
* ```
|
|
6963
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
6964
|
+
*/
|
|
6965
|
+
GetGroups = "getGroups",
|
|
6660
6966
|
/**
|
|
6661
6967
|
* Set the visible tabs on a Liveboard.
|
|
6662
6968
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
@@ -6785,7 +7091,7 @@ export declare enum HostEvent {
|
|
|
6785
7091
|
* - `value`: The value to set for the parameter.
|
|
6786
7092
|
* - `isVisibleToUser`: Optional. To control the visibility of the parameter chip.
|
|
6787
7093
|
* - `applicability`: Optional. Scopes the parameter to a specific target,
|
|
6788
|
-
* for example, a single Liveboard tab. Available from SDK: 1.
|
|
7094
|
+
* for example, a single Liveboard tab. Available from SDK: 1.53.0 |
|
|
6789
7095
|
* ThoughtSpot: 26.10.0.cl. Includes the following attributes:
|
|
6790
7096
|
*
|
|
6791
7097
|
* - `level`: The scope of the parameter: `LIVEBOARD`, `TAB`, or `GROUP`.
|
|
@@ -6829,13 +7135,13 @@ export declare enum HostEvent {
|
|
|
6829
7135
|
UpdateParameters = "UpdateParameters",
|
|
6830
7136
|
/**
|
|
6831
7137
|
* Triggers GetParameters to fetch the runtime Parameters.
|
|
6832
|
-
* Each parameter
|
|
7138
|
+
* Each parameter includes an optional `applicability` attribute
|
|
6833
7139
|
* indicating the scope of the parameter. It contains a `level`
|
|
6834
7140
|
* (`LIVEBOARD`, `TAB`, or `GROUP`) and, when `level` is `TAB` or
|
|
6835
7141
|
* `GROUP`, a `targetId` with the GUID of the target. At `LIVEBOARD`
|
|
6836
7142
|
* level there is no `targetId`, since the parameter applies to the
|
|
6837
7143
|
* whole Liveboard.
|
|
6838
|
-
* The `applicability` attribute is available from SDK: 1.
|
|
7144
|
+
* The `applicability` attribute is available from SDK: 1.53.0 |
|
|
6839
7145
|
* ThoughtSpot: 26.10.0.cl.
|
|
6840
7146
|
* @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
|
|
6841
7147
|
* ```js
|
|
@@ -7103,6 +7409,36 @@ export declare enum HostEvent {
|
|
|
7103
7409
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
7104
7410
|
*/
|
|
7105
7411
|
ResetSpotterConversation = "ResetSpotterConversation",
|
|
7412
|
+
/**
|
|
7413
|
+
* Opens the Spotter share-conversation modal for the given conversation.
|
|
7414
|
+
* `conversationId` is **mandatory** — you must pass the id of the
|
|
7415
|
+
* conversation to share. Also no-op when sharing is disabled
|
|
7416
|
+
* (enableShareConversation off) or when already in the read-only shared view.
|
|
7417
|
+
* @example
|
|
7418
|
+
* ```js
|
|
7419
|
+
* spotterEmbed.trigger(HostEvent.ShareSpotterConversation, { conversationId: 'abc' });
|
|
7420
|
+
* ```
|
|
7421
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7422
|
+
*/
|
|
7423
|
+
ShareSpotterConversation = "ShareSpotterConversation",
|
|
7424
|
+
/**
|
|
7425
|
+
* Closes the Spotter share-conversation modal. No-op if none is open.
|
|
7426
|
+
* @example
|
|
7427
|
+
* ```js
|
|
7428
|
+
* spotterEmbed.trigger(HostEvent.CloseSpotterShareConversation);
|
|
7429
|
+
* ```
|
|
7430
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7431
|
+
*/
|
|
7432
|
+
CloseSpotterShareConversation = "CloseSpotterShareConversation",
|
|
7433
|
+
/**
|
|
7434
|
+
* Exits the read-only shared-conversation view.
|
|
7435
|
+
* @example
|
|
7436
|
+
* ```js
|
|
7437
|
+
* spotterEmbed.trigger(HostEvent.ExitSpotterSharedConversation);
|
|
7438
|
+
* ```
|
|
7439
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
7440
|
+
*/
|
|
7441
|
+
ExitSpotterSharedConversation = "ExitSpotterSharedConversation",
|
|
7106
7442
|
/**
|
|
7107
7443
|
* Deletes the last prompt in spotter embed.
|
|
7108
7444
|
* @example
|
|
@@ -7198,6 +7534,41 @@ export declare enum HostEvent {
|
|
|
7198
7534
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
7199
7535
|
*/
|
|
7200
7536
|
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
7537
|
+
/**
|
|
7538
|
+
* Pins a saved Spotter conversation so it floats to the top of the past
|
|
7539
|
+
* conversations sidebar. The `conversationId` of the conversation to pin is
|
|
7540
|
+
* required.
|
|
7541
|
+
*
|
|
7542
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
7543
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
7544
|
+
* instance.
|
|
7545
|
+
*
|
|
7546
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7547
|
+
* @example
|
|
7548
|
+
* ```js
|
|
7549
|
+
* spotterEmbed.trigger(HostEvent.PinSpotterConversation, {
|
|
7550
|
+
* conversationId: '<conversation-id>',
|
|
7551
|
+
* });
|
|
7552
|
+
* ```
|
|
7553
|
+
*/
|
|
7554
|
+
PinSpotterConversation = "PinSpotterConversation",
|
|
7555
|
+
/**
|
|
7556
|
+
* Unpins a previously pinned Spotter conversation. The `conversationId` of the
|
|
7557
|
+
* conversation to unpin is required.
|
|
7558
|
+
*
|
|
7559
|
+
* This feature is available only when chat history is enabled on your ThoughtSpot
|
|
7560
|
+
* instance. Contact your admin or ThoughtSpot Support to enable chat history on your
|
|
7561
|
+
* instance.
|
|
7562
|
+
*
|
|
7563
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
7564
|
+
* @example
|
|
7565
|
+
* ```js
|
|
7566
|
+
* spotterEmbed.trigger(HostEvent.UnpinSpotterConversation, {
|
|
7567
|
+
* conversationId: '<conversation-id>',
|
|
7568
|
+
* });
|
|
7569
|
+
* ```
|
|
7570
|
+
*/
|
|
7571
|
+
UnpinSpotterConversation = "UnpinSpotterConversation",
|
|
7201
7572
|
/**
|
|
7202
7573
|
* @hidden
|
|
7203
7574
|
* Get the current context of the embedded page.
|
|
@@ -8564,6 +8935,19 @@ export declare enum Action {
|
|
|
8564
8935
|
* @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl
|
|
8565
8936
|
*/
|
|
8566
8937
|
ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab",
|
|
8938
|
+
/**
|
|
8939
|
+
* Action ID to show, hide, or disable all filter surfaces on a Liveboard,
|
|
8940
|
+
* including filter, parameter, and cross-filter chips at the liveboard,
|
|
8941
|
+
* tab, and group levels. Parameter and cross-filter chips are hide-only.
|
|
8942
|
+
*
|
|
8943
|
+
* @example
|
|
8944
|
+
* ```js
|
|
8945
|
+
* hiddenActions: [Action.AllLiveboardFilters]
|
|
8946
|
+
* disabledActions: [Action.AllLiveboardFilters]
|
|
8947
|
+
* ```
|
|
8948
|
+
* @version SDK: 1.53.0 | ThoughtSpot: 26.10.0.cl
|
|
8949
|
+
*/
|
|
8950
|
+
AllLiveboardFilters = "allLiveboardFilters",
|
|
8567
8951
|
/**
|
|
8568
8952
|
* The **Data model instructions** button on the Spotter interface.
|
|
8569
8953
|
* Allows opening the data model instructions modal.
|
|
@@ -8899,6 +9283,89 @@ export declare enum Action {
|
|
|
8899
9283
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8900
9284
|
*/
|
|
8901
9285
|
SpotterChatRename = "spotterChatRename",
|
|
9286
|
+
/**
|
|
9287
|
+
* Controls visibility and disable state of the Spotter conversation Share
|
|
9288
|
+
* button in the chat header. Only takes effect once sharing is enabled
|
|
9289
|
+
* (enableShareConversation on).
|
|
9290
|
+
* @example
|
|
9291
|
+
* ```js
|
|
9292
|
+
* disabledActions: [Action.SpotterShareConversationButtonHeader]
|
|
9293
|
+
* ```
|
|
9294
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9295
|
+
*/
|
|
9296
|
+
SpotterShareConversationButtonHeader = "spotterShareConversationButtonHeader",
|
|
9297
|
+
/**
|
|
9298
|
+
* Controls visibility and disable state of the Share item in the Spotter
|
|
9299
|
+
* conversation history (sidebar) edit menu. Independent of the header button
|
|
9300
|
+
* above, so a host can show Share in one entry point and hide it in the other.
|
|
9301
|
+
* @example
|
|
9302
|
+
* ```js
|
|
9303
|
+
* disabledActions: [Action.SpotterShareConversationMenuItemSidebar]
|
|
9304
|
+
* ```
|
|
9305
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9306
|
+
*/
|
|
9307
|
+
SpotterShareConversationMenuItemSidebar = "spotterShareConversationMenuItemSidebar",
|
|
9308
|
+
/**
|
|
9309
|
+
* Controls visibility of the entire read-only shared-conversation data-access
|
|
9310
|
+
* banner shown when a recipient opens a shared view. Hide-only.
|
|
9311
|
+
* @example
|
|
9312
|
+
* ```js
|
|
9313
|
+
* hiddenActions: [Action.SpotterSharedConversationBanner]
|
|
9314
|
+
* ```
|
|
9315
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9316
|
+
*/
|
|
9317
|
+
SpotterSharedConversationBanner = "spotterSharedConversationBanner",
|
|
9318
|
+
/**
|
|
9319
|
+
* Controls visibility and disable state of the cross/close button on the
|
|
9320
|
+
* read-only shared-conversation data-access banner (keeps the banner itself).
|
|
9321
|
+
* @example
|
|
9322
|
+
* ```js
|
|
9323
|
+
* hiddenActions: [Action.SpotterSharedConversationBannerDismissButton]
|
|
9324
|
+
* ```
|
|
9325
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9326
|
+
*/
|
|
9327
|
+
SpotterSharedConversationBannerDismissButton = "spotterSharedConversationBannerDismissButton",
|
|
9328
|
+
/**
|
|
9329
|
+
* Controls visibility and disable state of the Exit button in the read-only
|
|
9330
|
+
* shared-view header. Hiding it does not disable the ExitSpotterSharedConversation
|
|
9331
|
+
* host event.
|
|
9332
|
+
* @example
|
|
9333
|
+
* ```js
|
|
9334
|
+
* hiddenActions: [Action.SpotterSharedConversationExitButton]
|
|
9335
|
+
* ```
|
|
9336
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9337
|
+
*/
|
|
9338
|
+
SpotterSharedConversationExitButton = "spotterSharedConversationExitButton",
|
|
9339
|
+
/**
|
|
9340
|
+
* Controls visibility of the share-modal footer note ("Chat will be shared up
|
|
9341
|
+
* to the current moment…"). Hide-only.
|
|
9342
|
+
* @example
|
|
9343
|
+
* ```js
|
|
9344
|
+
* hiddenActions: [Action.SpotterShareUpToCurrentInfo]
|
|
9345
|
+
* ```
|
|
9346
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9347
|
+
*/
|
|
9348
|
+
SpotterShareUpToCurrentInfo = "spotterShareUpToCurrentInfo",
|
|
9349
|
+
/**
|
|
9350
|
+
* Controls visibility and disable state of the share-modal "include new
|
|
9351
|
+
* messages since last shared version" checkbox.
|
|
9352
|
+
* @example
|
|
9353
|
+
* ```js
|
|
9354
|
+
* disabledActions: [Action.SpotterShareIncludeNewMessagesCheckbox]
|
|
9355
|
+
* ```
|
|
9356
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9357
|
+
*/
|
|
9358
|
+
SpotterShareIncludeNewMessagesCheckbox = "spotterShareIncludeNewMessagesCheckbox",
|
|
9359
|
+
/**
|
|
9360
|
+
* Controls visibility and disable state of the cross on the share-modal
|
|
9361
|
+
* stale-snapshot info banner.
|
|
9362
|
+
* @example
|
|
9363
|
+
* ```js
|
|
9364
|
+
* hiddenActions: [Action.SpotterShareStaleInfoBannerDismissButton]
|
|
9365
|
+
* ```
|
|
9366
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
9367
|
+
*/
|
|
9368
|
+
SpotterShareStaleInfoBannerDismissButton = "spotterShareStaleInfoBannerDismissButton",
|
|
8902
9369
|
/**
|
|
8903
9370
|
* Controls visibility and disable state of the delete action
|
|
8904
9371
|
* in the Spotter conversation edit menu.
|
|
@@ -8909,6 +9376,16 @@ export declare enum Action {
|
|
|
8909
9376
|
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
8910
9377
|
*/
|
|
8911
9378
|
SpotterChatDelete = "spotterChatDelete",
|
|
9379
|
+
/**
|
|
9380
|
+
* Controls visibility and disable state of the pin/unpin action
|
|
9381
|
+
* in the Spotter conversation edit menu.
|
|
9382
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
9383
|
+
* @example
|
|
9384
|
+
* ```js
|
|
9385
|
+
* disabledActions: [Action.SpotterChatPin]
|
|
9386
|
+
* ```
|
|
9387
|
+
*/
|
|
9388
|
+
SpotterChatPin = "spotterChatPin",
|
|
8912
9389
|
/**
|
|
8913
9390
|
* Controls visibility and disable state of the documentation/best practices
|
|
8914
9391
|
* link in the Spotter sidebar footer.
|
|
@@ -10085,6 +10562,11 @@ export interface LiveboardTab {
|
|
|
10085
10562
|
name: string;
|
|
10086
10563
|
[key: string]: any;
|
|
10087
10564
|
}
|
|
10565
|
+
export interface LiveboardGroup {
|
|
10566
|
+
id: string;
|
|
10567
|
+
name: string;
|
|
10568
|
+
[key: string]: any;
|
|
10569
|
+
}
|
|
10088
10570
|
declare enum ApplicabilityLevel {
|
|
10089
10571
|
Liveboard = "LIVEBOARD",
|
|
10090
10572
|
Tab = "TAB",
|
|
@@ -10130,6 +10612,7 @@ export declare enum UIPassthroughEvent {
|
|
|
10130
10612
|
GetParameters = "getParameters",
|
|
10131
10613
|
GetTML = "getTML",
|
|
10132
10614
|
GetTabs = "getTabs",
|
|
10615
|
+
GetGroups = "getGroups",
|
|
10133
10616
|
GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
|
|
10134
10617
|
}
|
|
10135
10618
|
export type UIPassthroughContractBase = {
|
|
@@ -10239,6 +10722,14 @@ export type UIPassthroughContractBase = {
|
|
|
10239
10722
|
Tabs: LiveboardTab[];
|
|
10240
10723
|
};
|
|
10241
10724
|
};
|
|
10725
|
+
[UIPassthroughEvent.GetGroups]: {
|
|
10726
|
+
request: Record<string, never>;
|
|
10727
|
+
response: {
|
|
10728
|
+
orderedGroupIds: string[];
|
|
10729
|
+
numberOfGroups: number;
|
|
10730
|
+
Groups: LiveboardGroup[];
|
|
10731
|
+
};
|
|
10732
|
+
};
|
|
10242
10733
|
[UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
|
|
10243
10734
|
request: Record<string, never>;
|
|
10244
10735
|
response: {
|
|
@@ -10284,6 +10775,7 @@ export type EmbedApiHostEventMapping = {
|
|
|
10284
10775
|
[HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
|
|
10285
10776
|
[HostEvent.GetTML]: UIPassthroughEvent.GetTML;
|
|
10286
10777
|
[HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
|
|
10778
|
+
[HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
|
|
10287
10779
|
[HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
|
|
10288
10780
|
};
|
|
10289
10781
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
@@ -10939,6 +11431,37 @@ export declare enum SpotterQueryMode {
|
|
|
10939
11431
|
FAST_SEARCH = "fastSearch",
|
|
10940
11432
|
RESEARCH = "research"
|
|
10941
11433
|
}
|
|
11434
|
+
/**
|
|
11435
|
+
* Configuration for the pin/unpin conversation feature in the Spotter sidebar.
|
|
11436
|
+
* Grouped into one object because pin exposes several related settings
|
|
11437
|
+
* (enable + label overrides), unlike single-item actions like rename or
|
|
11438
|
+
* delete.
|
|
11439
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11440
|
+
*/
|
|
11441
|
+
export interface SpotterChatPinConfig {
|
|
11442
|
+
/**
|
|
11443
|
+
* Enables the pin/unpin conversation feature in embedded Spotter. Disabled
|
|
11444
|
+
* by default — hosts must opt in. When off, the Pin/Unpin menu entry and
|
|
11445
|
+
* the pin glyph are hidden and the PinSpotterConversation /
|
|
11446
|
+
* UnpinSpotterConversation host events are no-ops. Native (non-embedded)
|
|
11447
|
+
* Spotter is unaffected and ships pin enabled.
|
|
11448
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11449
|
+
* @default false
|
|
11450
|
+
*/
|
|
11451
|
+
enabled?: boolean;
|
|
11452
|
+
/**
|
|
11453
|
+
* Custom label text for the pin action in the conversation edit menu.
|
|
11454
|
+
* Defaults to translated "Pin" text.
|
|
11455
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11456
|
+
*/
|
|
11457
|
+
pinLabel?: string;
|
|
11458
|
+
/**
|
|
11459
|
+
* Custom label text for the unpin action in the conversation edit menu.
|
|
11460
|
+
* Defaults to translated "Unpin" text.
|
|
11461
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11462
|
+
*/
|
|
11463
|
+
unpinLabel?: string;
|
|
11464
|
+
}
|
|
10942
11465
|
/**
|
|
10943
11466
|
* Configuration for the Spotter sidebar.
|
|
10944
11467
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
@@ -10976,6 +11499,12 @@ export interface SpotterSidebarViewConfig {
|
|
|
10976
11499
|
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
10977
11500
|
*/
|
|
10978
11501
|
spotterChatDeleteLabel?: string;
|
|
11502
|
+
/**
|
|
11503
|
+
* Pin/unpin conversation feature config (enable + label overrides).
|
|
11504
|
+
* Off by default in embed — hosts opt in via `enabled`.
|
|
11505
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
11506
|
+
*/
|
|
11507
|
+
spotterChatPinConfig?: SpotterChatPinConfig;
|
|
10979
11508
|
/**
|
|
10980
11509
|
* Custom title text for the delete conversation confirmation modal.
|
|
10981
11510
|
* Defaults to translated "Delete chat" text.
|
|
@@ -11026,6 +11555,84 @@ export interface SpotterSidebarViewConfig {
|
|
|
11026
11555
|
*/
|
|
11027
11556
|
spotterAnalystsLabel?: string;
|
|
11028
11557
|
}
|
|
11558
|
+
/**
|
|
11559
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
11560
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
11561
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11562
|
+
* @group Embed components
|
|
11563
|
+
*/
|
|
11564
|
+
export interface SpotterShareConversationConfig {
|
|
11565
|
+
/**
|
|
11566
|
+
* Enables sharing of the conversation.
|
|
11567
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11568
|
+
* @default false
|
|
11569
|
+
*/
|
|
11570
|
+
enableShareConversation?: boolean;
|
|
11571
|
+
/**
|
|
11572
|
+
* Header Share button + sidebar Share item label.
|
|
11573
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11574
|
+
* @default "Share"
|
|
11575
|
+
*/
|
|
11576
|
+
spotterShareLabel?: string;
|
|
11577
|
+
/**
|
|
11578
|
+
* Share modal title.
|
|
11579
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11580
|
+
*/
|
|
11581
|
+
spotterShareModalTitle?: string;
|
|
11582
|
+
/**
|
|
11583
|
+
* Modal confirm button label.
|
|
11584
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11585
|
+
* @default "Share"
|
|
11586
|
+
*/
|
|
11587
|
+
spotterShareConfirmLabel?: string;
|
|
11588
|
+
/**
|
|
11589
|
+
* Modal cancel button label.
|
|
11590
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11591
|
+
* @default "Cancel"
|
|
11592
|
+
*/
|
|
11593
|
+
spotterShareCancelLabel?: string;
|
|
11594
|
+
/**
|
|
11595
|
+
* "Add users or groups" label.
|
|
11596
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11597
|
+
*/
|
|
11598
|
+
spotterShareAddUsersLabel?: string;
|
|
11599
|
+
/**
|
|
11600
|
+
* Empty-state title ("No users added yet").
|
|
11601
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11602
|
+
*/
|
|
11603
|
+
spotterShareEmptyTitle?: string;
|
|
11604
|
+
/**
|
|
11605
|
+
* Empty-state subtitle ("Not shared with any user").
|
|
11606
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11607
|
+
*/
|
|
11608
|
+
spotterShareEmptySubtitle?: string;
|
|
11609
|
+
/**
|
|
11610
|
+
* "Include new messages since last shared version" checkbox label.
|
|
11611
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11612
|
+
*/
|
|
11613
|
+
spotterShareIncludeNewMessagesLabel?: string;
|
|
11614
|
+
/**
|
|
11615
|
+
* Footer note when the snapshot is current ("…up to the current moment…").
|
|
11616
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11617
|
+
*/
|
|
11618
|
+
spotterShareUpToCurrentLabel?: string;
|
|
11619
|
+
/**
|
|
11620
|
+
* Stale-snapshot info banner text ("All added users and groups will receive…").
|
|
11621
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11622
|
+
*/
|
|
11623
|
+
spotterShareStaleInfoLabel?: string;
|
|
11624
|
+
/**
|
|
11625
|
+
* Read-only shared-view data-access banner message.
|
|
11626
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11627
|
+
*/
|
|
11628
|
+
spotterSharedConversationBannerMessage?: string;
|
|
11629
|
+
/**
|
|
11630
|
+
* Read-only shared-view Exit button label.
|
|
11631
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11632
|
+
* @default "Exit"
|
|
11633
|
+
*/
|
|
11634
|
+
spotterSharedConversationExitLabel?: string;
|
|
11635
|
+
}
|
|
11029
11636
|
/**
|
|
11030
11637
|
* Configuration for customizing Spotter chat UI branding.
|
|
11031
11638
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
@@ -11080,8 +11687,27 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11080
11687
|
/**
|
|
11081
11688
|
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
11082
11689
|
* this object to query data and generate Answers.
|
|
11690
|
+
* This field is optional. If not provided, Spotter loads using the
|
|
11691
|
+
* previously selected user data source.
|
|
11083
11692
|
*/
|
|
11084
|
-
worksheetId
|
|
11693
|
+
worksheetId?: string;
|
|
11694
|
+
/**
|
|
11695
|
+
* The array of data source GUIDs to set on load. Spotter uses
|
|
11696
|
+
* these GUIDs to query data and generate Answers.
|
|
11697
|
+
* dataSources is preferred over worksheetId if both are provided.
|
|
11698
|
+
* The feature is currently behind a feature flag.
|
|
11699
|
+
*
|
|
11700
|
+
* Supported embed types: `SpotterEmbed`
|
|
11701
|
+
* @example
|
|
11702
|
+
* ```js
|
|
11703
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
11704
|
+
* // ...other embed view config
|
|
11705
|
+
* dataSources: ['id-2345', 'id-2345'],
|
|
11706
|
+
* });
|
|
11707
|
+
* ```
|
|
11708
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11709
|
+
*/
|
|
11710
|
+
dataSources?: string[];
|
|
11085
11711
|
/**
|
|
11086
11712
|
* Ability to pass a starting search query to the conversation.
|
|
11087
11713
|
*/
|
|
@@ -11241,6 +11867,21 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11241
11867
|
* ```
|
|
11242
11868
|
*/
|
|
11243
11869
|
updatedSpotterChatPrompt?: boolean;
|
|
11870
|
+
/**
|
|
11871
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
11872
|
+
*
|
|
11873
|
+
* Supported embed types: `SpotterEmbed`
|
|
11874
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11875
|
+
* @default false
|
|
11876
|
+
* @example
|
|
11877
|
+
* ```js
|
|
11878
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
11879
|
+
* ... //other embed view config
|
|
11880
|
+
* showSpotterRadiance : true,
|
|
11881
|
+
* })
|
|
11882
|
+
* ```
|
|
11883
|
+
*/
|
|
11884
|
+
showSpotterRadiance?: boolean;
|
|
11244
11885
|
/**
|
|
11245
11886
|
* Sets the default query mode when Spotter loads — Fast Search or
|
|
11246
11887
|
* Research Mode. Applies fresh on every new session for this embed
|
|
@@ -11317,6 +11958,59 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAct
|
|
|
11317
11958
|
* ```
|
|
11318
11959
|
*/
|
|
11319
11960
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
11961
|
+
/**
|
|
11962
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
11963
|
+
*
|
|
11964
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
11965
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11966
|
+
* @example
|
|
11967
|
+
* ```js
|
|
11968
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
11969
|
+
* ... //other embed view config
|
|
11970
|
+
* spotterShareConversationConfig: {
|
|
11971
|
+
* enableShareConversation: true,
|
|
11972
|
+
* },
|
|
11973
|
+
* })
|
|
11974
|
+
* ```
|
|
11975
|
+
*/
|
|
11976
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
11977
|
+
/**
|
|
11978
|
+
* The ID of a shared Spotter conversation to open directly in the read-only
|
|
11979
|
+
* reader view. Use this to land a share recipient in the shared conversation
|
|
11980
|
+
* when they open a host-configured `CONVERSATION_URL` share link: read the
|
|
11981
|
+
* `{conversation-id}` from your page URL and pass it here.
|
|
11982
|
+
*
|
|
11983
|
+
* Requires the Spotter conversation-sharing feature to be enabled
|
|
11984
|
+
* (`spotterShareConversationConfig.enableShareConversation`). The recipient
|
|
11985
|
+
* must be an authorized sharee — the server returns access-denied otherwise.
|
|
11986
|
+
*
|
|
11987
|
+
* Supported embed types: `SpotterEmbed`
|
|
11988
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
11989
|
+
* @example
|
|
11990
|
+
* ```js
|
|
11991
|
+
* const convId = new URLSearchParams(window.location.search).get('conversation-id');
|
|
11992
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
11993
|
+
* ... //other embed view config
|
|
11994
|
+
* sharedConversationId: convId,
|
|
11995
|
+
* })
|
|
11996
|
+
* ```
|
|
11997
|
+
*/
|
|
11998
|
+
sharedConversationId?: string;
|
|
11999
|
+
/**
|
|
12000
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
12001
|
+
*
|
|
12002
|
+
* Supported embed types: `SpotterEmbed`
|
|
12003
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12004
|
+
* @default false
|
|
12005
|
+
* @example
|
|
12006
|
+
* ```js
|
|
12007
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
12008
|
+
* ... //other embed view config
|
|
12009
|
+
* updatedSpotterExperience : true,
|
|
12010
|
+
* })
|
|
12011
|
+
* ```
|
|
12012
|
+
*/
|
|
12013
|
+
updatedSpotterExperience?: boolean;
|
|
11320
12014
|
}
|
|
11321
12015
|
/**
|
|
11322
12016
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -11333,6 +12027,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
11333
12027
|
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
11334
12028
|
embedParams?: {
|
|
11335
12029
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
12030
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
11336
12031
|
visualOverridesParams?: VisualizationOverrides | null;
|
|
11337
12032
|
};
|
|
11338
12033
|
}
|
|
@@ -11615,6 +12310,9 @@ export declare enum HomePage {
|
|
|
11615
12310
|
/**
|
|
11616
12311
|
* Modular (v2) introduces the updated Modular Home Experience.
|
|
11617
12312
|
* It serves as the foundational version of the home page.
|
|
12313
|
+
* Use {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
12314
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
12315
|
+
* @deprecated V1 and V2 home page experiences are deprecated.
|
|
11618
12316
|
*/
|
|
11619
12317
|
Modular = "v2",
|
|
11620
12318
|
/**
|
|
@@ -11688,13 +12386,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11688
12386
|
showPrimaryNavbar?: boolean;
|
|
11689
12387
|
/**
|
|
11690
12388
|
* Control the visibility of the left navigation panel on the home page
|
|
11691
|
-
* in the
|
|
12389
|
+
* in the V3 and V4 navigation and home page experience.
|
|
11692
12390
|
* If `showPrimaryNavbar` is true, that is, if the Global and Homepage
|
|
11693
12391
|
* navigation bars are visible, this flag will only hide the left navigation bar
|
|
11694
12392
|
* on the home page.
|
|
11695
12393
|
* The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
|
|
11696
12394
|
*
|
|
11697
|
-
* **Note**:
|
|
12395
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
12396
|
+
* deprecated. This attribute applies to V3 and V4 home page experiences.
|
|
11698
12397
|
*
|
|
11699
12398
|
* Supported embed types: `AppEmbed`
|
|
11700
12399
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11760,11 +12459,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11760
12459
|
hideHamburger?: boolean;
|
|
11761
12460
|
/**
|
|
11762
12461
|
* Control the visibility of the object search
|
|
11763
|
-
* on the top navigation bar in the
|
|
11764
|
-
* V2 and V3 navigation experience.
|
|
12462
|
+
* on the top navigation bar in the V3 navigation experience.
|
|
11765
12463
|
*
|
|
11766
|
-
* **Note**:
|
|
11767
|
-
*
|
|
12464
|
+
* **Note**: The classic (V1) and V2 navigation experiences are
|
|
12465
|
+
* deprecated. This attribute applies to the V3 navigation experience.
|
|
11768
12466
|
*
|
|
11769
12467
|
* Supported embed types: `AppEmbed`
|
|
11770
12468
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -11782,8 +12480,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11782
12480
|
* Control the visibility of the notification icon
|
|
11783
12481
|
* on the top navigation bar in V3 navigation experience.
|
|
11784
12482
|
*
|
|
11785
|
-
* **Note**:
|
|
11786
|
-
*
|
|
12483
|
+
* **Note**: The classic (V1) and V2 experience modes are deprecated.
|
|
12484
|
+
* This attribute applies to the V3 experience.
|
|
11787
12485
|
*
|
|
11788
12486
|
* Supported embed types: `AppEmbed`
|
|
11789
12487
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -11798,14 +12496,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11798
12496
|
*/
|
|
11799
12497
|
hideNotification?: boolean;
|
|
11800
12498
|
/**
|
|
11801
|
-
* Control the visibility of the application selection menu
|
|
11802
|
-
* in the top navigation bar in the V2 experience.
|
|
12499
|
+
* Control the visibility of the application selection menu.
|
|
11803
12500
|
* In the V3 experience, it shows or hides application selection
|
|
11804
12501
|
* icons on the left navigation panel.
|
|
11805
12502
|
* By default, the application selection menu and icons are
|
|
11806
12503
|
* shown in the UI.
|
|
11807
12504
|
*
|
|
11808
|
-
* **Note**:
|
|
12505
|
+
* **Note**: The classic (V1) and V2 experiences are deprecated.
|
|
12506
|
+
* This attribute applies to the V3 experience.
|
|
11809
12507
|
*
|
|
11810
12508
|
* Supported embed types: `AppEmbed`
|
|
11811
12509
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11823,7 +12521,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11823
12521
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
11824
12522
|
* By default, the Org switcher button is shown.
|
|
11825
12523
|
*
|
|
11826
|
-
* **Note**:
|
|
12524
|
+
* **Note**: The classic (V1) experience is deprecated. This attribute
|
|
12525
|
+
* applies to V2 (deprecated), V3 and V4 experiences.
|
|
11827
12526
|
*
|
|
11828
12527
|
* Supported embed types: `AppEmbed`
|
|
11829
12528
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -11982,6 +12681,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
11982
12681
|
* Supported embed types: `AppEmbed`
|
|
11983
12682
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
11984
12683
|
* @default false
|
|
12684
|
+
* Use the discoveryExperience.homePage option with
|
|
12685
|
+
* {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
12686
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
12687
|
+
* @deprecated The V1 and V2 home page experiences are deprecated.
|
|
11985
12688
|
* @example
|
|
11986
12689
|
* ```js
|
|
11987
12690
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -12113,11 +12816,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12113
12816
|
/**
|
|
12114
12817
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
12115
12818
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
12116
|
-
* This feature is GA from version
|
|
12819
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
12117
12820
|
*
|
|
12118
12821
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12119
12822
|
* @type {boolean}
|
|
12120
12823
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
12824
|
+
* @default true
|
|
12121
12825
|
* @example
|
|
12122
12826
|
* ```js
|
|
12123
12827
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12130,10 +12834,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12130
12834
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
12131
12835
|
/**
|
|
12132
12836
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
12837
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
12133
12838
|
*
|
|
12134
12839
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12135
12840
|
* @type {boolean}
|
|
12136
12841
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
12842
|
+
* @default true
|
|
12137
12843
|
* @example
|
|
12138
12844
|
* ```js
|
|
12139
12845
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12146,10 +12852,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12146
12852
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
12147
12853
|
/**
|
|
12148
12854
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
12855
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
12149
12856
|
*
|
|
12150
12857
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
12151
12858
|
* @type {boolean}
|
|
12152
12859
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
12860
|
+
* @default true
|
|
12153
12861
|
* @example
|
|
12154
12862
|
* ```js
|
|
12155
12863
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -12225,6 +12933,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12225
12933
|
* ```
|
|
12226
12934
|
*/
|
|
12227
12935
|
updatedSpotterChatPrompt?: boolean;
|
|
12936
|
+
/**
|
|
12937
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
12938
|
+
*
|
|
12939
|
+
* Supported embed types: `AppEmbed`
|
|
12940
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
12941
|
+
* @default false
|
|
12942
|
+
* @example
|
|
12943
|
+
* ```js
|
|
12944
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
12945
|
+
* ... //other embed view config
|
|
12946
|
+
* showSpotterRadiance : true,
|
|
12947
|
+
* })
|
|
12948
|
+
* ```
|
|
12949
|
+
*/
|
|
12950
|
+
showSpotterRadiance?: boolean;
|
|
12228
12951
|
/**
|
|
12229
12952
|
* Sets the default query mode when Spotter loads — Fast Search or
|
|
12230
12953
|
* Research Mode. Applies fresh on every new session for this embed
|
|
@@ -12269,6 +12992,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12269
12992
|
* spotterSidebarConfig: {
|
|
12270
12993
|
* enablePastConversationsSidebar: true,
|
|
12271
12994
|
* spotterSidebarTitle: 'My Conversations',
|
|
12995
|
+
* // Opt in to pin/unpin conversations in embedded Spotter
|
|
12996
|
+
* spotterChatPinConfig: {
|
|
12997
|
+
* enabled: true,
|
|
12998
|
+
* },
|
|
12272
12999
|
* },
|
|
12273
13000
|
* })
|
|
12274
13001
|
* ```
|
|
@@ -12292,6 +13019,49 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12292
13019
|
* ```
|
|
12293
13020
|
*/
|
|
12294
13021
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
13022
|
+
/**
|
|
13023
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
13024
|
+
*
|
|
13025
|
+
* Supported embed types: `AppEmbed`
|
|
13026
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13027
|
+
* @example
|
|
13028
|
+
* ```js
|
|
13029
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13030
|
+
* ... //other embed view config
|
|
13031
|
+
* spotterShareConversationConfig: {
|
|
13032
|
+
* enableShareConversation: true,
|
|
13033
|
+
* },
|
|
13034
|
+
* })
|
|
13035
|
+
* ```
|
|
13036
|
+
*/
|
|
13037
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
13038
|
+
/**
|
|
13039
|
+
* Sets the default data sources (Models) for the Spotter experience shown on
|
|
13040
|
+
* the home page of the full app embed. Accepts a list of Model GUIDs to
|
|
13041
|
+
* preselect the data sources available to Spotter, or the literal
|
|
13042
|
+
* `'auto_mode'` sentinel to load Spotter with the "Auto" model selected by
|
|
13043
|
+
* default. This is consistent with how `worksheetId: 'auto_mode'` enables
|
|
13044
|
+
* Auto mode in `SpotterEmbed`.
|
|
13045
|
+
*
|
|
13046
|
+
* **Note**: If `'auto_mode'` is included alongside one or more Model GUIDs,
|
|
13047
|
+
* `'auto_mode'` takes precedence and is selected by default.
|
|
13048
|
+
*
|
|
13049
|
+
* **Note**: `'auto_mode'` requires the Spotter 3 experience with data source
|
|
13050
|
+
* discovery enabled on your instance, and a Spotter-enabled home page (for
|
|
13051
|
+
* example, `discoveryExperience.homePage: HomePage.Focused`).
|
|
13052
|
+
*
|
|
13053
|
+
* Supported embed types: `AppEmbed`
|
|
13054
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
13055
|
+
* @example
|
|
13056
|
+
* ```js
|
|
13057
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13058
|
+
* ... // other embed view config
|
|
13059
|
+
* discoveryExperience: { homePage: HomePage.Focused },
|
|
13060
|
+
* spotterDataSources: ['model-guid-1', 'model-guid-2'], // or ['auto_mode']
|
|
13061
|
+
* })
|
|
13062
|
+
* ```
|
|
13063
|
+
*/
|
|
13064
|
+
spotterDataSources?: string[];
|
|
12295
13065
|
/**
|
|
12296
13066
|
* Configuration for the SpotterViz interface shown on the Liveboard.
|
|
12297
13067
|
* Customize the brand name, description, chat input placeholder,
|
|
@@ -12387,6 +13157,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
12387
13157
|
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
12388
13158
|
*/
|
|
12389
13159
|
visualOverrides?: VisualizationOverrides;
|
|
13160
|
+
/**
|
|
13161
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
13162
|
+
*
|
|
13163
|
+
* Supported embed types: `AppEmbed`
|
|
13164
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
13165
|
+
* @default false
|
|
13166
|
+
* @example
|
|
13167
|
+
* ```js
|
|
13168
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
13169
|
+
* ... //other embed view config
|
|
13170
|
+
* updatedSpotterExperience : true,
|
|
13171
|
+
* })
|
|
13172
|
+
* ```
|
|
13173
|
+
*/
|
|
13174
|
+
updatedSpotterExperience?: boolean;
|
|
12390
13175
|
}
|
|
12391
13176
|
/**
|
|
12392
13177
|
* APP_INIT data shape for AppEmbed.
|
|
@@ -12396,6 +13181,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
|
12396
13181
|
embedParams?: {
|
|
12397
13182
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
12398
13183
|
spotterVizConfig?: SpotterVizConfig;
|
|
13184
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
12399
13185
|
};
|
|
12400
13186
|
}
|
|
12401
13187
|
/**
|
|
@@ -12426,6 +13212,7 @@ export declare class AppEmbed extends V1Embed {
|
|
|
12426
13212
|
* embedded Liveboard or visualization.
|
|
12427
13213
|
*/
|
|
12428
13214
|
protected getEmbedParams(): string;
|
|
13215
|
+
protected getEmbedParamsObject(): any;
|
|
12429
13216
|
private sendFullHeightLazyLoadData;
|
|
12430
13217
|
/**
|
|
12431
13218
|
* This is a handler for the RequestVisibleEmbedCoordinates event.
|
|
@@ -13133,11 +13920,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13133
13920
|
/**
|
|
13134
13921
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
13135
13922
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
13136
|
-
* This feature is GA from version
|
|
13923
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
13137
13924
|
*
|
|
13138
13925
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
13139
13926
|
* @type {boolean}
|
|
13140
13927
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
13928
|
+
* @default true
|
|
13141
13929
|
* @example
|
|
13142
13930
|
* ```js
|
|
13143
13931
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -13150,10 +13938,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13150
13938
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
13151
13939
|
/**
|
|
13152
13940
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
13941
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
|
|
13153
13942
|
*
|
|
13154
13943
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
13155
13944
|
* @type {boolean}
|
|
13156
13945
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
13946
|
+
* @default true
|
|
13157
13947
|
* @example
|
|
13158
13948
|
* ```js
|
|
13159
13949
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -13166,10 +13956,12 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13166
13956
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
13167
13957
|
/**
|
|
13168
13958
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
13959
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl.
|
|
13169
13960
|
*
|
|
13170
13961
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
13171
13962
|
* @type {boolean}
|
|
13172
13963
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
13964
|
+
* @default true
|
|
13173
13965
|
* @example
|
|
13174
13966
|
* ```js
|
|
13175
13967
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -13260,6 +14052,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13260
14052
|
* ```
|
|
13261
14053
|
*/
|
|
13262
14054
|
updatedSpotterChatPrompt?: boolean;
|
|
14055
|
+
/**
|
|
14056
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
14057
|
+
*
|
|
14058
|
+
* Supported embed types: `LiveboardEmbed`
|
|
14059
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14060
|
+
* @default false
|
|
14061
|
+
* @example
|
|
14062
|
+
* ```js
|
|
14063
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
14064
|
+
* ... //other embed view config
|
|
14065
|
+
* showSpotterRadiance : true,
|
|
14066
|
+
* })
|
|
14067
|
+
* ```
|
|
14068
|
+
*/
|
|
14069
|
+
showSpotterRadiance?: boolean;
|
|
13263
14070
|
/**
|
|
13264
14071
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
13265
14072
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -13335,6 +14142,21 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
13335
14142
|
* ```
|
|
13336
14143
|
*/
|
|
13337
14144
|
enableLiveboardDataCache?: boolean;
|
|
14145
|
+
/**
|
|
14146
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
14147
|
+
*
|
|
14148
|
+
* Supported embed types: `LiveboardEmbed`
|
|
14149
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
14150
|
+
* @default false
|
|
14151
|
+
* @example
|
|
14152
|
+
* ```js
|
|
14153
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
14154
|
+
* ... //other embed view config
|
|
14155
|
+
* updatedSpotterExperience : true,
|
|
14156
|
+
* })
|
|
14157
|
+
* ```
|
|
14158
|
+
*/
|
|
14159
|
+
updatedSpotterExperience?: boolean;
|
|
13338
14160
|
}
|
|
13339
14161
|
/**
|
|
13340
14162
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -14095,6 +14917,10 @@ export declare const MIXPANEL_EVENT: {
|
|
|
14095
14917
|
VISUAL_SDK_IFRAME_LOAD_PERFORMANCE: string;
|
|
14096
14918
|
VISUAL_SDK_EMBED_CREATE: string;
|
|
14097
14919
|
VERCEL_INTEGRATION_COMPLETED: string;
|
|
14920
|
+
VISUAL_SDK_RENDER_CALLED: string;
|
|
14921
|
+
VISUAL_SDK_PRE_RENDER: string;
|
|
14922
|
+
VISUAL_SDK_SHOW_PRE_RENDER: string;
|
|
14923
|
+
VISUAL_SDK_HIDE_PRE_RENDER: string;
|
|
14098
14924
|
};
|
|
14099
14925
|
/**
|
|
14100
14926
|
* Pushes the event with its Property key-value map to mixpanel.
|