@thoughtspot/visual-embed-sdk 1.26.1 → 1.27.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/cjs/package.json +2 -2
- package/cjs/src/auth.d.ts +4 -16
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +26 -58
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.d.ts.map +1 -1
- package/cjs/src/auth.spec.js +42 -32
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/authToken.d.ts +4 -0
- package/cjs/src/authToken.d.ts.map +1 -0
- package/cjs/src/authToken.js +61 -0
- package/cjs/src/authToken.js.map +1 -0
- package/cjs/src/embed/app.d.ts +15 -15
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +1 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +0 -9
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +21 -44
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +15 -14
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +18 -0
- package/cjs/src/embed/embedConfig.d.ts.map +1 -0
- package/cjs/src/embed/embedConfig.js +25 -0
- package/cjs/src/embed/embedConfig.js.map +1 -0
- package/cjs/src/embed/liveboard.d.ts +28 -23
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -3
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +48 -30
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +1 -1
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +22 -6
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +34 -19
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +10 -4
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +10 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js +3 -2
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +1 -0
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +30 -8
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +145 -22
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -1
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +0 -12
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +2 -0
- package/cjs/src/tokenizedFetch.d.ts.map +1 -0
- package/cjs/src/tokenizedFetch.js +20 -0
- package/cjs/src/tokenizedFetch.js.map +1 -0
- package/cjs/src/types.d.ts +733 -242
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +653 -175
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/{authService.d.ts → authService/authService.d.ts} +12 -11
- package/cjs/src/utils/authService/authService.d.ts.map +1 -0
- package/cjs/src/utils/{authService.js → authService/authService.js} +31 -39
- package/cjs/src/utils/authService/authService.js.map +1 -0
- package/cjs/src/utils/authService/authService.spec.d.ts.map +1 -0
- package/cjs/src/utils/{authService.spec.js → authService/authService.spec.js} +11 -12
- package/cjs/src/utils/authService/authService.spec.js.map +1 -0
- package/cjs/src/utils/authService/index.d.ts +3 -0
- package/cjs/src/utils/authService/index.d.ts.map +1 -0
- package/cjs/src/utils/authService/index.js +14 -0
- package/cjs/src/utils/authService/index.js.map +1 -0
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts +11 -0
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
- package/cjs/src/utils/authService/tokenizedAuthService.js +44 -0
- package/cjs/src/utils/authService/tokenizedAuthService.js.map +1 -0
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -4
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +4 -5
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +15 -3
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/processData.d.ts +6 -0
- package/cjs/src/utils/processData.d.ts.map +1 -1
- package/cjs/src/utils/processData.js +10 -5
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +8 -7
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.js +1 -1
- package/dist/src/auth.d.ts +4 -16
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/auth.spec.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +4 -0
- package/dist/src/authToken.d.ts.map +1 -0
- package/dist/src/embed/app.d.ts +15 -15
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +0 -9
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +18 -0
- package/dist/src/embed/embedConfig.d.ts.map +1 -0
- package/dist/src/embed/liveboard.d.ts +28 -23
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +48 -30
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +22 -6
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +34 -19
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +1 -0
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/tokenizedFetch.d.ts +2 -0
- package/dist/src/tokenizedFetch.d.ts.map +1 -0
- package/dist/src/types.d.ts +733 -242
- package/dist/src/types.d.ts.map +1 -1
- package/{lib/src/utils → dist/src/utils/authService}/authService.d.ts +44 -43
- package/dist/src/utils/authService/authService.d.ts.map +1 -0
- package/dist/src/utils/authService/index.d.ts +3 -0
- package/dist/src/utils/authService/index.d.ts.map +1 -0
- package/dist/src/utils/authService/tokenizedAuthService.d.ts +11 -0
- package/dist/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -4
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/processData.d.ts +6 -0
- package/dist/src/utils/processData.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +906 -339
- package/dist/tsembed-react.js +905 -338
- package/dist/tsembed.es.js +938 -370
- package/dist/tsembed.js +936 -368
- package/dist/visual-embed-sdk-react-full.d.ts +921 -360
- package/dist/visual-embed-sdk-react.d.ts +921 -360
- package/dist/visual-embed-sdk.d.ts +921 -360
- package/lib/package.json +2 -2
- package/lib/src/auth.d.ts +4 -16
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +21 -52
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.d.ts.map +1 -1
- package/lib/src/auth.spec.js +42 -32
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/authToken.d.ts +4 -0
- package/lib/src/authToken.d.ts.map +1 -0
- package/lib/src/authToken.js +56 -0
- package/lib/src/authToken.js.map +1 -0
- package/lib/src/embed/app.d.ts +15 -15
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +1 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +0 -9
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +21 -43
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +15 -14
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +18 -0
- package/lib/src/embed/embedConfig.d.ts.map +1 -0
- package/lib/src/embed/embedConfig.js +20 -0
- package/lib/src/embed/embedConfig.js.map +1 -0
- package/lib/src/embed/liveboard.d.ts +28 -23
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -3
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/sage.d.ts +48 -30
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +1 -1
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +22 -6
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +34 -19
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +11 -5
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +10 -0
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.js +3 -2
- package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -0
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +32 -10
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +145 -22
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -1
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/index.spec.js +0 -12
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +2 -0
- package/lib/src/tokenizedFetch.d.ts.map +1 -0
- package/lib/src/tokenizedFetch.js +16 -0
- package/lib/src/tokenizedFetch.js.map +1 -0
- package/lib/src/types.d.ts +733 -242
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +653 -175
- package/lib/src/types.js.map +1 -1
- package/{dist/src/utils → lib/src/utils/authService}/authService.d.ts +44 -43
- package/lib/src/utils/authService/authService.d.ts.map +1 -0
- package/lib/src/utils/{authService.js → authService/authService.js} +26 -32
- package/lib/src/utils/authService/authService.js.map +1 -0
- package/lib/src/utils/authService/authService.spec.d.ts.map +1 -0
- package/lib/src/utils/{authService.spec.js → authService/authService.spec.js} +1 -2
- package/lib/src/utils/authService/authService.spec.js.map +1 -0
- package/lib/src/utils/authService/index.d.ts +3 -0
- package/lib/src/utils/authService/index.d.ts.map +1 -0
- package/lib/src/utils/authService/index.js +3 -0
- package/lib/src/utils/authService/index.js.map +1 -0
- package/lib/src/utils/authService/tokenizedAuthService.d.ts +11 -0
- package/lib/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
- package/lib/src/utils/authService/tokenizedAuthService.js +39 -0
- package/lib/src/utils/authService/tokenizedAuthService.js.map +1 -0
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -4
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +4 -5
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +14 -3
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/processData.d.ts +6 -0
- package/lib/src/utils/processData.d.ts.map +1 -1
- package/lib/src/utils/processData.js +8 -4
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +8 -7
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.js +1 -1
- package/lib/src/visual-embed-sdk.d.ts +926 -361
- package/package.json +2 -2
- package/src/auth.spec.ts +77 -63
- package/src/auth.ts +22 -59
- package/src/authToken.ts +66 -0
- package/src/embed/app.ts +20 -20
- package/src/embed/base.spec.ts +18 -17
- package/src/embed/base.ts +26 -51
- package/src/embed/embedConfig.ts +23 -0
- package/src/embed/liveboard.ts +32 -27
- package/src/embed/sage.ts +48 -30
- package/src/embed/search-bar.tsx +22 -6
- package/src/embed/search.spec.ts +13 -0
- package/src/embed/search.ts +51 -31
- package/src/embed/searchEmbed-basic-auth.spec.ts +3 -2
- package/src/embed/ts-embed.spec.ts +189 -45
- package/src/embed/ts-embed.ts +33 -24
- package/src/index.ts +8 -2
- package/src/react/index.spec.tsx +0 -29
- package/src/tokenizedFetch.ts +18 -0
- package/src/types.ts +761 -266
- package/src/utils/{authService.spec.ts → authService/authService.spec.ts} +2 -3
- package/src/utils/{authService.ts → authService/authService.ts} +29 -34
- package/src/utils/authService/index.ts +9 -0
- package/src/utils/authService/tokenizedAuthService.ts +40 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +16 -4
- package/src/utils/graphql/answerService/answerService.ts +4 -5
- package/src/utils/processData.spec.ts +19 -16
- package/src/utils/processData.ts +7 -3
- package/src/utils/processTrigger.ts +1 -1
- package/cjs/src/utils/authService.d.ts.map +0 -1
- package/cjs/src/utils/authService.js.map +0 -1
- package/cjs/src/utils/authService.spec.d.ts.map +0 -1
- package/cjs/src/utils/authService.spec.js.map +0 -1
- package/dist/src/utils/authService.d.ts.map +0 -1
- package/lib/src/utils/authService.d.ts.map +0 -1
- package/lib/src/utils/authService.js.map +0 -1
- package/lib/src/utils/authService.spec.d.ts.map +0 -1
- package/lib/src/utils/authService.spec.js.map +0 -1
- /package/cjs/src/utils/{authService.spec.d.ts → authService/authService.spec.d.ts} +0 -0
- /package/dist/src/utils/{authService.spec.d.ts → authService/authService.spec.d.ts} +0 -0
- /package/dist/src/utils/{authService.spec.d.ts.map → authService/authService.spec.d.ts.map} +0 -0
- /package/lib/src/utils/{authService.spec.d.ts → authService/authService.spec.d.ts} +0 -0
|
@@ -242,25 +242,41 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
242
242
|
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
243
243
|
/**
|
|
244
244
|
* The array of data source GUIDs to set on load.
|
|
245
|
-
* Only a single
|
|
245
|
+
* Only a single data source is supported currently.
|
|
246
246
|
*
|
|
247
|
-
* @deprecated Use dataSource instead
|
|
247
|
+
* @deprecated Use `dataSource` instead
|
|
248
248
|
*/
|
|
249
249
|
dataSources?: string[];
|
|
250
250
|
/**
|
|
251
251
|
* The array of data source GUIDs to set on load.
|
|
252
252
|
*
|
|
253
|
-
* @version: SDK: 1.19.0
|
|
253
|
+
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
254
254
|
*/
|
|
255
255
|
dataSource?: string;
|
|
256
256
|
/**
|
|
257
|
-
*
|
|
257
|
+
* Boolean to define if the last selected data source should be used
|
|
258
258
|
*
|
|
259
|
-
* @version: SDK: 1.24.0
|
|
259
|
+
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
260
260
|
*/
|
|
261
261
|
useLastSelectedSources?: boolean;
|
|
262
262
|
/**
|
|
263
|
-
* Configuration for search options
|
|
263
|
+
* Configuration for search options.
|
|
264
|
+
* Includes the following properties:
|
|
265
|
+
*
|
|
266
|
+
* `searchTokenString`: Search tokens to pass in the query.
|
|
267
|
+
*
|
|
268
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
269
|
+
* If it is executed, the focus is placed on the results.
|
|
270
|
+
* If it’s not executed, the focus is placed at the end of
|
|
271
|
+
* the token string in the search bar.
|
|
272
|
+
*
|
|
273
|
+
* @example
|
|
274
|
+
* ```js
|
|
275
|
+
* searchOptions: {
|
|
276
|
+
* searchTokenString: '[quantity purchased] [region]',
|
|
277
|
+
* executeSearch: true,
|
|
278
|
+
* }
|
|
279
|
+
* ```
|
|
264
280
|
*/
|
|
265
281
|
searchOptions?: SearchOptions;
|
|
266
282
|
}
|
|
@@ -296,14 +312,14 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
296
312
|
*/
|
|
297
313
|
export interface SearchOptions {
|
|
298
314
|
/**
|
|
299
|
-
* The query string to
|
|
315
|
+
* The query string to pass for Natural Language Search.
|
|
300
316
|
*/
|
|
301
317
|
searchQuery: string;
|
|
302
318
|
/**
|
|
303
|
-
* Boolean to
|
|
304
|
-
*
|
|
305
|
-
*
|
|
306
|
-
* the
|
|
319
|
+
* Boolean to define if the search should be executed or not.
|
|
320
|
+
* If it is executed, the focus is placed on the results.
|
|
321
|
+
* If it’s not executed, the focus is placed at the end of
|
|
322
|
+
* the token string in the search bar.
|
|
307
323
|
*/
|
|
308
324
|
executeSearch?: boolean;
|
|
309
325
|
}
|
|
@@ -311,16 +327,16 @@ export interface SearchOptions {
|
|
|
311
327
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
312
328
|
* GPT and LLM.
|
|
313
329
|
*
|
|
314
|
-
* @version: SDK: 1.23.0 | ThoughtSpot: 9.
|
|
330
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
315
331
|
* @group Embed components
|
|
316
332
|
*/
|
|
317
333
|
export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
318
334
|
/**
|
|
319
|
-
* If set to true, a list of
|
|
335
|
+
* If set to true, a list of Liveboard and Answers related
|
|
320
336
|
* to the natural language search will be shown below the
|
|
321
337
|
* AI generated answer.
|
|
322
338
|
*
|
|
323
|
-
* @deprecated Currently
|
|
339
|
+
* @deprecated Currently Liveboard and Answers related
|
|
324
340
|
* to the natural language search will not be shown for sage
|
|
325
341
|
* embed
|
|
326
342
|
*/
|
|
@@ -337,63 +353,81 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
337
353
|
*/
|
|
338
354
|
isProductTour?: boolean;
|
|
339
355
|
/**
|
|
340
|
-
*
|
|
356
|
+
* Show or hide the search bar title.
|
|
341
357
|
*
|
|
342
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
358
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
343
359
|
*/
|
|
344
360
|
hideSearchBarTitle?: boolean;
|
|
345
361
|
/**
|
|
346
|
-
*
|
|
347
|
-
*
|
|
362
|
+
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
363
|
+
* at the top of the Answer page.
|
|
348
364
|
*
|
|
349
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
365
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
350
366
|
*/
|
|
351
367
|
hideSageAnswerHeader?: boolean;
|
|
352
368
|
/**
|
|
353
|
-
*
|
|
369
|
+
* Disable the worksheet selection option.
|
|
354
370
|
*
|
|
355
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.9.0.
|
|
371
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
356
372
|
*/
|
|
357
373
|
disableWorksheetChange?: boolean;
|
|
358
374
|
/**
|
|
359
|
-
*
|
|
375
|
+
* Hide the worksheet selection panel.
|
|
376
|
+
*
|
|
377
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
360
378
|
*/
|
|
361
379
|
hideWorksheetSelector?: boolean;
|
|
362
380
|
/**
|
|
363
|
-
*
|
|
364
|
-
* default false
|
|
381
|
+
* Show or hide autocomplete suggestions for the search query string.
|
|
365
382
|
*
|
|
366
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.9.0.
|
|
383
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
367
384
|
*/
|
|
368
385
|
hideAutocompleteSuggestions?: boolean;
|
|
369
386
|
/**
|
|
370
|
-
*
|
|
387
|
+
* Show or hide autocomplete suggestions for the search query string.
|
|
371
388
|
*
|
|
372
|
-
* @deprecated
|
|
373
|
-
*
|
|
389
|
+
* @deprecated
|
|
390
|
+
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
391
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
374
392
|
*/
|
|
375
393
|
showObjectSuggestions?: boolean;
|
|
376
394
|
/**
|
|
377
|
-
*
|
|
378
|
-
*
|
|
395
|
+
* Show or hide sample questions.
|
|
396
|
+
* The sample questions are autogenerated based on the worksheet
|
|
397
|
+
* selected for the search operation.
|
|
379
398
|
*
|
|
380
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
399
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
381
400
|
*/
|
|
382
401
|
hideSampleQuestions?: boolean;
|
|
383
402
|
/**
|
|
384
|
-
* The data source GUID to set on load.
|
|
403
|
+
* The data source GUID (Worksheet GUID) to set on load.
|
|
385
404
|
*/
|
|
386
405
|
dataSource?: string;
|
|
387
406
|
/**
|
|
388
|
-
*
|
|
407
|
+
* Includes the following properties:
|
|
389
408
|
*
|
|
390
|
-
*
|
|
409
|
+
* `searchQuery`: The search query string to pass in the search bar.
|
|
410
|
+
* Supports Natural Language Search queries.
|
|
411
|
+
*
|
|
412
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
413
|
+
* If it is executed, the focus is placed on the results.
|
|
414
|
+
* If it’s not executed, the focus is placed at the end of
|
|
415
|
+
* the token string in the search bar.
|
|
416
|
+
*
|
|
417
|
+
* @example
|
|
418
|
+
* ```js
|
|
419
|
+
* searchOptions: {
|
|
420
|
+
* searchQuery: 'average sales by country and product type',
|
|
421
|
+
* executeSearch: true,
|
|
422
|
+
* }
|
|
423
|
+
* ```
|
|
424
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
391
425
|
*/
|
|
392
426
|
searchOptions?: SearchOptions;
|
|
393
427
|
}
|
|
394
428
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
395
429
|
/**
|
|
396
|
-
* Embed ThoughtSpot LLM and GPT
|
|
430
|
+
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
397
431
|
*
|
|
398
432
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
399
433
|
* @group Embed components
|
|
@@ -413,6 +447,13 @@ export declare class SageEmbed extends V1Embed {
|
|
|
413
447
|
* @returns {string} query string
|
|
414
448
|
*/
|
|
415
449
|
protected getEmbedParams(): string;
|
|
450
|
+
/**
|
|
451
|
+
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
452
|
+
* loaded in the iframe
|
|
453
|
+
*
|
|
454
|
+
* @returns {string} iframe url
|
|
455
|
+
*/
|
|
456
|
+
getIFrameSrc(): string;
|
|
416
457
|
/**
|
|
417
458
|
* Render the embedded ThoughtSpot Sage
|
|
418
459
|
*
|
|
@@ -430,18 +471,19 @@ export declare class SageEmbed extends V1Embed {
|
|
|
430
471
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
431
472
|
*/
|
|
432
473
|
/**
|
|
433
|
-
* Configuration for search options
|
|
474
|
+
* Configuration for search options.
|
|
475
|
+
*
|
|
434
476
|
*/
|
|
435
477
|
export interface SearchOptions {
|
|
436
478
|
/**
|
|
437
|
-
*
|
|
479
|
+
* Search tokens to pass in the query.
|
|
438
480
|
*/
|
|
439
481
|
searchTokenString: string;
|
|
440
482
|
/**
|
|
441
|
-
* Boolean to
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
* the
|
|
483
|
+
* Boolean to define if the search should be executed or not.
|
|
484
|
+
* If it is executed, the focus is placed on the results.
|
|
485
|
+
* If it’s not executed, the focus is placed at the end of
|
|
486
|
+
* the token string in the search bar.
|
|
445
487
|
*/
|
|
446
488
|
executeSearch?: boolean;
|
|
447
489
|
}
|
|
@@ -457,19 +499,15 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
457
499
|
*/
|
|
458
500
|
collapseDataSources?: boolean;
|
|
459
501
|
/**
|
|
460
|
-
*
|
|
502
|
+
* Show or hide the data sources panel.
|
|
461
503
|
*/
|
|
462
504
|
hideDataSources?: boolean;
|
|
463
505
|
/**
|
|
464
|
-
*
|
|
506
|
+
* Show or hide the charts and tables in search answers.
|
|
465
507
|
* This attribute can be used to create a custom visualization
|
|
466
508
|
* using raw answer data.
|
|
467
509
|
*/
|
|
468
510
|
hideResults?: boolean;
|
|
469
|
-
/**
|
|
470
|
-
* If set to true, expands all the data sources panel.
|
|
471
|
-
*/
|
|
472
|
-
expandAllDataSource?: boolean;
|
|
473
511
|
/**
|
|
474
512
|
* If set to true, the Search Assist feature is enabled.
|
|
475
513
|
*
|
|
@@ -483,9 +521,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
483
521
|
forceTable?: boolean;
|
|
484
522
|
/**
|
|
485
523
|
* The array of data source GUIDs to set on load.
|
|
486
|
-
* Only a single
|
|
524
|
+
* Only a single data source is supported currently.
|
|
487
525
|
*
|
|
488
|
-
* @deprecated Use dataSource instead
|
|
526
|
+
* @deprecated Use `dataSource` instead.
|
|
489
527
|
*/
|
|
490
528
|
dataSources?: string[];
|
|
491
529
|
/**
|
|
@@ -497,11 +535,29 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
497
535
|
/**
|
|
498
536
|
* The initial search query to load the answer with.
|
|
499
537
|
*
|
|
500
|
-
* @deprecated
|
|
538
|
+
* @deprecated
|
|
539
|
+
*
|
|
540
|
+
* Use {@link searchOptions} instead.
|
|
501
541
|
*/
|
|
502
542
|
searchQuery?: string;
|
|
503
543
|
/**
|
|
504
|
-
* Configuration for search options
|
|
544
|
+
* Configuration for search options.
|
|
545
|
+
* Includes the following properties:
|
|
546
|
+
*
|
|
547
|
+
* `searchTokenString`: Search tokens to pass in the query.
|
|
548
|
+
*
|
|
549
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
550
|
+
* If it is executed, the focus is placed on the results.
|
|
551
|
+
* If it’s not executed, the focus is placed at the end of
|
|
552
|
+
* the token string in the search bar.
|
|
553
|
+
*
|
|
554
|
+
* @example
|
|
555
|
+
* ```js
|
|
556
|
+
* searchOptions: {
|
|
557
|
+
* searchTokenString: '[quantity purchased] [region]',
|
|
558
|
+
* executeSearch: true,
|
|
559
|
+
* }
|
|
560
|
+
* ```
|
|
505
561
|
*/
|
|
506
562
|
searchOptions?: SearchOptions;
|
|
507
563
|
/**
|
|
@@ -509,10 +565,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
509
565
|
*/
|
|
510
566
|
answerId?: string;
|
|
511
567
|
/**
|
|
512
|
-
* If set to true, search page will render without the Search Bar
|
|
568
|
+
* If set to true, the search page will render without the Search Bar
|
|
513
569
|
* The chart/table should still be visible.
|
|
514
570
|
*
|
|
515
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
571
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
516
572
|
*/
|
|
517
573
|
hideSearchBar?: boolean;
|
|
518
574
|
/**
|
|
@@ -543,6 +599,14 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
543
599
|
protected embedComponentType: string;
|
|
544
600
|
constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
|
|
545
601
|
protected getEmbedParams(): string;
|
|
602
|
+
/**
|
|
603
|
+
* Construct the URL of the embedded ThoughtSpot search to be
|
|
604
|
+
* loaded in the iframe
|
|
605
|
+
*
|
|
606
|
+
* @param answerId The GUID of a saved answer
|
|
607
|
+
* @param dataSources A list of data source GUIDs
|
|
608
|
+
*/
|
|
609
|
+
getIFrameSrc(): string;
|
|
546
610
|
/**
|
|
547
611
|
* Render the embedded ThoughtSpot search
|
|
548
612
|
*/
|
|
@@ -599,43 +663,43 @@ export declare enum Page {
|
|
|
599
663
|
*/
|
|
600
664
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
601
665
|
/**
|
|
602
|
-
* If true, the
|
|
666
|
+
* If true, the top navigation bar within the ThoughtSpot app
|
|
603
667
|
* is displayed. By default, the navigation bar is hidden.
|
|
604
|
-
* This flag also
|
|
668
|
+
* This flag also controls the homepage left navigation bar.
|
|
605
669
|
*/
|
|
606
670
|
showPrimaryNavbar?: boolean;
|
|
607
671
|
/**
|
|
608
|
-
*
|
|
609
|
-
* If showPrimaryNavbar is true,
|
|
610
|
-
* nav-
|
|
611
|
-
*
|
|
672
|
+
* Control the visibility of the left navigation bar on the Homepage.
|
|
673
|
+
* If showPrimaryNavbar is true, that is, if the Global and Homepage
|
|
674
|
+
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
675
|
+
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
612
676
|
*
|
|
613
677
|
* @default false
|
|
614
678
|
* @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
615
679
|
*/
|
|
616
680
|
hideHomepageLeftNav?: boolean;
|
|
617
681
|
/**
|
|
618
|
-
*
|
|
619
|
-
*
|
|
682
|
+
* Control the visibility of the help (?) and profile buttons on the
|
|
683
|
+
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
620
684
|
*/
|
|
621
685
|
disableProfileAndHelp?: boolean;
|
|
622
686
|
/**
|
|
623
|
-
*
|
|
624
|
-
*
|
|
687
|
+
* Control the visibility of the application switcher button on the nav-bar.
|
|
688
|
+
* By default, the application switcher is shown.
|
|
625
689
|
*/
|
|
626
690
|
hideApplicationSwitcher?: boolean;
|
|
627
691
|
/**
|
|
628
|
-
*
|
|
629
|
-
*
|
|
692
|
+
* Control the visibility of the Org switcher button on the nav-bar.
|
|
693
|
+
* By default, the Org switcher button is shown.
|
|
630
694
|
*/
|
|
631
695
|
hideOrgSwitcher?: boolean;
|
|
632
696
|
/**
|
|
633
|
-
* A URL path
|
|
697
|
+
* A URL path to the embedded application page
|
|
634
698
|
* If both path and pageId attributes are defined, the path definition
|
|
635
699
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
636
700
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
637
701
|
*
|
|
638
|
-
* For eg, if you want the component to open to a specific
|
|
702
|
+
* For eg, if you want the component to open to a specific Liveboard
|
|
639
703
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
640
704
|
*
|
|
641
705
|
* @example
|
|
@@ -747,6 +811,12 @@ export declare class AppEmbed extends V1Embed {
|
|
|
747
811
|
* embedded Liveboard or visualization.
|
|
748
812
|
*/
|
|
749
813
|
protected getEmbedParams(): string;
|
|
814
|
+
/**
|
|
815
|
+
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
816
|
+
*
|
|
817
|
+
* @param pageId The ID of the page to be embedded.
|
|
818
|
+
*/
|
|
819
|
+
getIFrameSrc(): string;
|
|
750
820
|
/**
|
|
751
821
|
* Set the iframe height as per the computed height received
|
|
752
822
|
* from the ThoughtSpot app.
|
|
@@ -800,8 +870,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
800
870
|
*/
|
|
801
871
|
fullHeight?: boolean;
|
|
802
872
|
/**
|
|
803
|
-
* This is the minimum height(in pixels) for a full
|
|
804
|
-
* Setting this height helps
|
|
873
|
+
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
874
|
+
* Setting this height helps resolve issues with empty Liveboards and
|
|
805
875
|
* other screens navigable from a Liveboard.
|
|
806
876
|
*
|
|
807
877
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
@@ -814,7 +884,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
814
884
|
enableVizTransformations?: boolean;
|
|
815
885
|
/**
|
|
816
886
|
* The Liveboard to display in the embedded view.
|
|
817
|
-
* Use either
|
|
887
|
+
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
818
888
|
*
|
|
819
889
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
820
890
|
*/
|
|
@@ -833,79 +903,84 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
833
903
|
* If set to true, all filter chips from a
|
|
834
904
|
* Liveboard page will be read-only (no X buttons)
|
|
835
905
|
*
|
|
836
|
-
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
906
|
+
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
837
907
|
*/
|
|
838
908
|
preventLiveboardFilterRemoval?: boolean;
|
|
839
909
|
/**
|
|
840
|
-
* Array of
|
|
841
|
-
*
|
|
910
|
+
* Array of visualization IDs which should be visible when the Liveboard
|
|
911
|
+
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
842
912
|
* event.
|
|
843
913
|
*
|
|
844
914
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
845
915
|
*/
|
|
846
916
|
visibleVizs?: string[];
|
|
847
917
|
/**
|
|
848
|
-
* To support backward
|
|
918
|
+
* To support backward compatibility
|
|
849
919
|
*
|
|
850
920
|
* @hidden
|
|
851
921
|
*/
|
|
852
922
|
preventPinboardFilterRemoval?: boolean;
|
|
853
923
|
/**
|
|
854
|
-
* Render embedded Liveboards and visualizations in the
|
|
924
|
+
* Render embedded Liveboards and visualizations in the
|
|
925
|
+
* new Liveboard experience mode.
|
|
855
926
|
*
|
|
856
927
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
857
928
|
*/
|
|
858
929
|
liveboardV2?: boolean;
|
|
859
930
|
/**
|
|
860
|
-
*
|
|
931
|
+
* Set a Liveboard tab as an active tab.
|
|
932
|
+
* Specify the tab ID.
|
|
861
933
|
*
|
|
862
934
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
863
935
|
*/
|
|
864
936
|
activeTabId?: string;
|
|
865
937
|
/**
|
|
866
|
-
*
|
|
938
|
+
* Show or hide the tab panel of the embedded Liveboard.
|
|
867
939
|
*
|
|
868
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
940
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
869
941
|
*/
|
|
870
942
|
hideTabPanel?: boolean;
|
|
871
943
|
/**
|
|
872
|
-
* Show or hide Liveboard header
|
|
944
|
+
* Show or hide the Liveboard header.
|
|
873
945
|
*
|
|
874
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
946
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
875
947
|
* @default false
|
|
876
948
|
*/
|
|
877
949
|
hideLiveboardHeader?: boolean;
|
|
878
950
|
/**
|
|
879
|
-
* Show or hide Liveboard title
|
|
951
|
+
* Show or hide the Liveboard title.
|
|
880
952
|
*
|
|
881
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
953
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
882
954
|
* @default false
|
|
883
955
|
*/
|
|
884
956
|
showLiveboardTitle?: boolean;
|
|
885
957
|
/**
|
|
886
|
-
* Show or hide Liveboard description
|
|
958
|
+
* Show or hide the Liveboard description.
|
|
887
959
|
*
|
|
888
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
960
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
889
961
|
* @default false
|
|
890
962
|
*/
|
|
891
963
|
showLiveboardDescription?: boolean;
|
|
892
964
|
/**
|
|
893
|
-
*
|
|
965
|
+
* Control the position and visibility of
|
|
966
|
+
* the Liveboard header as the users scroll down the
|
|
967
|
+
* embedded Liveboard page.
|
|
894
968
|
*
|
|
895
969
|
* @example
|
|
896
970
|
* ```js
|
|
897
971
|
* const embed = new LiveboardEmbed('#embed', {
|
|
898
|
-
* ... // other
|
|
972
|
+
* ... // other Liveboard view config
|
|
899
973
|
* isLiveboardHeaderSticky: true,
|
|
900
974
|
* });
|
|
901
975
|
* ```
|
|
902
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
976
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
903
977
|
*/
|
|
904
978
|
isLiveboardHeaderSticky?: boolean;
|
|
905
979
|
}
|
|
906
980
|
/**
|
|
907
|
-
* Embed a ThoughtSpot Liveboard or
|
|
908
|
-
* waits for the authentication to complete, so
|
|
981
|
+
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
982
|
+
* waits for the authentication to complete, so you need not wait for
|
|
983
|
+
* `AuthStatus.SUCCESS`.
|
|
909
984
|
*
|
|
910
985
|
* @example
|
|
911
986
|
* ```js
|
|
@@ -984,14 +1059,6 @@ export interface exportTMLInput {
|
|
|
984
1059
|
edoc_format?: 'YAML' | 'JSON';
|
|
985
1060
|
}
|
|
986
1061
|
export declare let authPromise: Promise<boolean>;
|
|
987
|
-
/**
|
|
988
|
-
* Gets the configuration embed was initialized with.
|
|
989
|
-
*
|
|
990
|
-
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
991
|
-
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
992
|
-
* @group Global methods
|
|
993
|
-
*/
|
|
994
|
-
export declare const getEmbedConfig: () => EmbedConfig;
|
|
995
1062
|
export declare const getAuthPromise: () => Promise<boolean>;
|
|
996
1063
|
export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, };
|
|
997
1064
|
/**
|
|
@@ -1106,7 +1173,6 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
1106
1173
|
console.error(error);
|
|
1107
1174
|
});
|
|
1108
1175
|
* ```
|
|
1109
|
-
*
|
|
1110
1176
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1111
1177
|
* @group Global methods
|
|
1112
1178
|
*/
|
|
@@ -1120,17 +1186,6 @@ export declare let loggedInStatus: boolean;
|
|
|
1120
1186
|
export declare let samlAuthWindow: Window;
|
|
1121
1187
|
export declare let samlCompletionPromise: Promise<void>;
|
|
1122
1188
|
export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
|
|
1123
|
-
export declare const EndPoints: {
|
|
1124
|
-
AUTH_VERIFICATION: string;
|
|
1125
|
-
SAML_LOGIN_TEMPLATE: (targetUrl: string) => string;
|
|
1126
|
-
OIDC_LOGIN_TEMPLATE: (targetUrl: string) => string;
|
|
1127
|
-
TOKEN_LOGIN: string;
|
|
1128
|
-
BASIC_LOGIN: string;
|
|
1129
|
-
LOGOUT: string;
|
|
1130
|
-
EXECUTE_TML: string;
|
|
1131
|
-
EXPORT_TML: string;
|
|
1132
|
-
IS_ACTIVE: string;
|
|
1133
|
-
};
|
|
1134
1189
|
interface sessionInfoInterface {
|
|
1135
1190
|
userGUID: any;
|
|
1136
1191
|
isPublicUser: any;
|
|
@@ -1172,8 +1227,8 @@ export declare enum AuthStatus {
|
|
|
1172
1227
|
*/
|
|
1173
1228
|
LOGOUT = "LOGOUT",
|
|
1174
1229
|
/**
|
|
1175
|
-
* Emitted when inPopup
|
|
1176
|
-
*
|
|
1230
|
+
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
1231
|
+
* popup is waiting to be triggered either programmatically
|
|
1177
1232
|
* or by the trigger button.
|
|
1178
1233
|
*
|
|
1179
1234
|
* @version SDK: 1.19.0
|
|
@@ -1218,8 +1273,8 @@ export interface AuthEventEmitter {
|
|
|
1218
1273
|
*/
|
|
1219
1274
|
export declare enum AuthEvent {
|
|
1220
1275
|
/**
|
|
1221
|
-
* Manually trigger the SSO popup. This is useful
|
|
1222
|
-
* authStatus
|
|
1276
|
+
* Manually trigger the SSO popup. This is useful when
|
|
1277
|
+
* authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true
|
|
1223
1278
|
*/
|
|
1224
1279
|
TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
|
|
1225
1280
|
}
|
|
@@ -1262,7 +1317,6 @@ export declare function getReleaseVersion(): string;
|
|
|
1262
1317
|
* @group Global methods
|
|
1263
1318
|
*/
|
|
1264
1319
|
export declare function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
1265
|
-
export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<any>;
|
|
1266
1320
|
/**
|
|
1267
1321
|
* Perform token based authentication
|
|
1268
1322
|
*
|
|
@@ -1329,10 +1383,14 @@ export declare enum AuthType {
|
|
|
1329
1383
|
*/
|
|
1330
1384
|
None = "None",
|
|
1331
1385
|
/**
|
|
1332
|
-
* Passthrough SSO to the embedded
|
|
1386
|
+
* Passthrough SSO to the embedded application within the iframe. Requires least
|
|
1333
1387
|
* configuration, but may not be supported by all IDPs. This will behave like `None`
|
|
1334
1388
|
* if SSO is not configured on ThoughtSpot.
|
|
1335
1389
|
*
|
|
1390
|
+
* To use this:
|
|
1391
|
+
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1392
|
+
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1393
|
+
*
|
|
1336
1394
|
* @example
|
|
1337
1395
|
* ```js
|
|
1338
1396
|
* init({
|
|
@@ -1340,12 +1398,7 @@ export declare enum AuthType {
|
|
|
1340
1398
|
* authType: AuthType.EmbeddedSSO,
|
|
1341
1399
|
* });
|
|
1342
1400
|
* ```
|
|
1343
|
-
*
|
|
1344
|
-
*
|
|
1345
|
-
* To use this:
|
|
1346
|
-
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1347
|
-
* eg. If you are using okta as IdP, you can enable iFrame embedding.
|
|
1348
|
-
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
1401
|
+
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
1349
1402
|
*/
|
|
1350
1403
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1351
1404
|
/**
|
|
@@ -1364,10 +1417,10 @@ export declare enum AuthType {
|
|
|
1364
1417
|
SAML = "SSO_SAML",
|
|
1365
1418
|
/**
|
|
1366
1419
|
* SSO using SAML
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1420
|
+
* Makes the host application redirect to the SAML IdP. Use this
|
|
1421
|
+
* if your IdP does not allow itself to be embedded.
|
|
1369
1422
|
*
|
|
1370
|
-
* This redirects the host application to the SAML
|
|
1423
|
+
* This redirects the host application to the SAML IdP. The host application
|
|
1371
1424
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1372
1425
|
*
|
|
1373
1426
|
* @example
|
|
@@ -1378,7 +1431,7 @@ export declare enum AuthType {
|
|
|
1378
1431
|
* });
|
|
1379
1432
|
* ```
|
|
1380
1433
|
*
|
|
1381
|
-
* This opens the SAML
|
|
1434
|
+
* This opens the SAML IdP in a popup window. The popup is triggered
|
|
1382
1435
|
* when the user clicks the trigger button. The popup window will be
|
|
1383
1436
|
* closed automatically after authentication.
|
|
1384
1437
|
* @example
|
|
@@ -1392,8 +1445,8 @@ export declare enum AuthType {
|
|
|
1392
1445
|
* });
|
|
1393
1446
|
* ```
|
|
1394
1447
|
*
|
|
1395
|
-
* Can also use event to trigger the popup flow. Works the same
|
|
1396
|
-
* as above example.
|
|
1448
|
+
* Can also use the event to trigger the popup flow. Works the same
|
|
1449
|
+
* as the above example.
|
|
1397
1450
|
* @example
|
|
1398
1451
|
* ```js
|
|
1399
1452
|
* const authEE = init({
|
|
@@ -1417,7 +1470,7 @@ export declare enum AuthType {
|
|
|
1417
1470
|
OIDC = "SSO_OIDC",
|
|
1418
1471
|
/**
|
|
1419
1472
|
* SSO using OIDC
|
|
1420
|
-
* Will make the host application redirect to the OIDC
|
|
1473
|
+
* Will make the host application redirect to the OIDC IdP.
|
|
1421
1474
|
* See code samples in {@link SAMLRedirect}.
|
|
1422
1475
|
*/
|
|
1423
1476
|
OIDCRedirect = "SSO_OIDC",
|
|
@@ -1429,8 +1482,8 @@ export declare enum AuthType {
|
|
|
1429
1482
|
*/
|
|
1430
1483
|
AuthServer = "AuthServer",
|
|
1431
1484
|
/**
|
|
1432
|
-
* Trusted authentication server
|
|
1433
|
-
* which returns a bearer token, generated using the secret_key obtained
|
|
1485
|
+
* Trusted authentication server. Use your own authentication server
|
|
1486
|
+
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1434
1487
|
* from ThoughtSpot.
|
|
1435
1488
|
*
|
|
1436
1489
|
* @example
|
|
@@ -1447,11 +1500,11 @@ export declare enum AuthType {
|
|
|
1447
1500
|
*/
|
|
1448
1501
|
TrustedAuthToken = "AuthServer",
|
|
1449
1502
|
/**
|
|
1450
|
-
* Trusted authentication server Cookieless, Use
|
|
1451
|
-
* server which returns a bearer token, generated using the secret_key
|
|
1503
|
+
* Trusted authentication server Cookieless, Use your own authentication
|
|
1504
|
+
* server which returns a bearer token, generated using the `secret_key`
|
|
1452
1505
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1453
|
-
* approach, recommended to
|
|
1454
|
-
* implemented by some browsers
|
|
1506
|
+
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1507
|
+
* implemented by some browsers.
|
|
1455
1508
|
*
|
|
1456
1509
|
* @example
|
|
1457
1510
|
* ```js
|
|
@@ -1464,7 +1517,7 @@ export declare enum AuthType {
|
|
|
1464
1517
|
* .then((data) => data.token);
|
|
1465
1518
|
* }
|
|
1466
1519
|
* ```
|
|
1467
|
-
* @version SDK: 1.22.0|
|
|
1520
|
+
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1468
1521
|
*/
|
|
1469
1522
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1470
1523
|
/**
|
|
@@ -1586,13 +1639,19 @@ export interface EmbedConfig {
|
|
|
1586
1639
|
* The ThoughtSpot cluster hostname or IP address.
|
|
1587
1640
|
*/
|
|
1588
1641
|
thoughtSpotHost: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* If true, all the iframe links will have /v2 added automatically.
|
|
1644
|
+
* If false, all the iframe links will have /v1 added automatically.
|
|
1645
|
+
* If undefined, nothing will be added
|
|
1646
|
+
*/
|
|
1647
|
+
enableReactShell?: boolean | undefined;
|
|
1589
1648
|
/**
|
|
1590
1649
|
* The authentication mechanism to use.
|
|
1591
1650
|
*/
|
|
1592
1651
|
authType: AuthType;
|
|
1593
1652
|
/**
|
|
1594
1653
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
1595
|
-
* authentication token. A GET request is made to the
|
|
1654
|
+
* authentication token. A `GET` request is made to the
|
|
1596
1655
|
* authentication API endpoint, which returns the token
|
|
1597
1656
|
* as a plaintext response. For trusted authentication,
|
|
1598
1657
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
@@ -1605,8 +1664,8 @@ export interface EmbedConfig {
|
|
|
1605
1664
|
* attribute is required.
|
|
1606
1665
|
*
|
|
1607
1666
|
* It is advisable to fetch a new token inside this method and not
|
|
1608
|
-
* reuse
|
|
1609
|
-
* called again and if it is called with an older token the authentication
|
|
1667
|
+
* reuse the old issued token. When auth expires this method is
|
|
1668
|
+
* called again and if it is called with an older token, the authentication
|
|
1610
1669
|
* will not succeed.
|
|
1611
1670
|
*/
|
|
1612
1671
|
getAuthToken?: () => Promise<string>;
|
|
@@ -1616,7 +1675,7 @@ export interface EmbedConfig {
|
|
|
1616
1675
|
*/
|
|
1617
1676
|
username?: string;
|
|
1618
1677
|
/**
|
|
1619
|
-
* [Basic] The ThoughtSpot login password corresponding to the
|
|
1678
|
+
* [Basic] The ThoughtSpot login password corresponding to the username
|
|
1620
1679
|
*
|
|
1621
1680
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1622
1681
|
* strongly advised not to use this authentication method in production.
|
|
@@ -1624,7 +1683,7 @@ export interface EmbedConfig {
|
|
|
1624
1683
|
password?: string;
|
|
1625
1684
|
/**
|
|
1626
1685
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1627
|
-
* open the SAML auth flow in a popup, instead of redirecting browser in
|
|
1686
|
+
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1628
1687
|
* place.
|
|
1629
1688
|
*
|
|
1630
1689
|
* @default false
|
|
@@ -1633,91 +1692,93 @@ export interface EmbedConfig {
|
|
|
1633
1692
|
noRedirect?: boolean;
|
|
1634
1693
|
/**
|
|
1635
1694
|
* [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
|
|
1636
|
-
* the SAML auth flow in a popup, instead of redirecting browser in place.
|
|
1695
|
+
* the SAML auth flow in a popup, instead of redirecting the browser in place.
|
|
1637
1696
|
*
|
|
1638
|
-
* Need to use this with authTriggerContainer
|
|
1639
|
-
* the AuthEvent.TRIGGER_SSO_POPUP event on a user interaction.
|
|
1697
|
+
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1698
|
+
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1640
1699
|
*
|
|
1641
1700
|
* @default false
|
|
1642
1701
|
* @version SDK: 1.18.0
|
|
1643
1702
|
*/
|
|
1644
1703
|
inPopup?: boolean;
|
|
1645
1704
|
/**
|
|
1646
|
-
* [SSO] For SSO Authentication, one can supply an optional path param
|
|
1647
|
-
*
|
|
1705
|
+
* [SSO] For SSO Authentication, one can supply an optional path param;
|
|
1706
|
+
* This will be the path on the host origin where the SAML flow will be
|
|
1648
1707
|
* terminated.
|
|
1649
1708
|
*
|
|
1650
1709
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1651
1710
|
*
|
|
1652
|
-
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
|
|
1711
|
+
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1653
1712
|
*/
|
|
1654
1713
|
redirectPath?: string;
|
|
1655
1714
|
/** @internal */
|
|
1656
1715
|
basepath?: string;
|
|
1657
1716
|
/**
|
|
1658
|
-
*
|
|
1659
|
-
*
|
|
1660
|
-
*
|
|
1717
|
+
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1718
|
+
* should be encoded in base64. This provides additional security to
|
|
1719
|
+
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1661
1720
|
*
|
|
1662
1721
|
* @default false
|
|
1663
1722
|
*/
|
|
1664
1723
|
shouldEncodeUrlQueryParams?: boolean;
|
|
1665
1724
|
/**
|
|
1666
|
-
* Suppress cookie access alert when third
|
|
1667
|
-
* user's browser. Third
|
|
1668
|
-
*
|
|
1669
|
-
* encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1725
|
+
* Suppress cookie access alert when third-party cookies are blocked by the
|
|
1726
|
+
* user's browser. Third-party cookie blocking is the default behaviour on
|
|
1727
|
+
* some web browsers like Safari. If you set this attribute to `true`,
|
|
1728
|
+
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1670
1729
|
* in this case.
|
|
1671
1730
|
*
|
|
1672
1731
|
* @default false
|
|
1673
1732
|
*/
|
|
1674
1733
|
suppressNoCookieAccessAlert?: boolean;
|
|
1675
1734
|
/**
|
|
1676
|
-
* Ignore cookie access alert when third
|
|
1735
|
+
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
1677
1736
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
1678
|
-
*
|
|
1737
|
+
* persists even in the case of a non-logged-in user.
|
|
1679
1738
|
*
|
|
1680
1739
|
* @default false
|
|
1681
1740
|
*/
|
|
1682
1741
|
ignoreNoCookieAccess?: boolean;
|
|
1683
1742
|
/**
|
|
1684
|
-
* Re-login
|
|
1743
|
+
* Re-login a user with the previous login options
|
|
1744
|
+
* when a user session expires.
|
|
1685
1745
|
*
|
|
1686
1746
|
* @default false
|
|
1687
1747
|
*/
|
|
1688
1748
|
autoLogin?: boolean;
|
|
1689
1749
|
/**
|
|
1690
1750
|
* Disable redirection to the login page when the embedded session expires
|
|
1691
|
-
* This flag is typically used alongside the combination of
|
|
1692
|
-
* AuthType.AuthServer} and auto
|
|
1751
|
+
* This flag is typically used alongside the combination of authentication modes such
|
|
1752
|
+
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
1753
|
+
* EmbedConfig.autoLogin}
|
|
1693
1754
|
*
|
|
1694
1755
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1695
1756
|
* @default false
|
|
1696
1757
|
*/
|
|
1697
1758
|
disableLoginRedirect?: boolean;
|
|
1698
1759
|
/**
|
|
1699
|
-
* This message is displayed
|
|
1760
|
+
* This message is displayed in the embedded view when a user login fails.
|
|
1700
1761
|
*
|
|
1701
1762
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1702
1763
|
*/
|
|
1703
1764
|
loginFailedMessage?: string;
|
|
1704
1765
|
/**
|
|
1705
|
-
* Calls the prefetch method internally when set to true
|
|
1766
|
+
* Calls the prefetch method internally when set to `true`
|
|
1706
1767
|
*
|
|
1707
1768
|
* @default false
|
|
1708
1769
|
*/
|
|
1709
1770
|
callPrefetch?: boolean;
|
|
1710
1771
|
/**
|
|
1711
|
-
* When there are multiple
|
|
1712
|
-
*
|
|
1713
|
-
*
|
|
1772
|
+
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1773
|
+
* to start after the previous embed's render is complete. This helps improve
|
|
1774
|
+
* performance by decreasing the load on the browser.
|
|
1714
1775
|
*
|
|
1715
1776
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1716
1777
|
* @default false
|
|
1717
1778
|
*/
|
|
1718
1779
|
queueMultiRenders?: boolean;
|
|
1719
1780
|
/**
|
|
1720
|
-
* Dynamic CSS
|
|
1781
|
+
* Dynamic CSS URL to be injected in the loaded application.
|
|
1721
1782
|
* You would also need to set `style-src` in the CSP settings.
|
|
1722
1783
|
*
|
|
1723
1784
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -1725,9 +1786,9 @@ export interface EmbedConfig {
|
|
|
1725
1786
|
*/
|
|
1726
1787
|
customCssUrl?: string;
|
|
1727
1788
|
/**
|
|
1728
|
-
* [AuthServer|Basic] Detect if
|
|
1789
|
+
* [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
|
|
1729
1790
|
* additional call. This is slower and should be avoided. Listen to the
|
|
1730
|
-
* NO_COOKIE_ACCESS event to handle the situation.
|
|
1791
|
+
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
1731
1792
|
*
|
|
1732
1793
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1733
1794
|
* involves an extra network call.
|
|
@@ -1736,26 +1797,26 @@ export interface EmbedConfig {
|
|
|
1736
1797
|
*/
|
|
1737
1798
|
detectCookieAccessSlow?: boolean;
|
|
1738
1799
|
/**
|
|
1739
|
-
* Hide beta alert warning message for SearchEmbed.
|
|
1800
|
+
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1740
1801
|
*
|
|
1741
1802
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
1742
1803
|
*/
|
|
1743
1804
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1744
1805
|
/**
|
|
1745
|
-
* Hide beta alert warning message for SageEmbed.
|
|
1806
|
+
* Hide `beta` alert warning message for SageEmbed.
|
|
1746
1807
|
*
|
|
1747
1808
|
*/
|
|
1748
1809
|
suppressSageEmbedBetaWarning?: boolean;
|
|
1749
1810
|
/**
|
|
1750
1811
|
* Custom style params for embed Config.
|
|
1751
1812
|
*
|
|
1752
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
|
|
1813
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1753
1814
|
*/
|
|
1754
1815
|
customizations?: CustomisationsInterface;
|
|
1755
1816
|
/**
|
|
1756
|
-
* For inPopup SAMLRedirect or OIDCRedirect
|
|
1757
|
-
* click to trigger the flow.
|
|
1758
|
-
* for that button.
|
|
1817
|
+
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1818
|
+
* button that the user can click to trigger the flow.
|
|
1819
|
+
* This attribute sets a containing element for that button.
|
|
1759
1820
|
*
|
|
1760
1821
|
* @example
|
|
1761
1822
|
* ```js
|
|
@@ -1765,11 +1826,11 @@ export interface EmbedConfig {
|
|
|
1765
1826
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1766
1827
|
* })
|
|
1767
1828
|
* ```
|
|
1768
|
-
* @version SDK: 1.17.0 | ThoughtSpot:
|
|
1829
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1769
1830
|
*/
|
|
1770
1831
|
authTriggerContainer?: string | HTMLElement;
|
|
1771
1832
|
/**
|
|
1772
|
-
* Specify that we want to use the AuthEvent.TRIGGER_SSO_POPUP event to trigger
|
|
1833
|
+
* Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger
|
|
1773
1834
|
* SAML popup. This is useful when you want to trigger the popup on a custom user
|
|
1774
1835
|
* action.
|
|
1775
1836
|
*
|
|
@@ -1777,20 +1838,22 @@ export interface EmbedConfig {
|
|
|
1777
1838
|
useEventForSAMLPopup?: boolean;
|
|
1778
1839
|
/**
|
|
1779
1840
|
* Text to show in the button which triggers the popup auth flow.
|
|
1780
|
-
* Default:
|
|
1841
|
+
* Default: `Authorize`.
|
|
1781
1842
|
*
|
|
1782
|
-
* @version SDK: 1.17.0 | ThoughtSpot:
|
|
1843
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1783
1844
|
*/
|
|
1784
1845
|
authTriggerText?: string;
|
|
1785
1846
|
/**
|
|
1786
|
-
*
|
|
1847
|
+
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
1848
|
+
* access to the embedded application users
|
|
1849
|
+
* outside of the iframe.
|
|
1787
1850
|
*
|
|
1788
1851
|
* @default true
|
|
1789
1852
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1790
1853
|
*/
|
|
1791
1854
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1792
1855
|
/**
|
|
1793
|
-
* Host config
|
|
1856
|
+
* Host config in case embedded app is inside TS app itself
|
|
1794
1857
|
*
|
|
1795
1858
|
* @hidden
|
|
1796
1859
|
*/
|
|
@@ -1806,21 +1869,27 @@ export interface EmbedConfig {
|
|
|
1806
1869
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
1807
1870
|
*/
|
|
1808
1871
|
pendoTrackingKey?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
* If passed as true all alerts will be suppressed in the embedded app.
|
|
1874
|
+
*
|
|
1875
|
+
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
1876
|
+
*/
|
|
1877
|
+
suppressErrorAlerts?: boolean;
|
|
1809
1878
|
}
|
|
1810
1879
|
export interface LayoutConfig {
|
|
1811
1880
|
}
|
|
1812
1881
|
/**
|
|
1813
|
-
* Embedded
|
|
1882
|
+
* Embedded iframe configuration
|
|
1814
1883
|
*
|
|
1815
1884
|
* @group Embed components
|
|
1816
1885
|
*/
|
|
1817
1886
|
export interface FrameParams {
|
|
1818
1887
|
/**
|
|
1819
|
-
* The width of the
|
|
1888
|
+
* The width of the iframe (unit is pixels if numeric).
|
|
1820
1889
|
*/
|
|
1821
1890
|
width?: number | string;
|
|
1822
1891
|
/**
|
|
1823
|
-
* The height of the
|
|
1892
|
+
* The height of the iframe (unit is pixels if numeric).
|
|
1824
1893
|
*/
|
|
1825
1894
|
height?: number | string;
|
|
1826
1895
|
/**
|
|
@@ -1921,7 +1990,6 @@ export interface ViewConfig {
|
|
|
1921
1990
|
*/
|
|
1922
1991
|
runtimeParameters?: RuntimeParameter[];
|
|
1923
1992
|
/**
|
|
1924
|
-
/**
|
|
1925
1993
|
* The locale/language to use for the embedded view.
|
|
1926
1994
|
*
|
|
1927
1995
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
@@ -2021,31 +2089,29 @@ export interface ViewConfig {
|
|
|
2021
2089
|
*/
|
|
2022
2090
|
reorderedHomepageModules?: HomepageModule[];
|
|
2023
2091
|
/**
|
|
2024
|
-
* The list of tab IDs to show in the embedded.
|
|
2025
|
-
* Only
|
|
2026
|
-
* Use this to show an tabID.
|
|
2092
|
+
* The list of tab IDs to show in the embedded Liveboard.
|
|
2093
|
+
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2027
2094
|
*
|
|
2028
|
-
* Use either
|
|
2095
|
+
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2029
2096
|
*
|
|
2030
2097
|
* @example
|
|
2031
2098
|
* ```js
|
|
2032
|
-
*
|
|
2033
|
-
* ... // other liveboard view config
|
|
2034
|
-
* visibleTabs: [
|
|
2099
|
+
* visibleTabs: [
|
|
2035
2100
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2036
|
-
*
|
|
2037
|
-
* });
|
|
2101
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
2038
2102
|
* ```
|
|
2039
2103
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2040
2104
|
*/
|
|
2041
2105
|
visibleTabs?: string[];
|
|
2042
2106
|
/**
|
|
2043
|
-
* homepageLeftNavItems :
|
|
2044
|
-
* There are 8 home
|
|
2045
|
-
*
|
|
2046
|
-
* eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
|
|
2107
|
+
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2108
|
+
* There are 8 eight home navigation list items.
|
|
2109
|
+
* To hide these items, specify the string in the array.
|
|
2047
2110
|
*
|
|
2048
|
-
*
|
|
2111
|
+
* ```js
|
|
2112
|
+
* hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
|
|
2113
|
+
* ```
|
|
2114
|
+
* @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
|
|
2049
2115
|
*/
|
|
2050
2116
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2051
2117
|
/**
|
|
@@ -2061,7 +2127,7 @@ export interface ViewConfig {
|
|
|
2061
2127
|
* });
|
|
2062
2128
|
* embed.showPreRender();
|
|
2063
2129
|
* ```
|
|
2064
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2130
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
2065
2131
|
*/
|
|
2066
2132
|
preRenderId?: string;
|
|
2067
2133
|
/**
|
|
@@ -2094,7 +2160,7 @@ export type MessagePayload = {
|
|
|
2094
2160
|
status?: string;
|
|
2095
2161
|
};
|
|
2096
2162
|
/**
|
|
2097
|
-
* MessageOptions: By
|
|
2163
|
+
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2098
2164
|
* option
|
|
2099
2165
|
*
|
|
2100
2166
|
* @group Events
|
|
@@ -2102,7 +2168,7 @@ export type MessagePayload = {
|
|
|
2102
2168
|
export type MessageOptions = {
|
|
2103
2169
|
/**
|
|
2104
2170
|
* A boolean value indicating that start status events of this type
|
|
2105
|
-
* will be dispatched
|
|
2171
|
+
* will be dispatched.
|
|
2106
2172
|
*/
|
|
2107
2173
|
start?: boolean;
|
|
2108
2174
|
};
|
|
@@ -2122,7 +2188,7 @@ responder?: (data: any) => void) => void;
|
|
|
2122
2188
|
*/
|
|
2123
2189
|
export type MessageCallbackObj = {
|
|
2124
2190
|
/**
|
|
2125
|
-
* options: It contains start,
|
|
2191
|
+
* options: It contains start, a boolean value indicating that start
|
|
2126
2192
|
* status events of this type will be dispatched
|
|
2127
2193
|
*/
|
|
2128
2194
|
options: MessageOptions;
|
|
@@ -2194,7 +2260,7 @@ export declare enum RuntimeFilterOp {
|
|
|
2194
2260
|
IN = "IN"
|
|
2195
2261
|
}
|
|
2196
2262
|
/**
|
|
2197
|
-
* Home page module that can be
|
|
2263
|
+
* Home page module that can be hidden
|
|
2198
2264
|
*/
|
|
2199
2265
|
export declare enum HomepageModule {
|
|
2200
2266
|
/**
|
|
@@ -2210,7 +2276,7 @@ export declare enum HomepageModule {
|
|
|
2210
2276
|
*/
|
|
2211
2277
|
Favorite = "FAVORITE",
|
|
2212
2278
|
/**
|
|
2213
|
-
* List of answers and
|
|
2279
|
+
* List of answers and Liveboards
|
|
2214
2280
|
*/
|
|
2215
2281
|
MyLibrary = "MY_LIBRARY",
|
|
2216
2282
|
/**
|
|
@@ -2243,7 +2309,7 @@ export interface RuntimeFilter {
|
|
|
2243
2309
|
values: (number | boolean | string)[];
|
|
2244
2310
|
}
|
|
2245
2311
|
/**
|
|
2246
|
-
* A filter that can be applied to ThoughtSpot
|
|
2312
|
+
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
2247
2313
|
* visualizations at runtime.
|
|
2248
2314
|
*/
|
|
2249
2315
|
export interface RuntimeParameter {
|
|
@@ -2279,6 +2345,14 @@ export interface RuntimeParameter {
|
|
|
2279
2345
|
export declare enum EmbedEvent {
|
|
2280
2346
|
/**
|
|
2281
2347
|
* Rendering has initialized.
|
|
2348
|
+
* @example
|
|
2349
|
+
*```js
|
|
2350
|
+
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2351
|
+
* //show a loader
|
|
2352
|
+
* function showLoader() {
|
|
2353
|
+
* document.getElementById("loader");
|
|
2354
|
+
* }
|
|
2355
|
+
*```
|
|
2282
2356
|
*
|
|
2283
2357
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2284
2358
|
*/
|
|
@@ -2286,69 +2360,162 @@ export declare enum EmbedEvent {
|
|
|
2286
2360
|
/**
|
|
2287
2361
|
* Authentication has either succeeded or failed.
|
|
2288
2362
|
*
|
|
2363
|
+
* @example
|
|
2364
|
+
*```js
|
|
2365
|
+
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2366
|
+
* console.log('AuthInit', payload);
|
|
2367
|
+
* })
|
|
2368
|
+
*```
|
|
2369
|
+
*
|
|
2289
2370
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
2290
2371
|
*/
|
|
2291
2372
|
AuthInit = "authInit",
|
|
2292
2373
|
/**
|
|
2293
2374
|
* The embed object container has loaded.
|
|
2294
|
-
*
|
|
2295
2375
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2376
|
+
* @example
|
|
2377
|
+
*```js
|
|
2378
|
+
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2379
|
+
* //hide loader
|
|
2380
|
+
* function hideLoader() {
|
|
2381
|
+
* document.getElementById("loader");
|
|
2382
|
+
* }
|
|
2383
|
+
*```
|
|
2296
2384
|
*/
|
|
2297
2385
|
Load = "load",
|
|
2298
2386
|
/**
|
|
2299
2387
|
* Data pertaining to answer or Liveboard is received
|
|
2300
|
-
*
|
|
2301
2388
|
* @return data - The answer or Liveboard data
|
|
2389
|
+
* @example
|
|
2390
|
+
*```js
|
|
2391
|
+
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2392
|
+
* console.log('data', payload);
|
|
2393
|
+
* })
|
|
2394
|
+
*```
|
|
2302
2395
|
* @important
|
|
2303
2396
|
*/
|
|
2304
2397
|
Data = "data",
|
|
2305
2398
|
/**
|
|
2306
|
-
* Search/
|
|
2399
|
+
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2307
2400
|
*
|
|
2308
2401
|
* @hidden
|
|
2309
2402
|
*/
|
|
2310
2403
|
FiltersChanged = "filtersChanged",
|
|
2311
2404
|
/**
|
|
2312
2405
|
* Search query has been updated by the user.
|
|
2406
|
+
*
|
|
2407
|
+
* @example
|
|
2408
|
+
*```js
|
|
2409
|
+
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2410
|
+
*```
|
|
2411
|
+
*
|
|
2313
2412
|
*/
|
|
2314
2413
|
QueryChanged = "queryChanged",
|
|
2315
2414
|
/**
|
|
2316
|
-
* A drill
|
|
2415
|
+
* A drill-down operation has been performed.
|
|
2317
2416
|
*
|
|
2318
2417
|
* @returns additionalFilters - Any additional filters applied
|
|
2319
2418
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2320
2419
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2420
|
+
*
|
|
2421
|
+
* @example
|
|
2422
|
+
*```js
|
|
2423
|
+
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
2424
|
+
* points: {
|
|
2425
|
+
* clickedPoint,
|
|
2426
|
+
* selectedPoints: selectedPoint
|
|
2427
|
+
* },
|
|
2428
|
+
* autoDrillDown: true,
|
|
2429
|
+
* })
|
|
2430
|
+
*```
|
|
2431
|
+
* In this example, `VizPointDoubleClick` event is used for
|
|
2432
|
+
* triggering the `DrillDown` event when an area or specific
|
|
2433
|
+
* data point on a table or chart is double-clicked.
|
|
2434
|
+
*
|
|
2435
|
+
* @example
|
|
2436
|
+
*```js
|
|
2437
|
+
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2438
|
+
* console.log(payload);
|
|
2439
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
2440
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
2441
|
+
* console.log('>>> called', clickedPoint);
|
|
2442
|
+
* embed.trigger(HostEvent.DrillDown, {
|
|
2443
|
+
* points: {
|
|
2444
|
+
* clickedPoint,
|
|
2445
|
+
* selectedPoints: selectedPoint
|
|
2446
|
+
* },
|
|
2447
|
+
* autoDrillDown: true,
|
|
2448
|
+
* })
|
|
2449
|
+
* })
|
|
2450
|
+
*```
|
|
2451
|
+
*
|
|
2321
2452
|
*/
|
|
2322
2453
|
Drilldown = "drillDown",
|
|
2323
2454
|
/**
|
|
2324
2455
|
* One or more data sources have been selected.
|
|
2325
|
-
*
|
|
2326
2456
|
* @returns dataSourceIds - the list of data sources
|
|
2457
|
+
*
|
|
2458
|
+
* @example
|
|
2459
|
+
* ```js
|
|
2460
|
+
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
2461
|
+
* console.log('DataSourceSelected', payload);
|
|
2462
|
+
* })
|
|
2463
|
+
* ```
|
|
2464
|
+
*
|
|
2327
2465
|
*/
|
|
2328
2466
|
DataSourceSelected = "dataSourceSelected",
|
|
2329
2467
|
/**
|
|
2330
2468
|
* One or more data columns have been selected.
|
|
2331
|
-
*
|
|
2332
2469
|
* @returns columnIds - the list of columns
|
|
2333
2470
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2471
|
+
*
|
|
2472
|
+
* @example
|
|
2473
|
+
* ```js
|
|
2474
|
+
* appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
|
|
2475
|
+
* console.log('AddRemoveColumns', payload);
|
|
2476
|
+
* })
|
|
2477
|
+
* ```
|
|
2478
|
+
*
|
|
2334
2479
|
*/
|
|
2335
2480
|
AddRemoveColumns = "addRemoveColumns",
|
|
2336
2481
|
/**
|
|
2337
|
-
* A custom action has been triggered
|
|
2482
|
+
* A custom action has been triggered.
|
|
2338
2483
|
*
|
|
2339
|
-
* @returns actionId -
|
|
2340
|
-
* @returns data -
|
|
2484
|
+
* @returns actionId - ID of the custom action
|
|
2485
|
+
* @returns data - Response payload with the Answer or Liveboard data
|
|
2486
|
+
*
|
|
2487
|
+
* @example
|
|
2488
|
+
* ```js
|
|
2489
|
+
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
2490
|
+
* const data = payload.data;
|
|
2491
|
+
* if (data.id === 'insert Custom Action ID here') {
|
|
2492
|
+
* console.log('Custom Action event:', data.embedAnswerData);
|
|
2493
|
+
* }
|
|
2494
|
+
* })
|
|
2495
|
+
* ```
|
|
2341
2496
|
*/
|
|
2342
2497
|
CustomAction = "customAction",
|
|
2343
2498
|
/**
|
|
2344
|
-
* Listen to double
|
|
2499
|
+
* Listen to double click actions on a visualization.
|
|
2500
|
+
*
|
|
2501
|
+
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
2345
2502
|
*
|
|
2346
|
-
* @return ContextMenuInputPoints - data point that is double clicked
|
|
2347
2503
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2504
|
+
*
|
|
2505
|
+
* @example
|
|
2506
|
+
* ```js
|
|
2507
|
+
* livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
|
|
2508
|
+
* console.log('VizPointDoubleClick', payload)
|
|
2509
|
+
* })
|
|
2510
|
+
* ```
|
|
2348
2511
|
*/
|
|
2349
2512
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
2350
2513
|
/**
|
|
2351
|
-
* Listen to clicks on a visualization in a
|
|
2514
|
+
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
2515
|
+
*
|
|
2516
|
+
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
2517
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2518
|
+
* @important
|
|
2352
2519
|
*
|
|
2353
2520
|
* @example
|
|
2354
2521
|
* ```js
|
|
@@ -2362,25 +2529,46 @@ export declare enum EmbedEvent {
|
|
|
2362
2529
|
* )
|
|
2363
2530
|
* });
|
|
2364
2531
|
* ```
|
|
2365
|
-
* @return viz, clickedPoint - metadata about point that is clicked
|
|
2366
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2367
|
-
* @important
|
|
2368
2532
|
*/
|
|
2369
2533
|
VizPointClick = "vizPointClick",
|
|
2370
2534
|
/**
|
|
2371
2535
|
* An error has occurred.
|
|
2372
2536
|
*
|
|
2373
2537
|
* @returns error - An error object or message
|
|
2538
|
+
*
|
|
2539
|
+
* @example
|
|
2540
|
+
* ```js
|
|
2541
|
+
* SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
|
|
2542
|
+
* //show error messaage
|
|
2543
|
+
* function showErrorMsg() {
|
|
2544
|
+
* document.getElementById("error");
|
|
2545
|
+
* ```
|
|
2546
|
+
*
|
|
2374
2547
|
*/
|
|
2375
2548
|
Error = "Error",
|
|
2376
2549
|
/**
|
|
2377
|
-
* The embedded object has sent an alert
|
|
2550
|
+
* The embedded object has sent an alert.
|
|
2378
2551
|
*
|
|
2379
2552
|
* @returns alert - An alert object
|
|
2553
|
+
*
|
|
2554
|
+
* @example
|
|
2555
|
+
* ```js
|
|
2556
|
+
* searchEmbed.on(EmbedEvent.Alert)
|
|
2557
|
+
* ```
|
|
2558
|
+
*
|
|
2380
2559
|
*/
|
|
2381
2560
|
Alert = "alert",
|
|
2382
2561
|
/**
|
|
2383
2562
|
* The ThoughtSpot auth session has expired.
|
|
2563
|
+
*
|
|
2564
|
+
* @example
|
|
2565
|
+
*```js
|
|
2566
|
+
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
2567
|
+
* //show auth expired banner
|
|
2568
|
+
* function showAuthExpired() {
|
|
2569
|
+
* document.getElementById("authExpiredBanner");
|
|
2570
|
+
* }
|
|
2571
|
+
*```
|
|
2384
2572
|
*/
|
|
2385
2573
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2386
2574
|
/**
|
|
@@ -2410,14 +2598,28 @@ export declare enum EmbedEvent {
|
|
|
2410
2598
|
*/
|
|
2411
2599
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
2412
2600
|
/**
|
|
2413
|
-
* Emitted when
|
|
2414
|
-
*
|
|
2601
|
+
* Emitted when the **Get Data** action is initiated.
|
|
2602
|
+
* Applicable to `SearchBarEmbed` only.
|
|
2603
|
+
*
|
|
2604
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2415
2605
|
*
|
|
2416
|
-
* @
|
|
2606
|
+
* @example
|
|
2607
|
+
*```js
|
|
2608
|
+
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
2609
|
+
* .then(data => {
|
|
2610
|
+
* console.log('Answer Data:', data);
|
|
2611
|
+
* })
|
|
2612
|
+
*```
|
|
2417
2613
|
*/
|
|
2418
2614
|
GetDataClick = "getDataClick",
|
|
2419
2615
|
/**
|
|
2420
2616
|
* Detects the route change.
|
|
2617
|
+
*
|
|
2618
|
+
* @example
|
|
2619
|
+
*```js
|
|
2620
|
+
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
2621
|
+
* console.log('data', payload))
|
|
2622
|
+
*```
|
|
2421
2623
|
*/
|
|
2422
2624
|
RouteChange = "ROUTE_CHANGE",
|
|
2423
2625
|
/**
|
|
@@ -2427,10 +2629,15 @@ export declare enum EmbedEvent {
|
|
|
2427
2629
|
*/
|
|
2428
2630
|
V1Data = "exportVizDataToParent",
|
|
2429
2631
|
/**
|
|
2430
|
-
* Emitted when the embed does not have cookie access. This
|
|
2431
|
-
*
|
|
2632
|
+
* Emitted when the embed does not have cookie access. This happens
|
|
2633
|
+
* when Safari and other Web browsers block third-party cookies
|
|
2634
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
2432
2635
|
*
|
|
2433
|
-
* @
|
|
2636
|
+
* @example
|
|
2637
|
+
*```js
|
|
2638
|
+
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
2639
|
+
*```
|
|
2640
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
2434
2641
|
*/
|
|
2435
2642
|
NoCookieAccess = "noCookieAccess",
|
|
2436
2643
|
/**
|
|
@@ -2442,239 +2649,539 @@ export declare enum EmbedEvent {
|
|
|
2442
2649
|
SAMLComplete = "samlComplete",
|
|
2443
2650
|
/**
|
|
2444
2651
|
* Emitted when any modal is opened in the app
|
|
2445
|
-
*
|
|
2446
2652
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2653
|
+
*
|
|
2654
|
+
* @example
|
|
2655
|
+
*```js
|
|
2656
|
+
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
2657
|
+
* console.log('dialog open', payload);
|
|
2658
|
+
* })
|
|
2659
|
+
*```
|
|
2447
2660
|
*/
|
|
2448
2661
|
DialogOpen = "dialog-open",
|
|
2449
2662
|
/**
|
|
2450
2663
|
* Emitted when any modal is closed in the app
|
|
2451
|
-
*
|
|
2452
2664
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2665
|
+
*
|
|
2666
|
+
* @example
|
|
2667
|
+
*```js
|
|
2668
|
+
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
2669
|
+
* console.log('dialog close', payload);
|
|
2670
|
+
* })
|
|
2671
|
+
*```
|
|
2453
2672
|
*/
|
|
2454
2673
|
DialogClose = "dialog-close",
|
|
2455
2674
|
/**
|
|
2456
2675
|
* Emitted when the Liveboard shell loads.
|
|
2457
2676
|
* You can use this event as a hook to trigger
|
|
2458
2677
|
* other events on the rendered Liveboard.
|
|
2459
|
-
*
|
|
2460
2678
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2679
|
+
*
|
|
2680
|
+
* @example
|
|
2681
|
+
*```js
|
|
2682
|
+
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
2683
|
+
console.log('Liveboard is rendered', payload);
|
|
2684
|
+
})
|
|
2685
|
+
*```
|
|
2686
|
+
* The following example shows how to trigger
|
|
2687
|
+
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
2688
|
+
*
|
|
2689
|
+
* @example
|
|
2690
|
+
*```js
|
|
2691
|
+
* const embedRef = useEmbedRef();
|
|
2692
|
+
* const onLiveboardRendered = () => {
|
|
2693
|
+
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
2694
|
+
* };
|
|
2695
|
+
*```
|
|
2461
2696
|
*/
|
|
2462
2697
|
LiveboardRendered = "PinboardRendered",
|
|
2463
2698
|
/**
|
|
2464
2699
|
* This can be used to register an event listener which
|
|
2465
2700
|
* is triggered on all events.
|
|
2466
|
-
*
|
|
2467
2701
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2702
|
+
*
|
|
2703
|
+
* @example
|
|
2704
|
+
*```js
|
|
2705
|
+
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
2706
|
+
* console.log('Embed Events', payload)
|
|
2707
|
+
* })
|
|
2708
|
+
*```
|
|
2468
2709
|
*/
|
|
2469
2710
|
ALL = "*",
|
|
2470
2711
|
/**
|
|
2471
2712
|
* Emitted when an Answer is saved in the app
|
|
2472
|
-
*
|
|
2473
2713
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2714
|
+
* @example
|
|
2715
|
+
*```js
|
|
2716
|
+
* //trigger when action starts
|
|
2717
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2718
|
+
* console.log('Save', payload)
|
|
2719
|
+
* }, {
|
|
2720
|
+
* start: true
|
|
2721
|
+
* })
|
|
2722
|
+
* //trigger when action ends
|
|
2723
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2724
|
+
* console.log('Save', payload)
|
|
2725
|
+
* })
|
|
2726
|
+
*```
|
|
2474
2727
|
*/
|
|
2475
2728
|
Save = "save",
|
|
2476
2729
|
/**
|
|
2477
2730
|
* Emitted when the download action is triggered on an answer
|
|
2478
2731
|
*
|
|
2732
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
2733
|
+
* To fire an event when a download action is initiated on a chart or table,
|
|
2734
|
+
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
2735
|
+
* or `EmbedEvent.DownloadAsXLSX`
|
|
2736
|
+
*
|
|
2479
2737
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2738
|
+
*
|
|
2739
|
+
* @example
|
|
2740
|
+
*```js
|
|
2741
|
+
* liveboardEmbed.trigger(HostEvent.Download, {
|
|
2742
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2743
|
+
* })
|
|
2744
|
+
*```
|
|
2480
2745
|
*/
|
|
2481
2746
|
Download = "download",
|
|
2482
2747
|
/**
|
|
2483
2748
|
* Emitted when the download action is triggered on an answer
|
|
2484
|
-
*
|
|
2485
2749
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
2750
|
+
*
|
|
2751
|
+
* @example
|
|
2752
|
+
*```js
|
|
2753
|
+
* //trigger when action starts
|
|
2754
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2755
|
+
* console.log('download PNG', payload)}, {start: true })
|
|
2756
|
+
* //trigger when action ends
|
|
2757
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2758
|
+
* console.log('download PNG', payload)})
|
|
2759
|
+
*```
|
|
2760
|
+
*
|
|
2486
2761
|
*/
|
|
2487
2762
|
DownloadAsPng = "downloadAsPng",
|
|
2488
2763
|
/**
|
|
2489
2764
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
2490
2765
|
*
|
|
2491
2766
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2767
|
+
*
|
|
2768
|
+
* @example
|
|
2769
|
+
*```js
|
|
2770
|
+
* //trigger when action starts
|
|
2771
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2772
|
+
* console.log('download PDF', payload)}, {start: true })
|
|
2773
|
+
* //trigger when action ends
|
|
2774
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2775
|
+
* console.log('download PDF', payload)})
|
|
2776
|
+
*```
|
|
2777
|
+
*
|
|
2492
2778
|
*/
|
|
2493
2779
|
DownloadAsPdf = "downloadAsPdf",
|
|
2494
2780
|
/**
|
|
2495
2781
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
2496
2782
|
*
|
|
2497
2783
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2784
|
+
* @example
|
|
2785
|
+
*```js
|
|
2786
|
+
* //trigger when action starts
|
|
2787
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2788
|
+
* console.log('download CSV', payload)}, {start: true })
|
|
2789
|
+
* //trigger when action ends
|
|
2790
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2791
|
+
* console.log('download CSV', payload)})
|
|
2792
|
+
*```
|
|
2498
2793
|
*/
|
|
2499
2794
|
DownloadAsCsv = "downloadAsCsv",
|
|
2500
2795
|
/**
|
|
2501
2796
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
2502
2797
|
*
|
|
2503
2798
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2799
|
+
*
|
|
2800
|
+
* @example
|
|
2801
|
+
*```js
|
|
2802
|
+
* //trigger when action starts
|
|
2803
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2804
|
+
* console.log('download Xlsx', payload)}, { start: true })
|
|
2805
|
+
* //trigger when action ends
|
|
2806
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2807
|
+
* console.log('download Xlsx', payload)})
|
|
2808
|
+
*```
|
|
2504
2809
|
*/
|
|
2505
2810
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
2506
2811
|
/**
|
|
2507
|
-
* Emitted when an
|
|
2812
|
+
* Emitted when an Answer is deleted in the app
|
|
2508
2813
|
*
|
|
2509
2814
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2815
|
+
*
|
|
2816
|
+
* @example
|
|
2817
|
+
*```js
|
|
2818
|
+
* //trigger when action starts
|
|
2819
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2820
|
+
* console.log('delete answer', payload)}, {start: true })
|
|
2821
|
+
* //trigger when action is completed
|
|
2822
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2823
|
+
* console.log('delete answer', payload)})
|
|
2824
|
+
*```
|
|
2510
2825
|
*/
|
|
2511
2826
|
AnswerDelete = "answerDelete",
|
|
2512
2827
|
/**
|
|
2513
2828
|
* Emitted when an answer is pinned to a Liveboard
|
|
2514
2829
|
*
|
|
2515
2830
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2831
|
+
* @example
|
|
2832
|
+
*```js
|
|
2833
|
+
* //trigger when action starts
|
|
2834
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2835
|
+
* console.log('pin', payload)
|
|
2836
|
+
* }, {
|
|
2837
|
+
* start: true
|
|
2838
|
+
* })
|
|
2839
|
+
* //trigger when action ends
|
|
2840
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2841
|
+
* console.log('pin', payload)
|
|
2842
|
+
* })
|
|
2843
|
+
*```
|
|
2516
2844
|
*/
|
|
2517
2845
|
Pin = "pin",
|
|
2518
2846
|
/**
|
|
2519
2847
|
* Emitted when SpotIQ analysis is triggered
|
|
2520
2848
|
*
|
|
2521
2849
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2850
|
+
* @example
|
|
2851
|
+
*```js
|
|
2852
|
+
* //trigger when action starts
|
|
2853
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2854
|
+
* console.log('SpotIQAnalyze', payload)
|
|
2855
|
+
* }, {
|
|
2856
|
+
* start: true
|
|
2857
|
+
* })
|
|
2858
|
+
* //trigger when action ends
|
|
2859
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2860
|
+
* console.log('SpotIQ analyze', payload)
|
|
2861
|
+
* })
|
|
2862
|
+
*```
|
|
2522
2863
|
*/
|
|
2523
2864
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2524
2865
|
/**
|
|
2525
2866
|
* Emitted when a user shares an object with another user or group
|
|
2526
2867
|
*
|
|
2527
2868
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2869
|
+
*
|
|
2870
|
+
* @example
|
|
2871
|
+
*```js
|
|
2872
|
+
* //trigger when action starts
|
|
2873
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2874
|
+
* console.log('Share', payload)
|
|
2875
|
+
* }, {
|
|
2876
|
+
* start: true
|
|
2877
|
+
* })
|
|
2878
|
+
* //trigger when action ends
|
|
2879
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2880
|
+
* console.log('Share', payload)
|
|
2881
|
+
* })
|
|
2882
|
+
*```
|
|
2528
2883
|
*/
|
|
2529
2884
|
Share = "share",
|
|
2530
2885
|
/**
|
|
2531
|
-
* Emitted when a user clicks the Include action to include a specific value or
|
|
2532
|
-
* on a chart or table
|
|
2886
|
+
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
2887
|
+
* data on a chart or table.
|
|
2533
2888
|
*
|
|
2534
2889
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2890
|
+
* @example
|
|
2891
|
+
*```js
|
|
2892
|
+
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
2893
|
+
* console.log('Drill include', payload);
|
|
2894
|
+
* })
|
|
2895
|
+
*```
|
|
2535
2896
|
*/
|
|
2536
2897
|
DrillInclude = "context-menu-item-include",
|
|
2537
2898
|
/**
|
|
2538
|
-
* Emitted when a user clicks the Exclude action to exclude a specific value or
|
|
2539
|
-
* on a chart or table
|
|
2899
|
+
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
2900
|
+
* data on a chart or table
|
|
2540
2901
|
*
|
|
2541
2902
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2903
|
+
* @example
|
|
2904
|
+
*```js
|
|
2905
|
+
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
2906
|
+
* console.log('Drill exclude', payload);
|
|
2907
|
+
* })
|
|
2908
|
+
*```
|
|
2542
2909
|
*/
|
|
2543
2910
|
DrillExclude = "context-menu-item-exclude",
|
|
2544
2911
|
/**
|
|
2545
|
-
* Emitted when
|
|
2912
|
+
* Emitted when a column value is copied in the embedded app.
|
|
2546
2913
|
*
|
|
2547
2914
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2915
|
+
* @example
|
|
2916
|
+
*```js
|
|
2917
|
+
* seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
2918
|
+
* console.log('copy to clipboard', payload);
|
|
2919
|
+
* })
|
|
2920
|
+
*```
|
|
2548
2921
|
*/
|
|
2549
2922
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2550
2923
|
/**
|
|
2551
|
-
* Emitted when a user clicks the Update TML action
|
|
2924
|
+
* Emitted when a user clicks the **Update TML** action
|
|
2552
2925
|
*
|
|
2553
2926
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2927
|
+
* @example
|
|
2928
|
+
*```js
|
|
2929
|
+
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
2930
|
+
* })
|
|
2931
|
+
*```
|
|
2554
2932
|
*/
|
|
2555
2933
|
UpdateTML = "updateTSL",
|
|
2556
2934
|
/**
|
|
2557
|
-
* Emitted when a user clicks the Edit TML action
|
|
2935
|
+
* Emitted when a user clicks the **Edit TML** action
|
|
2558
2936
|
*
|
|
2559
2937
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2938
|
+
* @example
|
|
2939
|
+
*```js
|
|
2940
|
+
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
2941
|
+
* console.log('Edit TML', payload);
|
|
2942
|
+
* })
|
|
2943
|
+
*```
|
|
2560
2944
|
*/
|
|
2561
2945
|
EditTML = "editTSL",
|
|
2562
2946
|
/**
|
|
2563
|
-
* Emitted when
|
|
2564
|
-
*
|
|
2947
|
+
* Emitted when the **Export TML** action is triggered on an
|
|
2948
|
+
* an embedded object in the app
|
|
2565
2949
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2950
|
+
* @example
|
|
2951
|
+
*```js
|
|
2952
|
+
* //trigger when action starts
|
|
2953
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2954
|
+
* console.log('Export TML', payload)}, { start: true })
|
|
2955
|
+
* //trigger when action ends
|
|
2956
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2957
|
+
* console.log('Export TML', payload)})
|
|
2958
|
+
*```
|
|
2566
2959
|
*/
|
|
2567
2960
|
ExportTML = "exportTSL",
|
|
2568
2961
|
/**
|
|
2569
|
-
* Emitted when an
|
|
2962
|
+
* Emitted when an Answer is saved as a View.
|
|
2570
2963
|
*
|
|
2571
2964
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2965
|
+
* @example
|
|
2966
|
+
*```js
|
|
2967
|
+
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
2968
|
+
* console.log('View', payload);
|
|
2969
|
+
* })
|
|
2970
|
+
*```
|
|
2572
2971
|
*/
|
|
2573
2972
|
SaveAsView = "saveAsView",
|
|
2574
2973
|
/**
|
|
2575
|
-
* Emitted when
|
|
2974
|
+
* Emitted when the user creates a copy of an Answer
|
|
2576
2975
|
*
|
|
2577
2976
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2977
|
+
* @example
|
|
2978
|
+
*```js
|
|
2979
|
+
* //trigger when action starts
|
|
2980
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2981
|
+
* console.log('Copy and edit', payload)}, {start: true })
|
|
2982
|
+
* //trigger when action ends
|
|
2983
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2984
|
+
* console.log('Copy and edit', payload)})
|
|
2985
|
+
*```
|
|
2578
2986
|
*/
|
|
2579
2987
|
CopyAEdit = "copyAEdit",
|
|
2580
2988
|
/**
|
|
2581
|
-
* Emitted when a user clicks Show underlying data on an
|
|
2989
|
+
* Emitted when a user clicks Show underlying data on an Answer
|
|
2582
2990
|
*
|
|
2583
2991
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2992
|
+
* @example
|
|
2993
|
+
*```js
|
|
2994
|
+
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
2995
|
+
* console.log('show data', payload);
|
|
2996
|
+
* })
|
|
2997
|
+
*```
|
|
2584
2998
|
*/
|
|
2585
2999
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2586
3000
|
/**
|
|
2587
|
-
* Emitted when an answer is switched to a chart or table view
|
|
3001
|
+
* Emitted when an answer is switched to a chart or table view.
|
|
2588
3002
|
*
|
|
2589
3003
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3004
|
+
* @example
|
|
3005
|
+
*```js
|
|
3006
|
+
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3007
|
+
* console.log('switch view', payload);
|
|
3008
|
+
* })
|
|
3009
|
+
*```
|
|
2590
3010
|
*/
|
|
2591
3011
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2592
3012
|
/**
|
|
2593
|
-
* Internal event to communicate the initial settings back to the
|
|
3013
|
+
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
2594
3014
|
*
|
|
2595
3015
|
* @hidden
|
|
2596
3016
|
*/
|
|
2597
3017
|
APP_INIT = "appInit",
|
|
2598
3018
|
/**
|
|
2599
|
-
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
3019
|
+
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
2600
3020
|
*
|
|
2601
3021
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3022
|
+
* @example
|
|
3023
|
+
*```js
|
|
3024
|
+
* liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3025
|
+
* console.log('Liveboard details', payload);
|
|
3026
|
+
* })
|
|
3027
|
+
*```
|
|
2602
3028
|
*/
|
|
2603
3029
|
LiveboardInfo = "pinboardInfo",
|
|
2604
3030
|
/**
|
|
2605
3031
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
2606
3032
|
*
|
|
2607
3033
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3034
|
+
* @example
|
|
3035
|
+
*```js
|
|
3036
|
+
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3037
|
+
* console.log('favorites', payload);
|
|
3038
|
+
* })
|
|
3039
|
+
*```
|
|
2608
3040
|
*/
|
|
2609
3041
|
AddToFavorites = "addToFavorites",
|
|
2610
3042
|
/**
|
|
2611
|
-
* Emitted when a user clicks Schedule on a Liveboard
|
|
3043
|
+
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
2612
3044
|
*
|
|
2613
3045
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3046
|
+
* @example
|
|
3047
|
+
*```js
|
|
3048
|
+
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3049
|
+
* console.log(`Liveboard schedule', payload);
|
|
3050
|
+
* })
|
|
3051
|
+
*```
|
|
2614
3052
|
*/
|
|
2615
3053
|
Schedule = "subscription",
|
|
2616
3054
|
/**
|
|
2617
|
-
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
3055
|
+
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
2618
3056
|
*
|
|
2619
3057
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3058
|
+
* @example
|
|
3059
|
+
*```js
|
|
3060
|
+
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3061
|
+
* console.log(`Liveboard edit', payload);
|
|
3062
|
+
* })
|
|
3063
|
+
*```
|
|
2620
3064
|
*/
|
|
2621
3065
|
Edit = "edit",
|
|
2622
3066
|
/**
|
|
2623
|
-
* Emitted when a user clicks Make a copy on a Liveboard
|
|
3067
|
+
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
2624
3068
|
*
|
|
2625
3069
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3070
|
+
* @example
|
|
3071
|
+
*```js
|
|
3072
|
+
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3073
|
+
* console.log(`Copy', payload);
|
|
3074
|
+
* })
|
|
3075
|
+
*```
|
|
2626
3076
|
*/
|
|
2627
3077
|
MakeACopy = "makeACopy",
|
|
2628
3078
|
/**
|
|
2629
|
-
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
3079
|
+
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
2630
3080
|
*
|
|
2631
3081
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3082
|
+
* @example
|
|
3083
|
+
*```js
|
|
3084
|
+
* liveboardEmbed.trigger(HostEvent.Present)
|
|
3085
|
+
*```
|
|
3086
|
+
*
|
|
3087
|
+
* @example
|
|
3088
|
+
*```js
|
|
3089
|
+
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3090
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3091
|
+
* })
|
|
3092
|
+
*```
|
|
2632
3093
|
*/
|
|
2633
3094
|
Present = "present",
|
|
2634
3095
|
/**
|
|
2635
|
-
* Emitted when a user clicks Delete on a
|
|
3096
|
+
* Emitted when a user clicks **Delete** on a visualization
|
|
2636
3097
|
*
|
|
2637
3098
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3099
|
+
* @example
|
|
3100
|
+
*```js
|
|
3101
|
+
* liveboardEmbed.trigger(HostEvent.Delete,
|
|
3102
|
+
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3103
|
+
*```
|
|
3104
|
+
*
|
|
2638
3105
|
*/
|
|
2639
3106
|
Delete = "delete",
|
|
2640
3107
|
/**
|
|
2641
3108
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2642
3109
|
*
|
|
2643
3110
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3111
|
+
*
|
|
3112
|
+
* @example
|
|
3113
|
+
*```js
|
|
3114
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList)
|
|
3115
|
+
*```
|
|
3116
|
+
*
|
|
2644
3117
|
*/
|
|
2645
3118
|
SchedulesList = "schedule-list",
|
|
2646
3119
|
/**
|
|
2647
|
-
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
3120
|
+
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
2648
3121
|
*
|
|
2649
3122
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3123
|
+
*
|
|
3124
|
+
* @example
|
|
3125
|
+
*```js
|
|
3126
|
+
* liveboardEmbed.trigger(HostEvent.Cancel)
|
|
3127
|
+
*```
|
|
3128
|
+
*
|
|
2650
3129
|
*/
|
|
2651
3130
|
Cancel = "cancel",
|
|
2652
3131
|
/**
|
|
2653
|
-
* Emitted when a user clicks Explore on a visualization
|
|
3132
|
+
* Emitted when a user clicks **Explore** on a visualization
|
|
2654
3133
|
*
|
|
2655
3134
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3135
|
+
*
|
|
3136
|
+
* @example
|
|
3137
|
+
*```js
|
|
3138
|
+
* liveboardEmbed.trigger(HostEvent.Explore, {
|
|
3139
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3140
|
+
*```
|
|
3141
|
+
*
|
|
2656
3142
|
*/
|
|
2657
3143
|
Explore = "explore",
|
|
2658
3144
|
/**
|
|
2659
|
-
* Emitted when a user clicks Copy link action on a visualization
|
|
3145
|
+
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2660
3146
|
*
|
|
2661
3147
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3148
|
+
*
|
|
3149
|
+
* @example
|
|
3150
|
+
*```js
|
|
3151
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
3152
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3153
|
+
*```
|
|
3154
|
+
*
|
|
2662
3155
|
*/
|
|
2663
3156
|
CopyLink = "embedDocument",
|
|
2664
3157
|
/**
|
|
2665
|
-
* Emitted when a user interacts with cross filters on a visualization or
|
|
3158
|
+
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3159
|
+
*
|
|
3160
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3161
|
+
*
|
|
3162
|
+
* @example
|
|
3163
|
+
*```js
|
|
3164
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
3165
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3166
|
+
*```
|
|
2666
3167
|
*
|
|
2667
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2668
3168
|
*/
|
|
2669
3169
|
CrossFilterChanged = "cross-filter-changed",
|
|
2670
3170
|
/**
|
|
2671
3171
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2672
3172
|
*
|
|
2673
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3173
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3174
|
+
*
|
|
3175
|
+
* @example
|
|
3176
|
+
*```js
|
|
3177
|
+
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3178
|
+
* console.log('VizPointClick', payload)
|
|
3179
|
+
* })
|
|
3180
|
+
*```
|
|
2674
3181
|
*/
|
|
2675
3182
|
VizPointRightClick = "vizPointRightClick",
|
|
2676
3183
|
/**
|
|
2677
|
-
* Emitted when a user clicks
|
|
3184
|
+
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2678
3185
|
*
|
|
2679
3186
|
* @hidden
|
|
2680
3187
|
*/
|
|
@@ -2682,52 +3189,53 @@ export declare enum EmbedEvent {
|
|
|
2682
3189
|
/**
|
|
2683
3190
|
* @hidden
|
|
2684
3191
|
* Emitted when a user changes any filter on a Liveboard.
|
|
2685
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3192
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
2686
3193
|
*/
|
|
2687
3194
|
FilterChanged = "filterChanged",
|
|
2688
3195
|
/**
|
|
2689
|
-
* Emitted when a user
|
|
3196
|
+
* Emitted when a user clicks the **Go** button on the Search page
|
|
2690
3197
|
*
|
|
2691
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3198
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2692
3199
|
*/
|
|
2693
3200
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2694
3201
|
/**
|
|
2695
|
-
*
|
|
3202
|
+
* Emitted when a user selects a data source.
|
|
3203
|
+
*
|
|
3204
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2696
3205
|
*
|
|
2697
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2698
3206
|
*/
|
|
2699
3207
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2700
3208
|
/**
|
|
2701
|
-
* Emitted when a user updates a connection
|
|
3209
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2702
3210
|
*
|
|
2703
|
-
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3211
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2704
3212
|
*/
|
|
2705
3213
|
UpdateConnection = "updateConnection",
|
|
2706
3214
|
/**
|
|
2707
|
-
* Emitted when a user updates a connection
|
|
3215
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2708
3216
|
*
|
|
2709
|
-
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3217
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2710
3218
|
*/
|
|
2711
3219
|
CreateConnection = "createConnection",
|
|
2712
3220
|
/**
|
|
2713
3221
|
* Emitted when name, status (private or public) or filter values of a
|
|
2714
|
-
*
|
|
3222
|
+
* Personalised view is updated.
|
|
2715
3223
|
*
|
|
2716
3224
|
* @returns viewName: string
|
|
2717
3225
|
* @returns viewId: string
|
|
2718
3226
|
* @returns liveboardId: string
|
|
2719
3227
|
* @returns isPublic: boolean
|
|
2720
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3228
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2721
3229
|
*/
|
|
2722
3230
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2723
3231
|
/**
|
|
2724
|
-
* Emitted when a
|
|
3232
|
+
* Emitted when a Personalised view is saved.
|
|
2725
3233
|
*
|
|
2726
3234
|
* @returns viewName: string
|
|
2727
3235
|
* @returns viewId: string
|
|
2728
3236
|
* @returns liveboardId: string
|
|
2729
3237
|
* @returns isPublic: boolean
|
|
2730
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3238
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2731
3239
|
*/
|
|
2732
3240
|
SavePersonalisedView = "savePersonalisedView",
|
|
2733
3241
|
/**
|
|
@@ -2737,7 +3245,7 @@ export declare enum EmbedEvent {
|
|
|
2737
3245
|
* @returns viewId: string
|
|
2738
3246
|
* @returns liveboardId: string
|
|
2739
3247
|
* @returns isPublic: boolean
|
|
2740
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3248
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2741
3249
|
*/
|
|
2742
3250
|
ResetLiveboard = "resetLiveboard",
|
|
2743
3251
|
/**
|
|
@@ -2745,11 +3253,11 @@ export declare enum EmbedEvent {
|
|
|
2745
3253
|
*
|
|
2746
3254
|
* @returns views: string[]
|
|
2747
3255
|
* @returns liveboardId: string
|
|
2748
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3256
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2749
3257
|
*/
|
|
2750
3258
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
2751
3259
|
/**
|
|
2752
|
-
*
|
|
3260
|
+
* Emitted when a user creates a new worksheet
|
|
2753
3261
|
*
|
|
2754
3262
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2755
3263
|
*/
|
|
@@ -2779,15 +3287,16 @@ export declare enum EmbedEvent {
|
|
|
2779
3287
|
*/
|
|
2780
3288
|
export declare enum HostEvent {
|
|
2781
3289
|
/**
|
|
2782
|
-
* Triggers a search
|
|
2783
|
-
*
|
|
3290
|
+
* Triggers a search operation with the search tokens specified in
|
|
3291
|
+
* the search query string.
|
|
3292
|
+
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2784
3293
|
* Includes the following properties:
|
|
2785
3294
|
*
|
|
2786
|
-
* @param -
|
|
3295
|
+
* @param - `searchQuery` - query string with search tokens
|
|
3296
|
+
* @param - `dataSources` - Data source GUID to Search on
|
|
2787
3297
|
* - Although an array, only a single source
|
|
2788
3298
|
* is supported.
|
|
2789
|
-
* @param -
|
|
2790
|
-
* @param - execute - executes the existing / updated query
|
|
3299
|
+
* @param - `execute` - executes search and updates the existing query
|
|
2791
3300
|
* @example
|
|
2792
3301
|
* ```js
|
|
2793
3302
|
* searchembed.trigger(HostEvent.Search, {
|
|
@@ -2807,6 +3316,10 @@ export declare enum HostEvent {
|
|
|
2807
3316
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
2808
3317
|
* by. If not provided it will auto drill by the configured
|
|
2809
3318
|
* column.
|
|
3319
|
+
* @param - autoDrillDown - Optional. If true, the drill down will be
|
|
3320
|
+
* done automatically on the most popular column.
|
|
3321
|
+
* @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
|
|
3322
|
+
* in case of a liveboard.
|
|
2810
3323
|
* @example
|
|
2811
3324
|
* ```js
|
|
2812
3325
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -2823,6 +3336,25 @@ export declare enum HostEvent {
|
|
|
2823
3336
|
* });
|
|
2824
3337
|
* })
|
|
2825
3338
|
* ```
|
|
3339
|
+
* @example
|
|
3340
|
+
* ```js
|
|
3341
|
+
* // Works with TS 9.8.0 and above
|
|
3342
|
+
*
|
|
3343
|
+
* liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3344
|
+
* console.log(payload);
|
|
3345
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
3346
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
3347
|
+
* console.log('>>> called', clickedPoint);
|
|
3348
|
+
* liveboardEmbed.trigger(HostEvent.DrillDown, {
|
|
3349
|
+
* points: {
|
|
3350
|
+
* clickedPoint,
|
|
3351
|
+
* selectedPoints: selectedPoint
|
|
3352
|
+
* },
|
|
3353
|
+
* autoDrillDown: true,
|
|
3354
|
+
* vizId: payload.data.vizId
|
|
3355
|
+
* });
|
|
3356
|
+
* })
|
|
3357
|
+
* ```
|
|
2826
3358
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2827
3359
|
*/
|
|
2828
3360
|
DrillDown = "triggerDrillDown",
|
|
@@ -2839,7 +3371,7 @@ export declare enum HostEvent {
|
|
|
2839
3371
|
*/
|
|
2840
3372
|
Reload = "reload",
|
|
2841
3373
|
/**
|
|
2842
|
-
*
|
|
3374
|
+
* Display specific visualizations on a Liveboard.
|
|
2843
3375
|
*
|
|
2844
3376
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2845
3377
|
* in this parameter will be hidden.
|
|
@@ -2853,7 +3385,7 @@ export declare enum HostEvent {
|
|
|
2853
3385
|
*/
|
|
2854
3386
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2855
3387
|
/**
|
|
2856
|
-
* Set
|
|
3388
|
+
* Set a Liveboard tab as an active tab.
|
|
2857
3389
|
*
|
|
2858
3390
|
* @param - tabId - string of id of Tab to show
|
|
2859
3391
|
* @example
|
|
@@ -2866,7 +3398,7 @@ export declare enum HostEvent {
|
|
|
2866
3398
|
*/
|
|
2867
3399
|
SetActiveTab = "SetActiveTab",
|
|
2868
3400
|
/**
|
|
2869
|
-
*
|
|
3401
|
+
* Update runtime filters applied on a Saved Answer or Liveboard. The
|
|
2870
3402
|
* runtime filters passed here are appended to the existing runtime
|
|
2871
3403
|
* filters.
|
|
2872
3404
|
* Pass an array of runtime filters with the following attributes:
|
|
@@ -2892,10 +3424,12 @@ export declare enum HostEvent {
|
|
|
2892
3424
|
*/
|
|
2893
3425
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
2894
3426
|
/**
|
|
2895
|
-
* Navigate to a specific page in the embedded application
|
|
3427
|
+
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2896
3428
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2897
3429
|
*
|
|
2898
|
-
* @param - path - the path to navigate to
|
|
3430
|
+
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
3431
|
+
* be a number; for example, `1`, `-1`.
|
|
3432
|
+
*
|
|
2899
3433
|
* @example
|
|
2900
3434
|
* ```js
|
|
2901
3435
|
* appEmbed.navigateToPage(-1)
|
|
@@ -2904,7 +3438,7 @@ export declare enum HostEvent {
|
|
|
2904
3438
|
*/
|
|
2905
3439
|
Navigate = "Navigate",
|
|
2906
3440
|
/**
|
|
2907
|
-
*
|
|
3441
|
+
* Open the filter panel for a particular column.
|
|
2908
3442
|
* Works with Search and Liveboard embed.
|
|
2909
3443
|
*
|
|
2910
3444
|
* @param - { columnId: string,
|
|
@@ -2922,7 +3456,7 @@ export declare enum HostEvent {
|
|
|
2922
3456
|
*/
|
|
2923
3457
|
OpenFilter = "openFilter",
|
|
2924
3458
|
/**
|
|
2925
|
-
*
|
|
3459
|
+
* Add columns to the current search query.
|
|
2926
3460
|
*
|
|
2927
3461
|
* @param - { columnIds: string[] }
|
|
2928
3462
|
* @example
|
|
@@ -2933,7 +3467,7 @@ export declare enum HostEvent {
|
|
|
2933
3467
|
*/
|
|
2934
3468
|
AddColumns = "addColumns",
|
|
2935
3469
|
/**
|
|
2936
|
-
*
|
|
3470
|
+
* Remove a column from the current search query.
|
|
2937
3471
|
*
|
|
2938
3472
|
* @param - { columnId: string }
|
|
2939
3473
|
* @example
|
|
@@ -2944,27 +3478,29 @@ export declare enum HostEvent {
|
|
|
2944
3478
|
*/
|
|
2945
3479
|
RemoveColumn = "removeColumn",
|
|
2946
3480
|
/**
|
|
2947
|
-
*
|
|
3481
|
+
* Get the transient state of a Liveboard as encoded content.
|
|
3482
|
+
* This includes unsaved and ad hoc changes such as
|
|
3483
|
+
* Liveboard filters, runtime filters applied on visualizations on a
|
|
3484
|
+
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
3485
|
+
* sorting, toggling of legends, and data drill down.
|
|
2948
3486
|
*
|
|
2949
3487
|
* @example
|
|
2950
3488
|
* ```js
|
|
2951
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
3489
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
3490
|
+
* data=>console.log(data))
|
|
2952
3491
|
* ```
|
|
2953
3492
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
2954
3493
|
*/
|
|
2955
3494
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2956
3495
|
/**
|
|
2957
|
-
*
|
|
3496
|
+
* Trigger the **Pin** action on an embedded object
|
|
2958
3497
|
*
|
|
2959
3498
|
* @param - Liveboard embed takes the `vizId` as a
|
|
2960
|
-
* key. Can be left undefined when embedding Search, full app or
|
|
3499
|
+
* key. Can be left undefined when embedding Search, full app, or
|
|
2961
3500
|
* a visualization.
|
|
2962
3501
|
* @example
|
|
2963
3502
|
* ```js
|
|
2964
|
-
*
|
|
2965
|
-
* ```
|
|
2966
|
-
* ```js
|
|
2967
|
-
* vizEmbed.trigger(HostEvent.Pin)
|
|
3503
|
+
* appEmbed.trigger(HostEvent.Pin)
|
|
2968
3504
|
* ```
|
|
2969
3505
|
* ```js
|
|
2970
3506
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
@@ -2973,17 +3509,18 @@ export declare enum HostEvent {
|
|
|
2973
3509
|
*/
|
|
2974
3510
|
Pin = "pin",
|
|
2975
3511
|
/**
|
|
2976
|
-
*
|
|
3512
|
+
* Trigger the **Show Liveboard details** action
|
|
3513
|
+
* on an embedded Liveboard.
|
|
2977
3514
|
*
|
|
2978
3515
|
* @example
|
|
2979
|
-
|
|
2980
|
-
*
|
|
2981
|
-
|
|
3516
|
+
*```js
|
|
3517
|
+
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
3518
|
+
*```
|
|
2982
3519
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2983
3520
|
*/
|
|
2984
3521
|
LiveboardInfo = "pinboardInfo",
|
|
2985
3522
|
/**
|
|
2986
|
-
*
|
|
3523
|
+
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2987
3524
|
*
|
|
2988
3525
|
* @example
|
|
2989
3526
|
* ```js
|
|
@@ -2993,7 +3530,7 @@ export declare enum HostEvent {
|
|
|
2993
3530
|
*/
|
|
2994
3531
|
Schedule = "subscription",
|
|
2995
3532
|
/**
|
|
2996
|
-
*
|
|
3533
|
+
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2997
3534
|
*
|
|
2998
3535
|
* @example
|
|
2999
3536
|
* ```js
|
|
@@ -3003,7 +3540,7 @@ export declare enum HostEvent {
|
|
|
3003
3540
|
*/
|
|
3004
3541
|
SchedulesList = "schedule-list",
|
|
3005
3542
|
/**
|
|
3006
|
-
*
|
|
3543
|
+
* Trigger the **Export TML** action on an embedded Liveboard.
|
|
3007
3544
|
*
|
|
3008
3545
|
* @example
|
|
3009
3546
|
* ```js
|
|
@@ -3013,7 +3550,7 @@ export declare enum HostEvent {
|
|
|
3013
3550
|
*/
|
|
3014
3551
|
ExportTML = "exportTSL",
|
|
3015
3552
|
/**
|
|
3016
|
-
*
|
|
3553
|
+
* Trigger the **Edit TML** action on an embedded Liveboard.
|
|
3017
3554
|
*
|
|
3018
3555
|
* @example
|
|
3019
3556
|
* ```js
|
|
@@ -3023,7 +3560,7 @@ export declare enum HostEvent {
|
|
|
3023
3560
|
*/
|
|
3024
3561
|
EditTML = "editTSL",
|
|
3025
3562
|
/**
|
|
3026
|
-
*
|
|
3563
|
+
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
3027
3564
|
*
|
|
3028
3565
|
* @example
|
|
3029
3566
|
* ```js
|
|
@@ -3033,7 +3570,7 @@ export declare enum HostEvent {
|
|
|
3033
3570
|
*/
|
|
3034
3571
|
UpdateTML = "updateTSL",
|
|
3035
3572
|
/**
|
|
3036
|
-
*
|
|
3573
|
+
* Trigger the **Download PDF** action on an embedded Liveboard.
|
|
3037
3574
|
*
|
|
3038
3575
|
* @example
|
|
3039
3576
|
* ```js
|
|
@@ -3043,8 +3580,8 @@ export declare enum HostEvent {
|
|
|
3043
3580
|
*/
|
|
3044
3581
|
DownloadAsPdf = "downloadAsPdf",
|
|
3045
3582
|
/**
|
|
3046
|
-
*
|
|
3047
|
-
* visualization page
|
|
3583
|
+
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
3584
|
+
* visualization page.
|
|
3048
3585
|
*
|
|
3049
3586
|
* @example
|
|
3050
3587
|
* ```js
|
|
@@ -3060,7 +3597,7 @@ export declare enum HostEvent {
|
|
|
3060
3597
|
*/
|
|
3061
3598
|
MakeACopy = "makeACopy",
|
|
3062
3599
|
/**
|
|
3063
|
-
*
|
|
3600
|
+
* Trigger the **Delete** action for a Liveboard.
|
|
3064
3601
|
*
|
|
3065
3602
|
* @example
|
|
3066
3603
|
* ```js
|
|
@@ -3070,7 +3607,7 @@ export declare enum HostEvent {
|
|
|
3070
3607
|
*/
|
|
3071
3608
|
Remove = "delete",
|
|
3072
3609
|
/**
|
|
3073
|
-
*
|
|
3610
|
+
* Trigger the **Explore** action on a visualization.
|
|
3074
3611
|
*
|
|
3075
3612
|
* @param - an object with `vizId` as a key
|
|
3076
3613
|
* @example
|
|
@@ -3081,7 +3618,7 @@ export declare enum HostEvent {
|
|
|
3081
3618
|
*/
|
|
3082
3619
|
Explore = "explore",
|
|
3083
3620
|
/**
|
|
3084
|
-
*
|
|
3621
|
+
* Trigger the **Create alert** action on a visualization
|
|
3085
3622
|
*
|
|
3086
3623
|
* @param - an object with `vizId` as a key
|
|
3087
3624
|
* @example
|
|
@@ -3094,7 +3631,7 @@ export declare enum HostEvent {
|
|
|
3094
3631
|
*/
|
|
3095
3632
|
CreateMonitor = "createMonitor",
|
|
3096
3633
|
/**
|
|
3097
|
-
*
|
|
3634
|
+
* Trigger the **Manage alerts** action on a visualization
|
|
3098
3635
|
*
|
|
3099
3636
|
* @param - an object with `vizId` as a key
|
|
3100
3637
|
* @example
|
|
@@ -3107,7 +3644,7 @@ export declare enum HostEvent {
|
|
|
3107
3644
|
*/
|
|
3108
3645
|
ManageMonitor = "manageMonitor",
|
|
3109
3646
|
/**
|
|
3110
|
-
*
|
|
3647
|
+
* Trigger the **Edit** action on a Liveboard or visualization
|
|
3111
3648
|
*
|
|
3112
3649
|
* @param - object - To trigger the action for a specific visualization
|
|
3113
3650
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
@@ -3128,7 +3665,7 @@ export declare enum HostEvent {
|
|
|
3128
3665
|
*/
|
|
3129
3666
|
Edit = "edit",
|
|
3130
3667
|
/**
|
|
3131
|
-
*
|
|
3668
|
+
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
3132
3669
|
*
|
|
3133
3670
|
* @param - object - to trigger the action for a
|
|
3134
3671
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
@@ -3146,7 +3683,7 @@ export declare enum HostEvent {
|
|
|
3146
3683
|
*/
|
|
3147
3684
|
CopyLink = "embedDocument",
|
|
3148
3685
|
/**
|
|
3149
|
-
*
|
|
3686
|
+
* Trigger the **Present** action on a Liveboard or visualization
|
|
3150
3687
|
*
|
|
3151
3688
|
* @param - object - to trigger the action for a specific visualization
|
|
3152
3689
|
* in Liveboard embed, pass in `vizId` as a key
|
|
@@ -3164,7 +3701,7 @@ export declare enum HostEvent {
|
|
|
3164
3701
|
*/
|
|
3165
3702
|
Present = "present",
|
|
3166
3703
|
/**
|
|
3167
|
-
*
|
|
3704
|
+
* Get TML for the current search.
|
|
3168
3705
|
*
|
|
3169
3706
|
* @example
|
|
3170
3707
|
* ```js
|
|
@@ -3179,7 +3716,7 @@ export declare enum HostEvent {
|
|
|
3179
3716
|
*/
|
|
3180
3717
|
GetTML = "getTML",
|
|
3181
3718
|
/**
|
|
3182
|
-
*
|
|
3719
|
+
* Trigger the **Show underlying data** action on visualization or search
|
|
3183
3720
|
*
|
|
3184
3721
|
* @param - an object with vizId as a key
|
|
3185
3722
|
* @example
|
|
@@ -3197,7 +3734,9 @@ export declare enum HostEvent {
|
|
|
3197
3734
|
*/
|
|
3198
3735
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3199
3736
|
/**
|
|
3200
|
-
*
|
|
3737
|
+
* Trigger the **Delete** action for a visualization
|
|
3738
|
+
* in an embedded Liveboard, or a chart or table
|
|
3739
|
+
* generated from Search.
|
|
3201
3740
|
*
|
|
3202
3741
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
3203
3742
|
* Can be left empty if embedding Search or visualization.
|
|
@@ -3207,16 +3746,13 @@ export declare enum HostEvent {
|
|
|
3207
3746
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3208
3747
|
* ```
|
|
3209
3748
|
* ```js
|
|
3210
|
-
* vizEmbed.trigger(HostEvent.Delete)
|
|
3211
|
-
* ```
|
|
3212
|
-
* ```js
|
|
3213
3749
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
3214
3750
|
* ```
|
|
3215
3751
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3216
3752
|
*/
|
|
3217
3753
|
Delete = "onDeleteAnswer",
|
|
3218
3754
|
/**
|
|
3219
|
-
*
|
|
3755
|
+
* Trigger the **SpotIQ analyze** action on visualization
|
|
3220
3756
|
* or search.
|
|
3221
3757
|
*
|
|
3222
3758
|
* @param - Liveboard embed takes `vizId` as a
|
|
@@ -3237,7 +3773,7 @@ export declare enum HostEvent {
|
|
|
3237
3773
|
*/
|
|
3238
3774
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3239
3775
|
/**
|
|
3240
|
-
*
|
|
3776
|
+
* Trigger the **Download** action on charts in
|
|
3241
3777
|
* the embedded view.
|
|
3242
3778
|
*
|
|
3243
3779
|
* @example
|
|
@@ -3246,17 +3782,15 @@ export declare enum HostEvent {
|
|
|
3246
3782
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3247
3783
|
* ```
|
|
3248
3784
|
* ```js
|
|
3249
|
-
*
|
|
3250
|
-
* ```
|
|
3251
|
-
* ```js
|
|
3252
|
-
* searchEmbed.trigger(HostEvent.Download)
|
|
3785
|
+
* embed.trigger(HostEvent.Download)
|
|
3253
3786
|
* ```
|
|
3254
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
3787
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
3788
|
+
* Use {@link DownloadAsPng}
|
|
3255
3789
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3256
3790
|
*/
|
|
3257
3791
|
Download = "downloadAsPng",
|
|
3258
3792
|
/**
|
|
3259
|
-
*
|
|
3793
|
+
* Trigger the **Download** > **PNG** action on
|
|
3260
3794
|
* charts in the embedded view.
|
|
3261
3795
|
*
|
|
3262
3796
|
* @example
|
|
@@ -3272,7 +3806,7 @@ export declare enum HostEvent {
|
|
|
3272
3806
|
*/
|
|
3273
3807
|
DownloadAsPng = "downloadAsPng",
|
|
3274
3808
|
/**
|
|
3275
|
-
*
|
|
3809
|
+
* Trigger the **Download** > **CSV** action on tables in
|
|
3276
3810
|
* the embedded view.
|
|
3277
3811
|
*
|
|
3278
3812
|
* @example
|
|
@@ -3290,7 +3824,7 @@ export declare enum HostEvent {
|
|
|
3290
3824
|
*/
|
|
3291
3825
|
DownloadAsCsv = "downloadAsCSV",
|
|
3292
3826
|
/**
|
|
3293
|
-
*
|
|
3827
|
+
* Trigger the **Download** > **XLSX** action on tables
|
|
3294
3828
|
* in the embedded view.
|
|
3295
3829
|
*
|
|
3296
3830
|
* @example
|
|
@@ -3308,7 +3842,7 @@ export declare enum HostEvent {
|
|
|
3308
3842
|
*/
|
|
3309
3843
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3310
3844
|
/**
|
|
3311
|
-
*
|
|
3845
|
+
* Trigger the **Share** action on an embedded
|
|
3312
3846
|
* Liveboard or Answer.
|
|
3313
3847
|
*
|
|
3314
3848
|
* @example
|
|
@@ -3322,7 +3856,7 @@ export declare enum HostEvent {
|
|
|
3322
3856
|
*/
|
|
3323
3857
|
Share = "share",
|
|
3324
3858
|
/**
|
|
3325
|
-
*
|
|
3859
|
+
* Trigger the **Save** action on a Liveboard or Answer.
|
|
3326
3860
|
* Saves the changes.
|
|
3327
3861
|
*
|
|
3328
3862
|
* @example
|
|
@@ -3336,7 +3870,7 @@ export declare enum HostEvent {
|
|
|
3336
3870
|
*/
|
|
3337
3871
|
Save = "save",
|
|
3338
3872
|
/**
|
|
3339
|
-
*
|
|
3873
|
+
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
3340
3874
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
3341
3875
|
*
|
|
3342
3876
|
* @param - an object with `vizId` as a key
|
|
@@ -3352,7 +3886,7 @@ export declare enum HostEvent {
|
|
|
3352
3886
|
*/
|
|
3353
3887
|
SyncToSheets = "sync-to-sheets",
|
|
3354
3888
|
/**
|
|
3355
|
-
*
|
|
3889
|
+
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
3356
3890
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
3357
3891
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
3358
3892
|
*
|
|
@@ -3369,7 +3903,7 @@ export declare enum HostEvent {
|
|
|
3369
3903
|
*/
|
|
3370
3904
|
SyncToOtherApps = "sync-to-other-apps",
|
|
3371
3905
|
/**
|
|
3372
|
-
*
|
|
3906
|
+
* Trigger the **Manage pipelines** action on an embedded
|
|
3373
3907
|
* visualization or Answer.
|
|
3374
3908
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
3375
3909
|
*
|
|
@@ -3386,18 +3920,21 @@ export declare enum HostEvent {
|
|
|
3386
3920
|
*/
|
|
3387
3921
|
ManagePipelines = "manage-pipeline",
|
|
3388
3922
|
/**
|
|
3389
|
-
*
|
|
3923
|
+
* Reset search operation on the Search or Answer page.
|
|
3390
3924
|
*
|
|
3391
3925
|
* @example
|
|
3392
3926
|
* ```js
|
|
3393
3927
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
3394
3928
|
* ```
|
|
3929
|
+
* ```js
|
|
3930
|
+
* appEmbed.trigger(HostEvent.ResetSearch)
|
|
3931
|
+
* ```
|
|
3395
3932
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
3396
3933
|
*/
|
|
3397
3934
|
ResetSearch = "resetSearch",
|
|
3398
3935
|
/**
|
|
3399
3936
|
* @hidden
|
|
3400
|
-
*
|
|
3937
|
+
* Get the currents visible and runtime filters applied on a Liveboard
|
|
3401
3938
|
* @example
|
|
3402
3939
|
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
3403
3940
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
@@ -3405,7 +3942,7 @@ export declare enum HostEvent {
|
|
|
3405
3942
|
GetFilters = "getFilters",
|
|
3406
3943
|
/**
|
|
3407
3944
|
* @hidden
|
|
3408
|
-
*
|
|
3945
|
+
* Update the visible filters on the Liveboard.
|
|
3409
3946
|
* @param - filter: filter object containing column name and filter operation and values
|
|
3410
3947
|
* @example
|
|
3411
3948
|
*
|
|
@@ -3418,7 +3955,7 @@ export declare enum HostEvent {
|
|
|
3418
3955
|
*/
|
|
3419
3956
|
UpdateFilters = "updateFilters",
|
|
3420
3957
|
/**
|
|
3421
|
-
* Get
|
|
3958
|
+
* Get tab details for the current Liveboard.
|
|
3422
3959
|
*
|
|
3423
3960
|
* @example
|
|
3424
3961
|
* ```js
|
|
@@ -3432,9 +3969,9 @@ export declare enum HostEvent {
|
|
|
3432
3969
|
*/
|
|
3433
3970
|
GetTabs = "getTabs",
|
|
3434
3971
|
/**
|
|
3435
|
-
* Set the visible
|
|
3972
|
+
* Set the visible tabs on a Liveboard.
|
|
3436
3973
|
*
|
|
3437
|
-
* @param - an array of ids of
|
|
3974
|
+
* @param - an array of ids of tabs to show, the IDs not passed
|
|
3438
3975
|
* will be hidden.
|
|
3439
3976
|
* @example
|
|
3440
3977
|
* ```js
|
|
@@ -3448,8 +3985,8 @@ export declare enum HostEvent {
|
|
|
3448
3985
|
/**
|
|
3449
3986
|
* Set the hidden tabs on a Liveboard.
|
|
3450
3987
|
*
|
|
3451
|
-
* @param - an array of
|
|
3452
|
-
*
|
|
3988
|
+
* @param - an array of the IDs of the tabs to hide.
|
|
3989
|
+
* The IDs not passed will be shown.
|
|
3453
3990
|
* @example
|
|
3454
3991
|
* ```js
|
|
3455
3992
|
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
@@ -3460,9 +3997,12 @@ export declare enum HostEvent {
|
|
|
3460
3997
|
*/
|
|
3461
3998
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
3462
3999
|
/**
|
|
3463
|
-
* Updates the search query for
|
|
4000
|
+
* Updates the search query string for Natural Language Search operations.
|
|
4001
|
+
*
|
|
4002
|
+
* @param - `queryString`: Text string in Natural Language format
|
|
4003
|
+
*
|
|
4004
|
+
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
3464
4005
|
*
|
|
3465
|
-
* @param - searchOptions: an object queryString and option to execute the query.
|
|
3466
4006
|
* @example
|
|
3467
4007
|
* ```js
|
|
3468
4008
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -3470,7 +4010,7 @@ export declare enum HostEvent {
|
|
|
3470
4010
|
* executeSearch: true,
|
|
3471
4011
|
* })
|
|
3472
4012
|
* ```
|
|
3473
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
4013
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3474
4014
|
*/
|
|
3475
4015
|
UpdateSageQuery = "updateSageQuery",
|
|
3476
4016
|
/**
|
|
@@ -3483,24 +4023,25 @@ export declare enum HostEvent {
|
|
|
3483
4023
|
* vizId: '123', // For Liveboard Visualization.
|
|
3484
4024
|
* })
|
|
3485
4025
|
* ```
|
|
4026
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
3486
4027
|
*/
|
|
3487
4028
|
GetAnswerSession = "getAnswerSession"
|
|
3488
4029
|
}
|
|
3489
4030
|
/**
|
|
3490
4031
|
* The different visual modes that the data sources panel within
|
|
3491
|
-
* search could appear in,
|
|
4032
|
+
* search could appear in, such as hidden, collapsed, or expanded.
|
|
3492
4033
|
*/
|
|
3493
4034
|
export declare enum DataSourceVisualMode {
|
|
3494
4035
|
/**
|
|
3495
|
-
*
|
|
4036
|
+
* The data source panel is hidden.
|
|
3496
4037
|
*/
|
|
3497
4038
|
Hidden = "hide",
|
|
3498
4039
|
/**
|
|
3499
|
-
*
|
|
4040
|
+
* The data source panel is collapsed, but the user can manually expand it.
|
|
3500
4041
|
*/
|
|
3501
4042
|
Collapsed = "collapse",
|
|
3502
4043
|
/**
|
|
3503
|
-
*
|
|
4044
|
+
* The data source panel is expanded, but the user can manually collapse it.
|
|
3504
4045
|
*/
|
|
3505
4046
|
Expanded = "expand"
|
|
3506
4047
|
}
|
|
@@ -3576,7 +4117,8 @@ export declare enum Param {
|
|
|
3576
4117
|
LiveboardHeaderSticky = "isLiveboardHeaderSticky",
|
|
3577
4118
|
IsProductTour = "isProductTour",
|
|
3578
4119
|
HideSearchBarTitle = "hideSearchBarTitle",
|
|
3579
|
-
HideSageAnswerHeader = "hideSageAnswerHeader"
|
|
4120
|
+
HideSageAnswerHeader = "hideSageAnswerHeader",
|
|
4121
|
+
HideSearchBar = "hideSearchBar"
|
|
3580
4122
|
}
|
|
3581
4123
|
/**
|
|
3582
4124
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3636,9 +4178,11 @@ export declare enum Action {
|
|
|
3636
4178
|
SaveAsView = "saveAsView",
|
|
3637
4179
|
/**
|
|
3638
4180
|
* The **Make a copy** action on a Liveboard or Answer
|
|
3639
|
-
* page.
|
|
3640
|
-
*
|
|
3641
|
-
*
|
|
4181
|
+
* page. Creates a copy of the Liveboard.
|
|
4182
|
+
* In LiveboardEmbed, the **Make a copy** action is not available for
|
|
4183
|
+
* visualizations in the embedded Liveboard view.
|
|
4184
|
+
* In AppEmbed, the **Make a copy** action is available on both
|
|
4185
|
+
* Liveboards and visualizations.
|
|
3642
4186
|
*
|
|
3643
4187
|
* @example
|
|
3644
4188
|
* ```js
|
|
@@ -3822,7 +4366,7 @@ export declare enum Action {
|
|
|
3822
4366
|
*/
|
|
3823
4367
|
DownloadAsPdf = "downloadAsPdf",
|
|
3824
4368
|
/**
|
|
3825
|
-
* The **Download**
|
|
4369
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3826
4370
|
* or Answer page.
|
|
3827
4371
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3828
4372
|
*
|
|
@@ -4353,6 +4897,7 @@ export declare enum Action {
|
|
|
4353
4897
|
*/
|
|
4354
4898
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
4355
4899
|
/**
|
|
4900
|
+
*
|
|
4356
4901
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4357
4902
|
*/
|
|
4358
4903
|
RequestVerification = "requestVerification",
|
|
@@ -4861,8 +5406,7 @@ interface UnderlyingDataPoint {
|
|
|
4861
5406
|
* const data = await underlying.fetchData(0, 100);
|
|
4862
5407
|
* })
|
|
4863
5408
|
* ```
|
|
4864
|
-
* @version
|
|
4865
|
-
* ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
|
|
5409
|
+
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
4866
5410
|
* @group Events
|
|
4867
5411
|
*/
|
|
4868
5412
|
export declare class AnswerService {
|
|
@@ -4896,8 +5440,7 @@ export declare class AnswerService {
|
|
|
4896
5440
|
* const data = await underlying.fetchData(0, 100);
|
|
4897
5441
|
* })
|
|
4898
5442
|
* ```
|
|
4899
|
-
* @version
|
|
4900
|
-
* ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
|
|
5443
|
+
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
4901
5444
|
*/
|
|
4902
5445
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
4903
5446
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
@@ -4905,6 +5448,23 @@ export declare class AnswerService {
|
|
|
4905
5448
|
}
|
|
4906
5449
|
export {};
|
|
4907
5450
|
|
|
5451
|
+
/**
|
|
5452
|
+
* Gets the configuration embed was initialized with.
|
|
5453
|
+
*
|
|
5454
|
+
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
5455
|
+
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
5456
|
+
* @group Global methods
|
|
5457
|
+
*/
|
|
5458
|
+
export declare const getEmbedConfig: () => EmbedConfig;
|
|
5459
|
+
/**
|
|
5460
|
+
* Sets the configuration embed was initialized with.
|
|
5461
|
+
*
|
|
5462
|
+
* @param newConfig The configuration to set.
|
|
5463
|
+
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
5464
|
+
* @group Global methods
|
|
5465
|
+
*/
|
|
5466
|
+
export declare const setEmbedConfig: (newConfig: EmbedConfig) => void;
|
|
5467
|
+
|
|
4908
5468
|
/**
|
|
4909
5469
|
* Copyright (c) 2022
|
|
4910
5470
|
*
|
|
@@ -5099,6 +5659,7 @@ export declare class TsEmbed {
|
|
|
5099
5659
|
* @param args
|
|
5100
5660
|
*/
|
|
5101
5661
|
render(): TsEmbed;
|
|
5662
|
+
getIframeSrc(): string;
|
|
5102
5663
|
protected handleRenderForPrerender(): void;
|
|
5103
5664
|
/**
|
|
5104
5665
|
* Creates the preRender shell
|