@thoughtspot/visual-embed-sdk 1.20.0-prerender.2 → 1.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/src/auth.d.ts +2 -38
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/config.d.ts +0 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +5 -17
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +9 -20
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +5 -17
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +0 -3
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +5 -9
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +6 -43
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +0 -8
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/react/util.d.ts +0 -4
- package/dist/src/react/util.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +2 -11
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/types.d.ts +76 -273
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/answerService.d.ts +0 -7
- package/dist/src/utils/answerService.d.ts.map +1 -1
- package/dist/src/utils/authService.d.ts +0 -30
- package/dist/src/utils/authService.d.ts.map +1 -1
- package/dist/src/utils/processData.d.ts +0 -12
- package/dist/src/utils/processData.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +0 -7
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +0 -12
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed.es.js +262 -637
- package/dist/tsembed.js +261 -629
- package/lib/package.json +8 -3
- package/lib/src/auth.d.ts +2 -38
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +25 -70
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +5 -14
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/config.d.ts +0 -1
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +3 -5
- package/lib/src/config.js.map +1 -1
- package/lib/src/config.spec.js.map +1 -1
- package/lib/src/embed/app.d.ts +5 -17
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +15 -25
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +12 -12
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +9 -20
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +15 -31
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embed.spec.js +1 -1
- package/lib/src/embed/embed.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +5 -17
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +37 -49
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +30 -37
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +26 -14
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +0 -3
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +6 -5
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +5 -9
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +14 -18
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +19 -16
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.js +0 -4
- package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +6 -43
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +72 -117
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +24 -23
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +0 -8
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +1 -13
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/mixpanel-service.spec.js.map +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +6 -6
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +6 -15
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/react/util.d.ts +0 -4
- package/lib/src/react/util.d.ts.map +1 -1
- package/lib/src/react/util.js +0 -4
- package/lib/src/react/util.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +2 -11
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +25 -36
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/types.d.ts +76 -273
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +54 -200
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/answerService.d.ts +0 -7
- package/lib/src/utils/answerService.d.ts.map +1 -1
- package/lib/src/utils/answerService.js +0 -7
- package/lib/src/utils/answerService.js.map +1 -1
- package/lib/src/utils/answerService.spec.js.map +1 -1
- package/lib/src/utils/authService.d.ts +0 -30
- package/lib/src/utils/authService.d.ts.map +1 -1
- package/lib/src/utils/authService.js +2 -39
- package/lib/src/utils/authService.js.map +1 -1
- package/lib/src/utils/authService.spec.js.map +1 -1
- package/lib/src/utils/processData.d.ts +0 -12
- package/lib/src/utils/processData.d.ts.map +1 -1
- package/lib/src/utils/processData.js +5 -33
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +0 -7
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +3 -17
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/lib/src/utils.d.ts +0 -12
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +19 -24
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +102 -406
- package/package.json +8 -3
- package/src/auth.spec.ts +150 -68
- package/src/auth.ts +108 -102
- package/src/config.spec.ts +4 -2
- package/src/config.ts +3 -5
- package/src/embed/app.spec.ts +14 -25
- package/src/embed/app.ts +35 -47
- package/src/embed/base.spec.ts +9 -3
- package/src/embed/base.ts +53 -51
- package/src/embed/embed.spec.ts +6 -5
- package/src/embed/liveboard.spec.ts +37 -56
- package/src/embed/liveboard.ts +64 -66
- package/src/embed/pinboard.spec.ts +29 -26
- package/src/embed/search-bar.tsx +8 -10
- package/src/embed/search.spec.ts +21 -31
- package/src/embed/search.ts +25 -26
- package/src/embed/searchEmbed-basic-auth.spec.ts +28 -22
- package/src/embed/ts-embed.spec.ts +148 -70
- package/src/embed/ts-embed.ts +157 -147
- package/src/errors.ts +6 -3
- package/src/index.ts +10 -4
- package/src/mixpanel-service.spec.ts +3 -1
- package/src/mixpanel-service.ts +1 -13
- package/src/react/index.spec.tsx +13 -37
- package/src/react/index.tsx +57 -38
- package/src/react/util.ts +4 -8
- package/src/test/test-utils.ts +39 -43
- package/src/types.ts +78 -270
- package/src/utils/answerService.spec.ts +5 -3
- package/src/utils/answerService.ts +17 -21
- package/src/utils/authService.spec.ts +41 -26
- package/src/utils/authService.ts +21 -47
- package/src/utils/processData.spec.ts +59 -26
- package/src/utils/processData.ts +14 -36
- package/src/utils/processTrigger.spec.ts +6 -1
- package/src/utils/processTrigger.ts +9 -18
- package/src/utils.spec.ts +12 -8
- package/src/utils.ts +26 -25
package/lib/src/types.js
CHANGED
|
@@ -9,35 +9,29 @@
|
|
|
9
9
|
/**
|
|
10
10
|
* The authentication mechanism for allowing access to the
|
|
11
11
|
* the embedded app
|
|
12
|
-
*
|
|
13
12
|
* @group Authentication / Init
|
|
14
13
|
*/
|
|
15
14
|
// eslint-disable-next-line no-shadow
|
|
16
15
|
export var AuthType;
|
|
17
16
|
(function (AuthType) {
|
|
18
17
|
/**
|
|
19
|
-
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
20
|
-
* `Passthrough`.
|
|
18
|
+
* No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
|
|
21
19
|
*/
|
|
22
20
|
AuthType["None"] = "None";
|
|
23
21
|
/**
|
|
24
|
-
* Passthrough SSO to the embedded App within the iframe. Requires least
|
|
25
|
-
*
|
|
26
|
-
* if SSO is not configured on ThoughtSpot.
|
|
27
|
-
*
|
|
22
|
+
* Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
|
|
23
|
+
* be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
|
|
28
24
|
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
29
25
|
*/
|
|
30
26
|
AuthType["EmbeddedSSO"] = "EmbeddedSSO";
|
|
31
27
|
/**
|
|
32
28
|
* SSO using SAML
|
|
33
|
-
*
|
|
34
29
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
35
30
|
* @hidden
|
|
36
31
|
*/
|
|
37
32
|
AuthType["SSO"] = "SSO_SAML";
|
|
38
33
|
/**
|
|
39
34
|
* SSO using SAML
|
|
40
|
-
*
|
|
41
35
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
42
36
|
* @hidden
|
|
43
37
|
*/
|
|
@@ -45,7 +39,6 @@ export var AuthType;
|
|
|
45
39
|
/**
|
|
46
40
|
* SSO using SAML
|
|
47
41
|
* Will make the host application redirect to the SAML Idp.
|
|
48
|
-
*
|
|
49
42
|
* @example
|
|
50
43
|
* ```js
|
|
51
44
|
* init({
|
|
@@ -59,7 +52,6 @@ export var AuthType;
|
|
|
59
52
|
AuthType["SAMLRedirect"] = "SSO_SAML";
|
|
60
53
|
/**
|
|
61
54
|
* SSO using OIDC
|
|
62
|
-
*
|
|
63
55
|
* @hidden
|
|
64
56
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
65
57
|
*/
|
|
@@ -71,15 +63,14 @@ export var AuthType;
|
|
|
71
63
|
AuthType["OIDCRedirect"] = "SSO_OIDC";
|
|
72
64
|
/**
|
|
73
65
|
* Trusted authentication server
|
|
74
|
-
*
|
|
75
66
|
* @hidden
|
|
76
67
|
* @deprecated Use {@link TrustedAuth} instead
|
|
77
68
|
*/
|
|
78
69
|
AuthType["AuthServer"] = "AuthServer";
|
|
79
70
|
/**
|
|
80
71
|
* Trusted authentication server, Use your own authentication server
|
|
81
|
-
* which returns a bearer token, generated using the secret_key obtained
|
|
82
|
-
*
|
|
72
|
+
* which returns a bearer token, generated using the secret_key obtained from
|
|
73
|
+
* ThoughtSpot.
|
|
83
74
|
*
|
|
84
75
|
* @example
|
|
85
76
|
* ```js
|
|
@@ -95,11 +86,10 @@ export var AuthType;
|
|
|
95
86
|
*/
|
|
96
87
|
AuthType["TrustedAuthToken"] = "AuthServer";
|
|
97
88
|
/**
|
|
98
|
-
* Trusted authentication server Cookieless, Use you own authentication
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
* implemented by some browsers
|
|
89
|
+
* Trusted authentication server Cookieless, Use you own authentication server
|
|
90
|
+
* which returns a bearer token, generated using the secret_key obtained from
|
|
91
|
+
* ThoughtSpot. This uses a cookieless authentication approach, recommended
|
|
92
|
+
* to by pass third-party cookie-blocking restriction implemented by some browsers
|
|
103
93
|
*/
|
|
104
94
|
AuthType["TrustedAuthTokenCookieless"] = "AuthServerCookieless";
|
|
105
95
|
/**
|
|
@@ -178,7 +168,6 @@ export var RuntimeFilterOp;
|
|
|
178
168
|
*
|
|
179
169
|
* To add an event listener use the corresponding
|
|
180
170
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
181
|
-
*
|
|
182
171
|
* @group Events
|
|
183
172
|
*/
|
|
184
173
|
// eslint-disable-next-line no-shadow
|
|
@@ -186,31 +175,26 @@ export var EmbedEvent;
|
|
|
186
175
|
(function (EmbedEvent) {
|
|
187
176
|
/**
|
|
188
177
|
* Rendering has initialized.
|
|
189
|
-
*
|
|
190
|
-
* @returns timestamp - The timestamp when the event was generated.
|
|
178
|
+
* @return timestamp - The timestamp when the event was generated.
|
|
191
179
|
*/
|
|
192
180
|
EmbedEvent["Init"] = "init";
|
|
193
181
|
/**
|
|
194
182
|
* Authentication has either succeeded or failed.
|
|
195
|
-
*
|
|
196
|
-
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
183
|
+
* @return isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
197
184
|
*/
|
|
198
185
|
EmbedEvent["AuthInit"] = "authInit";
|
|
199
186
|
/**
|
|
200
187
|
* The embed object container has loaded.
|
|
201
|
-
*
|
|
202
|
-
* @returns timestamp - The timestamp when the event was generated.
|
|
188
|
+
* @return timestamp - The timestamp when the event was generated.
|
|
203
189
|
*/
|
|
204
190
|
EmbedEvent["Load"] = "load";
|
|
205
191
|
/**
|
|
206
192
|
* Data pertaining to answer or Liveboard is received
|
|
207
|
-
*
|
|
208
|
-
* @returns data - The answer or Liveboard data
|
|
193
|
+
* @return data - The answer or Liveboard data
|
|
209
194
|
*/
|
|
210
195
|
EmbedEvent["Data"] = "data";
|
|
211
196
|
/**
|
|
212
197
|
* Search/answer/Liveboard filters have been applied/updated
|
|
213
|
-
*
|
|
214
198
|
* @hidden
|
|
215
199
|
*/
|
|
216
200
|
EmbedEvent["FiltersChanged"] = "filtersChanged";
|
|
@@ -220,56 +204,48 @@ export var EmbedEvent;
|
|
|
220
204
|
EmbedEvent["QueryChanged"] = "queryChanged";
|
|
221
205
|
/**
|
|
222
206
|
* A drill down operation has been performed.
|
|
223
|
-
*
|
|
224
|
-
* @
|
|
225
|
-
* @
|
|
226
|
-
* @returns nonFilteredColumns - The columns that were not filtered
|
|
207
|
+
* @return additionalFilters - Any additional filters applied
|
|
208
|
+
* @return drillDownColumns - The columns on which drill down was performed
|
|
209
|
+
* @return nonFilteredColumns - The columns that were not filtered
|
|
227
210
|
*/
|
|
228
211
|
EmbedEvent["Drilldown"] = "drillDown";
|
|
229
212
|
/**
|
|
230
213
|
* One or more data sources have been selected.
|
|
231
|
-
*
|
|
232
|
-
* @returns dataSourceIds - the list of data sources
|
|
214
|
+
* @return dataSourceIds - the list of data sources
|
|
233
215
|
*/
|
|
234
216
|
EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
|
|
235
217
|
/**
|
|
236
218
|
* One or more data columns have been selected.
|
|
237
|
-
*
|
|
238
|
-
* @returns columnIds - the list of columns
|
|
219
|
+
* @return columnIds - the list of columns
|
|
239
220
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
240
221
|
*/
|
|
241
222
|
EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
|
|
242
223
|
/**
|
|
243
224
|
* A custom action has been triggered
|
|
244
|
-
*
|
|
245
|
-
* @
|
|
246
|
-
* @returns data - The answer or Liveboard data
|
|
225
|
+
* @return actionId - The id of the custom action
|
|
226
|
+
* @return data - The answer or Liveboard data
|
|
247
227
|
*/
|
|
248
228
|
EmbedEvent["CustomAction"] = "customAction";
|
|
249
229
|
/**
|
|
250
230
|
* A double click has been triggered on table/chart
|
|
251
|
-
*
|
|
252
|
-
* @returns ContextMenuInputPoints - data point that is double clicked
|
|
231
|
+
* @return ContextMenuInputPoints - data point that is double clicked
|
|
253
232
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
254
233
|
*/
|
|
255
234
|
EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
|
|
256
235
|
/**
|
|
257
236
|
* A click has been triggered on table/chart
|
|
258
|
-
*
|
|
259
|
-
* @returns ContextMenuInputPoints - data point that is clicked
|
|
237
|
+
* @return ContextMenuInputPoints - data point that is clicked
|
|
260
238
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
261
239
|
*/
|
|
262
240
|
EmbedEvent["VizPointClick"] = "vizPointClick";
|
|
263
241
|
/**
|
|
264
242
|
* An error has occurred.
|
|
265
|
-
*
|
|
266
|
-
* @returns error - An error object or message
|
|
243
|
+
* @return error - An error object or message
|
|
267
244
|
*/
|
|
268
245
|
EmbedEvent["Error"] = "Error";
|
|
269
246
|
/**
|
|
270
247
|
* The embedded object has sent an alert
|
|
271
|
-
*
|
|
272
|
-
* @returns alert - An alert object
|
|
248
|
+
* @return alert - An alert object
|
|
273
249
|
*/
|
|
274
250
|
EmbedEvent["Alert"] = "alert";
|
|
275
251
|
/**
|
|
@@ -278,34 +254,29 @@ export var EmbedEvent;
|
|
|
278
254
|
EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
|
|
279
255
|
/**
|
|
280
256
|
* ThoughtSpot failed to validate the auth session.
|
|
281
|
-
*
|
|
282
257
|
* @hidden
|
|
283
258
|
*/
|
|
284
259
|
EmbedEvent["AuthFailure"] = "ThoughtspotAuthFailure";
|
|
285
260
|
/**
|
|
286
261
|
* ThoughtSpot failed to validate the auth session.
|
|
287
|
-
*
|
|
288
262
|
* @hidden
|
|
289
263
|
*/
|
|
290
264
|
EmbedEvent["AuthLogout"] = "ThoughtspotAuthLogout";
|
|
291
265
|
/**
|
|
292
266
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
293
|
-
*
|
|
294
|
-
* @returns data - The height of the embedded Liveboard or visualization
|
|
267
|
+
* @return data - The height of the embedded Liveboard or visualization
|
|
295
268
|
* @hidden
|
|
296
269
|
*/
|
|
297
270
|
EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
|
|
298
271
|
/**
|
|
299
272
|
* The center of visible iframe viewport is calculated.
|
|
300
|
-
*
|
|
301
|
-
* @returns data - The center of the visible Iframe viewport.
|
|
273
|
+
* @return data - The center of the visible Iframe viewport.
|
|
302
274
|
* @hidden
|
|
303
275
|
*/
|
|
304
276
|
EmbedEvent["EmbedIframeCenter"] = "EmbedIframeCenter";
|
|
305
277
|
/**
|
|
306
278
|
* Emitted when the "Get Data" button in Search Bar embed
|
|
307
279
|
* is clicked.
|
|
308
|
-
*
|
|
309
280
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
|
|
310
281
|
*/
|
|
311
282
|
EmbedEvent["GetDataClick"] = "getDataClick";
|
|
@@ -315,7 +286,6 @@ export var EmbedEvent;
|
|
|
315
286
|
EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
|
|
316
287
|
/**
|
|
317
288
|
* The v1 event type for Data
|
|
318
|
-
*
|
|
319
289
|
* @hidden
|
|
320
290
|
*/
|
|
321
291
|
EmbedEvent["V1Data"] = "exportVizDataToParent";
|
|
@@ -328,20 +298,17 @@ export var EmbedEvent;
|
|
|
328
298
|
EmbedEvent["NoCookieAccess"] = "noCookieAccess";
|
|
329
299
|
/**
|
|
330
300
|
* Emitted when SAML is complete
|
|
331
|
-
*
|
|
332
301
|
* @private
|
|
333
302
|
* @hidden
|
|
334
303
|
*/
|
|
335
304
|
EmbedEvent["SAMLComplete"] = "samlComplete";
|
|
336
305
|
/**
|
|
337
306
|
* Emitted when any modal is opened in the app
|
|
338
|
-
*
|
|
339
307
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
340
308
|
*/
|
|
341
309
|
EmbedEvent["DialogOpen"] = "dialog-open";
|
|
342
310
|
/**
|
|
343
311
|
* Emitted when any modal is closed in the app
|
|
344
|
-
*
|
|
345
312
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
346
313
|
*/
|
|
347
314
|
EmbedEvent["DialogClose"] = "dialog-close";
|
|
@@ -349,232 +316,187 @@ export var EmbedEvent;
|
|
|
349
316
|
* Emitted when the Liveboard shell loads.
|
|
350
317
|
* You can use this event as a hook to trigger
|
|
351
318
|
* other events on the rendered Liveboard.
|
|
352
|
-
*
|
|
353
319
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
354
320
|
*/
|
|
355
321
|
EmbedEvent["LiveboardRendered"] = "PinboardRendered";
|
|
356
322
|
/**
|
|
357
323
|
* This can be used to register an event listener which
|
|
358
324
|
* is triggered on all events.
|
|
359
|
-
*
|
|
360
325
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
361
326
|
*/
|
|
362
327
|
EmbedEvent["ALL"] = "*";
|
|
363
328
|
/**
|
|
364
329
|
* Emitted when answer is saved in the app
|
|
365
|
-
*
|
|
366
330
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
367
331
|
*/
|
|
368
332
|
EmbedEvent["Save"] = "save";
|
|
369
333
|
/**
|
|
370
334
|
* Emitted when the download action is triggered on an answer
|
|
371
|
-
*
|
|
372
335
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
373
336
|
*/
|
|
374
337
|
EmbedEvent["Download"] = "download";
|
|
375
338
|
/**
|
|
376
339
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
377
|
-
*
|
|
378
340
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
379
341
|
*/
|
|
380
342
|
EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
381
343
|
/**
|
|
382
344
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
383
|
-
*
|
|
384
345
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
385
346
|
*/
|
|
386
347
|
EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
|
|
387
348
|
/**
|
|
388
349
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
389
|
-
*
|
|
390
350
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
391
351
|
*/
|
|
392
352
|
EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
|
|
393
353
|
/**
|
|
394
354
|
* Emitted when an answer is deleted in the app
|
|
395
|
-
*
|
|
396
355
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
397
356
|
*/
|
|
398
357
|
EmbedEvent["AnswerDelete"] = "answerDelete";
|
|
399
358
|
/**
|
|
400
359
|
* Emitted when an answer is pinned to a Liveboard
|
|
401
|
-
*
|
|
402
360
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
403
361
|
*/
|
|
404
362
|
EmbedEvent["Pin"] = "pin";
|
|
405
363
|
/**
|
|
406
364
|
* Emitted when SpotIQ analysis is triggered
|
|
407
|
-
*
|
|
408
365
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
409
366
|
*/
|
|
410
367
|
EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
411
368
|
/**
|
|
412
369
|
* Emitted when a user shares an object with another user or group
|
|
413
|
-
*
|
|
414
370
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
415
371
|
*/
|
|
416
372
|
EmbedEvent["Share"] = "share";
|
|
417
373
|
/**
|
|
418
|
-
* Emitted when a user clicks the Include action to include a specific value or data
|
|
419
|
-
* on a chart or table
|
|
420
|
-
*
|
|
374
|
+
* Emitted when a user clicks the Include action to include a specific value or data on a chart or table
|
|
421
375
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
422
376
|
*/
|
|
423
377
|
EmbedEvent["DrillInclude"] = "context-menu-item-include";
|
|
424
378
|
/**
|
|
425
|
-
* Emitted when a user clicks the Exclude action to exclude a specific value or data
|
|
426
|
-
* on a chart or table
|
|
427
|
-
*
|
|
379
|
+
* Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
|
|
428
380
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
429
381
|
*/
|
|
430
382
|
EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
|
|
431
383
|
/**
|
|
432
384
|
* Emitted when copied column value on the app
|
|
433
|
-
*
|
|
434
385
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
435
386
|
*/
|
|
436
387
|
EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
|
|
437
388
|
/**
|
|
438
389
|
* Emitted when a user clicks the Update TML action
|
|
439
|
-
*
|
|
440
390
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
441
391
|
*/
|
|
442
392
|
EmbedEvent["UpdateTML"] = "updateTSL";
|
|
443
393
|
/**
|
|
444
394
|
* Emitted when a user clicks the Edit TML action
|
|
445
|
-
*
|
|
446
395
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
447
396
|
*/
|
|
448
397
|
EmbedEvent["EditTML"] = "editTSL";
|
|
449
398
|
/**
|
|
450
399
|
* Emitted when ExportTML trigger in answer on the app
|
|
451
|
-
*
|
|
452
400
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
453
401
|
*/
|
|
454
402
|
EmbedEvent["ExportTML"] = "exportTSL";
|
|
455
403
|
/**
|
|
456
404
|
* Emitted when an answer is saved as a view
|
|
457
|
-
*
|
|
458
405
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
459
406
|
*/
|
|
460
407
|
EmbedEvent["SaveAsView"] = "saveAsView";
|
|
461
408
|
/**
|
|
462
409
|
* Emitted when copy of existing answer on the app
|
|
463
|
-
*
|
|
464
410
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
465
411
|
*/
|
|
466
412
|
EmbedEvent["CopyAEdit"] = "copyAEdit";
|
|
467
413
|
/**
|
|
468
414
|
* Emitted when a user clicks Show underlying data on an answe
|
|
469
|
-
*
|
|
470
415
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
471
416
|
*/
|
|
472
417
|
EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
473
418
|
/**
|
|
474
419
|
* Emitted when an answer is switched to a chart or table view
|
|
475
|
-
*
|
|
476
420
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
477
421
|
*/
|
|
478
422
|
EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
|
|
479
423
|
/**
|
|
480
424
|
* Internal event to communicate the initial settings back to the TS APP
|
|
481
|
-
*
|
|
482
425
|
* @hidden
|
|
483
426
|
*/
|
|
484
427
|
EmbedEvent["APP_INIT"] = "appInit";
|
|
485
428
|
/**
|
|
486
429
|
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
487
|
-
*
|
|
488
430
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
489
431
|
*/
|
|
490
432
|
EmbedEvent["LiveboardInfo"] = "pinboardInfo";
|
|
491
433
|
/**
|
|
492
434
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
493
|
-
*
|
|
494
435
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
495
436
|
*/
|
|
496
437
|
EmbedEvent["AddToFavorites"] = "addToFavorites";
|
|
497
438
|
/**
|
|
498
439
|
* Emitted when a user clicks Schedule on a Liveboard
|
|
499
|
-
*
|
|
500
440
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
501
441
|
*/
|
|
502
442
|
EmbedEvent["Schedule"] = "subscription";
|
|
503
443
|
/**
|
|
504
444
|
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
505
|
-
*
|
|
506
445
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
507
446
|
*/
|
|
508
447
|
EmbedEvent["Edit"] = "edit";
|
|
509
448
|
/**
|
|
510
449
|
* Emitted when a user clicks Make a copy on a Liveboard
|
|
511
|
-
*
|
|
512
450
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
513
451
|
*/
|
|
514
452
|
EmbedEvent["MakeACopy"] = "makeACopy";
|
|
515
453
|
/**
|
|
516
454
|
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
517
|
-
*
|
|
518
455
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
519
456
|
*/
|
|
520
457
|
EmbedEvent["Present"] = "present";
|
|
521
458
|
/**
|
|
522
459
|
* Emitted when a user clicks Delete on a Liveboard
|
|
523
|
-
*
|
|
524
460
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
525
461
|
*/
|
|
526
462
|
EmbedEvent["Delete"] = "delete";
|
|
527
463
|
/**
|
|
528
464
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
529
|
-
*
|
|
530
465
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
531
466
|
*/
|
|
532
467
|
EmbedEvent["SchedulesList"] = "schedule-list";
|
|
533
468
|
/**
|
|
534
469
|
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
535
|
-
*
|
|
536
470
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
537
471
|
*/
|
|
538
472
|
EmbedEvent["Cancel"] = "cancel";
|
|
539
473
|
/**
|
|
540
474
|
* Emitted when a user clicks Explore on a visualization
|
|
541
|
-
*
|
|
542
475
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
543
476
|
*/
|
|
544
477
|
EmbedEvent["Explore"] = "explore";
|
|
545
478
|
/**
|
|
546
479
|
* Emitted when a user clicks Copy link action on a visualization
|
|
547
|
-
*
|
|
548
480
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
549
481
|
*/
|
|
550
482
|
EmbedEvent["CopyLink"] = "embedDocument";
|
|
551
483
|
/**
|
|
552
484
|
* Emitted when a user interacts with cross filters on a visualization or liveboard
|
|
553
|
-
*
|
|
554
485
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
555
486
|
*/
|
|
556
487
|
EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
|
|
557
488
|
/**
|
|
558
489
|
* Emitted when a user right clicks on chart or table
|
|
559
|
-
*
|
|
560
490
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
561
491
|
*/
|
|
562
492
|
EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
|
|
563
|
-
/**
|
|
564
|
-
* Emitted when a user clicks on Insert to slide on a visualization
|
|
565
|
-
*
|
|
566
|
-
* @hidden
|
|
567
|
-
*/
|
|
568
|
-
EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
|
|
569
493
|
})(EmbedEvent || (EmbedEvent = {}));
|
|
570
494
|
/**
|
|
571
495
|
* Event types that can be triggered by the host application
|
|
572
496
|
* to the embedded ThoughtSpot app
|
|
573
497
|
*
|
|
574
498
|
* To trigger an event use the corresponding
|
|
575
|
-
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
576
|
-
* SearchEmbed.trigger} method.
|
|
577
|
-
*
|
|
499
|
+
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
|
|
578
500
|
* @group Events
|
|
579
501
|
*/
|
|
580
502
|
// eslint-disable-next-line no-shadow
|
|
@@ -582,7 +504,6 @@ export var HostEvent;
|
|
|
582
504
|
(function (HostEvent) {
|
|
583
505
|
/**
|
|
584
506
|
* Trigger a search
|
|
585
|
-
*
|
|
586
507
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
587
508
|
* - Although an array, only a single source
|
|
588
509
|
* is supported at this time.
|
|
@@ -600,12 +521,10 @@ export var HostEvent;
|
|
|
600
521
|
HostEvent["Search"] = "search";
|
|
601
522
|
/**
|
|
602
523
|
* Trigger a drill on certain points by certain column
|
|
603
|
-
*
|
|
604
524
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
605
525
|
* eg. { selectedPoints: []}
|
|
606
526
|
* @param - columnGuid - a string guid of the column to drill by. This is optional,
|
|
607
|
-
* if not provided it will auto drill by the configured
|
|
608
|
-
* column.
|
|
527
|
+
* if not provided it will auto drill by the configured column.
|
|
609
528
|
* @example
|
|
610
529
|
* ```js
|
|
611
530
|
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
@@ -613,50 +532,44 @@ export var HostEvent;
|
|
|
613
532
|
* autoDrillDown: true,
|
|
614
533
|
* })
|
|
615
534
|
* ```
|
|
535
|
+
*
|
|
616
536
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
617
537
|
*/
|
|
618
538
|
HostEvent["DrillDown"] = "triggerDrillDown";
|
|
619
539
|
/**
|
|
620
540
|
* Apply filters
|
|
621
|
-
*
|
|
622
541
|
* @hidden
|
|
623
542
|
*/
|
|
624
543
|
HostEvent["Filter"] = "filter";
|
|
625
544
|
/**
|
|
626
545
|
* Reload the answer or visualization
|
|
627
|
-
*
|
|
628
546
|
* @hidden
|
|
629
547
|
*/
|
|
630
548
|
HostEvent["Reload"] = "reload";
|
|
631
549
|
/**
|
|
632
550
|
* Set the visible visualizations on a Liveboard.
|
|
633
|
-
*
|
|
634
551
|
* @param - an array of ids of visualizations to show, the ids not passed
|
|
635
552
|
* will be hidden.
|
|
636
553
|
* @example
|
|
637
|
-
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
638
|
-
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
639
|
-
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
554
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
640
555
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
641
556
|
*/
|
|
642
557
|
HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
|
|
643
558
|
/**
|
|
644
559
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
645
560
|
* on to the existing runtime filters if they exist.
|
|
646
|
-
*
|
|
647
561
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
648
562
|
* @example
|
|
649
563
|
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
650
564
|
* {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
|
|
651
|
-
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values:
|
|
652
|
-
*
|
|
565
|
+
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
|
|
566
|
+
* ])
|
|
653
567
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
654
568
|
*/
|
|
655
569
|
HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
|
|
656
570
|
/**
|
|
657
571
|
* Navigate to a specific page in App embed without any reload.
|
|
658
572
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
659
|
-
*
|
|
660
573
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
661
574
|
* @example
|
|
662
575
|
* ```js
|
|
@@ -668,22 +581,16 @@ export var HostEvent;
|
|
|
668
581
|
/**
|
|
669
582
|
* Opens the filter panel for a particular column.
|
|
670
583
|
* Works with Search embed.
|
|
671
|
-
*
|
|
672
|
-
* @param - { columnId: string,
|
|
673
|
-
* name: string,
|
|
674
|
-
* type: INT64/CHAR/DATE,
|
|
675
|
-
* dataType: ATTRIBUTE/MEASURE }
|
|
584
|
+
* @param - { columnId: string, name: string, type: INT64/CHAR/DATE, dataType: ATTRIBUTE/MEASURE }
|
|
676
585
|
* @example
|
|
677
586
|
* ```js
|
|
678
|
-
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
679
|
-
* { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
|
|
587
|
+
* searchEmbed.trigger(HostEvent.OpenFilter, { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
|
|
680
588
|
* ```
|
|
681
589
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
682
590
|
*/
|
|
683
591
|
HostEvent["OpenFilter"] = "openFilter";
|
|
684
592
|
/**
|
|
685
593
|
* Adds the columns to the current Search.
|
|
686
|
-
*
|
|
687
594
|
* @param - { columnIds: string[] }
|
|
688
595
|
* @example
|
|
689
596
|
* ```js
|
|
@@ -694,7 +601,6 @@ export var HostEvent;
|
|
|
694
601
|
HostEvent["AddColumns"] = "addColumns";
|
|
695
602
|
/**
|
|
696
603
|
* Removes a column from the current Search.
|
|
697
|
-
*
|
|
698
604
|
* @param - { columnId: string }
|
|
699
605
|
* @example
|
|
700
606
|
* ```js
|
|
@@ -705,7 +611,6 @@ export var HostEvent;
|
|
|
705
611
|
HostEvent["RemoveColumn"] = "removeColumn";
|
|
706
612
|
/**
|
|
707
613
|
* Gets the current pinboard content.
|
|
708
|
-
*
|
|
709
614
|
* @example
|
|
710
615
|
* ```js
|
|
711
616
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
@@ -715,7 +620,6 @@ export var HostEvent;
|
|
|
715
620
|
HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
|
|
716
621
|
/**
|
|
717
622
|
* Triggers the Pin action on an embedded object
|
|
718
|
-
*
|
|
719
623
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
720
624
|
* can be left empty for search and visualization embeds
|
|
721
625
|
* @example
|
|
@@ -729,7 +633,6 @@ export var HostEvent;
|
|
|
729
633
|
HostEvent["Pin"] = "pin";
|
|
730
634
|
/**
|
|
731
635
|
* Triggers the Show Liveboard details action on a Liveboard
|
|
732
|
-
*
|
|
733
636
|
* @example
|
|
734
637
|
* ```js
|
|
735
638
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -739,7 +642,6 @@ export var HostEvent;
|
|
|
739
642
|
HostEvent["LiveboardInfo"] = "pinboardInfo";
|
|
740
643
|
/**
|
|
741
644
|
* Triggers the Schedule action on a Liveboard
|
|
742
|
-
*
|
|
743
645
|
* @example
|
|
744
646
|
* ```js
|
|
745
647
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -749,7 +651,6 @@ export var HostEvent;
|
|
|
749
651
|
HostEvent["Schedule"] = "subscription";
|
|
750
652
|
/**
|
|
751
653
|
* Triggers the Manage schedule action on a Liveboard
|
|
752
|
-
*
|
|
753
654
|
* @example
|
|
754
655
|
* ```js
|
|
755
656
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -759,7 +660,6 @@ export var HostEvent;
|
|
|
759
660
|
HostEvent["SchedulesList"] = "schedule-list";
|
|
760
661
|
/**
|
|
761
662
|
* Triggers the Export TML action on a Liveboard
|
|
762
|
-
*
|
|
763
663
|
* @example
|
|
764
664
|
* ```js
|
|
765
665
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
@@ -769,7 +669,6 @@ export var HostEvent;
|
|
|
769
669
|
HostEvent["ExportTML"] = "exportTSL";
|
|
770
670
|
/**
|
|
771
671
|
* Triggers the Edit TML action on a Liveboard
|
|
772
|
-
*
|
|
773
672
|
* @example
|
|
774
673
|
* ```js
|
|
775
674
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -779,7 +678,6 @@ export var HostEvent;
|
|
|
779
678
|
HostEvent["EditTML"] = "editTSL";
|
|
780
679
|
/**
|
|
781
680
|
* Triggers the Update TML action on a Liveboard
|
|
782
|
-
*
|
|
783
681
|
* @example
|
|
784
682
|
* ```js
|
|
785
683
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -789,7 +687,6 @@ export var HostEvent;
|
|
|
789
687
|
HostEvent["UpdateTML"] = "updateTSL";
|
|
790
688
|
/**
|
|
791
689
|
* Triggers the Download PDF action on a Liveboard
|
|
792
|
-
*
|
|
793
690
|
* @example
|
|
794
691
|
* ```js
|
|
795
692
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
|
|
@@ -799,7 +696,6 @@ export var HostEvent;
|
|
|
799
696
|
HostEvent["DownloadAsPdf"] = "downloadAsPdf";
|
|
800
697
|
/**
|
|
801
698
|
* Triggers the Make a copy action on a Liveboard, search or visualization
|
|
802
|
-
*
|
|
803
699
|
* @example
|
|
804
700
|
* ```js
|
|
805
701
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -811,7 +707,6 @@ export var HostEvent;
|
|
|
811
707
|
HostEvent["MakeACopy"] = "makeACopy";
|
|
812
708
|
/**
|
|
813
709
|
* Triggers the Delete action on a Liveboard
|
|
814
|
-
*
|
|
815
710
|
* @example
|
|
816
711
|
* ```js
|
|
817
712
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -821,7 +716,6 @@ export var HostEvent;
|
|
|
821
716
|
HostEvent["Remove"] = "delete";
|
|
822
717
|
/**
|
|
823
718
|
* Triggers the Explore action on a visualization
|
|
824
|
-
*
|
|
825
719
|
* @param - an object with vizId as a key
|
|
826
720
|
* @example
|
|
827
721
|
* ```js
|
|
@@ -832,48 +726,37 @@ export var HostEvent;
|
|
|
832
726
|
HostEvent["Explore"] = "explore";
|
|
833
727
|
/**
|
|
834
728
|
* Triggers the Create alert action on a visualization
|
|
835
|
-
*
|
|
836
729
|
* @param - an object with vizId as a key
|
|
837
730
|
* @example
|
|
838
731
|
* ```js
|
|
839
|
-
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
840
|
-
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
841
|
-
* })
|
|
732
|
+
* liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
842
733
|
* ```
|
|
843
734
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
844
735
|
*/
|
|
845
736
|
HostEvent["CreateMonitor"] = "createMonitor";
|
|
846
737
|
/**
|
|
847
738
|
* Triggers the Manage alert action on a visualization
|
|
848
|
-
*
|
|
849
739
|
* @param - an object with vizId as a key
|
|
850
740
|
* @example
|
|
851
741
|
* ```js
|
|
852
|
-
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
853
|
-
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
854
|
-
* })
|
|
742
|
+
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
855
743
|
* ```
|
|
856
744
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
857
745
|
*/
|
|
858
746
|
HostEvent["ManageMonitor"] = "manageMonitor";
|
|
859
747
|
/**
|
|
860
748
|
* Triggers the Edit action on a Liveboard or visualization
|
|
861
|
-
*
|
|
862
|
-
* @param - object - to trigger the action for a specfic visualization
|
|
863
|
-
* in Liveboard embed, pass in vizId as a key
|
|
749
|
+
* @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
|
|
864
750
|
* @example
|
|
865
751
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
866
|
-
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
867
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
752
|
+
* liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
868
753
|
* vizEmbed.trigger((HostEvent.Edit)
|
|
869
754
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
870
755
|
*/
|
|
871
756
|
HostEvent["Edit"] = "edit";
|
|
872
757
|
/**
|
|
873
758
|
* Triggers the Copy link action on a Liveboard or visualization
|
|
874
|
-
*
|
|
875
|
-
* @param - object - to trigger the action for a s
|
|
876
|
-
* pecfic visualization in Liveboard embed, pass in vizId as a key
|
|
759
|
+
* @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
|
|
877
760
|
* @example
|
|
878
761
|
* ```js
|
|
879
762
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
@@ -885,9 +768,7 @@ export var HostEvent;
|
|
|
885
768
|
HostEvent["CopyLink"] = "embedDocument";
|
|
886
769
|
/**
|
|
887
770
|
* Triggers the Present action on a Liveboard or visualization
|
|
888
|
-
*
|
|
889
|
-
* @param - object - to trigger the action for a specfic visualization
|
|
890
|
-
* in Liveboard embed, pass in vizId as a key
|
|
771
|
+
* @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
|
|
891
772
|
* @example
|
|
892
773
|
* ```js
|
|
893
774
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
@@ -899,21 +780,18 @@ export var HostEvent;
|
|
|
899
780
|
HostEvent["Present"] = "present";
|
|
900
781
|
/**
|
|
901
782
|
* Get TML for the current search.
|
|
902
|
-
*
|
|
903
783
|
* @example
|
|
904
784
|
* ```js
|
|
905
785
|
* searchEmbed.trigger(HostEvent.GetTML)
|
|
906
786
|
* ```
|
|
907
|
-
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
|
|
787
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
908
788
|
*/
|
|
909
789
|
HostEvent["GetTML"] = "getTML";
|
|
910
790
|
/**
|
|
911
791
|
* Triggers the ShowUnderlyingData action on visualization or search
|
|
912
|
-
*
|
|
913
792
|
* @param - an object with vizId as a key
|
|
914
793
|
* @example
|
|
915
|
-
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
916
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
794
|
+
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
917
795
|
* vizEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
918
796
|
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
919
797
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -921,12 +799,10 @@ export var HostEvent;
|
|
|
921
799
|
HostEvent["ShowUnderlyingData"] = "showUnderlyingData";
|
|
922
800
|
/**
|
|
923
801
|
* Triggers the Delete action on visualization or search
|
|
924
|
-
*
|
|
925
802
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
926
803
|
* can be left empty for search and visualization embeds
|
|
927
804
|
* @example
|
|
928
|
-
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
929
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
805
|
+
* liveboardEmbed.trigger(HostEvent.Delete, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
930
806
|
* vizEmbed.trigger(HostEvent.Delete)
|
|
931
807
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
932
808
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -934,12 +810,10 @@ export var HostEvent;
|
|
|
934
810
|
HostEvent["Delete"] = "delete";
|
|
935
811
|
/**
|
|
936
812
|
* Triggers the SpotIQAnalyze action on visualization or search
|
|
937
|
-
*
|
|
938
813
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
939
814
|
* can be left empty for search and visualization embeds
|
|
940
815
|
* @example
|
|
941
|
-
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
942
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
816
|
+
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
943
817
|
* vizEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
944
818
|
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
945
819
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -947,34 +821,26 @@ export var HostEvent;
|
|
|
947
821
|
HostEvent["SpotIQAnalyze"] = "spotIQAnalyze";
|
|
948
822
|
/**
|
|
949
823
|
* Triggers the Download action on visualization or search when Displaymode is Chart
|
|
950
|
-
*
|
|
951
824
|
* @example
|
|
952
|
-
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
953
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
825
|
+
* liveboardEmbed.trigger(HostEvent.Download, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
954
826
|
* vizEmbed.trigger(HostEvent.Download)
|
|
955
827
|
* searchEmbed.trigger(HostEvent.Download)
|
|
956
828
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
957
829
|
*/
|
|
958
830
|
HostEvent["Download"] = "download";
|
|
959
831
|
/**
|
|
960
|
-
* Triggers the downloadAsCSV action on visualization or search when Displaymode is
|
|
961
|
-
* Table
|
|
962
|
-
*
|
|
832
|
+
* Triggers the downloadAsCSV action on visualization or search when Displaymode is Table
|
|
963
833
|
* @example
|
|
964
|
-
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
965
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
834
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
966
835
|
* vizEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
967
836
|
* searchEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
968
837
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
969
838
|
*/
|
|
970
839
|
HostEvent["DownloadAsCsv"] = "downloadAsCSV";
|
|
971
840
|
/**
|
|
972
|
-
* Triggers the downloadAsXLSX action on visualization or search when Displaymode is
|
|
973
|
-
* Table
|
|
974
|
-
*
|
|
841
|
+
* Triggers the downloadAsXLSX action on visualization or search when Displaymode is Table
|
|
975
842
|
* @example
|
|
976
|
-
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
977
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
843
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
978
844
|
* vizEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
979
845
|
* searchEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
980
846
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -982,7 +848,6 @@ export var HostEvent;
|
|
|
982
848
|
HostEvent["DownloadAsXlsx"] = "downloadAsXLSX";
|
|
983
849
|
/**
|
|
984
850
|
* Triggers the Share action on a liveboard or answer
|
|
985
|
-
*
|
|
986
851
|
* @example
|
|
987
852
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
988
853
|
* searchEmbed.trigger(HostEvent.Share)
|
|
@@ -991,7 +856,6 @@ export var HostEvent;
|
|
|
991
856
|
HostEvent["Share"] = "share";
|
|
992
857
|
/**
|
|
993
858
|
* Trigger the Save action on a liveboard or answer
|
|
994
|
-
*
|
|
995
859
|
* @example
|
|
996
860
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
997
861
|
* searchEmbed.trigger(HostEvent.Save)
|
|
@@ -1000,40 +864,33 @@ export var HostEvent;
|
|
|
1000
864
|
HostEvent["Save"] = "save";
|
|
1001
865
|
/**
|
|
1002
866
|
* Triggers the SyncToSheets action on visualization
|
|
1003
|
-
*
|
|
1004
867
|
* @param - an object with vizId as a key
|
|
1005
868
|
* @example
|
|
1006
|
-
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
1007
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
869
|
+
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1008
870
|
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
1009
871
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1010
872
|
*/
|
|
1011
873
|
HostEvent["SyncToSheets"] = "sync-to-sheets";
|
|
1012
874
|
/**
|
|
1013
875
|
* Triggers the SyncToOtherApps action on visualization
|
|
1014
|
-
*
|
|
1015
876
|
* @param - an object with vizId as a key
|
|
1016
877
|
* @example
|
|
1017
|
-
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
1018
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
878
|
+
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1019
879
|
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
1020
880
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1021
881
|
*/
|
|
1022
882
|
HostEvent["SyncToOtherApps"] = "sync-to-other-apps";
|
|
1023
883
|
/**
|
|
1024
884
|
* Triggers the ManagePipelines action on visualization
|
|
1025
|
-
*
|
|
1026
885
|
* @param - an object with vizId as a key
|
|
1027
886
|
* @example
|
|
1028
|
-
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
1029
|
-
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
887
|
+
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1030
888
|
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
1031
889
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1032
890
|
*/
|
|
1033
891
|
HostEvent["ManagePipelines"] = "manage-pipeline";
|
|
1034
892
|
/**
|
|
1035
893
|
* Triggers the Reset search in answer
|
|
1036
|
-
*
|
|
1037
894
|
* @example
|
|
1038
895
|
* searchEmbed.trigger(HostEvent.SearchReset
|
|
1039
896
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
|
|
@@ -1067,7 +924,6 @@ export var DataSourceVisualMode;
|
|
|
1067
924
|
// eslint-disable-next-line no-shadow
|
|
1068
925
|
export var Param;
|
|
1069
926
|
(function (Param) {
|
|
1070
|
-
Param["EmbedApp"] = "embedApp";
|
|
1071
927
|
Param["DataSources"] = "dataSources";
|
|
1072
928
|
Param["DataSourceMode"] = "dataSourceMode";
|
|
1073
929
|
Param["DisableActions"] = "disableAction";
|
|
@@ -1108,8 +964,6 @@ export var Param;
|
|
|
1108
964
|
Param["ContextMenuTrigger"] = "isContextMenuEnabledOnLeftClick";
|
|
1109
965
|
Param["LinkOverride"] = "linkOverride";
|
|
1110
966
|
Param["ShowInsertToSlide"] = "insertInToSlide";
|
|
1111
|
-
Param["PrimaryNavHidden"] = "primaryNavHidden";
|
|
1112
|
-
Param["HideProfleAndHelp"] = "profileAndHelpInNavBarHidden";
|
|
1113
967
|
})(Param || (Param = {}));
|
|
1114
968
|
/**
|
|
1115
969
|
* The list of actions that can be performed on visual ThoughtSpot
|