@thoughtspot/visual-embed-sdk 1.20.1 → 1.21.0-alpha.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 +48 -3
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/config.d.ts +1 -0
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +17 -5
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +20 -9
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +17 -5
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +3 -0
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +9 -5
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +64 -6
- 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 +8 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +15 -0
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/react/util.d.ts +4 -0
- package/dist/src/react/util.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +11 -2
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/types.d.ts +297 -77
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/answerService.d.ts +7 -0
- package/dist/src/utils/answerService.d.ts.map +1 -1
- package/dist/src/utils/authService.d.ts +30 -0
- package/dist/src/utils/authService.d.ts.map +1 -1
- package/dist/src/utils/processData.d.ts +12 -0
- package/dist/src/utils/processData.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +7 -0
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +12 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed.es.js +694 -267
- package/dist/tsembed.js +686 -266
- package/lib/package.json +3 -8
- package/lib/src/auth.d.ts +48 -3
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +70 -25
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.js +14 -5
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/config.d.ts +1 -0
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +5 -3
- package/lib/src/config.js.map +1 -1
- package/lib/src/config.spec.js.map +1 -1
- package/lib/src/embed/app.d.ts +17 -5
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +25 -15
- 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 +20 -9
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +31 -15
- 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 +17 -5
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +49 -37
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +37 -30
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +14 -26
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +3 -0
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +5 -6
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +9 -5
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +18 -14
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +16 -19
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.js +4 -0
- package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +64 -6
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +150 -76
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +46 -24
- 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 +8 -0
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +13 -1
- 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 +15 -0
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +21 -6
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +15 -6
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/react/util.d.ts +4 -0
- package/lib/src/react/util.d.ts.map +1 -1
- package/lib/src/react/util.js +4 -0
- package/lib/src/react/util.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +11 -2
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +36 -25
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/types.d.ts +297 -77
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +224 -55
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/answerService.d.ts +7 -0
- package/lib/src/utils/answerService.d.ts.map +1 -1
- package/lib/src/utils/answerService.js +7 -0
- 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 +30 -0
- package/lib/src/utils/authService.d.ts.map +1 -1
- package/lib/src/utils/authService.js +39 -2
- 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 +12 -0
- package/lib/src/utils/processData.d.ts.map +1 -1
- package/lib/src/utils/processData.js +33 -5
- 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 +7 -0
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +17 -3
- 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 +12 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +24 -19
- 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 +461 -104
- package/package.json +3 -8
- package/src/auth.spec.ts +68 -150
- package/src/auth.ts +115 -109
- package/src/config.spec.ts +2 -4
- package/src/config.ts +5 -3
- package/src/embed/app.spec.ts +25 -14
- package/src/embed/app.ts +47 -35
- package/src/embed/base.spec.ts +3 -9
- package/src/embed/base.ts +51 -53
- package/src/embed/embed.spec.ts +5 -6
- package/src/embed/liveboard.spec.ts +56 -37
- package/src/embed/liveboard.ts +66 -64
- package/src/embed/pinboard.spec.ts +26 -29
- package/src/embed/search-bar.tsx +10 -8
- package/src/embed/search.spec.ts +31 -21
- package/src/embed/search.ts +26 -25
- package/src/embed/searchEmbed-basic-auth.spec.ts +22 -28
- package/src/embed/ts-embed.spec.ts +99 -144
- package/src/embed/ts-embed.ts +183 -160
- package/src/errors.ts +3 -6
- package/src/index.ts +4 -10
- package/src/mixpanel-service.spec.ts +1 -3
- package/src/mixpanel-service.ts +13 -1
- package/src/react/index.spec.tsx +37 -13
- package/src/react/index.tsx +53 -57
- package/src/react/util.ts +8 -4
- package/src/test/test-utils.ts +43 -39
- package/src/types.ts +294 -79
- package/src/utils/answerService.spec.ts +3 -5
- package/src/utils/answerService.ts +21 -17
- package/src/utils/authService.spec.ts +26 -41
- package/src/utils/authService.ts +47 -21
- package/src/utils/processData.spec.ts +26 -59
- package/src/utils/processData.ts +36 -14
- package/src/utils/processTrigger.spec.ts +1 -6
- package/src/utils/processTrigger.ts +18 -9
- package/src/utils.spec.ts +8 -12
- package/src/utils.ts +25 -26
|
@@ -70,6 +70,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
|
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
72
|
* The view configuration for full app embedding.
|
|
73
|
+
*
|
|
73
74
|
* @group Embed components
|
|
74
75
|
*/
|
|
75
76
|
export interface AppViewConfig extends ViewConfig {
|
|
@@ -95,8 +96,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
|
|
|
95
96
|
*/
|
|
96
97
|
pageId?: Page;
|
|
97
98
|
/**
|
|
98
|
-
* This puts a filter tag on the application. All metadata lists in the
|
|
99
|
-
* Liveboards and answers, would be filtered by this
|
|
99
|
+
* This puts a filter tag on the application. All metadata lists in the
|
|
100
|
+
* application, such as Liveboards and answers, would be filtered by this
|
|
101
|
+
* tag.
|
|
100
102
|
*/
|
|
101
103
|
tag?: string;
|
|
102
104
|
/**
|
|
@@ -106,35 +108,47 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
|
|
|
106
108
|
/**
|
|
107
109
|
* Render liveboards using the new v2 rendering mode
|
|
108
110
|
* This is a transient flag which is primarily meant for internal use
|
|
111
|
+
*
|
|
109
112
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
110
113
|
* @hidden
|
|
111
114
|
*/
|
|
112
115
|
liveboardV2?: boolean;
|
|
113
116
|
/**
|
|
114
117
|
* If set to true, the Search Assist feature is enabled.
|
|
118
|
+
*
|
|
115
119
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
116
120
|
*/
|
|
117
121
|
enableSearchAssist?: boolean;
|
|
118
122
|
}
|
|
119
123
|
/**
|
|
120
124
|
* Embeds full ThoughtSpot experience in a host application.
|
|
125
|
+
*
|
|
121
126
|
* @group Embed components
|
|
122
127
|
*/
|
|
123
128
|
export class AppEmbed extends V1Embed {
|
|
124
129
|
protected viewConfig: AppViewConfig;
|
|
125
130
|
constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
|
|
131
|
+
/**
|
|
132
|
+
* Constructs a map of parameters to be passed on to the
|
|
133
|
+
* embedded Liveboard or visualization.
|
|
134
|
+
*/
|
|
135
|
+
protected getEmbedParams(): string;
|
|
126
136
|
/**
|
|
127
137
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
128
|
-
* This is used for embedding answers, pinboards, visualizations and full application
|
|
138
|
+
* This is used for embedding answers, pinboards, visualizations and full application
|
|
139
|
+
* only.
|
|
140
|
+
*
|
|
129
141
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
130
142
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
131
|
-
* When used with `noReload` this can also be a number
|
|
143
|
+
* When used with `noReload` (default: true) this can also be a number
|
|
144
|
+
* like 1/-1 to go forward/back.
|
|
132
145
|
* @param noReload boolean Trigger the navigation without reloading the page
|
|
133
146
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
134
147
|
*/
|
|
135
148
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
136
149
|
/**
|
|
137
150
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
151
|
+
*
|
|
138
152
|
* @param renderOptions An object containing the page ID
|
|
139
153
|
* to be embedded.
|
|
140
154
|
*/
|
|
@@ -161,7 +175,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
|
|
|
161
175
|
*/
|
|
162
176
|
export const handleAuth: () => Promise<boolean>;
|
|
163
177
|
/**
|
|
164
|
-
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
178
|
+
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
179
|
+
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
180
|
+
* to your app.
|
|
181
|
+
*
|
|
165
182
|
* @param url The URL provided for prefetch
|
|
166
183
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
167
184
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -171,9 +188,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
|
|
|
171
188
|
/**
|
|
172
189
|
* Initializes the Visual Embed SDK globally and perform
|
|
173
190
|
* authentication if applicable.
|
|
191
|
+
*
|
|
174
192
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
175
193
|
* authentication mechanism and so on.
|
|
176
|
-
*
|
|
177
194
|
* @example
|
|
178
195
|
* ```js
|
|
179
196
|
* const authStatus = init({
|
|
@@ -182,19 +199,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
|
|
|
182
199
|
* });
|
|
183
200
|
* authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
|
|
184
201
|
* ```
|
|
185
|
-
*
|
|
186
|
-
*
|
|
202
|
+
* @returns {@link AuthEventEmitter} event emitter which emits events on authentication success,
|
|
203
|
+
* failure and logout. See {@link AuthStatus}
|
|
187
204
|
* @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
|
|
188
205
|
* @group Authentication / Init
|
|
189
206
|
*/
|
|
190
207
|
export const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
|
|
208
|
+
/**
|
|
209
|
+
*
|
|
210
|
+
*/
|
|
191
211
|
export function disableAutoLogin(): void;
|
|
192
212
|
/**
|
|
193
|
-
* Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
|
|
194
|
-
* the SDK from automatically logging in again.
|
|
213
|
+
* Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
|
|
214
|
+
* prevent the SDK from automatically logging in again.
|
|
195
215
|
*
|
|
196
|
-
* You can call the `init` method again to re login, if autoLogin is set to
|
|
197
|
-
* second call it will be honored.
|
|
216
|
+
* You can call the `init` method again to re login, if autoLogin is set to
|
|
217
|
+
* true in this second call it will be honored.
|
|
198
218
|
*
|
|
199
219
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
200
220
|
* @returns Promise which resolves when logout completes.
|
|
@@ -203,10 +223,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
|
|
|
203
223
|
*/
|
|
204
224
|
export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
|
|
205
225
|
/**
|
|
206
|
-
* Renders functions in a queue, resolves to next function only after the callback next
|
|
226
|
+
* Renders functions in a queue, resolves to next function only after the callback next
|
|
227
|
+
* is called
|
|
228
|
+
*
|
|
207
229
|
* @param fn The function being registered
|
|
208
230
|
*/
|
|
209
231
|
export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
232
|
+
/**
|
|
233
|
+
*
|
|
234
|
+
*/
|
|
210
235
|
export function reset(): void;
|
|
211
236
|
}
|
|
212
237
|
|
|
@@ -225,12 +250,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
225
250
|
import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
|
|
226
251
|
/**
|
|
227
252
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
253
|
+
*
|
|
228
254
|
* @group Embed components
|
|
229
255
|
*/
|
|
230
256
|
export interface LiveboardViewConfig extends ViewConfig {
|
|
231
257
|
/**
|
|
232
258
|
* If set to true, the embedded object container dynamically resizes
|
|
233
259
|
* according to the height of the Liveboard.
|
|
260
|
+
*
|
|
234
261
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
235
262
|
*/
|
|
236
263
|
fullHeight?: boolean;
|
|
@@ -238,6 +265,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
238
265
|
* This is the minimum height(in pixels) for a full height Liveboard.
|
|
239
266
|
* Setting this height helps resolves issues with empty Liveboards and
|
|
240
267
|
* other screens navigable from a Liveboard.
|
|
268
|
+
*
|
|
241
269
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
242
270
|
* @default 500
|
|
243
271
|
*/
|
|
@@ -249,11 +277,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
249
277
|
/**
|
|
250
278
|
* The Liveboard to display in the embedded view.
|
|
251
279
|
* Use either of liveboardId or pinboardId to reference the Liveboard to embed.
|
|
280
|
+
*
|
|
252
281
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
253
282
|
*/
|
|
254
283
|
liveboardId?: string;
|
|
255
284
|
/**
|
|
256
285
|
* To support backward compatibility
|
|
286
|
+
*
|
|
257
287
|
* @hidden
|
|
258
288
|
*/
|
|
259
289
|
pinboardId?: string;
|
|
@@ -264,6 +294,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
264
294
|
/**
|
|
265
295
|
* If set to true, all filter chips from a
|
|
266
296
|
* Liveboard page will be read-only (no X buttons)
|
|
297
|
+
*
|
|
267
298
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
268
299
|
*/
|
|
269
300
|
preventLiveboardFilterRemoval?: boolean;
|
|
@@ -271,44 +302,57 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
|
|
|
271
302
|
* Array of viz ids which should be visible when the liveboard
|
|
272
303
|
* first renders. This can be changed by triggering the "SetVisibleVizs"
|
|
273
304
|
* event.
|
|
305
|
+
*
|
|
274
306
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
275
307
|
*/
|
|
276
308
|
visibleVizs?: string[];
|
|
277
309
|
/**
|
|
278
310
|
* To support backward compatibilty
|
|
311
|
+
*
|
|
279
312
|
* @hidden
|
|
280
313
|
*/
|
|
281
314
|
preventPinboardFilterRemoval?: boolean;
|
|
282
315
|
/**
|
|
283
316
|
* Render embedded Liveboards and visualizations in the new Liveboard experience mode
|
|
317
|
+
*
|
|
284
318
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
285
319
|
*/
|
|
286
320
|
liveboardV2?: boolean;
|
|
287
321
|
/**
|
|
288
322
|
* Tab Id of the Liveboard that is supposed to be active
|
|
323
|
+
*
|
|
289
324
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
290
325
|
*/
|
|
291
326
|
activeTabId?: string;
|
|
292
327
|
}
|
|
293
328
|
/**
|
|
294
329
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
330
|
+
*
|
|
295
331
|
* @group Embed components
|
|
296
332
|
*/
|
|
297
333
|
export class LiveboardEmbed extends V1Embed {
|
|
298
334
|
protected viewConfig: LiveboardViewConfig;
|
|
299
335
|
constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
|
|
336
|
+
/**
|
|
337
|
+
* Construct a map of params to be passed on to the
|
|
338
|
+
* embedded Liveboard or visualization.
|
|
339
|
+
*/
|
|
340
|
+
protected getEmbedParams(): string;
|
|
300
341
|
/**
|
|
301
342
|
* Triggers an event to the embedded app
|
|
343
|
+
*
|
|
302
344
|
* @param messageType The event type
|
|
303
345
|
* @param data The payload to send with the message
|
|
304
346
|
*/
|
|
305
347
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
306
348
|
/**
|
|
307
349
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
350
|
+
*
|
|
308
351
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
309
352
|
* visualization ID and the runtime filters.
|
|
310
353
|
*/
|
|
311
354
|
render(): LiveboardEmbed;
|
|
355
|
+
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
312
356
|
}
|
|
313
357
|
/**
|
|
314
358
|
* @hidden
|
|
@@ -339,7 +383,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
|
|
|
339
383
|
/**
|
|
340
384
|
* Boolean to determine if the search should be executed or not.
|
|
341
385
|
* if it is executed, put the focus on the results.
|
|
342
|
-
* if it’s not executed, put the focus in the search bar - at the end of
|
|
386
|
+
* if it’s not executed, put the focus in the search bar - at the end of
|
|
387
|
+
* the tokens
|
|
343
388
|
*/
|
|
344
389
|
executeSearch?: boolean;
|
|
345
390
|
}
|
|
@@ -364,12 +409,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
|
|
|
364
409
|
* using raw answer data.
|
|
365
410
|
*/
|
|
366
411
|
hideResults?: boolean;
|
|
367
|
-
/**
|
|
368
|
-
* If set to true, expands all the data sources panel.
|
|
369
|
-
*/
|
|
370
|
-
expandAllDataSource?: boolean;
|
|
371
412
|
/**
|
|
372
413
|
* If set to true, the Search Assist feature is enabled.
|
|
414
|
+
*
|
|
373
415
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
374
416
|
*/
|
|
375
417
|
enableSearchAssist?: boolean;
|
|
@@ -381,16 +423,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
|
|
|
381
423
|
/**
|
|
382
424
|
* The array of data source GUIDs to set on load.
|
|
383
425
|
* Only a single dataSource supported currently.
|
|
426
|
+
*
|
|
384
427
|
* @deprecated Use dataSource instead
|
|
385
428
|
*/
|
|
386
429
|
dataSources?: string[];
|
|
387
430
|
/**
|
|
388
431
|
* The array of data source GUIDs to set on load.
|
|
432
|
+
*
|
|
389
433
|
* @version: SDK: 1.19.0
|
|
390
434
|
*/
|
|
391
435
|
dataSource?: string;
|
|
392
436
|
/**
|
|
393
437
|
* The initial search query to load the answer with.
|
|
438
|
+
*
|
|
394
439
|
* @deprecated Use {@link searchOptions} instead
|
|
395
440
|
*/
|
|
396
441
|
searchQuery?: string;
|
|
@@ -405,6 +450,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
|
|
|
405
450
|
/**
|
|
406
451
|
* If set to true, search page will render without the Search Bar
|
|
407
452
|
* The chart/table should still be visible.
|
|
453
|
+
*
|
|
408
454
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
409
455
|
*/
|
|
410
456
|
hideSearchBar?: boolean;
|
|
@@ -421,6 +467,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
|
|
|
421
467
|
*/
|
|
422
468
|
protected viewConfig: SearchViewConfig;
|
|
423
469
|
constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
|
|
470
|
+
protected getEmbedParams(): string;
|
|
424
471
|
/**
|
|
425
472
|
* Render the embedded ThoughtSpot search
|
|
426
473
|
*/
|
|
@@ -439,11 +486,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
|
|
|
439
486
|
/**
|
|
440
487
|
* The array of data source GUIDs to set on load.
|
|
441
488
|
* Only a single dataSource supported currently.
|
|
489
|
+
*
|
|
442
490
|
* @deprecated Use dataSource instead
|
|
443
491
|
*/
|
|
444
492
|
dataSources?: string[];
|
|
445
493
|
/**
|
|
446
494
|
* The array of data source GUIDs to set on load.
|
|
495
|
+
*
|
|
447
496
|
* @version: SDK: 1.19.0
|
|
448
497
|
*/
|
|
449
498
|
dataSource?: string;
|
|
@@ -489,6 +538,7 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
|
|
|
489
538
|
/**
|
|
490
539
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
491
540
|
* of {@link AuthStatus.FAILURE}.
|
|
541
|
+
*
|
|
492
542
|
* @group Authentication / Init
|
|
493
543
|
*/
|
|
494
544
|
export enum AuthFailureType {
|
|
@@ -499,6 +549,7 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
|
|
|
499
549
|
}
|
|
500
550
|
/**
|
|
501
551
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
552
|
+
*
|
|
502
553
|
* @group Authentication / Init
|
|
503
554
|
*/
|
|
504
555
|
export enum AuthStatus {
|
|
@@ -522,31 +573,45 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
|
|
|
522
573
|
* Emitted when inPopup: true in the SAMLRedirect flow.
|
|
523
574
|
* And, we are waiting for popup to be triggered either programatically
|
|
524
575
|
* or by the trigger button.
|
|
576
|
+
*
|
|
525
577
|
* @version SDK: 1.19.0
|
|
526
578
|
*/
|
|
527
579
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
528
580
|
}
|
|
529
581
|
/**
|
|
530
582
|
* Event emitter returned from {@link init}.
|
|
583
|
+
*
|
|
531
584
|
* @group Authentication / Init
|
|
532
585
|
*/
|
|
533
586
|
export interface AuthEventEmitter {
|
|
534
587
|
/**
|
|
535
|
-
*
|
|
588
|
+
* Register a listener on Auth failure.
|
|
589
|
+
*
|
|
536
590
|
* @param event
|
|
537
591
|
* @param listener
|
|
538
592
|
*/
|
|
539
593
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
594
|
+
/**
|
|
595
|
+
* Register a listener on Auth SDK success.
|
|
596
|
+
*
|
|
597
|
+
* @param event
|
|
598
|
+
* @param listener
|
|
599
|
+
*/
|
|
540
600
|
on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
|
|
541
601
|
on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
602
|
+
once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
603
|
+
once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
|
|
604
|
+
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
542
605
|
/**
|
|
543
606
|
* Trigger an event on the emitter returned from init.
|
|
607
|
+
*
|
|
544
608
|
* @param {@link AuthEvent}
|
|
545
609
|
*/
|
|
546
610
|
emit(event: AuthEvent): void;
|
|
547
611
|
}
|
|
548
612
|
/**
|
|
549
613
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
614
|
+
*
|
|
550
615
|
* @group Authentication / Init
|
|
551
616
|
*/
|
|
552
617
|
export enum AuthEvent {
|
|
@@ -556,31 +621,58 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
|
|
|
556
621
|
*/
|
|
557
622
|
TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
|
|
558
623
|
}
|
|
624
|
+
/**
|
|
625
|
+
*
|
|
626
|
+
*/
|
|
559
627
|
export function getAuthEE(): EventEmitter<AuthStatus | AuthEvent>;
|
|
628
|
+
/**
|
|
629
|
+
*
|
|
630
|
+
* @param eventEmitter
|
|
631
|
+
*/
|
|
560
632
|
export function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): void;
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
*/
|
|
561
636
|
export function notifyAuthSDKSuccess(): void;
|
|
637
|
+
/**
|
|
638
|
+
*
|
|
639
|
+
*/
|
|
562
640
|
export function notifyAuthSuccess(): void;
|
|
641
|
+
/**
|
|
642
|
+
*
|
|
643
|
+
* @param failureType
|
|
644
|
+
*/
|
|
563
645
|
export function notifyAuthFailure(failureType: AuthFailureType): void;
|
|
646
|
+
/**
|
|
647
|
+
*
|
|
648
|
+
*/
|
|
564
649
|
export function notifyLogout(): void;
|
|
565
650
|
/**
|
|
566
651
|
* Return releaseVersion if available
|
|
567
652
|
*/
|
|
568
653
|
export function getReleaseVersion(): string;
|
|
569
654
|
/**
|
|
570
|
-
* Return a promise that resolves with the session information when
|
|
571
|
-
* successful. And info is available.
|
|
655
|
+
* Return a promise that resolves with the session information when
|
|
656
|
+
* authentication is successful. And info is available.
|
|
657
|
+
*
|
|
572
658
|
* @group Global methods
|
|
573
659
|
*/
|
|
574
660
|
export function getSessionInfo(): Promise<any>;
|
|
661
|
+
/**
|
|
662
|
+
*
|
|
663
|
+
* @param sessionDetails
|
|
664
|
+
*/
|
|
575
665
|
export function initSession(sessionDetails: any): void;
|
|
576
666
|
export const getAuthenticaionToken: (embedConfig: EmbedConfig) => Promise<any>;
|
|
577
667
|
/**
|
|
578
668
|
* Perform token based authentication
|
|
669
|
+
*
|
|
579
670
|
* @param embedConfig The embed configuration
|
|
580
671
|
*/
|
|
581
672
|
export const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
582
673
|
/**
|
|
583
674
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
675
|
+
*
|
|
584
676
|
* @param embedConfig The embed configuration
|
|
585
677
|
*/
|
|
586
678
|
export const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -590,6 +682,7 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
|
|
|
590
682
|
*
|
|
591
683
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
592
684
|
* strongly advised not to use this authentication method in production.
|
|
685
|
+
*
|
|
593
686
|
* @param embedConfig The embed configuration
|
|
594
687
|
*/
|
|
595
688
|
export const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -598,6 +691,7 @@ declare module '@thoughtspot/visual-embed-sdk/auth' {
|
|
|
598
691
|
export const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
599
692
|
/**
|
|
600
693
|
* Perform authentication on the ThoughtSpot cluster
|
|
694
|
+
*
|
|
601
695
|
* @param embedConfig The embed configuration
|
|
602
696
|
*/
|
|
603
697
|
export const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -611,27 +705,33 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
611
705
|
/**
|
|
612
706
|
* The authentication mechanism for allowing access to the
|
|
613
707
|
* the embedded app
|
|
708
|
+
*
|
|
614
709
|
* @group Authentication / Init
|
|
615
710
|
*/
|
|
616
711
|
export enum AuthType {
|
|
617
712
|
/**
|
|
618
|
-
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
713
|
+
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
714
|
+
* `Passthrough`.
|
|
619
715
|
*/
|
|
620
716
|
None = "None",
|
|
621
717
|
/**
|
|
622
|
-
* Passthrough SSO to the embedded App within the iframe. Requires least
|
|
623
|
-
* be supported by all IDPs. This will behave like `None`
|
|
718
|
+
* Passthrough SSO to the embedded App within the iframe. Requires least
|
|
719
|
+
* configuration, but may not be supported by all IDPs. This will behave like `None`
|
|
720
|
+
* if SSO is not configured on ThoughtSpot.
|
|
721
|
+
*
|
|
624
722
|
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
625
723
|
*/
|
|
626
724
|
EmbeddedSSO = "EmbeddedSSO",
|
|
627
725
|
/**
|
|
628
726
|
* SSO using SAML
|
|
727
|
+
*
|
|
629
728
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
630
729
|
* @hidden
|
|
631
730
|
*/
|
|
632
731
|
SSO = "SSO_SAML",
|
|
633
732
|
/**
|
|
634
733
|
* SSO using SAML
|
|
734
|
+
*
|
|
635
735
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
636
736
|
* @hidden
|
|
637
737
|
*/
|
|
@@ -639,6 +739,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
639
739
|
/**
|
|
640
740
|
* SSO using SAML
|
|
641
741
|
* Will make the host application redirect to the SAML Idp.
|
|
742
|
+
*
|
|
642
743
|
* @example
|
|
643
744
|
* ```js
|
|
644
745
|
* init({
|
|
@@ -652,6 +753,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
652
753
|
SAMLRedirect = "SSO_SAML",
|
|
653
754
|
/**
|
|
654
755
|
* SSO using OIDC
|
|
756
|
+
*
|
|
655
757
|
* @hidden
|
|
656
758
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
657
759
|
*/
|
|
@@ -663,14 +765,15 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
663
765
|
OIDCRedirect = "SSO_OIDC",
|
|
664
766
|
/**
|
|
665
767
|
* Trusted authentication server
|
|
768
|
+
*
|
|
666
769
|
* @hidden
|
|
667
770
|
* @deprecated Use {@link TrustedAuth} instead
|
|
668
771
|
*/
|
|
669
772
|
AuthServer = "AuthServer",
|
|
670
773
|
/**
|
|
671
774
|
* Trusted authentication server, Use your own authentication server
|
|
672
|
-
* which returns a bearer token, generated using the secret_key obtained
|
|
673
|
-
* ThoughtSpot.
|
|
775
|
+
* which returns a bearer token, generated using the secret_key obtained
|
|
776
|
+
* from ThoughtSpot.
|
|
674
777
|
*
|
|
675
778
|
* @example
|
|
676
779
|
* ```js
|
|
@@ -686,10 +789,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
686
789
|
*/
|
|
687
790
|
TrustedAuthToken = "AuthServer",
|
|
688
791
|
/**
|
|
689
|
-
* Trusted authentication server Cookieless, Use you own authentication
|
|
690
|
-
* which returns a bearer token, generated using the secret_key
|
|
691
|
-
* ThoughtSpot. This uses a cookieless authentication
|
|
692
|
-
* to by pass third-party cookie-blocking restriction
|
|
792
|
+
* Trusted authentication server Cookieless, Use you own authentication
|
|
793
|
+
* server which returns a bearer token, generated using the secret_key
|
|
794
|
+
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
795
|
+
* approach, recommended to by pass third-party cookie-blocking restriction
|
|
796
|
+
* implemented by some browsers
|
|
693
797
|
*/
|
|
694
798
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
695
799
|
/**
|
|
@@ -792,8 +896,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
792
896
|
*/
|
|
793
897
|
getAuthToken?: () => Promise<string>;
|
|
794
898
|
/**
|
|
795
|
-
* [AuthServer / Basic] The user name of the ThoughtSpot user. This
|
|
796
|
-
* required for trusted authentication.
|
|
899
|
+
* [AuthServer / Basic] The user name of the ThoughtSpot user. This
|
|
900
|
+
* attribute is required for trusted authentication.
|
|
797
901
|
*/
|
|
798
902
|
username?: string;
|
|
799
903
|
/**
|
|
@@ -804,16 +908,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
804
908
|
*/
|
|
805
909
|
password?: string;
|
|
806
910
|
/**
|
|
807
|
-
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
808
|
-
* flow in a popup, instead of redirecting browser in
|
|
911
|
+
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
912
|
+
* open the SAML auth flow in a popup, instead of redirecting browser in
|
|
913
|
+
* place.
|
|
809
914
|
*
|
|
810
915
|
* @default false
|
|
811
916
|
* @deprecated
|
|
812
917
|
*/
|
|
813
918
|
noRedirect?: boolean;
|
|
814
919
|
/**
|
|
815
|
-
* [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
|
|
816
|
-
* flow in a popup, instead of redirecting browser in place.
|
|
920
|
+
* [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
|
|
921
|
+
* the SAML auth flow in a popup, instead of redirecting browser in place.
|
|
817
922
|
*
|
|
818
923
|
* @default false
|
|
819
924
|
* @version SDK: 1.18.0
|
|
@@ -825,6 +930,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
825
930
|
* terminated.
|
|
826
931
|
*
|
|
827
932
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
933
|
+
*
|
|
828
934
|
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
|
|
829
935
|
*/
|
|
830
936
|
redirectPath?: string;
|
|
@@ -834,43 +940,52 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
834
940
|
* Should we encode URL Query Params using base64 encoding which thoughtspot
|
|
835
941
|
* will generate for embedding. This provides additional security to
|
|
836
942
|
* thoughtspot clusters against Cross site scripting attacks.
|
|
943
|
+
*
|
|
837
944
|
* @default false
|
|
838
945
|
*/
|
|
839
946
|
shouldEncodeUrlQueryParams?: boolean;
|
|
840
947
|
/**
|
|
841
|
-
* Suppress cookie access alert when third party cookies are blocked by the
|
|
842
|
-
* Third party cookie blocking is the default behaviour on
|
|
843
|
-
* If you set this to `true`, you are
|
|
948
|
+
* Suppress cookie access alert when third party cookies are blocked by the
|
|
949
|
+
* user's browser. Third party cookie blocking is the default behaviour on
|
|
950
|
+
* Safari and opt-in for Firefox/Chrome. If you set this to `true`, you are
|
|
951
|
+
* encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
844
952
|
* in this case.
|
|
953
|
+
*
|
|
845
954
|
* @default false
|
|
846
955
|
*/
|
|
847
956
|
suppressNoCookieAccessAlert?: boolean;
|
|
848
957
|
/**
|
|
849
958
|
* Re-login when session expires with the previous login options
|
|
959
|
+
*
|
|
850
960
|
* @default false
|
|
851
961
|
*/
|
|
852
962
|
autoLogin?: boolean;
|
|
853
963
|
/**
|
|
854
964
|
* Disable redirection to the login page when the embedded session expires
|
|
855
|
-
* This flag is typically used alongside the combination of auth modes such as {@link
|
|
965
|
+
* This flag is typically used alongside the combination of auth modes such as {@link
|
|
966
|
+
* AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
|
|
967
|
+
*
|
|
856
968
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
857
969
|
* @default false
|
|
858
970
|
*/
|
|
859
971
|
disableLoginRedirect?: boolean;
|
|
860
972
|
/**
|
|
861
973
|
* This message is displayed on the embed view when the login fails.
|
|
974
|
+
*
|
|
862
975
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
863
976
|
*/
|
|
864
977
|
loginFailedMessage?: string;
|
|
865
978
|
/**
|
|
866
979
|
* Calls the prefetch method internally when set to true
|
|
980
|
+
*
|
|
867
981
|
* @default false
|
|
868
982
|
*/
|
|
869
983
|
callPrefetch?: boolean;
|
|
870
984
|
/**
|
|
871
985
|
* When there are multiple embeds, queue the render of embed to start
|
|
872
|
-
* after the previous embed's render is complete. This helps in the load
|
|
873
|
-
* by decreasing the load on the browser.
|
|
986
|
+
* after the previous embed's render is complete. This helps in the load
|
|
987
|
+
* performance by decreasing the load on the browser.
|
|
988
|
+
*
|
|
874
989
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
875
990
|
* @default false
|
|
876
991
|
*/
|
|
@@ -878,15 +993,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
878
993
|
/**
|
|
879
994
|
* Dynamic CSS Url to be injected in the loaded application.
|
|
880
995
|
* You would also need to set `style-src` in the CSP settings.
|
|
996
|
+
*
|
|
881
997
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
882
998
|
* @default ''
|
|
883
999
|
*/
|
|
884
1000
|
customCssUrl?: string;
|
|
885
1001
|
/**
|
|
886
|
-
* [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an
|
|
887
|
-
* and should be avoided. Listen to the
|
|
1002
|
+
* [AuthServer|Basic] Detect if 3rd party cookies are enabled by doing an
|
|
1003
|
+
* additional call. This is slower and should be avoided. Listen to the
|
|
1004
|
+
* NO_COOKIE_ACCESS event to handle the situation.
|
|
1005
|
+
*
|
|
1006
|
+
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1007
|
+
* involves an extra network call.
|
|
888
1008
|
*
|
|
889
|
-
* This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
|
|
890
1009
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
891
1010
|
*/
|
|
892
1011
|
detectCookieAccessSlow?: boolean;
|
|
@@ -913,6 +1032,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
913
1032
|
/**
|
|
914
1033
|
* Text to show in the button which triggers the popup auth flow.
|
|
915
1034
|
* Default: "Authorize".
|
|
1035
|
+
*
|
|
916
1036
|
* @version SDK: 1.17.0 | ThoughtSpot: *
|
|
917
1037
|
*/
|
|
918
1038
|
authTriggerText?: string;
|
|
@@ -954,7 +1074,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
954
1074
|
*/
|
|
955
1075
|
layoutConfig?: LayoutConfig;
|
|
956
1076
|
/**
|
|
957
|
-
* The <b>width</b> and <b>height</b> dimensions to render an embedded
|
|
1077
|
+
* The <b>width</b> and <b>height</b> dimensions to render an embedded
|
|
1078
|
+
* object inside your app. Specify the values in pixels or percentage.
|
|
958
1079
|
*/
|
|
959
1080
|
frameParams?: FrameParams;
|
|
960
1081
|
/**
|
|
@@ -982,11 +1103,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
982
1103
|
/**
|
|
983
1104
|
* The list of actions to display from the primary menu, more menu
|
|
984
1105
|
* (...), and the contextual menu.
|
|
1106
|
+
*
|
|
985
1107
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
986
1108
|
*/
|
|
987
1109
|
visibleActions?: Action[];
|
|
988
1110
|
/**
|
|
989
1111
|
* Show alert messages and toast messages in the embedded view.
|
|
1112
|
+
*
|
|
990
1113
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
991
1114
|
*/
|
|
992
1115
|
showAlerts?: boolean;
|
|
@@ -997,6 +1120,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
997
1120
|
runtimeFilters?: RuntimeFilter[];
|
|
998
1121
|
/**
|
|
999
1122
|
* The locale/language to use for the embedded view.
|
|
1123
|
+
*
|
|
1000
1124
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
|
|
1001
1125
|
*/
|
|
1002
1126
|
locale?: string;
|
|
@@ -1007,6 +1131,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1007
1131
|
* Warning: This option is for advanced use only and is used internally
|
|
1008
1132
|
* to control embed behavior in non-regular ways. We do not publish the
|
|
1009
1133
|
* list of supported keys and values associated with each.
|
|
1134
|
+
*
|
|
1010
1135
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1011
1136
|
*/
|
|
1012
1137
|
additionalFlags?: {
|
|
@@ -1015,33 +1140,46 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1015
1140
|
/**
|
|
1016
1141
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
1017
1142
|
* You would also need to set `style-src` in the CSP settings.
|
|
1143
|
+
*
|
|
1018
1144
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
|
|
1019
1145
|
* @default ''
|
|
1020
1146
|
*/
|
|
1021
1147
|
customizations?: CustomisationsInterface;
|
|
1022
1148
|
/**
|
|
1023
|
-
* Insert as a sibling of the target container, instead of appending to a
|
|
1149
|
+
* Insert as a sibling of the target container, instead of appending to a
|
|
1150
|
+
* child inside it.
|
|
1024
1151
|
*/
|
|
1025
1152
|
insertAsSibling?: boolean;
|
|
1026
1153
|
/**
|
|
1027
1154
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
1155
|
+
*
|
|
1028
1156
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1029
1157
|
*/
|
|
1030
1158
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
1031
1159
|
/**
|
|
1032
1160
|
* flag to override openNew tab context menu link
|
|
1161
|
+
*
|
|
1033
1162
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1034
1163
|
*/
|
|
1035
1164
|
linkOverride?: boolean;
|
|
1036
1165
|
/**
|
|
1037
1166
|
* flag to enable insert into slides action
|
|
1167
|
+
*
|
|
1038
1168
|
* @hidden
|
|
1039
1169
|
* @private
|
|
1040
1170
|
*/
|
|
1041
1171
|
insertInToSlide?: boolean;
|
|
1172
|
+
/**
|
|
1173
|
+
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
1174
|
+
* if available and matches the configuration.
|
|
1175
|
+
*
|
|
1176
|
+
* See [docs]() on how to create a prerender pool.
|
|
1177
|
+
*/
|
|
1178
|
+
usePrerenderedIfAvailable?: boolean;
|
|
1042
1179
|
}
|
|
1043
1180
|
/**
|
|
1044
1181
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
1182
|
+
*
|
|
1045
1183
|
* @group Events
|
|
1046
1184
|
*/
|
|
1047
1185
|
export type MessagePayload = {
|
|
@@ -1050,21 +1188,37 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1050
1188
|
status?: string;
|
|
1051
1189
|
};
|
|
1052
1190
|
/**
|
|
1053
|
-
* MessageOptions: By Providing options, getting specific event start / end based on
|
|
1191
|
+
* MessageOptions: By Providing options, getting specific event start / end based on
|
|
1192
|
+
* option
|
|
1193
|
+
*
|
|
1054
1194
|
* @group Events
|
|
1055
1195
|
*/
|
|
1056
1196
|
export type MessageOptions = {
|
|
1197
|
+
/**
|
|
1198
|
+
* A boolean value indicating that start status events of this type
|
|
1199
|
+
* will be dispatched
|
|
1200
|
+
*/
|
|
1057
1201
|
start?: boolean;
|
|
1058
1202
|
};
|
|
1059
1203
|
/**
|
|
1060
1204
|
* MessageCallback: Embed event message callback
|
|
1205
|
+
*
|
|
1061
1206
|
* @group Events
|
|
1062
1207
|
*/
|
|
1063
|
-
export type MessageCallback = (payload: MessagePayload,
|
|
1208
|
+
export type MessageCallback = (payload: MessagePayload,
|
|
1209
|
+
/**
|
|
1210
|
+
* responder: Message callback function triggered when embed event
|
|
1211
|
+
* initiated
|
|
1212
|
+
*/
|
|
1213
|
+
responder?: (data: any) => void) => void;
|
|
1064
1214
|
/**
|
|
1065
1215
|
* MessageCallbackObj: contains message options & callback function
|
|
1066
1216
|
*/
|
|
1067
1217
|
export type MessageCallbackObj = {
|
|
1218
|
+
/**
|
|
1219
|
+
* options: It contains start, A boolean value indicating that start
|
|
1220
|
+
* status events of this type will be dispatched
|
|
1221
|
+
*/
|
|
1068
1222
|
options: MessageOptions;
|
|
1069
1223
|
callback: MessageCallback;
|
|
1070
1224
|
};
|
|
@@ -1148,7 +1302,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1148
1302
|
operator: RuntimeFilterOp;
|
|
1149
1303
|
/**
|
|
1150
1304
|
* The list of operands. Some operators like EQ, LE accept
|
|
1151
|
-
* a single operand, whereas other operators like BW and IN accept multiple
|
|
1305
|
+
* a single operand, whereas other operators like BW and IN accept multiple
|
|
1306
|
+
* operands.
|
|
1152
1307
|
*/
|
|
1153
1308
|
values: (number | boolean | string)[];
|
|
1154
1309
|
}
|
|
@@ -1157,31 +1312,37 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1157
1312
|
*
|
|
1158
1313
|
* To add an event listener use the corresponding
|
|
1159
1314
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
1315
|
+
*
|
|
1160
1316
|
* @group Events
|
|
1161
1317
|
*/
|
|
1162
1318
|
export enum EmbedEvent {
|
|
1163
1319
|
/**
|
|
1164
1320
|
* Rendering has initialized.
|
|
1165
|
-
*
|
|
1321
|
+
*
|
|
1322
|
+
* @returns timestamp - The timestamp when the event was generated.
|
|
1166
1323
|
*/
|
|
1167
1324
|
Init = "init",
|
|
1168
1325
|
/**
|
|
1169
1326
|
* Authentication has either succeeded or failed.
|
|
1170
|
-
*
|
|
1327
|
+
*
|
|
1328
|
+
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
1171
1329
|
*/
|
|
1172
1330
|
AuthInit = "authInit",
|
|
1173
1331
|
/**
|
|
1174
1332
|
* The embed object container has loaded.
|
|
1175
|
-
*
|
|
1333
|
+
*
|
|
1334
|
+
* @returns timestamp - The timestamp when the event was generated.
|
|
1176
1335
|
*/
|
|
1177
1336
|
Load = "load",
|
|
1178
1337
|
/**
|
|
1179
1338
|
* Data pertaining to answer or Liveboard is received
|
|
1180
|
-
*
|
|
1339
|
+
*
|
|
1340
|
+
* @returns data - The answer or Liveboard data
|
|
1181
1341
|
*/
|
|
1182
1342
|
Data = "data",
|
|
1183
1343
|
/**
|
|
1184
1344
|
* Search/answer/Liveboard filters have been applied/updated
|
|
1345
|
+
*
|
|
1185
1346
|
* @hidden
|
|
1186
1347
|
*/
|
|
1187
1348
|
FiltersChanged = "filtersChanged",
|
|
@@ -1191,48 +1352,56 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1191
1352
|
QueryChanged = "queryChanged",
|
|
1192
1353
|
/**
|
|
1193
1354
|
* A drill down operation has been performed.
|
|
1194
|
-
*
|
|
1195
|
-
* @
|
|
1196
|
-
* @
|
|
1355
|
+
*
|
|
1356
|
+
* @returns additionalFilters - Any additional filters applied
|
|
1357
|
+
* @returns drillDownColumns - The columns on which drill down was performed
|
|
1358
|
+
* @returns nonFilteredColumns - The columns that were not filtered
|
|
1197
1359
|
*/
|
|
1198
1360
|
Drilldown = "drillDown",
|
|
1199
1361
|
/**
|
|
1200
1362
|
* One or more data sources have been selected.
|
|
1201
|
-
*
|
|
1363
|
+
*
|
|
1364
|
+
* @returns dataSourceIds - the list of data sources
|
|
1202
1365
|
*/
|
|
1203
1366
|
DataSourceSelected = "dataSourceSelected",
|
|
1204
1367
|
/**
|
|
1205
1368
|
* One or more data columns have been selected.
|
|
1206
|
-
*
|
|
1369
|
+
*
|
|
1370
|
+
* @returns columnIds - the list of columns
|
|
1207
1371
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
1208
1372
|
*/
|
|
1209
1373
|
AddRemoveColumns = "addRemoveColumns",
|
|
1210
1374
|
/**
|
|
1211
1375
|
* A custom action has been triggered
|
|
1212
|
-
*
|
|
1213
|
-
* @
|
|
1376
|
+
*
|
|
1377
|
+
* @returns actionId - The id of the custom action
|
|
1378
|
+
* @returns data - The answer or Liveboard data
|
|
1214
1379
|
*/
|
|
1215
1380
|
CustomAction = "customAction",
|
|
1216
1381
|
/**
|
|
1217
1382
|
* A double click has been triggered on table/chart
|
|
1218
|
-
*
|
|
1383
|
+
*
|
|
1384
|
+
* @returns ContextMenuInputPoints - data point that is double clicked
|
|
1219
1385
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1220
1386
|
*/
|
|
1221
1387
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
1222
1388
|
/**
|
|
1223
1389
|
* A click has been triggered on table/chart
|
|
1224
|
-
*
|
|
1390
|
+
*
|
|
1391
|
+
* @returns ContextMenuInputPoints - data point that is clicked
|
|
1225
1392
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1226
1393
|
*/
|
|
1227
1394
|
VizPointClick = "vizPointClick",
|
|
1228
1395
|
/**
|
|
1229
1396
|
* An error has occurred.
|
|
1230
|
-
*
|
|
1397
|
+
*
|
|
1398
|
+
* @returns error - An error object or message
|
|
1231
1399
|
*/
|
|
1232
1400
|
Error = "Error",
|
|
1233
1401
|
/**
|
|
1234
1402
|
* The embedded object has sent an alert
|
|
1235
|
-
*
|
|
1403
|
+
*
|
|
1404
|
+
* @returns alert - An alert object
|
|
1236
1405
|
*/
|
|
1237
1406
|
Alert = "alert",
|
|
1238
1407
|
/**
|
|
@@ -1241,29 +1410,34 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1241
1410
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
1242
1411
|
/**
|
|
1243
1412
|
* ThoughtSpot failed to validate the auth session.
|
|
1413
|
+
*
|
|
1244
1414
|
* @hidden
|
|
1245
1415
|
*/
|
|
1246
1416
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
1247
1417
|
/**
|
|
1248
1418
|
* ThoughtSpot failed to validate the auth session.
|
|
1419
|
+
*
|
|
1249
1420
|
* @hidden
|
|
1250
1421
|
*/
|
|
1251
1422
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
1252
1423
|
/**
|
|
1253
1424
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
1254
|
-
*
|
|
1425
|
+
*
|
|
1426
|
+
* @returns data - The height of the embedded Liveboard or visualization
|
|
1255
1427
|
* @hidden
|
|
1256
1428
|
*/
|
|
1257
1429
|
EmbedHeight = "EMBED_HEIGHT",
|
|
1258
1430
|
/**
|
|
1259
1431
|
* The center of visible iframe viewport is calculated.
|
|
1260
|
-
*
|
|
1432
|
+
*
|
|
1433
|
+
* @returns data - The center of the visible Iframe viewport.
|
|
1261
1434
|
* @hidden
|
|
1262
1435
|
*/
|
|
1263
1436
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
1264
1437
|
/**
|
|
1265
1438
|
* Emitted when the "Get Data" button in Search Bar embed
|
|
1266
1439
|
* is clicked.
|
|
1440
|
+
*
|
|
1267
1441
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.0-sw
|
|
1268
1442
|
*/
|
|
1269
1443
|
GetDataClick = "getDataClick",
|
|
@@ -1273,6 +1447,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1273
1447
|
RouteChange = "ROUTE_CHANGE",
|
|
1274
1448
|
/**
|
|
1275
1449
|
* The v1 event type for Data
|
|
1450
|
+
*
|
|
1276
1451
|
* @hidden
|
|
1277
1452
|
*/
|
|
1278
1453
|
V1Data = "exportVizDataToParent",
|
|
@@ -1285,17 +1460,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1285
1460
|
NoCookieAccess = "noCookieAccess",
|
|
1286
1461
|
/**
|
|
1287
1462
|
* Emitted when SAML is complete
|
|
1463
|
+
*
|
|
1288
1464
|
* @private
|
|
1289
1465
|
* @hidden
|
|
1290
1466
|
*/
|
|
1291
1467
|
SAMLComplete = "samlComplete",
|
|
1292
1468
|
/**
|
|
1293
1469
|
* Emitted when any modal is opened in the app
|
|
1470
|
+
*
|
|
1294
1471
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
1295
1472
|
*/
|
|
1296
1473
|
DialogOpen = "dialog-open",
|
|
1297
1474
|
/**
|
|
1298
1475
|
* Emitted when any modal is closed in the app
|
|
1476
|
+
*
|
|
1299
1477
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
1300
1478
|
*/
|
|
1301
1479
|
DialogClose = "dialog-close",
|
|
@@ -1303,192 +1481,244 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1303
1481
|
* Emitted when the Liveboard shell loads.
|
|
1304
1482
|
* You can use this event as a hook to trigger
|
|
1305
1483
|
* other events on the rendered Liveboard.
|
|
1484
|
+
*
|
|
1306
1485
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1307
1486
|
*/
|
|
1308
1487
|
LiveboardRendered = "PinboardRendered",
|
|
1309
1488
|
/**
|
|
1310
1489
|
* This can be used to register an event listener which
|
|
1311
1490
|
* is triggered on all events.
|
|
1491
|
+
*
|
|
1312
1492
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
1313
1493
|
*/
|
|
1314
1494
|
ALL = "*",
|
|
1315
1495
|
/**
|
|
1316
1496
|
* Emitted when answer is saved in the app
|
|
1497
|
+
*
|
|
1317
1498
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1318
1499
|
*/
|
|
1319
1500
|
Save = "save",
|
|
1320
1501
|
/**
|
|
1321
1502
|
* Emitted when the download action is triggered on an answer
|
|
1503
|
+
*
|
|
1322
1504
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1323
1505
|
*/
|
|
1324
1506
|
Download = "download",
|
|
1507
|
+
/**
|
|
1508
|
+
* Emitted when the download action is triggered on an answer
|
|
1509
|
+
*
|
|
1510
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
|
|
1511
|
+
*/
|
|
1512
|
+
DownloadAsPng = "downloadAsPng",
|
|
1325
1513
|
/**
|
|
1326
1514
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
1515
|
+
*
|
|
1327
1516
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1328
1517
|
*/
|
|
1329
1518
|
DownloadAsPdf = "downloadAsPdf",
|
|
1330
1519
|
/**
|
|
1331
1520
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
1521
|
+
*
|
|
1332
1522
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1333
1523
|
*/
|
|
1334
1524
|
DownloadAsCsv = "downloadAsCsv",
|
|
1335
1525
|
/**
|
|
1336
1526
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1527
|
+
*
|
|
1337
1528
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1338
1529
|
*/
|
|
1339
1530
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
1340
1531
|
/**
|
|
1341
1532
|
* Emitted when an answer is deleted in the app
|
|
1533
|
+
*
|
|
1342
1534
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1343
1535
|
*/
|
|
1344
1536
|
AnswerDelete = "answerDelete",
|
|
1345
1537
|
/**
|
|
1346
1538
|
* Emitted when an answer is pinned to a Liveboard
|
|
1539
|
+
*
|
|
1347
1540
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1348
1541
|
*/
|
|
1349
1542
|
Pin = "pin",
|
|
1350
1543
|
/**
|
|
1351
1544
|
* Emitted when SpotIQ analysis is triggered
|
|
1545
|
+
*
|
|
1352
1546
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1353
1547
|
*/
|
|
1354
1548
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1355
1549
|
/**
|
|
1356
1550
|
* Emitted when a user shares an object with another user or group
|
|
1551
|
+
*
|
|
1357
1552
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1358
1553
|
*/
|
|
1359
1554
|
Share = "share",
|
|
1360
1555
|
/**
|
|
1361
|
-
* Emitted when a user clicks the Include action to include a specific value or data
|
|
1556
|
+
* Emitted when a user clicks the Include action to include a specific value or data
|
|
1557
|
+
* on a chart or table
|
|
1558
|
+
*
|
|
1362
1559
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1363
1560
|
*/
|
|
1364
1561
|
DrillInclude = "context-menu-item-include",
|
|
1365
1562
|
/**
|
|
1366
|
-
* Emitted when a user clicks the Exclude action to exclude a specific value or data
|
|
1563
|
+
* Emitted when a user clicks the Exclude action to exclude a specific value or data
|
|
1564
|
+
* on a chart or table
|
|
1565
|
+
*
|
|
1367
1566
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1368
1567
|
*/
|
|
1369
1568
|
DrillExclude = "context-menu-item-exclude",
|
|
1370
1569
|
/**
|
|
1371
1570
|
* Emitted when copied column value on the app
|
|
1571
|
+
*
|
|
1372
1572
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1373
1573
|
*/
|
|
1374
1574
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
1375
1575
|
/**
|
|
1376
1576
|
* Emitted when a user clicks the Update TML action
|
|
1577
|
+
*
|
|
1377
1578
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1378
1579
|
*/
|
|
1379
1580
|
UpdateTML = "updateTSL",
|
|
1380
1581
|
/**
|
|
1381
1582
|
* Emitted when a user clicks the Edit TML action
|
|
1583
|
+
*
|
|
1382
1584
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1383
1585
|
*/
|
|
1384
1586
|
EditTML = "editTSL",
|
|
1385
1587
|
/**
|
|
1386
1588
|
* Emitted when ExportTML trigger in answer on the app
|
|
1589
|
+
*
|
|
1387
1590
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1388
1591
|
*/
|
|
1389
1592
|
ExportTML = "exportTSL",
|
|
1390
1593
|
/**
|
|
1391
1594
|
* Emitted when an answer is saved as a view
|
|
1595
|
+
*
|
|
1392
1596
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1393
1597
|
*/
|
|
1394
1598
|
SaveAsView = "saveAsView",
|
|
1395
1599
|
/**
|
|
1396
1600
|
* Emitted when copy of existing answer on the app
|
|
1601
|
+
*
|
|
1397
1602
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1398
1603
|
*/
|
|
1399
1604
|
CopyAEdit = "copyAEdit",
|
|
1400
1605
|
/**
|
|
1401
1606
|
* Emitted when a user clicks Show underlying data on an answe
|
|
1607
|
+
*
|
|
1402
1608
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1403
1609
|
*/
|
|
1404
1610
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1405
1611
|
/**
|
|
1406
1612
|
* Emitted when an answer is switched to a chart or table view
|
|
1613
|
+
*
|
|
1407
1614
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
1408
1615
|
*/
|
|
1409
1616
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
1410
1617
|
/**
|
|
1411
1618
|
* Internal event to communicate the initial settings back to the TS APP
|
|
1619
|
+
*
|
|
1412
1620
|
* @hidden
|
|
1413
1621
|
*/
|
|
1414
1622
|
APP_INIT = "appInit",
|
|
1415
1623
|
/**
|
|
1416
1624
|
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
1625
|
+
*
|
|
1417
1626
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1418
1627
|
*/
|
|
1419
1628
|
LiveboardInfo = "pinboardInfo",
|
|
1420
1629
|
/**
|
|
1421
1630
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1631
|
+
*
|
|
1422
1632
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1423
1633
|
*/
|
|
1424
1634
|
AddToFavorites = "addToFavorites",
|
|
1425
1635
|
/**
|
|
1426
1636
|
* Emitted when a user clicks Schedule on a Liveboard
|
|
1637
|
+
*
|
|
1427
1638
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1428
1639
|
*/
|
|
1429
1640
|
Schedule = "subscription",
|
|
1430
1641
|
/**
|
|
1431
1642
|
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
1643
|
+
*
|
|
1432
1644
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1433
1645
|
*/
|
|
1434
1646
|
Edit = "edit",
|
|
1435
1647
|
/**
|
|
1436
1648
|
* Emitted when a user clicks Make a copy on a Liveboard
|
|
1649
|
+
*
|
|
1437
1650
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1438
1651
|
*/
|
|
1439
1652
|
MakeACopy = "makeACopy",
|
|
1440
1653
|
/**
|
|
1441
1654
|
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
1655
|
+
*
|
|
1442
1656
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1443
1657
|
*/
|
|
1444
1658
|
Present = "present",
|
|
1445
1659
|
/**
|
|
1446
1660
|
* Emitted when a user clicks Delete on a Liveboard
|
|
1661
|
+
*
|
|
1447
1662
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1448
1663
|
*/
|
|
1449
1664
|
Delete = "delete",
|
|
1450
1665
|
/**
|
|
1451
1666
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1667
|
+
*
|
|
1452
1668
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1453
1669
|
*/
|
|
1454
1670
|
SchedulesList = "schedule-list",
|
|
1455
1671
|
/**
|
|
1456
1672
|
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
1673
|
+
*
|
|
1457
1674
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1458
1675
|
*/
|
|
1459
1676
|
Cancel = "cancel",
|
|
1460
1677
|
/**
|
|
1461
1678
|
* Emitted when a user clicks Explore on a visualization
|
|
1679
|
+
*
|
|
1462
1680
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1463
1681
|
*/
|
|
1464
1682
|
Explore = "explore",
|
|
1465
1683
|
/**
|
|
1466
1684
|
* Emitted when a user clicks Copy link action on a visualization
|
|
1685
|
+
*
|
|
1467
1686
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1468
1687
|
*/
|
|
1469
1688
|
CopyLink = "embedDocument",
|
|
1470
1689
|
/**
|
|
1471
1690
|
* Emitted when a user interacts with cross filters on a visualization or liveboard
|
|
1691
|
+
*
|
|
1472
1692
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1473
1693
|
*/
|
|
1474
1694
|
CrossFilterChanged = "cross-filter-changed",
|
|
1475
1695
|
/**
|
|
1476
1696
|
* Emitted when a user right clicks on chart or table
|
|
1697
|
+
*
|
|
1477
1698
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1478
1699
|
*/
|
|
1479
|
-
VizPointRightClick = "vizPointRightClick"
|
|
1700
|
+
VizPointRightClick = "vizPointRightClick",
|
|
1701
|
+
/**
|
|
1702
|
+
* Emitted when a user clicks on Insert to slide on a visualization
|
|
1703
|
+
*
|
|
1704
|
+
* @hidden
|
|
1705
|
+
*/
|
|
1706
|
+
InsertIntoSlide = "insertInToSlide"
|
|
1480
1707
|
}
|
|
1481
1708
|
/**
|
|
1482
1709
|
* Event types that can be triggered by the host application
|
|
1483
1710
|
* to the embedded ThoughtSpot app
|
|
1484
1711
|
*
|
|
1485
1712
|
* To trigger an event use the corresponding
|
|
1486
|
-
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
1713
|
+
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
1714
|
+
* SearchEmbed.trigger} method.
|
|
1715
|
+
*
|
|
1487
1716
|
* @group Events
|
|
1488
1717
|
*/
|
|
1489
1718
|
export enum HostEvent {
|
|
1490
1719
|
/**
|
|
1491
1720
|
* Trigger a search
|
|
1721
|
+
*
|
|
1492
1722
|
* @param - dataSourceIds - The data source GUID to Search on
|
|
1493
1723
|
* - Although an array, only a single source
|
|
1494
1724
|
* is supported at this time.
|
|
@@ -1506,10 +1736,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1506
1736
|
Search = "search",
|
|
1507
1737
|
/**
|
|
1508
1738
|
* Trigger a drill on certain points by certain column
|
|
1739
|
+
*
|
|
1509
1740
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
1510
1741
|
* eg. { selectedPoints: []}
|
|
1511
1742
|
* @param - columnGuid - a string guid of the column to drill by. This is optional,
|
|
1512
|
-
* if not provided it will auto drill by the configured
|
|
1743
|
+
* if not provided it will auto drill by the configured
|
|
1744
|
+
* column.
|
|
1513
1745
|
* @example
|
|
1514
1746
|
* ```js
|
|
1515
1747
|
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
@@ -1517,44 +1749,50 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1517
1749
|
* autoDrillDown: true,
|
|
1518
1750
|
* })
|
|
1519
1751
|
* ```
|
|
1520
|
-
*
|
|
1521
1752
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1522
1753
|
*/
|
|
1523
1754
|
DrillDown = "triggerDrillDown",
|
|
1524
1755
|
/**
|
|
1525
1756
|
* Apply filters
|
|
1757
|
+
*
|
|
1526
1758
|
* @hidden
|
|
1527
1759
|
*/
|
|
1528
1760
|
Filter = "filter",
|
|
1529
1761
|
/**
|
|
1530
1762
|
* Reload the answer or visualization
|
|
1763
|
+
*
|
|
1531
1764
|
* @hidden
|
|
1532
1765
|
*/
|
|
1533
1766
|
Reload = "reload",
|
|
1534
1767
|
/**
|
|
1535
1768
|
* Set the visible visualizations on a Liveboard.
|
|
1769
|
+
*
|
|
1536
1770
|
* @param - an array of ids of visualizations to show, the ids not passed
|
|
1537
1771
|
* will be hidden.
|
|
1538
1772
|
* @example
|
|
1539
|
-
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
1773
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
1774
|
+
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
1775
|
+
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
1540
1776
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
|
|
1541
1777
|
*/
|
|
1542
1778
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
1543
1779
|
/**
|
|
1544
1780
|
* Update the runtime filters. The runtime filters passed here are extended
|
|
1545
1781
|
* on to the existing runtime filters if they exist.
|
|
1782
|
+
*
|
|
1546
1783
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
1547
1784
|
* @example
|
|
1548
1785
|
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
1549
1786
|
* {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
|
|
1550
|
-
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values:
|
|
1551
|
-
* ])
|
|
1787
|
+
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values:
|
|
1788
|
+
* ["Jackets"]} ])
|
|
1552
1789
|
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1553
1790
|
*/
|
|
1554
1791
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
1555
1792
|
/**
|
|
1556
1793
|
* Navigate to a specific page in App embed without any reload.
|
|
1557
1794
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
1795
|
+
*
|
|
1558
1796
|
* @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
|
|
1559
1797
|
* @example
|
|
1560
1798
|
* ```js
|
|
@@ -1566,16 +1804,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1566
1804
|
/**
|
|
1567
1805
|
* Opens the filter panel for a particular column.
|
|
1568
1806
|
* Works with Search embed.
|
|
1569
|
-
*
|
|
1807
|
+
*
|
|
1808
|
+
* @param - { columnId: string,
|
|
1809
|
+
* name: string,
|
|
1810
|
+
* type: INT64/CHAR/DATE,
|
|
1811
|
+
* dataType: ATTRIBUTE/MEASURE }
|
|
1570
1812
|
* @example
|
|
1571
1813
|
* ```js
|
|
1572
|
-
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
1814
|
+
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
1815
|
+
* { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
|
|
1573
1816
|
* ```
|
|
1574
1817
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
1575
1818
|
*/
|
|
1576
1819
|
OpenFilter = "openFilter",
|
|
1577
1820
|
/**
|
|
1578
1821
|
* Adds the columns to the current Search.
|
|
1822
|
+
*
|
|
1579
1823
|
* @param - { columnIds: string[] }
|
|
1580
1824
|
* @example
|
|
1581
1825
|
* ```js
|
|
@@ -1586,6 +1830,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1586
1830
|
AddColumns = "addColumns",
|
|
1587
1831
|
/**
|
|
1588
1832
|
* Removes a column from the current Search.
|
|
1833
|
+
*
|
|
1589
1834
|
* @param - { columnId: string }
|
|
1590
1835
|
* @example
|
|
1591
1836
|
* ```js
|
|
@@ -1596,6 +1841,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1596
1841
|
RemoveColumn = "removeColumn",
|
|
1597
1842
|
/**
|
|
1598
1843
|
* Gets the current pinboard content.
|
|
1844
|
+
*
|
|
1599
1845
|
* @example
|
|
1600
1846
|
* ```js
|
|
1601
1847
|
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
|
|
@@ -1605,6 +1851,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1605
1851
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
1606
1852
|
/**
|
|
1607
1853
|
* Triggers the Pin action on an embedded object
|
|
1854
|
+
*
|
|
1608
1855
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
1609
1856
|
* can be left empty for search and visualization embeds
|
|
1610
1857
|
* @example
|
|
@@ -1618,6 +1865,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1618
1865
|
Pin = "pin",
|
|
1619
1866
|
/**
|
|
1620
1867
|
* Triggers the Show Liveboard details action on a Liveboard
|
|
1868
|
+
*
|
|
1621
1869
|
* @example
|
|
1622
1870
|
* ```js
|
|
1623
1871
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -1627,6 +1875,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1627
1875
|
LiveboardInfo = "pinboardInfo",
|
|
1628
1876
|
/**
|
|
1629
1877
|
* Triggers the Schedule action on a Liveboard
|
|
1878
|
+
*
|
|
1630
1879
|
* @example
|
|
1631
1880
|
* ```js
|
|
1632
1881
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -1636,6 +1885,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1636
1885
|
Schedule = "subscription",
|
|
1637
1886
|
/**
|
|
1638
1887
|
* Triggers the Manage schedule action on a Liveboard
|
|
1888
|
+
*
|
|
1639
1889
|
* @example
|
|
1640
1890
|
* ```js
|
|
1641
1891
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -1645,6 +1895,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1645
1895
|
SchedulesList = "schedule-list",
|
|
1646
1896
|
/**
|
|
1647
1897
|
* Triggers the Export TML action on a Liveboard
|
|
1898
|
+
*
|
|
1648
1899
|
* @example
|
|
1649
1900
|
* ```js
|
|
1650
1901
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
@@ -1654,6 +1905,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1654
1905
|
ExportTML = "exportTSL",
|
|
1655
1906
|
/**
|
|
1656
1907
|
* Triggers the Edit TML action on a Liveboard
|
|
1908
|
+
*
|
|
1657
1909
|
* @example
|
|
1658
1910
|
* ```js
|
|
1659
1911
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -1663,6 +1915,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1663
1915
|
EditTML = "editTSL",
|
|
1664
1916
|
/**
|
|
1665
1917
|
* Triggers the Update TML action on a Liveboard
|
|
1918
|
+
*
|
|
1666
1919
|
* @example
|
|
1667
1920
|
* ```js
|
|
1668
1921
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -1672,6 +1925,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1672
1925
|
UpdateTML = "updateTSL",
|
|
1673
1926
|
/**
|
|
1674
1927
|
* Triggers the Download PDF action on a Liveboard
|
|
1928
|
+
*
|
|
1675
1929
|
* @example
|
|
1676
1930
|
* ```js
|
|
1677
1931
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
|
|
@@ -1681,6 +1935,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1681
1935
|
DownloadAsPdf = "downloadAsPdf",
|
|
1682
1936
|
/**
|
|
1683
1937
|
* Triggers the Make a copy action on a Liveboard, search or visualization
|
|
1938
|
+
*
|
|
1684
1939
|
* @example
|
|
1685
1940
|
* ```js
|
|
1686
1941
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -1692,6 +1947,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1692
1947
|
MakeACopy = "makeACopy",
|
|
1693
1948
|
/**
|
|
1694
1949
|
* Triggers the Delete action on a Liveboard
|
|
1950
|
+
*
|
|
1695
1951
|
* @example
|
|
1696
1952
|
* ```js
|
|
1697
1953
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -1701,6 +1957,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1701
1957
|
Remove = "delete",
|
|
1702
1958
|
/**
|
|
1703
1959
|
* Triggers the Explore action on a visualization
|
|
1960
|
+
*
|
|
1704
1961
|
* @param - an object with vizId as a key
|
|
1705
1962
|
* @example
|
|
1706
1963
|
* ```js
|
|
@@ -1711,37 +1968,48 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1711
1968
|
Explore = "explore",
|
|
1712
1969
|
/**
|
|
1713
1970
|
* Triggers the Create alert action on a visualization
|
|
1971
|
+
*
|
|
1714
1972
|
* @param - an object with vizId as a key
|
|
1715
1973
|
* @example
|
|
1716
1974
|
* ```js
|
|
1717
|
-
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
1975
|
+
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
1976
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1977
|
+
* })
|
|
1718
1978
|
* ```
|
|
1719
1979
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1720
1980
|
*/
|
|
1721
1981
|
CreateMonitor = "createMonitor",
|
|
1722
1982
|
/**
|
|
1723
1983
|
* Triggers the Manage alert action on a visualization
|
|
1984
|
+
*
|
|
1724
1985
|
* @param - an object with vizId as a key
|
|
1725
1986
|
* @example
|
|
1726
1987
|
* ```js
|
|
1727
|
-
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
1988
|
+
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
1989
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1990
|
+
* })
|
|
1728
1991
|
* ```
|
|
1729
1992
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1730
1993
|
*/
|
|
1731
1994
|
ManageMonitor = "manageMonitor",
|
|
1732
1995
|
/**
|
|
1733
1996
|
* Triggers the Edit action on a Liveboard or visualization
|
|
1734
|
-
*
|
|
1997
|
+
*
|
|
1998
|
+
* @param - object - to trigger the action for a specfic visualization
|
|
1999
|
+
* in Liveboard embed, pass in vizId as a key
|
|
1735
2000
|
* @example
|
|
1736
2001
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
1737
|
-
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
2002
|
+
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
2003
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1738
2004
|
* vizEmbed.trigger((HostEvent.Edit)
|
|
1739
2005
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
1740
2006
|
*/
|
|
1741
2007
|
Edit = "edit",
|
|
1742
2008
|
/**
|
|
1743
2009
|
* Triggers the Copy link action on a Liveboard or visualization
|
|
1744
|
-
*
|
|
2010
|
+
*
|
|
2011
|
+
* @param - object - to trigger the action for a s
|
|
2012
|
+
* pecfic visualization in Liveboard embed, pass in vizId as a key
|
|
1745
2013
|
* @example
|
|
1746
2014
|
* ```js
|
|
1747
2015
|
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
@@ -1753,7 +2021,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1753
2021
|
CopyLink = "embedDocument",
|
|
1754
2022
|
/**
|
|
1755
2023
|
* Triggers the Present action on a Liveboard or visualization
|
|
1756
|
-
*
|
|
2024
|
+
*
|
|
2025
|
+
* @param - object - to trigger the action for a specfic visualization
|
|
2026
|
+
* in Liveboard embed, pass in vizId as a key
|
|
1757
2027
|
* @example
|
|
1758
2028
|
* ```js
|
|
1759
2029
|
* liveboardEmbed.trigger(HostEvent.Present)
|
|
@@ -1765,18 +2035,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1765
2035
|
Present = "present",
|
|
1766
2036
|
/**
|
|
1767
2037
|
* Get TML for the current search.
|
|
2038
|
+
*
|
|
1768
2039
|
* @example
|
|
1769
2040
|
* ```js
|
|
1770
2041
|
* searchEmbed.trigger(HostEvent.GetTML)
|
|
1771
2042
|
* ```
|
|
1772
|
-
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
|
|
2043
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
|
|
1773
2044
|
*/
|
|
1774
2045
|
GetTML = "getTML",
|
|
1775
2046
|
/**
|
|
1776
2047
|
* Triggers the ShowUnderlyingData action on visualization or search
|
|
2048
|
+
*
|
|
1777
2049
|
* @param - an object with vizId as a key
|
|
1778
2050
|
* @example
|
|
1779
|
-
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
2051
|
+
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
2052
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1780
2053
|
* vizEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
1781
2054
|
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
1782
2055
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -1784,10 +2057,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1784
2057
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1785
2058
|
/**
|
|
1786
2059
|
* Triggers the Delete action on visualization or search
|
|
2060
|
+
*
|
|
1787
2061
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
1788
2062
|
* can be left empty for search and visualization embeds
|
|
1789
2063
|
* @example
|
|
1790
|
-
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
2064
|
+
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
2065
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1791
2066
|
* vizEmbed.trigger(HostEvent.Delete)
|
|
1792
2067
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
1793
2068
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -1795,10 +2070,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1795
2070
|
Delete = "delete",
|
|
1796
2071
|
/**
|
|
1797
2072
|
* Triggers the SpotIQAnalyze action on visualization or search
|
|
2073
|
+
*
|
|
1798
2074
|
* @param - incase of Liveboard embed, takes in an object with vizId as a key
|
|
1799
2075
|
* can be left empty for search and visualization embeds
|
|
1800
2076
|
* @example
|
|
1801
|
-
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
2077
|
+
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
2078
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1802
2079
|
* vizEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
1803
2080
|
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
1804
2081
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -1806,26 +2083,50 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1806
2083
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1807
2084
|
/**
|
|
1808
2085
|
* Triggers the Download action on visualization or search when Displaymode is Chart
|
|
2086
|
+
*
|
|
1809
2087
|
* @example
|
|
1810
|
-
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
2088
|
+
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
2089
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1811
2090
|
* vizEmbed.trigger(HostEvent.Download)
|
|
1812
2091
|
* searchEmbed.trigger(HostEvent.Download)
|
|
2092
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw, Please use DownloadAsPng
|
|
1813
2093
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1814
2094
|
*/
|
|
1815
|
-
Download = "
|
|
2095
|
+
Download = "downloadAsPng",
|
|
2096
|
+
/**
|
|
2097
|
+
* Triggers the Download action on visualization or search when Displaymode is Chart
|
|
2098
|
+
*
|
|
2099
|
+
* @example
|
|
2100
|
+
* ```js
|
|
2101
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
2102
|
+
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
2103
|
+
* ```
|
|
2104
|
+
* ```js
|
|
2105
|
+
* vizEmbed.trigger(HostEvent.DownloadAsPng)
|
|
2106
|
+
* ```
|
|
2107
|
+
* ```js
|
|
2108
|
+
* searchEmbed.trigger(HostEvent.DownloadAsPng)
|
|
2109
|
+
* ```
|
|
2110
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
|
|
2111
|
+
*/
|
|
2112
|
+
DownloadAsPng = "downloadAsPng",
|
|
1816
2113
|
/**
|
|
1817
|
-
* Triggers the downloadAsCSV action on visualization or search
|
|
2114
|
+
* Triggers the downloadAsCSV action on visualization or search
|
|
2115
|
+
*
|
|
1818
2116
|
* @example
|
|
1819
|
-
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
2117
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
2118
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1820
2119
|
* vizEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
1821
2120
|
* searchEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
1822
2121
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1823
2122
|
*/
|
|
1824
2123
|
DownloadAsCsv = "downloadAsCSV",
|
|
1825
2124
|
/**
|
|
1826
|
-
* Triggers the downloadAsXLSX action on visualization or search
|
|
2125
|
+
* Triggers the downloadAsXLSX action on visualization or search
|
|
2126
|
+
*
|
|
1827
2127
|
* @example
|
|
1828
|
-
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
2128
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
2129
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1829
2130
|
* vizEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
1830
2131
|
* searchEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
1831
2132
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
@@ -1833,6 +2134,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1833
2134
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
1834
2135
|
/**
|
|
1835
2136
|
* Triggers the Share action on a liveboard or answer
|
|
2137
|
+
*
|
|
1836
2138
|
* @example
|
|
1837
2139
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
1838
2140
|
* searchEmbed.trigger(HostEvent.Share)
|
|
@@ -1841,6 +2143,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1841
2143
|
Share = "share",
|
|
1842
2144
|
/**
|
|
1843
2145
|
* Trigger the Save action on a liveboard or answer
|
|
2146
|
+
*
|
|
1844
2147
|
* @example
|
|
1845
2148
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
1846
2149
|
* searchEmbed.trigger(HostEvent.Save)
|
|
@@ -1849,33 +2152,40 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1849
2152
|
Save = "save",
|
|
1850
2153
|
/**
|
|
1851
2154
|
* Triggers the SyncToSheets action on visualization
|
|
2155
|
+
*
|
|
1852
2156
|
* @param - an object with vizId as a key
|
|
1853
2157
|
* @example
|
|
1854
|
-
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
2158
|
+
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
2159
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1855
2160
|
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
1856
2161
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1857
2162
|
*/
|
|
1858
2163
|
SyncToSheets = "sync-to-sheets",
|
|
1859
2164
|
/**
|
|
1860
2165
|
* Triggers the SyncToOtherApps action on visualization
|
|
2166
|
+
*
|
|
1861
2167
|
* @param - an object with vizId as a key
|
|
1862
2168
|
* @example
|
|
1863
|
-
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
2169
|
+
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
2170
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1864
2171
|
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
1865
2172
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1866
2173
|
*/
|
|
1867
2174
|
SyncToOtherApps = "sync-to-other-apps",
|
|
1868
2175
|
/**
|
|
1869
2176
|
* Triggers the ManagePipelines action on visualization
|
|
2177
|
+
*
|
|
1870
2178
|
* @param - an object with vizId as a key
|
|
1871
2179
|
* @example
|
|
1872
|
-
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
2180
|
+
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
2181
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1873
2182
|
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
1874
2183
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
|
|
1875
2184
|
*/
|
|
1876
2185
|
ManagePipelines = "manage-pipeline",
|
|
1877
2186
|
/**
|
|
1878
2187
|
* Triggers the Reset search in answer
|
|
2188
|
+
*
|
|
1879
2189
|
* @example
|
|
1880
2190
|
* searchEmbed.trigger(HostEvent.SearchReset
|
|
1881
2191
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
|
|
@@ -1905,6 +2215,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1905
2215
|
* containing configuration and/or visual information.
|
|
1906
2216
|
*/
|
|
1907
2217
|
export enum Param {
|
|
2218
|
+
EmbedApp = "embedApp",
|
|
1908
2219
|
DataSources = "dataSources",
|
|
1909
2220
|
DataSourceMode = "dataSourceMode",
|
|
1910
2221
|
DisableActions = "disableAction",
|
|
@@ -1943,7 +2254,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1943
2254
|
cookieless = "cookieless",
|
|
1944
2255
|
ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
|
|
1945
2256
|
LinkOverride = "linkOverride",
|
|
1946
|
-
ShowInsertToSlide = "insertInToSlide"
|
|
2257
|
+
ShowInsertToSlide = "insertInToSlide",
|
|
2258
|
+
PrimaryNavHidden = "primaryNavHidden",
|
|
2259
|
+
HideProfleAndHelp = "profileAndHelpInNavBarHidden"
|
|
1947
2260
|
}
|
|
1948
2261
|
/**
|
|
1949
2262
|
* The list of actions that can be performed on visual ThoughtSpot
|
|
@@ -1996,6 +2309,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
|
|
|
1996
2309
|
ReplaySearch = "replaySearch",
|
|
1997
2310
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1998
2311
|
Download = "download",
|
|
2312
|
+
DownloadAsPng = "downloadAsPng",
|
|
1999
2313
|
DownloadAsPdf = "downloadAsPdf",
|
|
2000
2314
|
DownloadAsCsv = "downloadAsCSV",
|
|
2001
2315
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
@@ -2188,7 +2502,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2188
2502
|
* @summary Base classes
|
|
2189
2503
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
2190
2504
|
*/
|
|
2191
|
-
import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig
|
|
2505
|
+
import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
|
|
2192
2506
|
/**
|
|
2193
2507
|
* Global prefix for all Thoughtspot postHash Params.
|
|
2194
2508
|
*/
|
|
@@ -2199,6 +2513,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2199
2513
|
* React+GraphQL
|
|
2200
2514
|
*/
|
|
2201
2515
|
export class TsEmbed {
|
|
2516
|
+
protected isAppInitialized: boolean;
|
|
2202
2517
|
/**
|
|
2203
2518
|
* A reference to the iframe within which the ThoughtSpot app
|
|
2204
2519
|
* will be rendered.
|
|
@@ -2214,41 +2529,53 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2214
2529
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
2215
2530
|
/**
|
|
2216
2531
|
* Handles errors within the SDK
|
|
2532
|
+
*
|
|
2217
2533
|
* @param error The error message or object
|
|
2218
2534
|
*/
|
|
2219
2535
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
2220
2536
|
/**
|
|
2221
2537
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
2538
|
+
*
|
|
2539
|
+
* @param query
|
|
2222
2540
|
*/
|
|
2223
2541
|
protected getEmbedBasePath(query: string): string;
|
|
2224
2542
|
/**
|
|
2225
2543
|
* Common query params set for all the embed modes.
|
|
2544
|
+
*
|
|
2545
|
+
* @param queryParams
|
|
2226
2546
|
* @returns queryParams
|
|
2227
2547
|
*/
|
|
2228
|
-
protected getBaseQueryParams(): {};
|
|
2548
|
+
protected getBaseQueryParams(queryParams?: {}): {};
|
|
2229
2549
|
/**
|
|
2230
2550
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
2231
2551
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
2552
|
+
*
|
|
2232
2553
|
* @param queryString The query string to append to the URL.
|
|
2233
2554
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
2234
2555
|
* the full application.
|
|
2235
2556
|
*/
|
|
2236
|
-
protected getV1EmbedBasePath(queryString: string
|
|
2557
|
+
protected getV1EmbedBasePath(queryString: string): string;
|
|
2558
|
+
protected getEmbedParams(): string;
|
|
2559
|
+
protected getRootIframeSrc(): string;
|
|
2560
|
+
protected createIframeEl(frameSrc: string): HTMLIFrameElement;
|
|
2237
2561
|
/**
|
|
2238
2562
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
2239
2563
|
* event listeners.
|
|
2564
|
+
*
|
|
2240
2565
|
* @param url
|
|
2241
2566
|
* @param frameOptions
|
|
2242
2567
|
*/
|
|
2243
|
-
protected renderIFrame(url: string
|
|
2568
|
+
protected renderIFrame(url: string): Promise<any>;
|
|
2244
2569
|
protected insertIntoDOM(child: string | Node): void;
|
|
2245
2570
|
/**
|
|
2246
2571
|
* Sets the height of the iframe
|
|
2572
|
+
*
|
|
2247
2573
|
* @param height The height in pixels
|
|
2248
2574
|
*/
|
|
2249
2575
|
protected setIFrameHeight(height: number): void;
|
|
2250
2576
|
/**
|
|
2251
2577
|
* Executes all registered event handlers for a particular event type
|
|
2578
|
+
*
|
|
2252
2579
|
* @param eventType The event type
|
|
2253
2580
|
* @param data The payload invoked with the event handler
|
|
2254
2581
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -2260,6 +2587,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2260
2587
|
protected getThoughtSpotHost(): string;
|
|
2261
2588
|
/**
|
|
2262
2589
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
2590
|
+
*
|
|
2263
2591
|
* @param eventType The v2 event type
|
|
2264
2592
|
* @returns The corresponding v1 event type if one exists
|
|
2265
2593
|
* or else the v2 event type itself
|
|
@@ -2269,6 +2597,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2269
2597
|
* Calculates the iframe center for the current visible viewPort
|
|
2270
2598
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
2271
2599
|
* in Host app. ViewPort height of the tab.
|
|
2600
|
+
*
|
|
2272
2601
|
* @returns iframe Center in visible viewport,
|
|
2273
2602
|
* Iframe height,
|
|
2274
2603
|
* View port height.
|
|
@@ -2303,8 +2632,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2303
2632
|
* ```
|
|
2304
2633
|
*/
|
|
2305
2634
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
|
|
2635
|
+
/**
|
|
2636
|
+
* Removes an event listener for a particular event type.
|
|
2637
|
+
*
|
|
2638
|
+
* @param messageType The message type
|
|
2639
|
+
* @param callback The callback to remove
|
|
2640
|
+
* @example
|
|
2641
|
+
* ```js
|
|
2642
|
+
* const errorHandler = (data) => { console.error(data); };
|
|
2643
|
+
* tsEmbed.on(EmbedEvent.Error, errorHandler);
|
|
2644
|
+
* tsEmbed.off(EmbedEvent.Error, errorHandler);
|
|
2645
|
+
* ```
|
|
2646
|
+
*/
|
|
2647
|
+
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
2306
2648
|
/**
|
|
2307
2649
|
* Triggers an event to the embedded app
|
|
2650
|
+
*
|
|
2308
2651
|
* @param messageType The event type
|
|
2309
2652
|
* @param data The payload to send with the message
|
|
2310
2653
|
*/
|
|
@@ -2313,6 +2656,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2313
2656
|
* Marks the ThoughtSpot object to have been rendered
|
|
2314
2657
|
* Needs to be overridden by subclasses to do the actual
|
|
2315
2658
|
* rendering of the iframe.
|
|
2659
|
+
*
|
|
2316
2660
|
* @param args
|
|
2317
2661
|
*/
|
|
2318
2662
|
render(): TsEmbed;
|
|
@@ -2320,14 +2664,26 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2320
2664
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
2321
2665
|
* host app URL.
|
|
2322
2666
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
2667
|
+
*
|
|
2323
2668
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
2324
2669
|
*/
|
|
2325
2670
|
getThoughtSpotPostUrlParams(): string;
|
|
2326
2671
|
/**
|
|
2327
2672
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
2673
|
+
*
|
|
2328
2674
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
2329
2675
|
*/
|
|
2330
2676
|
destroy(): void;
|
|
2677
|
+
getUnderlyingFrameElement(): HTMLIFrameElement;
|
|
2678
|
+
/**
|
|
2679
|
+
* Prerenders a generic instance of the TS component.
|
|
2680
|
+
* This means without the path but with the flags already applied.
|
|
2681
|
+
* This is useful for prerendering the component in the background.
|
|
2682
|
+
*
|
|
2683
|
+
* @version SDK: 1.21.0 | ThoughtSpot: * / Search: 9.3.0.cl
|
|
2684
|
+
* @returns
|
|
2685
|
+
*/
|
|
2686
|
+
prerenderGeneric(): Promise<any>;
|
|
2331
2687
|
}
|
|
2332
2688
|
/**
|
|
2333
2689
|
* Base class for embedding v1 experience
|
|
@@ -2341,12 +2697,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
|
|
|
2341
2697
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
2342
2698
|
/**
|
|
2343
2699
|
* Render the ap p in an iframe and set up event handlers
|
|
2700
|
+
*
|
|
2344
2701
|
* @param iframeSrc
|
|
2345
2702
|
*/
|
|
2346
2703
|
protected renderV1Embed(iframeSrc: string): any;
|
|
2704
|
+
protected getRootIframeSrc(): string;
|
|
2347
2705
|
/**
|
|
2348
|
-
* @inheritdoc
|
|
2349
|
-
*
|
|
2706
|
+
* @inheritdoc
|
|
2350
2707
|
* @example
|
|
2351
2708
|
* ```js
|
|
2352
2709
|
* tsEmbed.on(EmbedEvent.Error, (data) => {
|