@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.2
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/auth.d.ts +29 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +29 -4
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/css-variables.d.ts +17 -17
- package/cjs/src/embed/app.d.ts +60 -32
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -3
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +34 -1
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +2 -2
- package/cjs/src/embed/base.js +2 -2
- package/cjs/src/embed/bodyless-conversation.d.ts +5 -5
- package/cjs/src/embed/bodyless-conversation.js +4 -4
- package/cjs/src/embed/conversation.d.ts +43 -30
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +10 -11
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +27 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +40 -34
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +1 -1
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +1 -1
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +5 -5
- package/cjs/src/embed/sage.js +1 -1
- package/cjs/src/embed/search-bar.d.ts +7 -7
- package/cjs/src/embed/search-bar.js +1 -1
- package/cjs/src/embed/search.d.ts +13 -12
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +3 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +12 -6
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +35 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +15 -15
- package/cjs/src/react/index.js +12 -12
- package/cjs/src/tokenizedFetch.d.ts +1 -1
- package/cjs/src/tokenizedFetch.js +1 -1
- package/cjs/src/types.d.ts +294 -255
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +206 -200
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +6 -4
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +10 -1
- package/cjs/src/utils.js.map +1 -1
- package/dist/{index-Vyh6Ha5f.js → index-DkizS4xM.js} +1 -1
- package/dist/src/auth.d.ts +29 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +17 -17
- package/dist/src/embed/app.d.ts +60 -32
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +2 -2
- package/dist/src/embed/bodyless-conversation.d.ts +5 -5
- package/dist/src/embed/conversation.d.ts +43 -30
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +40 -34
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +5 -5
- package/dist/src/embed/search-bar.d.ts +7 -7
- package/dist/src/embed/search.d.ts +13 -12
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +3 -3
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +15 -15
- package/dist/src/tokenizedFetch.d.ts +1 -1
- package/dist/src/types.d.ts +294 -255
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +307 -275
- package/dist/tsembed-react.js +306 -274
- package/dist/tsembed.es.js +299 -267
- package/dist/tsembed.js +298 -266
- package/dist/visual-embed-sdk-react-full.d.ts +520 -409
- package/dist/visual-embed-sdk-react.d.ts +518 -407
- package/dist/visual-embed-sdk.d.ts +519 -408
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +29 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +29 -4
- package/lib/src/auth.js.map +1 -1
- package/lib/src/css-variables.d.ts +17 -17
- package/lib/src/embed/app.d.ts +60 -32
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +11 -4
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +34 -1
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +2 -2
- package/lib/src/embed/base.js +2 -2
- package/lib/src/embed/bodyless-conversation.d.ts +5 -5
- package/lib/src/embed/bodyless-conversation.js +4 -4
- package/lib/src/embed/conversation.d.ts +43 -30
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +11 -11
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +27 -0
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +40 -34
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +1 -1
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +5 -5
- package/lib/src/embed/sage.js +1 -1
- package/lib/src/embed/search-bar.d.ts +7 -7
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search.d.ts +13 -12
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +3 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +12 -6
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +35 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +15 -15
- package/lib/src/react/index.js +12 -12
- package/lib/src/tokenizedFetch.d.ts +1 -1
- package/lib/src/tokenizedFetch.js +1 -1
- package/lib/src/types.d.ts +294 -255
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +206 -200
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +5 -3
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +55 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +8 -0
- package/lib/src/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/auth.ts +29 -4
- package/src/css-variables.ts +17 -17
- package/src/embed/app.spec.ts +46 -1
- package/src/embed/app.ts +72 -35
- package/src/embed/base.ts +2 -2
- package/src/embed/bodyless-conversation.ts +5 -5
- package/src/embed/conversation.spec.ts +37 -0
- package/src/embed/conversation.ts +55 -38
- package/src/embed/liveboard.spec.ts +1 -1
- package/src/embed/liveboard.ts +40 -34
- package/src/embed/sage.ts +5 -5
- package/src/embed/search-bar.tsx +7 -7
- package/src/embed/search.ts +13 -12
- package/src/embed/ts-embed.spec.ts +42 -0
- package/src/embed/ts-embed.ts +11 -6
- package/src/react/index.tsx +15 -15
- package/src/tokenizedFetch.ts +1 -1
- package/src/types.ts +293 -254
- package/src/utils/graphql/answerService/answerService.spec.ts +62 -0
- package/src/utils/graphql/answerService/answerService.ts +6 -3
- package/src/utils.ts +14 -0
package/cjs/src/types.js
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
10
|
exports.InterceptedApiType = exports.ContextType = exports.EmbedErrorCodes = exports.ErrorDetailsTypes = exports.LogLevel = exports.CustomActionTarget = exports.CustomActionsPosition = exports.ContextMenuTriggerOptions = exports.PrefetchFeatures = exports.Action = exports.Param = exports.DataSourceVisualMode = exports.HostEvent = exports.EmbedEvent = exports.ListPageColumns = exports.HomepageModule = exports.RuntimeFilterOp = exports.HomeLeftNavItem = exports.AuthType = void 0;
|
|
11
11
|
/**
|
|
12
|
-
* The authentication mechanism for allowing access to
|
|
12
|
+
* The authentication mechanism for allowing access to
|
|
13
13
|
* the embedded app
|
|
14
14
|
* @group Authentication / Init
|
|
15
15
|
*/
|
|
@@ -35,6 +35,7 @@ var AuthType;
|
|
|
35
35
|
* To use this:
|
|
36
36
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
37
37
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
38
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
38
39
|
* @example
|
|
39
40
|
* ```js
|
|
40
41
|
* init({
|
|
@@ -42,18 +43,17 @@ var AuthType;
|
|
|
42
43
|
* authType: AuthType.EmbeddedSSO,
|
|
43
44
|
* });
|
|
44
45
|
* ```
|
|
45
|
-
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
46
46
|
*/
|
|
47
47
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
48
48
|
/**
|
|
49
|
-
* SSO using SAML
|
|
50
|
-
* @deprecated
|
|
49
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
50
|
+
* @deprecated This option is deprecated.
|
|
51
51
|
* @hidden
|
|
52
52
|
*/
|
|
53
53
|
AuthType["SSO"] = "SSO_SAML";
|
|
54
54
|
/**
|
|
55
|
-
* SSO using SAML
|
|
56
|
-
* @deprecated
|
|
55
|
+
* SSO using SAML, Use {@link SAMLRedirect} instead
|
|
56
|
+
* @deprecated This option is deprecated.
|
|
57
57
|
* @hidden
|
|
58
58
|
*/
|
|
59
59
|
AuthType["SAML"] = "SSO_SAML";
|
|
@@ -104,8 +104,9 @@ var AuthType;
|
|
|
104
104
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
105
105
|
/**
|
|
106
106
|
* SSO using OIDC
|
|
107
|
+
* SSO using OIDC, Use {@link OIDCRedirect} instead
|
|
108
|
+
* @deprecated This option is deprecated.
|
|
107
109
|
* @hidden
|
|
108
|
-
* @deprecated Use {@link OIDCRedirect} instead
|
|
109
110
|
*/
|
|
110
111
|
AuthType["OIDC"] = "SSO_OIDC";
|
|
111
112
|
/**
|
|
@@ -116,8 +117,9 @@ var AuthType;
|
|
|
116
117
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
117
118
|
/**
|
|
118
119
|
* Trusted authentication server
|
|
120
|
+
* Use {@link TrustedAuth} instead
|
|
121
|
+
* @deprecated This option is deprecated.
|
|
119
122
|
* @hidden
|
|
120
|
-
* @deprecated Use {@link TrustedAuth} instead
|
|
121
123
|
*/
|
|
122
124
|
AuthType["AuthServer"] = "AuthServer";
|
|
123
125
|
/**
|
|
@@ -144,6 +146,7 @@ var AuthType;
|
|
|
144
146
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
145
147
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
146
148
|
* implemented by some browsers.
|
|
149
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
147
150
|
* @example
|
|
148
151
|
* ```js
|
|
149
152
|
* init({
|
|
@@ -154,8 +157,8 @@ var AuthType;
|
|
|
154
157
|
* .then((response) => response.json())
|
|
155
158
|
* .then((data) => data.token);
|
|
156
159
|
* }
|
|
160
|
+
* });
|
|
157
161
|
* ```
|
|
158
|
-
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
159
162
|
*/
|
|
160
163
|
AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
|
|
161
164
|
/**
|
|
@@ -176,43 +179,43 @@ var HomeLeftNavItem;
|
|
|
176
179
|
/**
|
|
177
180
|
* The *Search data* option in
|
|
178
181
|
* the *Insights* left navigation panel.
|
|
179
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
182
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
180
183
|
*/
|
|
181
184
|
HomeLeftNavItem["SearchData"] = "search-data";
|
|
182
185
|
/**
|
|
183
186
|
* The *Home* menu option in
|
|
184
187
|
* the *Insights* left navigation panel.
|
|
185
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
188
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
186
189
|
*/
|
|
187
190
|
HomeLeftNavItem["Home"] = "insights-home";
|
|
188
191
|
/**
|
|
189
192
|
* The *Liveboards* menu option in
|
|
190
193
|
* the *Insights* left navigation panel.
|
|
191
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
194
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
192
195
|
*/
|
|
193
196
|
HomeLeftNavItem["Liveboards"] = "liveboards";
|
|
194
197
|
/**
|
|
195
198
|
* The *Answers* menu option in
|
|
196
199
|
* the *Insights* left navigation panel.
|
|
197
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
200
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
198
201
|
*/
|
|
199
202
|
HomeLeftNavItem["Answers"] = "answers";
|
|
200
203
|
/**
|
|
201
204
|
* The *Monitor subscriptions* menu option in
|
|
202
205
|
* the *Insights* left navigation panel.
|
|
203
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
206
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
204
207
|
*/
|
|
205
208
|
HomeLeftNavItem["MonitorSubscription"] = "monitor-alerts";
|
|
206
209
|
/**
|
|
207
210
|
* The *SpotIQ analysis* menu option in
|
|
208
211
|
* the *Insights* left navigation panel.
|
|
209
|
-
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
212
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
210
213
|
*/
|
|
211
214
|
HomeLeftNavItem["SpotIQAnalysis"] = "spotiq-analysis";
|
|
212
215
|
/**
|
|
213
216
|
* The *Liveboard schedules* menu option in
|
|
214
217
|
* the *Insights* left navigation panel.
|
|
215
|
-
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
218
|
+
* @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
|
|
216
219
|
*/
|
|
217
220
|
HomeLeftNavItem["LiveboardSchedules"] = "liveboard-schedules";
|
|
218
221
|
/**
|
|
@@ -318,7 +321,7 @@ var HomepageModule;
|
|
|
318
321
|
*/
|
|
319
322
|
HomepageModule["Search"] = "SEARCH";
|
|
320
323
|
/**
|
|
321
|
-
*
|
|
324
|
+
* KPI watchlist module
|
|
322
325
|
*/
|
|
323
326
|
HomepageModule["Watchlist"] = "WATCHLIST";
|
|
324
327
|
/**
|
|
@@ -350,7 +353,8 @@ var ListPageColumns;
|
|
|
350
353
|
*/
|
|
351
354
|
ListPageColumns["Favorites"] = "FAVOURITE";
|
|
352
355
|
/**
|
|
353
|
-
*
|
|
356
|
+
* Favourite Use {@link ListPageColumns.Favorites} instead.
|
|
357
|
+
* @deprecated This option is deprecated.
|
|
354
358
|
*/
|
|
355
359
|
ListPageColumns["Favourite"] = "FAVOURITE";
|
|
356
360
|
/**
|
|
@@ -418,13 +422,13 @@ var EmbedEvent;
|
|
|
418
422
|
/**
|
|
419
423
|
* Rendering has initialized.
|
|
420
424
|
* @example
|
|
421
|
-
|
|
425
|
+
* ```js
|
|
422
426
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
423
427
|
* //show a loader
|
|
424
428
|
* function showLoader() {
|
|
425
429
|
* document.getElementById("loader");
|
|
426
430
|
* }
|
|
427
|
-
|
|
431
|
+
* ```
|
|
428
432
|
* @returns timestamp - The timestamp when the event was generated.
|
|
429
433
|
*/
|
|
430
434
|
EmbedEvent["Init"] = "init";
|
|
@@ -432,11 +436,11 @@ var EmbedEvent;
|
|
|
432
436
|
* Authentication has either succeeded or failed.
|
|
433
437
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
434
438
|
* @example
|
|
435
|
-
|
|
439
|
+
* ```js
|
|
436
440
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
437
441
|
* console.log('AuthInit', payload);
|
|
438
442
|
* })
|
|
439
|
-
|
|
443
|
+
* ```
|
|
440
444
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
441
445
|
*/
|
|
442
446
|
EmbedEvent["AuthInit"] = "authInit";
|
|
@@ -445,13 +449,13 @@ var EmbedEvent;
|
|
|
445
449
|
* @returns timestamp - The timestamp when the event was generated.
|
|
446
450
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
447
451
|
* @example
|
|
448
|
-
|
|
452
|
+
* ```js
|
|
449
453
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
450
454
|
* //hide loader
|
|
451
455
|
* function hideLoader() {
|
|
452
456
|
* document.getElementById("loader");
|
|
453
457
|
* }
|
|
454
|
-
|
|
458
|
+
* ```
|
|
455
459
|
*/
|
|
456
460
|
EmbedEvent["Load"] = "load";
|
|
457
461
|
/**
|
|
@@ -460,11 +464,11 @@ var EmbedEvent;
|
|
|
460
464
|
* @return data - Answer of Liveboard data
|
|
461
465
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
462
466
|
* @example
|
|
463
|
-
|
|
467
|
+
* ```js
|
|
464
468
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
465
469
|
* console.log('data', payload);
|
|
466
470
|
* })
|
|
467
|
-
|
|
471
|
+
* ```
|
|
468
472
|
* @important
|
|
469
473
|
*/
|
|
470
474
|
EmbedEvent["Data"] = "data";
|
|
@@ -472,9 +476,9 @@ var EmbedEvent;
|
|
|
472
476
|
* Search query has been updated by the user.
|
|
473
477
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
474
478
|
* @example
|
|
475
|
-
|
|
479
|
+
* ```js
|
|
476
480
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
477
|
-
|
|
481
|
+
* ```
|
|
478
482
|
*/
|
|
479
483
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
480
484
|
/**
|
|
@@ -484,7 +488,7 @@ var EmbedEvent;
|
|
|
484
488
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
485
489
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
486
490
|
* @example
|
|
487
|
-
|
|
491
|
+
* ```js
|
|
488
492
|
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
489
493
|
* points: {
|
|
490
494
|
* clickedPoint,
|
|
@@ -492,12 +496,12 @@ var EmbedEvent;
|
|
|
492
496
|
* },
|
|
493
497
|
* autoDrillDown: true,
|
|
494
498
|
* })
|
|
495
|
-
|
|
499
|
+
* ```
|
|
496
500
|
* In this example, `VizPointDoubleClick` event is used for
|
|
497
501
|
* triggering the `DrillDown` event when an area or specific
|
|
498
502
|
* data point on a table or chart is double-clicked.
|
|
499
503
|
* @example
|
|
500
|
-
|
|
504
|
+
* ```js
|
|
501
505
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
502
506
|
* console.log(payload);
|
|
503
507
|
* const clickedPoint = payload.data.clickedPoint;
|
|
@@ -511,7 +515,7 @@ var EmbedEvent;
|
|
|
511
515
|
* autoDrillDown: true,
|
|
512
516
|
* })
|
|
513
517
|
* })
|
|
514
|
-
|
|
518
|
+
* ```
|
|
515
519
|
*/
|
|
516
520
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
517
521
|
/**
|
|
@@ -636,13 +640,13 @@ var EmbedEvent;
|
|
|
636
640
|
* The ThoughtSpot authentication session has expired.
|
|
637
641
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
638
642
|
* @example
|
|
639
|
-
|
|
643
|
+
* ```js
|
|
640
644
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
641
645
|
* //show auth expired banner
|
|
642
646
|
* function showAuthExpired() {
|
|
643
647
|
* document.getElementById("authExpiredBanner");
|
|
644
648
|
* }
|
|
645
|
-
|
|
649
|
+
* ```
|
|
646
650
|
*/
|
|
647
651
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
648
652
|
/**
|
|
@@ -677,22 +681,22 @@ var EmbedEvent;
|
|
|
677
681
|
* Applicable to `SearchBarEmbed` only.
|
|
678
682
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
679
683
|
* @example
|
|
680
|
-
|
|
684
|
+
* ```js
|
|
681
685
|
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
682
686
|
* .then(data => {
|
|
683
687
|
* console.log('Answer Data:', data);
|
|
684
688
|
* })
|
|
685
|
-
|
|
689
|
+
* ```
|
|
686
690
|
*/
|
|
687
691
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
688
692
|
/**
|
|
689
693
|
* Detects the route change.
|
|
690
694
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
691
695
|
* @example
|
|
692
|
-
|
|
696
|
+
* ```js
|
|
693
697
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
694
698
|
* console.log('data', payload))
|
|
695
|
-
|
|
699
|
+
* ```
|
|
696
700
|
*/
|
|
697
701
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
698
702
|
/**
|
|
@@ -702,12 +706,12 @@ var EmbedEvent;
|
|
|
702
706
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
703
707
|
/**
|
|
704
708
|
* Emitted when the embed does not have cookie access. This happens
|
|
705
|
-
* when
|
|
706
|
-
*
|
|
709
|
+
* when third-party cookies are blocked by Safari or other
|
|
710
|
+
* web browsers. `NoCookieAccess` can trigger.
|
|
707
711
|
* @example
|
|
708
|
-
|
|
712
|
+
* ```js
|
|
709
713
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
710
|
-
|
|
714
|
+
* ```
|
|
711
715
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
712
716
|
*/
|
|
713
717
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
@@ -721,22 +725,22 @@ var EmbedEvent;
|
|
|
721
725
|
* Emitted when any modal is opened in the app
|
|
722
726
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
723
727
|
* @example
|
|
724
|
-
|
|
728
|
+
* ```js
|
|
725
729
|
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
726
730
|
* console.log('dialog open', payload);
|
|
727
731
|
* })
|
|
728
|
-
|
|
732
|
+
* ```
|
|
729
733
|
*/
|
|
730
734
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
731
735
|
/**
|
|
732
736
|
* Emitted when any modal is closed in the app
|
|
733
737
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
734
738
|
* @example
|
|
735
|
-
|
|
739
|
+
* ```js
|
|
736
740
|
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
737
741
|
* console.log('dialog close', payload);
|
|
738
742
|
* })
|
|
739
|
-
|
|
743
|
+
* ```
|
|
740
744
|
*/
|
|
741
745
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
742
746
|
/**
|
|
@@ -745,39 +749,39 @@ var EmbedEvent;
|
|
|
745
749
|
* other events on the rendered Liveboard.
|
|
746
750
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
747
751
|
* @example
|
|
748
|
-
|
|
752
|
+
* ```js
|
|
749
753
|
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
750
754
|
console.log('Liveboard is rendered', payload);
|
|
751
755
|
})
|
|
752
|
-
|
|
756
|
+
* ```
|
|
753
757
|
* The following example shows how to trigger
|
|
754
758
|
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
755
759
|
* @example
|
|
756
|
-
|
|
760
|
+
* ```js
|
|
757
761
|
* const embedRef = useEmbedRef();
|
|
758
762
|
* const onLiveboardRendered = () => {
|
|
759
763
|
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
760
764
|
* };
|
|
761
|
-
|
|
765
|
+
* ```
|
|
762
766
|
*/
|
|
763
767
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
764
768
|
/**
|
|
765
769
|
* Emits all events.
|
|
766
|
-
* @
|
|
770
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
767
771
|
* @example
|
|
768
|
-
|
|
772
|
+
* ```js
|
|
769
773
|
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
770
774
|
* console.log('Embed Events', payload)
|
|
771
775
|
* })
|
|
772
|
-
|
|
776
|
+
* ```
|
|
773
777
|
*/
|
|
774
778
|
EmbedEvent["ALL"] = "*";
|
|
775
779
|
/**
|
|
776
780
|
* Emitted when an Answer is saved in the app.
|
|
777
781
|
* Use start:true to subscribe to when save is initiated, or end:true to subscribe to when save is completed. Default is end:true.
|
|
778
|
-
* @
|
|
782
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
779
783
|
* @example
|
|
780
|
-
|
|
784
|
+
* ```js
|
|
781
785
|
* //Emit when action starts
|
|
782
786
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
783
787
|
* console.log('Save', payload)
|
|
@@ -788,7 +792,7 @@ var EmbedEvent;
|
|
|
788
792
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
789
793
|
* console.log('Save', payload)
|
|
790
794
|
* })
|
|
791
|
-
|
|
795
|
+
* ```
|
|
792
796
|
*/
|
|
793
797
|
EmbedEvent["Save"] = "save";
|
|
794
798
|
/**
|
|
@@ -800,11 +804,11 @@ var EmbedEvent;
|
|
|
800
804
|
* `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
|
|
801
805
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
802
806
|
* @example
|
|
803
|
-
|
|
807
|
+
* ```js
|
|
804
808
|
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
805
809
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
806
810
|
* })
|
|
807
|
-
|
|
811
|
+
* ```
|
|
808
812
|
*/
|
|
809
813
|
EmbedEvent["Download"] = "download";
|
|
810
814
|
/**
|
|
@@ -812,14 +816,14 @@ var EmbedEvent;
|
|
|
812
816
|
* Use start:true to subscribe to when download is initiated, or end:true to subscribe to when download is completed. Default is end:true.
|
|
813
817
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
814
818
|
* @example
|
|
815
|
-
|
|
819
|
+
* ```js
|
|
816
820
|
* //emit when action starts
|
|
817
821
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
818
822
|
* console.log('download PNG', payload)}, {start: true })
|
|
819
823
|
* //emit when action ends
|
|
820
824
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
821
825
|
* console.log('download PNG', payload)})
|
|
822
|
-
|
|
826
|
+
* ```
|
|
823
827
|
*/
|
|
824
828
|
EmbedEvent["DownloadAsPng"] = "downloadAsPng";
|
|
825
829
|
/**
|
|
@@ -827,14 +831,14 @@ var EmbedEvent;
|
|
|
827
831
|
* Use start:true to subscribe to when download as PDF is initiated, or end:true to subscribe to when download as PDF is completed. Default is end:true.
|
|
828
832
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
829
833
|
* @example
|
|
830
|
-
|
|
834
|
+
* ```js
|
|
831
835
|
* //emit when action starts
|
|
832
836
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
833
837
|
* console.log('download PDF', payload)}, {start: true })
|
|
834
838
|
* //emit when action ends
|
|
835
839
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
836
840
|
* console.log('download PDF', payload)})
|
|
837
|
-
|
|
841
|
+
* ```
|
|
838
842
|
*/
|
|
839
843
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
840
844
|
/**
|
|
@@ -842,14 +846,14 @@ var EmbedEvent;
|
|
|
842
846
|
* Use start:true to subscribe to when download as CSV is initiated, or end:true to subscribe to when download as CSV is completed. Default is end:true.
|
|
843
847
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
844
848
|
* @example
|
|
845
|
-
|
|
849
|
+
* ```js
|
|
846
850
|
* //emit when action starts
|
|
847
851
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
848
852
|
* console.log('download CSV', payload)}, {start: true })
|
|
849
853
|
* //emit when action ends
|
|
850
854
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
851
855
|
* console.log('download CSV', payload)})
|
|
852
|
-
|
|
856
|
+
* ```
|
|
853
857
|
*/
|
|
854
858
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
855
859
|
/**
|
|
@@ -857,14 +861,14 @@ var EmbedEvent;
|
|
|
857
861
|
* Use start:true to subscribe to when download as XLSX is initiated, or end:true to subscribe to when download as XLSX is completed. Default is end:true.
|
|
858
862
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
859
863
|
* @example
|
|
860
|
-
|
|
864
|
+
* ```js
|
|
861
865
|
* //emit when action starts
|
|
862
866
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
863
867
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
864
868
|
* //emit when action ends
|
|
865
869
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
866
870
|
* console.log('download Xlsx', payload)})
|
|
867
|
-
|
|
871
|
+
* ```
|
|
868
872
|
*/
|
|
869
873
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
870
874
|
/**
|
|
@@ -872,25 +876,25 @@ var EmbedEvent;
|
|
|
872
876
|
* Use start:true to subscribe to when delete is initiated, or end:true to subscribe to when delete is completed. Default is end:true.
|
|
873
877
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
874
878
|
* @example
|
|
875
|
-
|
|
879
|
+
* ```js
|
|
876
880
|
* //emit when action starts
|
|
877
881
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
878
882
|
* console.log('delete answer', payload)}, {start: true })
|
|
879
883
|
* //trigger when action is completed
|
|
880
884
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
881
885
|
* console.log('delete answer', payload)})
|
|
882
|
-
|
|
886
|
+
* ```
|
|
883
887
|
*/
|
|
884
888
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
885
889
|
/**
|
|
886
890
|
* Emitted when the AI Highlights action is triggered on a Liveboard
|
|
887
891
|
* @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl
|
|
888
892
|
* @example
|
|
889
|
-
|
|
893
|
+
* ```js
|
|
890
894
|
* liveboardEmbed.on(EmbedEvent.AIHighlights, (payload) => {
|
|
891
895
|
* console.log('AI Highlights', payload);
|
|
892
896
|
* })
|
|
893
|
-
|
|
897
|
+
* ```
|
|
894
898
|
*/
|
|
895
899
|
EmbedEvent["AIHighlights"] = "AIHighlights";
|
|
896
900
|
/**
|
|
@@ -899,7 +903,7 @@ var EmbedEvent;
|
|
|
899
903
|
* Use start:true to subscribe to when pin is initiated, or end:true to subscribe to when pin is completed. Default is end:true.
|
|
900
904
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
901
905
|
* @example
|
|
902
|
-
|
|
906
|
+
* ```js
|
|
903
907
|
* //emit when action starts
|
|
904
908
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
905
909
|
* console.log('pin', payload)
|
|
@@ -910,14 +914,14 @@ var EmbedEvent;
|
|
|
910
914
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
911
915
|
* console.log('pin', payload)
|
|
912
916
|
* })
|
|
913
|
-
|
|
917
|
+
* ```
|
|
914
918
|
*/
|
|
915
919
|
EmbedEvent["Pin"] = "pin";
|
|
916
920
|
/**
|
|
917
921
|
* Emitted when SpotIQ analysis is triggered
|
|
918
922
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
919
923
|
* @example
|
|
920
|
-
|
|
924
|
+
* ```js
|
|
921
925
|
* //emit when action starts
|
|
922
926
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
923
927
|
* console.log('SpotIQAnalyze', payload)
|
|
@@ -928,14 +932,14 @@ var EmbedEvent;
|
|
|
928
932
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
929
933
|
* console.log('SpotIQ analyze', payload)
|
|
930
934
|
* })
|
|
931
|
-
|
|
935
|
+
* ```
|
|
932
936
|
*/
|
|
933
937
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
934
938
|
/**
|
|
935
939
|
* Emitted when a user shares an object with another user or group
|
|
936
940
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
937
941
|
* @example
|
|
938
|
-
|
|
942
|
+
* ```js
|
|
939
943
|
* //emit when action starts
|
|
940
944
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
941
945
|
* console.log('Share', payload)
|
|
@@ -946,7 +950,7 @@ var EmbedEvent;
|
|
|
946
950
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
947
951
|
* console.log('Share', payload)
|
|
948
952
|
* })
|
|
949
|
-
|
|
953
|
+
* ```
|
|
950
954
|
*/
|
|
951
955
|
EmbedEvent["Share"] = "share";
|
|
952
956
|
/**
|
|
@@ -954,11 +958,11 @@ var EmbedEvent;
|
|
|
954
958
|
* data on a chart or table.
|
|
955
959
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
956
960
|
* @example
|
|
957
|
-
|
|
961
|
+
* ```js
|
|
958
962
|
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
959
963
|
* console.log('Drill include', payload);
|
|
960
964
|
* })
|
|
961
|
-
|
|
965
|
+
* ```
|
|
962
966
|
*/
|
|
963
967
|
EmbedEvent["DrillInclude"] = "context-menu-item-include";
|
|
964
968
|
/**
|
|
@@ -966,22 +970,22 @@ var EmbedEvent;
|
|
|
966
970
|
* data on a chart or table
|
|
967
971
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
968
972
|
* @example
|
|
969
|
-
|
|
973
|
+
* ```js
|
|
970
974
|
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
971
975
|
* console.log('Drill exclude', payload);
|
|
972
976
|
* })
|
|
973
|
-
|
|
977
|
+
* ```
|
|
974
978
|
*/
|
|
975
979
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
976
980
|
/**
|
|
977
981
|
* Emitted when a column value is copied in the embedded app.
|
|
978
982
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
979
983
|
* @example
|
|
980
|
-
|
|
981
|
-
*
|
|
984
|
+
* ```js
|
|
985
|
+
* searchEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
982
986
|
* console.log('copy to clipboard', payload);
|
|
983
987
|
* })
|
|
984
|
-
|
|
988
|
+
* ```
|
|
985
989
|
*/
|
|
986
990
|
EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
|
|
987
991
|
/**
|
|
@@ -989,10 +993,10 @@ var EmbedEvent;
|
|
|
989
993
|
* embedded Liveboard.
|
|
990
994
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
991
995
|
* @example
|
|
992
|
-
|
|
996
|
+
* ```js
|
|
993
997
|
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
994
998
|
* })
|
|
995
|
-
|
|
999
|
+
* ```
|
|
996
1000
|
*/
|
|
997
1001
|
EmbedEvent["UpdateTML"] = "updateTSL";
|
|
998
1002
|
/**
|
|
@@ -1000,11 +1004,11 @@ var EmbedEvent;
|
|
|
1000
1004
|
* on an embedded Liveboard.
|
|
1001
1005
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1002
1006
|
* @example
|
|
1003
|
-
|
|
1007
|
+
* ```js
|
|
1004
1008
|
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
1005
1009
|
* console.log('Edit TML', payload);
|
|
1006
1010
|
* })
|
|
1007
|
-
|
|
1011
|
+
* ```
|
|
1008
1012
|
*/
|
|
1009
1013
|
EmbedEvent["EditTML"] = "editTSL";
|
|
1010
1014
|
/**
|
|
@@ -1013,25 +1017,25 @@ var EmbedEvent;
|
|
|
1013
1017
|
* Use start:true to subscribe to when export is initiated, or end:true to subscribe to when export is completed. Default is end:true.
|
|
1014
1018
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1015
1019
|
* @example
|
|
1016
|
-
|
|
1020
|
+
* ```js
|
|
1017
1021
|
* //emit when action starts
|
|
1018
1022
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1019
1023
|
* console.log('Export TML', payload)}, { start: true })
|
|
1020
1024
|
* //emit when action ends
|
|
1021
1025
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1022
1026
|
* console.log('Export TML', payload)})
|
|
1023
|
-
|
|
1027
|
+
* ```
|
|
1024
1028
|
*/
|
|
1025
1029
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
1026
1030
|
/**
|
|
1027
1031
|
* Emitted when an Answer is saved as a View.
|
|
1028
1032
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1029
1033
|
* @example
|
|
1030
|
-
|
|
1034
|
+
* ```js
|
|
1031
1035
|
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
1032
1036
|
* console.log('View', payload);
|
|
1033
1037
|
* })
|
|
1034
|
-
|
|
1038
|
+
* ```
|
|
1035
1039
|
*/
|
|
1036
1040
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
1037
1041
|
/**
|
|
@@ -1039,36 +1043,36 @@ var EmbedEvent;
|
|
|
1039
1043
|
* Use start:true to subscribe to when copy and edit is initiated, or end:true to subscribe to when copy and edit is completed. Default is end:true.
|
|
1040
1044
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1041
1045
|
* @example
|
|
1042
|
-
|
|
1046
|
+
* ```js
|
|
1043
1047
|
* //emit when action starts
|
|
1044
1048
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1045
1049
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1046
1050
|
* //emit when action ends
|
|
1047
1051
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1048
1052
|
* console.log('Copy and edit', payload)})
|
|
1049
|
-
|
|
1053
|
+
* ```
|
|
1050
1054
|
*/
|
|
1051
1055
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
1052
1056
|
/**
|
|
1053
1057
|
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
1054
1058
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1055
1059
|
* @example
|
|
1056
|
-
|
|
1060
|
+
* ```js
|
|
1057
1061
|
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
1058
1062
|
* console.log('show data', payload);
|
|
1059
1063
|
* })
|
|
1060
|
-
|
|
1064
|
+
* ```
|
|
1061
1065
|
*/
|
|
1062
1066
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
1063
1067
|
/**
|
|
1064
1068
|
* Emitted when an Answer is switched to a chart or table view.
|
|
1065
1069
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1066
1070
|
* @example
|
|
1067
|
-
|
|
1071
|
+
* ```js
|
|
1068
1072
|
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1069
1073
|
* console.log('switch view', payload);
|
|
1070
1074
|
* })
|
|
1071
|
-
|
|
1075
|
+
* ```
|
|
1072
1076
|
*/
|
|
1073
1077
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
1074
1078
|
/**
|
|
@@ -1085,118 +1089,118 @@ var EmbedEvent;
|
|
|
1085
1089
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1086
1090
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1087
1091
|
* @example
|
|
1088
|
-
|
|
1092
|
+
* ```js
|
|
1089
1093
|
* liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
|
|
1090
1094
|
* console.log('Liveboard details', payload);
|
|
1091
1095
|
* })
|
|
1092
|
-
|
|
1096
|
+
* ```
|
|
1093
1097
|
*/
|
|
1094
1098
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
1095
1099
|
/**
|
|
1096
1100
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1097
1101
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1098
1102
|
* @example
|
|
1099
|
-
|
|
1103
|
+
* ```js
|
|
1100
1104
|
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
1101
1105
|
* console.log('favorites', payload);
|
|
1102
1106
|
* })
|
|
1103
|
-
|
|
1107
|
+
* ```
|
|
1104
1108
|
*/
|
|
1105
1109
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
1106
1110
|
/**
|
|
1107
1111
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1108
1112
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1109
1113
|
* @example
|
|
1110
|
-
|
|
1114
|
+
* ```js
|
|
1111
1115
|
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
1112
|
-
* console.log(
|
|
1116
|
+
* console.log('Liveboard schedule', payload);
|
|
1113
1117
|
* })
|
|
1114
|
-
|
|
1118
|
+
* ```
|
|
1115
1119
|
*/
|
|
1116
1120
|
EmbedEvent["Schedule"] = "subscription";
|
|
1117
1121
|
/**
|
|
1118
1122
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1119
1123
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1120
1124
|
* @example
|
|
1121
|
-
|
|
1125
|
+
* ```js
|
|
1122
1126
|
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
1123
|
-
* console.log(
|
|
1127
|
+
* console.log('Liveboard edit', payload);
|
|
1124
1128
|
* })
|
|
1125
|
-
|
|
1129
|
+
* ```
|
|
1126
1130
|
*/
|
|
1127
1131
|
EmbedEvent["Edit"] = "edit";
|
|
1128
1132
|
/**
|
|
1129
1133
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1130
1134
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1131
1135
|
* @example
|
|
1132
|
-
|
|
1136
|
+
* ```js
|
|
1133
1137
|
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
1134
|
-
* console.log(
|
|
1138
|
+
* console.log('Copy', payload);
|
|
1135
1139
|
* })
|
|
1136
|
-
|
|
1140
|
+
* ```
|
|
1137
1141
|
*/
|
|
1138
1142
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
1139
1143
|
/**
|
|
1140
1144
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1141
1145
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1142
1146
|
* @example
|
|
1143
|
-
|
|
1147
|
+
* ```js
|
|
1144
1148
|
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1145
|
-
|
|
1149
|
+
* ```
|
|
1146
1150
|
* @example
|
|
1147
|
-
|
|
1151
|
+
* ```js
|
|
1148
1152
|
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
1149
1153
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1150
1154
|
* })
|
|
1151
|
-
|
|
1155
|
+
* ```
|
|
1152
1156
|
*/
|
|
1153
1157
|
EmbedEvent["Present"] = "present";
|
|
1154
1158
|
/**
|
|
1155
1159
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1156
1160
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1157
1161
|
* @example
|
|
1158
|
-
|
|
1162
|
+
* ```js
|
|
1159
1163
|
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1160
1164
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1161
|
-
|
|
1165
|
+
* ```
|
|
1162
1166
|
*/
|
|
1163
1167
|
EmbedEvent["Delete"] = "delete";
|
|
1164
1168
|
/**
|
|
1165
1169
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1166
1170
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1167
1171
|
* @example
|
|
1168
|
-
|
|
1172
|
+
* ```js
|
|
1169
1173
|
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1170
|
-
|
|
1174
|
+
* ```
|
|
1171
1175
|
*/
|
|
1172
1176
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
1173
1177
|
/**
|
|
1174
1178
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1175
1179
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1176
1180
|
* @example
|
|
1177
|
-
|
|
1181
|
+
* ```js
|
|
1178
1182
|
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1179
|
-
|
|
1183
|
+
* ```
|
|
1180
1184
|
*/
|
|
1181
1185
|
EmbedEvent["Cancel"] = "cancel";
|
|
1182
1186
|
/**
|
|
1183
1187
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1184
1188
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1185
1189
|
* @example
|
|
1186
|
-
|
|
1190
|
+
* ```js
|
|
1187
1191
|
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1188
1192
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1189
|
-
|
|
1193
|
+
* ```
|
|
1190
1194
|
*/
|
|
1191
1195
|
EmbedEvent["Explore"] = "explore";
|
|
1192
1196
|
/**
|
|
1193
1197
|
* Emitted when a user clicks **Copy link** action on a visualization.
|
|
1194
1198
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1195
1199
|
* @example
|
|
1196
|
-
|
|
1200
|
+
* ```js
|
|
1197
1201
|
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
1198
1202
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1199
|
-
|
|
1203
|
+
* ```
|
|
1200
1204
|
*/
|
|
1201
1205
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
1202
1206
|
/**
|
|
@@ -1204,21 +1208,21 @@ var EmbedEvent;
|
|
|
1204
1208
|
* visualization or Liveboard.
|
|
1205
1209
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1206
1210
|
* @example
|
|
1207
|
-
|
|
1211
|
+
* ```js
|
|
1208
1212
|
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
1209
1213
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1210
|
-
|
|
1214
|
+
* ```
|
|
1211
1215
|
*/
|
|
1212
1216
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
1213
1217
|
/**
|
|
1214
1218
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
1215
1219
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1216
1220
|
* @example
|
|
1217
|
-
|
|
1221
|
+
* ```js
|
|
1218
1222
|
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
1219
1223
|
* console.log('VizPointClick', payload)
|
|
1220
1224
|
* })
|
|
1221
|
-
|
|
1225
|
+
* ```
|
|
1222
1226
|
*/
|
|
1223
1227
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
1224
1228
|
/**
|
|
@@ -1232,35 +1236,35 @@ var EmbedEvent;
|
|
|
1232
1236
|
* filter details.
|
|
1233
1237
|
* @example
|
|
1234
1238
|
*
|
|
1235
|
-
|
|
1239
|
+
* ```js
|
|
1236
1240
|
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1237
1241
|
* console.log('payload', payload);
|
|
1238
1242
|
* })
|
|
1239
|
-
*
|
|
1243
|
+
* ```
|
|
1240
1244
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1241
1245
|
*/
|
|
1242
1246
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
1243
1247
|
/**
|
|
1244
1248
|
* Emitted when a user clicks the **Go** button to initiate
|
|
1245
1249
|
* a Natural Language Search query
|
|
1246
|
-
* @version SDK
|
|
1250
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1247
1251
|
*/
|
|
1248
1252
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
1249
1253
|
/**
|
|
1250
1254
|
* Emitted when a user selects a data source on the embedded
|
|
1251
1255
|
* Natural Language Search interface.
|
|
1252
1256
|
*
|
|
1253
|
-
* @version SDK
|
|
1257
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1254
1258
|
*/
|
|
1255
1259
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
1256
1260
|
/**
|
|
1257
1261
|
* Emitted when a user updates a connection on the **Data** page
|
|
1258
|
-
* @version SDK
|
|
1262
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1259
1263
|
*/
|
|
1260
1264
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
1261
1265
|
/**
|
|
1262
1266
|
* Emitted when a user updates a connection on the **Data** page
|
|
1263
|
-
* @version SDK
|
|
1267
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1264
1268
|
*/
|
|
1265
1269
|
EmbedEvent["CreateConnection"] = "createConnection";
|
|
1266
1270
|
/**
|
|
@@ -1270,7 +1274,7 @@ var EmbedEvent;
|
|
|
1270
1274
|
* @returns viewId: string
|
|
1271
1275
|
* @returns liveboardId: string
|
|
1272
1276
|
* @returns isPublic: boolean
|
|
1273
|
-
* @version SDK
|
|
1277
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1274
1278
|
*/
|
|
1275
1279
|
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
1276
1280
|
/**
|
|
@@ -1279,7 +1283,7 @@ var EmbedEvent;
|
|
|
1279
1283
|
* @returns viewId: string
|
|
1280
1284
|
* @returns liveboardId: string
|
|
1281
1285
|
* @returns isPublic: boolean
|
|
1282
|
-
* @version SDK
|
|
1286
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1283
1287
|
*/
|
|
1284
1288
|
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
1285
1289
|
/**
|
|
@@ -1288,19 +1292,19 @@ var EmbedEvent;
|
|
|
1288
1292
|
* @returns viewId: string
|
|
1289
1293
|
* @returns liveboardId: string
|
|
1290
1294
|
* @returns isPublic: boolean
|
|
1291
|
-
* @version SDK
|
|
1295
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1292
1296
|
*/
|
|
1293
1297
|
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
1294
1298
|
/**
|
|
1295
1299
|
* Emitted when a PersonalisedView is deleted.
|
|
1296
1300
|
* @returns views: string[]
|
|
1297
1301
|
* @returns liveboardId: string
|
|
1298
|
-
* @version SDK
|
|
1302
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
|
|
1299
1303
|
*/
|
|
1300
1304
|
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
1301
1305
|
/**
|
|
1302
1306
|
* Emitted when a user creates a Worksheet.
|
|
1303
|
-
* @version SDK
|
|
1307
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
1304
1308
|
*/
|
|
1305
1309
|
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
1306
1310
|
/**
|
|
@@ -1309,12 +1313,12 @@ var EmbedEvent;
|
|
|
1309
1313
|
* @returns viewId: string
|
|
1310
1314
|
* @returns liveboardId: string
|
|
1311
1315
|
* @returns isPublic: boolean
|
|
1312
|
-
* @version SDK
|
|
1316
|
+
* @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl
|
|
1313
1317
|
*/
|
|
1314
1318
|
EmbedEvent["AskSageInit"] = "AskSageInit";
|
|
1315
1319
|
/**
|
|
1316
1320
|
* Emitted when a Liveboard or visualization is renamed.
|
|
1317
|
-
* @version SDK
|
|
1321
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
1318
1322
|
*/
|
|
1319
1323
|
EmbedEvent["Rename"] = "rename";
|
|
1320
1324
|
/**
|
|
@@ -1337,7 +1341,7 @@ var EmbedEvent;
|
|
|
1337
1341
|
* - `error` - Developers can customize the user-facing error message when `execute`
|
|
1338
1342
|
* is `false` by using the `error` parameters in `responder`.
|
|
1339
1343
|
* - `errorText` - The error message text shown to the user.
|
|
1340
|
-
* @version SDK
|
|
1344
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1341
1345
|
* @example
|
|
1342
1346
|
*
|
|
1343
1347
|
* This example blocks search operation and returns a custom error message:
|
|
@@ -1389,8 +1393,8 @@ var EmbedEvent;
|
|
|
1389
1393
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
1390
1394
|
* console.log('payload', payload);
|
|
1391
1395
|
* })
|
|
1392
|
-
|
|
1393
|
-
* @version SDK
|
|
1396
|
+
* ```
|
|
1397
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1394
1398
|
*/
|
|
1395
1399
|
EmbedEvent["ParameterChanged"] = "parameterChanged";
|
|
1396
1400
|
/**
|
|
@@ -1445,24 +1449,24 @@ var EmbedEvent;
|
|
|
1445
1449
|
* liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {
|
|
1446
1450
|
* console.log('payload', payload);
|
|
1447
1451
|
* })
|
|
1448
|
-
|
|
1449
|
-
* @version SDK
|
|
1452
|
+
* ```
|
|
1453
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1450
1454
|
*/
|
|
1451
1455
|
EmbedEvent["CreateLiveboard"] = "createLiveboard";
|
|
1452
1456
|
/**
|
|
1453
1457
|
* Emitted when a user creates a Model.
|
|
1454
|
-
* @version SDK
|
|
1458
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1455
1459
|
*/
|
|
1456
1460
|
EmbedEvent["CreateModel"] = "createModel";
|
|
1457
1461
|
/**
|
|
1458
1462
|
* @hidden
|
|
1459
1463
|
* Emitted when a user exits present mode.
|
|
1460
|
-
* @version SDK
|
|
1464
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1461
1465
|
*/
|
|
1462
1466
|
EmbedEvent["ExitPresentMode"] = "exitPresentMode";
|
|
1463
1467
|
/**
|
|
1464
1468
|
* Emitted when a user requests the full height lazy load data.
|
|
1465
|
-
* @version SDK
|
|
1469
|
+
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1466
1470
|
* @hidden
|
|
1467
1471
|
*/
|
|
1468
1472
|
EmbedEvent["RequestVisibleEmbedCoordinates"] = "requestVisibleEmbedCoordinates";
|
|
@@ -1473,7 +1477,7 @@ var EmbedEvent;
|
|
|
1473
1477
|
* spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
|
|
1474
1478
|
* console.log('payload', payload);
|
|
1475
1479
|
* })
|
|
1476
|
-
|
|
1480
|
+
* ```
|
|
1477
1481
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1478
1482
|
*/
|
|
1479
1483
|
EmbedEvent["SpotterData"] = "SpotterData";
|
|
@@ -1484,7 +1488,7 @@ var EmbedEvent;
|
|
|
1484
1488
|
* spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
|
|
1485
1489
|
* console.log('payload', payload);
|
|
1486
1490
|
* })
|
|
1487
|
-
|
|
1491
|
+
* ```
|
|
1488
1492
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1489
1493
|
*/
|
|
1490
1494
|
EmbedEvent["PreviewSpotterData"] = "PreviewSpotterData";
|
|
@@ -1495,7 +1499,7 @@ var EmbedEvent;
|
|
|
1495
1499
|
* spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
|
|
1496
1500
|
* console.log('payload', payload);
|
|
1497
1501
|
* })
|
|
1498
|
-
|
|
1502
|
+
* ```
|
|
1499
1503
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
1500
1504
|
*/
|
|
1501
1505
|
EmbedEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -1517,7 +1521,7 @@ var EmbedEvent;
|
|
|
1517
1521
|
* spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
|
|
1518
1522
|
* console.log('payload', payload);
|
|
1519
1523
|
* })
|
|
1520
|
-
|
|
1524
|
+
* ```
|
|
1521
1525
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1522
1526
|
*/
|
|
1523
1527
|
EmbedEvent["SpotterQueryTriggered"] = "SpotterQueryTriggered";
|
|
@@ -1528,7 +1532,7 @@ var EmbedEvent;
|
|
|
1528
1532
|
* spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
|
|
1529
1533
|
* console.log('payload', payload);
|
|
1530
1534
|
* })
|
|
1531
|
-
|
|
1535
|
+
* ```
|
|
1532
1536
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1533
1537
|
*/
|
|
1534
1538
|
EmbedEvent["LastPromptEdited"] = "LastPromptEdited";
|
|
@@ -1539,18 +1543,18 @@ var EmbedEvent;
|
|
|
1539
1543
|
* spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
|
|
1540
1544
|
* console.log('payload', payload);
|
|
1541
1545
|
* })
|
|
1542
|
-
|
|
1546
|
+
* ```
|
|
1543
1547
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1544
1548
|
*/
|
|
1545
1549
|
EmbedEvent["LastPromptDeleted"] = "LastPromptDeleted";
|
|
1546
1550
|
/**
|
|
1547
|
-
* Emitted when the
|
|
1551
|
+
* Emitted when the conversation is reset in Spotter embed.
|
|
1548
1552
|
* @example
|
|
1549
1553
|
* ```js
|
|
1550
1554
|
* spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
|
|
1551
1555
|
* console.log('payload', payload);
|
|
1552
1556
|
* })
|
|
1553
|
-
|
|
1557
|
+
* ```
|
|
1554
1558
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
1555
1559
|
*/
|
|
1556
1560
|
EmbedEvent["ResetSpotterConversation"] = "ResetSpotterConversation";
|
|
@@ -1561,7 +1565,7 @@ var EmbedEvent;
|
|
|
1561
1565
|
* spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
|
|
1562
1566
|
* console.log('payload', payload);
|
|
1563
1567
|
* })
|
|
1564
|
-
|
|
1568
|
+
* ```
|
|
1565
1569
|
* @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
|
|
1566
1570
|
*/
|
|
1567
1571
|
EmbedEvent["SpotterInit"] = "spotterInit";
|
|
@@ -1572,7 +1576,7 @@ var EmbedEvent;
|
|
|
1572
1576
|
* spotterEmbed.on(EmbedEvent.SpotterLoadComplete, (payload) => {
|
|
1573
1577
|
* console.log('payload', payload);
|
|
1574
1578
|
* })
|
|
1575
|
-
|
|
1579
|
+
* ```
|
|
1576
1580
|
* @version SDK: 1.44.0 | ThoughtSpot: 26.2.0.cl
|
|
1577
1581
|
*/
|
|
1578
1582
|
EmbedEvent["SpotterLoadComplete"] = "spotterLoadComplete";
|
|
@@ -1927,7 +1931,7 @@ var HostEvent;
|
|
|
1927
1931
|
* ```js
|
|
1928
1932
|
* appEmbed.navigateToPage(-1)
|
|
1929
1933
|
* ```
|
|
1930
|
-
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
1934
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
|
|
1931
1935
|
*/
|
|
1932
1936
|
HostEvent["Navigate"] = "Navigate";
|
|
1933
1937
|
/**
|
|
@@ -2060,9 +2064,9 @@ var HostEvent;
|
|
|
2060
2064
|
* Trigger the **Show Liveboard details** action
|
|
2061
2065
|
* on an embedded Liveboard.
|
|
2062
2066
|
* @example
|
|
2063
|
-
|
|
2067
|
+
* ```js
|
|
2064
2068
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2065
|
-
|
|
2069
|
+
* ```
|
|
2066
2070
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2067
2071
|
*/
|
|
2068
2072
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
@@ -2190,7 +2194,7 @@ var HostEvent;
|
|
|
2190
2194
|
* appEmbed.trigger(HostEvent.Remove)
|
|
2191
2195
|
* ```
|
|
2192
2196
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2193
|
-
*
|
|
2197
|
+
* @example
|
|
2194
2198
|
* ```js
|
|
2195
2199
|
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
2196
2200
|
* ```
|
|
@@ -2281,7 +2285,7 @@ var HostEvent;
|
|
|
2281
2285
|
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2282
2286
|
* ```
|
|
2283
2287
|
* ```js
|
|
2284
|
-
* vizEmbed.trigger(
|
|
2288
|
+
* vizEmbed.trigger(HostEvent.CopyLink)
|
|
2285
2289
|
* ```
|
|
2286
2290
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2287
2291
|
*/
|
|
@@ -2298,7 +2302,7 @@ var HostEvent;
|
|
|
2298
2302
|
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2299
2303
|
* ```
|
|
2300
2304
|
* ```js
|
|
2301
|
-
* vizEmbed.trigger(
|
|
2305
|
+
* vizEmbed.trigger(HostEvent.Present)
|
|
2302
2306
|
* ```
|
|
2303
2307
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2304
2308
|
*/
|
|
@@ -2313,23 +2317,22 @@ var HostEvent;
|
|
|
2313
2317
|
* );
|
|
2314
2318
|
* })
|
|
2315
2319
|
* ```
|
|
2316
|
-
*
|
|
2320
|
+
* @example
|
|
2317
2321
|
* ```js
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2322
|
+
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetTML host event.
|
|
2323
|
+
* let latestSpotterVizId = '';
|
|
2324
|
+
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
2325
|
+
* latestSpotterVizId = payload.data.id;
|
|
2326
|
+
* });
|
|
2327
|
+
*
|
|
2328
|
+
* spotterEmbed.trigger(HostEvent.GetTML, {
|
|
2326
2329
|
* vizId: latestSpotterVizId
|
|
2327
2330
|
* }).then((tml) => {
|
|
2328
2331
|
* console.log(
|
|
2329
2332
|
* tml.answer.search_query // TML representation of the search query
|
|
2330
2333
|
* );
|
|
2331
2334
|
* })
|
|
2332
|
-
|
|
2335
|
+
* ```
|
|
2333
2336
|
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2334
2337
|
* @important
|
|
2335
2338
|
*/
|
|
@@ -2393,6 +2396,11 @@ var HostEvent;
|
|
|
2393
2396
|
/**
|
|
2394
2397
|
* Trigger the **Download** action on charts in
|
|
2395
2398
|
* the embedded view.
|
|
2399
|
+
* Use {@link HostEvent.DownloadAsPng} instead.
|
|
2400
|
+
*
|
|
2401
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2402
|
+
*
|
|
2403
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2396
2404
|
* @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.
|
|
2397
2405
|
* @example
|
|
2398
2406
|
* ```js
|
|
@@ -2411,9 +2419,6 @@ var HostEvent;
|
|
|
2411
2419
|
*
|
|
2412
2420
|
* spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });
|
|
2413
2421
|
* ```
|
|
2414
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2415
|
-
* Use {@link DownloadAsPng}
|
|
2416
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2417
2422
|
*/
|
|
2418
2423
|
HostEvent["Download"] = "downloadAsPng";
|
|
2419
2424
|
/**
|
|
@@ -2851,8 +2856,8 @@ var HostEvent;
|
|
|
2851
2856
|
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
2852
2857
|
* console.log('parameters', parameter);
|
|
2853
2858
|
* });
|
|
2854
|
-
|
|
2855
|
-
|
|
2859
|
+
* ```
|
|
2860
|
+
* ```js
|
|
2856
2861
|
* // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.
|
|
2857
2862
|
* let latestSpotterVizId = '';
|
|
2858
2863
|
* spotterEmbed.on(EmbedEvent.Data, (payload) => {
|
|
@@ -2860,7 +2865,7 @@ var HostEvent;
|
|
|
2860
2865
|
* });
|
|
2861
2866
|
*
|
|
2862
2867
|
* spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
|
|
2863
|
-
|
|
2868
|
+
* ```
|
|
2864
2869
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
|
|
2865
2870
|
*/
|
|
2866
2871
|
HostEvent["GetParameters"] = "GetParameters";
|
|
@@ -2877,7 +2882,7 @@ var HostEvent;
|
|
|
2877
2882
|
* Notify when info call is completed successfully
|
|
2878
2883
|
* ```js
|
|
2879
2884
|
* liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
|
|
2880
|
-
|
|
2885
|
+
* ```
|
|
2881
2886
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
2882
2887
|
*/
|
|
2883
2888
|
HostEvent["InfoSuccess"] = "InfoSuccess";
|
|
@@ -2980,7 +2985,7 @@ var HostEvent;
|
|
|
2980
2985
|
* ```js
|
|
2981
2986
|
* spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
|
|
2982
2987
|
*
|
|
2983
|
-
|
|
2988
|
+
* ```
|
|
2984
2989
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
2985
2990
|
*/
|
|
2986
2991
|
HostEvent["AddToCoaching"] = "addToCoaching";
|
|
@@ -3022,7 +3027,7 @@ var HostEvent;
|
|
|
3022
3027
|
* });
|
|
3023
3028
|
*
|
|
3024
3029
|
* spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });
|
|
3025
|
-
|
|
3030
|
+
* ```
|
|
3026
3031
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3027
3032
|
*/
|
|
3028
3033
|
HostEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
@@ -3032,7 +3037,7 @@ var HostEvent;
|
|
|
3032
3037
|
* This is automatically triggered by the SDK when fullscreen mode is exited.
|
|
3033
3038
|
* ```js
|
|
3034
3039
|
* liveboardEmbed.trigger(HostEvent.ExitPresentMode);
|
|
3035
|
-
|
|
3040
|
+
* ```
|
|
3036
3041
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
3037
3042
|
*/
|
|
3038
3043
|
HostEvent["ExitPresentMode"] = "exitPresentMode";
|
|
@@ -3182,6 +3187,7 @@ var Param;
|
|
|
3182
3187
|
// 'both' clicks in `contextMenuTrigger` configuration.
|
|
3183
3188
|
Param["ContextMenuTrigger"] = "contextMenuEnabledOnWhichClick";
|
|
3184
3189
|
Param["LinkOverride"] = "linkOverride";
|
|
3190
|
+
Param["EnableLinkOverridesV2"] = "enableLinkOverridesV2";
|
|
3185
3191
|
Param["blockNonEmbedFullAppAccess"] = "blockNonEmbedFullAppAccess";
|
|
3186
3192
|
Param["ShowInsertToSlide"] = "insertInToSlide";
|
|
3187
3193
|
Param["PrimaryNavHidden"] = "primaryNavHidden";
|
|
@@ -3276,6 +3282,7 @@ var Param;
|
|
|
3276
3282
|
Param["IsThisPeriodInDateFiltersEnabled"] = "isThisPeriodInDateFiltersEnabled";
|
|
3277
3283
|
Param["HideToolResponseCardBranding"] = "hideToolResponseCardBranding";
|
|
3278
3284
|
Param["ToolResponseCardBrandingLabel"] = "toolResponseCardBrandingLabel";
|
|
3285
|
+
Param["EnableHomepageAnnouncement"] = "enableHomepageAnnouncement";
|
|
3279
3286
|
})(Param = exports.Param || (exports.Param = {}));
|
|
3280
3287
|
/**
|
|
3281
3288
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3435,14 +3442,14 @@ var Action;
|
|
|
3435
3442
|
* ```js
|
|
3436
3443
|
* disabledActions: [Action.CollapseDataPanel]
|
|
3437
3444
|
* ```
|
|
3438
|
-
* @version
|
|
3445
|
+
* @version SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
|
|
3439
3446
|
*/
|
|
3440
3447
|
Action["CollapseDataSources"] = "collapseDataSources";
|
|
3441
3448
|
/**
|
|
3442
3449
|
* The **Collapse data panel** icon on the Search page.
|
|
3443
3450
|
* Collapses the data panel view.
|
|
3444
3451
|
*
|
|
3445
|
-
* @version
|
|
3452
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
3446
3453
|
*
|
|
3447
3454
|
* @example
|
|
3448
3455
|
* ```js
|
|
@@ -3889,13 +3896,12 @@ var Action;
|
|
|
3889
3896
|
*/
|
|
3890
3897
|
Action["CreateMonitor"] = "createMonitor";
|
|
3891
3898
|
/**
|
|
3892
|
-
* @
|
|
3893
|
-
*
|
|
3899
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3900
|
+
* @deprecated This action is deprecated. It was used for reporting errors.
|
|
3894
3901
|
* @example
|
|
3895
3902
|
* ```js
|
|
3896
3903
|
* disabledActions: [Action.ReportError]
|
|
3897
3904
|
* ```
|
|
3898
|
-
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3899
3905
|
*/
|
|
3900
3906
|
Action["ReportError"] = "reportError";
|
|
3901
3907
|
/**
|
|
@@ -3905,7 +3911,7 @@ var Action;
|
|
|
3905
3911
|
* ```js
|
|
3906
3912
|
* disabledActions: [Action.SyncToSheets]
|
|
3907
3913
|
* ```
|
|
3908
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3914
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3909
3915
|
*/
|
|
3910
3916
|
Action["SyncToSheets"] = "sync-to-sheets";
|
|
3911
3917
|
/**
|
|
@@ -3916,7 +3922,7 @@ var Action;
|
|
|
3916
3922
|
* ```js
|
|
3917
3923
|
* disabledActions: [Action.SyncToOtherApps]
|
|
3918
3924
|
* ```
|
|
3919
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3925
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3920
3926
|
*/
|
|
3921
3927
|
Action["SyncToOtherApps"] = "sync-to-other-apps";
|
|
3922
3928
|
/**
|
|
@@ -3926,7 +3932,7 @@ var Action;
|
|
|
3926
3932
|
* ```js
|
|
3927
3933
|
* disabledActions: [Action.ManagePipelines]
|
|
3928
3934
|
* ```
|
|
3929
|
-
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3935
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3930
3936
|
*/
|
|
3931
3937
|
Action["ManagePipelines"] = "manage-pipeline";
|
|
3932
3938
|
/**
|
|
@@ -4238,7 +4244,7 @@ var Action;
|
|
|
4238
4244
|
* ```js
|
|
4239
4245
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4240
4246
|
* ```
|
|
4241
|
-
* @version SDK
|
|
4247
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4242
4248
|
*/
|
|
4243
4249
|
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
4244
4250
|
/**
|
|
@@ -4248,7 +4254,7 @@ var Action;
|
|
|
4248
4254
|
* ```js
|
|
4249
4255
|
* disabledActions: [Action.LiveboardUsers]
|
|
4250
4256
|
* ```
|
|
4251
|
-
* @version SDK
|
|
4257
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
|
|
4252
4258
|
*/
|
|
4253
4259
|
Action["LiveboardUsers"] = "liveboardUsers";
|
|
4254
4260
|
/**
|
|
@@ -4266,7 +4272,7 @@ var Action;
|
|
|
4266
4272
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4267
4273
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4268
4274
|
* ```
|
|
4269
|
-
* @version SDK
|
|
4275
|
+
* @version SDK: 1.28.3 | ThoughtSpot: 9.12.0.cl, 10.1.0.sw
|
|
4270
4276
|
*/
|
|
4271
4277
|
Action["TML"] = "tml";
|
|
4272
4278
|
/**
|
|
@@ -4312,7 +4318,7 @@ var Action;
|
|
|
4312
4318
|
* ```js
|
|
4313
4319
|
* disabledActions: [Action.AddToWatchlist]
|
|
4314
4320
|
* ```
|
|
4315
|
-
* @version SDK
|
|
4321
|
+
* @version SDK: 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl
|
|
4316
4322
|
*/
|
|
4317
4323
|
Action["AddToWatchlist"] = "addToWatchlist";
|
|
4318
4324
|
/**
|
|
@@ -4322,7 +4328,7 @@ var Action;
|
|
|
4322
4328
|
* ```js
|
|
4323
4329
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4324
4330
|
* ```
|
|
4325
|
-
* @version SDK
|
|
4331
|
+
* @version SDK: 1.27.9 | ThoughtSpot: 9.12.5.cl
|
|
4326
4332
|
*/
|
|
4327
4333
|
Action["RemoveFromWatchlist"] = "removeFromWatchlist";
|
|
4328
4334
|
/**
|
|
@@ -4333,7 +4339,7 @@ var Action;
|
|
|
4333
4339
|
* ```js
|
|
4334
4340
|
* disabledActions: [Action.OrganiseFavourites]
|
|
4335
4341
|
* ```
|
|
4336
|
-
* @version SDK
|
|
4342
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
4337
4343
|
*/
|
|
4338
4344
|
Action["OrganiseFavourites"] = "organiseFavourites";
|
|
4339
4345
|
/**
|
|
@@ -4394,7 +4400,7 @@ var Action;
|
|
|
4394
4400
|
* ```js
|
|
4395
4401
|
* disabledActions: [Action.ManageTags]
|
|
4396
4402
|
* ```
|
|
4397
|
-
* @version SDK
|
|
4403
|
+
* @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
|
|
4398
4404
|
*/
|
|
4399
4405
|
Action["ManageTags"] = "manageTags";
|
|
4400
4406
|
/**
|