@thoughtspot/visual-embed-sdk 1.26.2 → 1.27.0-logger
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 +1 -1
- package/cjs/src/auth.d.ts +4 -4
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +15 -8
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/embed/app.d.ts +14 -14
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +4 -3
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +5 -4
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +5 -2
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +3 -2
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embed.spec.js +2 -1
- package/cjs/src/embed/embed.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +2 -1
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +2 -0
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/events.spec.js +3 -2
- package/cjs/src/embed/events.spec.js.map +1 -1
- 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 +47 -29
- 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 +33 -18
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +4 -1
- 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/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +37 -17
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +141 -26
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +2 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +2 -1
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/index.spec.js +2 -14
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/types.d.ts +751 -242
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +665 -176
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +3 -2
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/authService/authService.spec.js +3 -2
- package/cjs/src/utils/authService/authService.spec.js.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.js +2 -1
- package/cjs/src/utils/authService/tokenizedAuthService.js.map +1 -1
- 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 +2 -4
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/logger.d.ts +4 -14
- package/cjs/src/utils/logger.d.ts.map +1 -1
- package/cjs/src/utils/logger.js +37 -41
- package/cjs/src/utils/logger.js.map +1 -1
- package/cjs/src/utils/logger.spec.d.ts +25 -0
- package/cjs/src/utils/logger.spec.d.ts.map +1 -0
- package/cjs/src/utils/logger.spec.js +80 -0
- package/cjs/src/utils/logger.spec.js.map +1 -0
- 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 +5 -1
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processTrigger.js +1 -1
- package/dist/src/auth.d.ts +4 -4
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +14 -14
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +2 -1
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- 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 +47 -29
- 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 +33 -18
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/types.d.ts +751 -242
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- 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/logger.d.ts +4 -14
- package/dist/src/utils/logger.d.ts.map +1 -1
- package/dist/src/utils/logger.spec.d.ts +25 -0
- package/dist/src/utils/logger.spec.d.ts.map +1 -0
- 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 +18186 -404
- package/dist/tsembed-react.js +18185 -403
- package/dist/tsembed.es.js +18336 -545
- package/dist/tsembed.js +32457 -14667
- package/dist/visual-embed-sdk-react-full.d.ts +903 -341
- package/dist/visual-embed-sdk-react.d.ts +903 -341
- package/dist/visual-embed-sdk.d.ts +903 -341
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +4 -4
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +15 -8
- package/lib/src/auth.js.map +1 -1
- package/lib/src/embed/app.d.ts +14 -14
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +4 -3
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +5 -4
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +6 -3
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +3 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embed.spec.js +2 -1
- package/lib/src/embed/embed.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +2 -1
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +2 -0
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/events.spec.js +3 -2
- package/lib/src/embed/events.spec.js.map +1 -1
- 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 +47 -29
- 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 +33 -18
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +4 -1
- 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/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +38 -18
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +141 -26
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +2 -1
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/index.spec.js +2 -14
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/types.d.ts +751 -242
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +664 -175
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +3 -2
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +3 -2
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.js +2 -1
- package/lib/src/utils/authService/tokenizedAuthService.js.map +1 -1
- 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 +2 -4
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/logger.d.ts +4 -14
- package/lib/src/utils/logger.d.ts.map +1 -1
- package/lib/src/utils/logger.js +23 -25
- package/lib/src/utils/logger.js.map +1 -1
- package/lib/src/utils/logger.spec.d.ts +25 -0
- package/lib/src/utils/logger.spec.d.ts.map +1 -0
- package/lib/src/utils/logger.spec.js +57 -0
- package/lib/src/utils/logger.spec.js.map +1 -0
- 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 +4 -1
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processTrigger.js +1 -1
- package/lib/src/visual-embed-sdk.d.ts +904 -342
- package/package.json +1 -1
- package/src/auth.ts +15 -8
- package/src/embed/app.spec.ts +5 -4
- package/src/embed/app.ts +22 -21
- package/src/embed/base.spec.ts +3 -2
- package/src/embed/base.ts +10 -3
- package/src/embed/embed.spec.ts +2 -1
- package/src/embed/embedConfig.ts +2 -0
- package/src/embed/events.spec.ts +3 -2
- package/src/embed/liveboard.ts +28 -23
- package/src/embed/sage.ts +47 -29
- package/src/embed/search-bar.tsx +22 -6
- package/src/embed/search.spec.ts +13 -0
- package/src/embed/search.ts +38 -19
- package/src/embed/ts-embed.spec.ts +159 -26
- package/src/embed/ts-embed.ts +37 -19
- package/src/index.ts +2 -0
- package/src/mixpanel-service.ts +2 -1
- package/src/react/index.spec.tsx +2 -31
- package/src/types.ts +753 -243
- package/src/utils/authService/authService.spec.ts +3 -2
- package/src/utils/authService/authService.ts +4 -2
- package/src/utils/authService/tokenizedAuthService.ts +2 -1
- package/src/utils/graphql/answerService/answerService.ts +2 -4
- package/src/utils/logger.spec.ts +67 -0
- package/src/utils/logger.ts +87 -0
- package/src/utils/processData.ts +4 -1
- package/src/utils/processTrigger.ts +1 -1
- package/cjs/src/embed/TsEmbed.d.ts +0 -302
- package/cjs/src/embed/TsEmbed.d.ts.map +0 -1
- package/cjs/src/embed/TsEmbed.js +0 -851
- package/cjs/src/embed/TsEmbed.js.map +0 -1
- package/cjs/src/utils/answerService.d.ts +0 -10
- package/cjs/src/utils/answerService.d.ts.map +0 -1
- package/cjs/src/utils/answerService.js +0 -61
- package/cjs/src/utils/answerService.js.map +0 -1
- package/cjs/src/utils/answerService.spec.d.ts +0 -2
- package/cjs/src/utils/answerService.spec.d.ts.map +0 -1
- package/cjs/src/utils/answerService.spec.js +0 -31
- package/cjs/src/utils/answerService.spec.js.map +0 -1
- package/cjs/src/utils/authService/tokenisedAuthSerice.d.ts +0 -11
- package/cjs/src/utils/authService/tokenisedAuthSerice.d.ts.map +0 -1
- package/cjs/src/utils/authService/tokenisedAuthSerice.js +0 -44
- package/cjs/src/utils/authService/tokenisedAuthSerice.js.map +0 -1
- package/cjs/src/utils/authService.d.ts +0 -55
- package/cjs/src/utils/authService.d.ts.map +0 -1
- package/cjs/src/utils/authService.js +0 -139
- package/cjs/src/utils/authService.js.map +0 -1
- package/cjs/src/utils/authService.spec.d.ts +0 -2
- package/cjs/src/utils/authService.spec.d.ts.map +0 -1
- package/cjs/src/utils/authService.spec.js +0 -82
- package/cjs/src/utils/authService.spec.js.map +0 -1
- package/cjs/src/utils/graphql/graphql-request.spec.d.ts +0 -2
- package/cjs/src/utils/graphql/graphql-request.spec.d.ts.map +0 -1
- package/cjs/src/utils/graphql/graphql-request.spec.js +0 -39
- package/cjs/src/utils/graphql/graphql-request.spec.js.map +0 -1
- package/dist/src/utils/answerService.d.ts +0 -10
- package/dist/src/utils/answerService.d.ts.map +0 -1
- package/dist/src/utils/answerService.spec.d.ts +0 -2
- package/dist/src/utils/answerService.spec.d.ts.map +0 -1
- package/dist/src/utils/authService/tokenisedAuthSerice.d.ts +0 -11
- package/dist/src/utils/authService/tokenisedAuthSerice.d.ts.map +0 -1
- package/dist/src/utils/authService.d.ts +0 -55
- package/dist/src/utils/authService.d.ts.map +0 -1
- package/dist/src/utils/authService.spec.d.ts +0 -2
- package/dist/src/utils/authService.spec.d.ts.map +0 -1
- package/dist/src/utils/graphql/graphql-request.spec.d.ts +0 -2
- package/dist/src/utils/graphql/graphql-request.spec.d.ts.map +0 -1
- package/lib/src/embed/TsEmbed.d.ts +0 -302
- package/lib/src/embed/TsEmbed.d.ts.map +0 -1
- package/lib/src/embed/TsEmbed.js +0 -847
- package/lib/src/embed/TsEmbed.js.map +0 -1
- package/lib/src/utils/answerService.d.ts +0 -10
- package/lib/src/utils/answerService.d.ts.map +0 -1
- package/lib/src/utils/answerService.js +0 -57
- package/lib/src/utils/answerService.js.map +0 -1
- package/lib/src/utils/answerService.spec.d.ts +0 -2
- package/lib/src/utils/answerService.spec.d.ts.map +0 -1
- package/lib/src/utils/answerService.spec.js +0 -29
- package/lib/src/utils/answerService.spec.js.map +0 -1
- package/lib/src/utils/authService/tokenisedAuthSerice.d.ts +0 -11
- package/lib/src/utils/authService/tokenisedAuthSerice.d.ts.map +0 -1
- package/lib/src/utils/authService/tokenisedAuthSerice.js +0 -39
- package/lib/src/utils/authService/tokenisedAuthSerice.js.map +0 -1
- package/lib/src/utils/authService.d.ts +0 -55
- package/lib/src/utils/authService.d.ts.map +0 -1
- package/lib/src/utils/authService.js +0 -129
- package/lib/src/utils/authService.js.map +0 -1
- package/lib/src/utils/authService.spec.d.ts +0 -2
- package/lib/src/utils/authService.spec.d.ts.map +0 -1
- package/lib/src/utils/authService.spec.js +0 -80
- package/lib/src/utils/authService.spec.js.map +0 -1
- package/lib/src/utils/graphql/graphql-request.spec.d.ts +0 -2
- package/lib/src/utils/graphql/graphql-request.spec.d.ts.map +0 -1
- package/lib/src/utils/graphql/graphql-request.spec.js +0 -36
- package/lib/src/utils/graphql/graphql-request.spec.js.map +0 -1
|
@@ -231,25 +231,41 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
|
|
|
231
231
|
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
232
232
|
/**
|
|
233
233
|
* The array of data source GUIDs to set on load.
|
|
234
|
-
* Only a single
|
|
234
|
+
* Only a single data source is supported currently.
|
|
235
235
|
*
|
|
236
|
-
* @deprecated Use dataSource instead
|
|
236
|
+
* @deprecated Use `dataSource` instead
|
|
237
237
|
*/
|
|
238
238
|
dataSources?: string[];
|
|
239
239
|
/**
|
|
240
240
|
* The array of data source GUIDs to set on load.
|
|
241
241
|
*
|
|
242
|
-
* @version: SDK: 1.19.0
|
|
242
|
+
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
243
243
|
*/
|
|
244
244
|
dataSource?: string;
|
|
245
245
|
/**
|
|
246
|
-
*
|
|
246
|
+
* Boolean to define if the last selected data source should be used
|
|
247
247
|
*
|
|
248
|
-
* @version: SDK: 1.24.0
|
|
248
|
+
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
249
249
|
*/
|
|
250
250
|
useLastSelectedSources?: boolean;
|
|
251
251
|
/**
|
|
252
|
-
* Configuration for search options
|
|
252
|
+
* Configuration for search options.
|
|
253
|
+
* Includes the following properties:
|
|
254
|
+
*
|
|
255
|
+
* `searchTokenString`: Search tokens to pass in the query.
|
|
256
|
+
*
|
|
257
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
258
|
+
* If it is executed, the focus is placed on the results.
|
|
259
|
+
* If it’s not executed, the focus is placed at the end of
|
|
260
|
+
* the token string in the search bar.
|
|
261
|
+
*
|
|
262
|
+
* @example
|
|
263
|
+
* ```js
|
|
264
|
+
* searchOptions: {
|
|
265
|
+
* searchTokenString: '[quantity purchased] [region]',
|
|
266
|
+
* executeSearch: true,
|
|
267
|
+
* }
|
|
268
|
+
* ```
|
|
253
269
|
*/
|
|
254
270
|
searchOptions?: SearchOptions;
|
|
255
271
|
}
|
|
@@ -285,14 +301,14 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
285
301
|
*/
|
|
286
302
|
export interface SearchOptions {
|
|
287
303
|
/**
|
|
288
|
-
* The query string to
|
|
304
|
+
* The query string to pass for Natural Language Search.
|
|
289
305
|
*/
|
|
290
306
|
searchQuery: string;
|
|
291
307
|
/**
|
|
292
|
-
* Boolean to
|
|
293
|
-
*
|
|
294
|
-
*
|
|
295
|
-
* the
|
|
308
|
+
* Boolean to define if the search should be executed or not.
|
|
309
|
+
* If it is executed, the focus is placed on the results.
|
|
310
|
+
* If it’s not executed, the focus is placed at the end of
|
|
311
|
+
* the token string in the search bar.
|
|
296
312
|
*/
|
|
297
313
|
executeSearch?: boolean;
|
|
298
314
|
}
|
|
@@ -300,16 +316,16 @@ export interface SearchOptions {
|
|
|
300
316
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
301
317
|
* GPT and LLM.
|
|
302
318
|
*
|
|
303
|
-
* @version: SDK: 1.23.0 | ThoughtSpot: 9.
|
|
319
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
304
320
|
* @group Embed components
|
|
305
321
|
*/
|
|
306
322
|
export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
307
323
|
/**
|
|
308
|
-
* If set to true, a list of
|
|
324
|
+
* If set to true, a list of Liveboard and Answers related
|
|
309
325
|
* to the natural language search will be shown below the
|
|
310
326
|
* AI generated answer.
|
|
311
327
|
*
|
|
312
|
-
* @deprecated Currently
|
|
328
|
+
* @deprecated Currently Liveboard and Answers related
|
|
313
329
|
* to the natural language search will not be shown for sage
|
|
314
330
|
* embed
|
|
315
331
|
*/
|
|
@@ -326,63 +342,81 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
326
342
|
*/
|
|
327
343
|
isProductTour?: boolean;
|
|
328
344
|
/**
|
|
329
|
-
*
|
|
345
|
+
* Show or hide the search bar title.
|
|
330
346
|
*
|
|
331
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
347
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
332
348
|
*/
|
|
333
349
|
hideSearchBarTitle?: boolean;
|
|
334
350
|
/**
|
|
335
|
-
*
|
|
336
|
-
*
|
|
351
|
+
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
352
|
+
* at the top of the Answer page.
|
|
337
353
|
*
|
|
338
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
354
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
339
355
|
*/
|
|
340
356
|
hideSageAnswerHeader?: boolean;
|
|
341
357
|
/**
|
|
342
|
-
*
|
|
358
|
+
* Disable the worksheet selection option.
|
|
343
359
|
*
|
|
344
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.9.0.
|
|
360
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
345
361
|
*/
|
|
346
362
|
disableWorksheetChange?: boolean;
|
|
347
363
|
/**
|
|
348
|
-
*
|
|
364
|
+
* Hide the worksheet selection panel.
|
|
365
|
+
*
|
|
366
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
349
367
|
*/
|
|
350
368
|
hideWorksheetSelector?: boolean;
|
|
351
369
|
/**
|
|
352
|
-
*
|
|
353
|
-
* default false
|
|
370
|
+
* Show or hide autocomplete suggestions for the search query string.
|
|
354
371
|
*
|
|
355
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.9.0.
|
|
372
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
356
373
|
*/
|
|
357
374
|
hideAutocompleteSuggestions?: boolean;
|
|
358
375
|
/**
|
|
359
|
-
*
|
|
376
|
+
* Show or hide autocomplete suggestions for the search query string.
|
|
360
377
|
*
|
|
361
|
-
* @deprecated
|
|
362
|
-
*
|
|
378
|
+
* @deprecated
|
|
379
|
+
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
380
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
363
381
|
*/
|
|
364
382
|
showObjectSuggestions?: boolean;
|
|
365
383
|
/**
|
|
366
|
-
*
|
|
367
|
-
*
|
|
384
|
+
* Show or hide sample questions.
|
|
385
|
+
* The sample questions are autogenerated based on the worksheet
|
|
386
|
+
* selected for the search operation.
|
|
368
387
|
*
|
|
369
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
388
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
370
389
|
*/
|
|
371
390
|
hideSampleQuestions?: boolean;
|
|
372
391
|
/**
|
|
373
|
-
* The data source GUID to set on load.
|
|
392
|
+
* The data source GUID (Worksheet GUID) to set on load.
|
|
374
393
|
*/
|
|
375
394
|
dataSource?: string;
|
|
376
395
|
/**
|
|
377
|
-
*
|
|
396
|
+
* Includes the following properties:
|
|
378
397
|
*
|
|
379
|
-
*
|
|
398
|
+
* `searchQuery`: The search query string to pass in the search bar.
|
|
399
|
+
* Supports Natural Language Search queries.
|
|
400
|
+
*
|
|
401
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
402
|
+
* If it is executed, the focus is placed on the results.
|
|
403
|
+
* If it’s not executed, the focus is placed at the end of
|
|
404
|
+
* the token string in the search bar.
|
|
405
|
+
*
|
|
406
|
+
* @example
|
|
407
|
+
* ```js
|
|
408
|
+
* searchOptions: {
|
|
409
|
+
* searchQuery: 'average sales by country and product type',
|
|
410
|
+
* executeSearch: true,
|
|
411
|
+
* }
|
|
412
|
+
* ```
|
|
413
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
380
414
|
*/
|
|
381
415
|
searchOptions?: SearchOptions;
|
|
382
416
|
}
|
|
383
417
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
384
418
|
/**
|
|
385
|
-
* Embed ThoughtSpot LLM and GPT
|
|
419
|
+
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
386
420
|
*
|
|
387
421
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
388
422
|
* @group Embed components
|
|
@@ -419,18 +453,19 @@ export declare class SageEmbed extends V1Embed {
|
|
|
419
453
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
420
454
|
*/
|
|
421
455
|
/**
|
|
422
|
-
* Configuration for search options
|
|
456
|
+
* Configuration for search options.
|
|
457
|
+
*
|
|
423
458
|
*/
|
|
424
459
|
export interface SearchOptions {
|
|
425
460
|
/**
|
|
426
|
-
*
|
|
461
|
+
* Search tokens to pass in the query.
|
|
427
462
|
*/
|
|
428
463
|
searchTokenString: string;
|
|
429
464
|
/**
|
|
430
|
-
* Boolean to
|
|
431
|
-
*
|
|
432
|
-
*
|
|
433
|
-
* the
|
|
465
|
+
* Boolean to define if the search should be executed or not.
|
|
466
|
+
* If it is executed, the focus is placed on the results.
|
|
467
|
+
* If it’s not executed, the focus is placed at the end of
|
|
468
|
+
* the token string in the search bar.
|
|
434
469
|
*/
|
|
435
470
|
executeSearch?: boolean;
|
|
436
471
|
}
|
|
@@ -446,19 +481,15 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
446
481
|
*/
|
|
447
482
|
collapseDataSources?: boolean;
|
|
448
483
|
/**
|
|
449
|
-
*
|
|
484
|
+
* Show or hide the data sources panel.
|
|
450
485
|
*/
|
|
451
486
|
hideDataSources?: boolean;
|
|
452
487
|
/**
|
|
453
|
-
*
|
|
488
|
+
* Show or hide the charts and tables in search answers.
|
|
454
489
|
* This attribute can be used to create a custom visualization
|
|
455
490
|
* using raw answer data.
|
|
456
491
|
*/
|
|
457
492
|
hideResults?: boolean;
|
|
458
|
-
/**
|
|
459
|
-
* If set to true, expands all the data sources panel.
|
|
460
|
-
*/
|
|
461
|
-
expandAllDataSource?: boolean;
|
|
462
493
|
/**
|
|
463
494
|
* If set to true, the Search Assist feature is enabled.
|
|
464
495
|
*
|
|
@@ -472,9 +503,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
472
503
|
forceTable?: boolean;
|
|
473
504
|
/**
|
|
474
505
|
* The array of data source GUIDs to set on load.
|
|
475
|
-
* Only a single
|
|
506
|
+
* Only a single data source is supported currently.
|
|
476
507
|
*
|
|
477
|
-
* @deprecated Use dataSource instead
|
|
508
|
+
* @deprecated Use `dataSource` instead.
|
|
478
509
|
*/
|
|
479
510
|
dataSources?: string[];
|
|
480
511
|
/**
|
|
@@ -486,11 +517,29 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
486
517
|
/**
|
|
487
518
|
* The initial search query to load the answer with.
|
|
488
519
|
*
|
|
489
|
-
* @deprecated
|
|
520
|
+
* @deprecated
|
|
521
|
+
*
|
|
522
|
+
* Use {@link searchOptions} instead.
|
|
490
523
|
*/
|
|
491
524
|
searchQuery?: string;
|
|
492
525
|
/**
|
|
493
|
-
* Configuration for search options
|
|
526
|
+
* Configuration for search options.
|
|
527
|
+
* Includes the following properties:
|
|
528
|
+
*
|
|
529
|
+
* `searchTokenString`: Search tokens to pass in the query.
|
|
530
|
+
*
|
|
531
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
532
|
+
* If it is executed, the focus is placed on the results.
|
|
533
|
+
* If it’s not executed, the focus is placed at the end of
|
|
534
|
+
* the token string in the search bar.
|
|
535
|
+
*
|
|
536
|
+
* @example
|
|
537
|
+
* ```js
|
|
538
|
+
* searchOptions: {
|
|
539
|
+
* searchTokenString: '[quantity purchased] [region]',
|
|
540
|
+
* executeSearch: true,
|
|
541
|
+
* }
|
|
542
|
+
* ```
|
|
494
543
|
*/
|
|
495
544
|
searchOptions?: SearchOptions;
|
|
496
545
|
/**
|
|
@@ -498,10 +547,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
498
547
|
*/
|
|
499
548
|
answerId?: string;
|
|
500
549
|
/**
|
|
501
|
-
* If set to true, search page will render without the Search Bar
|
|
550
|
+
* If set to true, the search page will render without the Search Bar
|
|
502
551
|
* The chart/table should still be visible.
|
|
503
552
|
*
|
|
504
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
553
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
505
554
|
*/
|
|
506
555
|
hideSearchBar?: boolean;
|
|
507
556
|
/**
|
|
@@ -588,43 +637,43 @@ export declare enum Page {
|
|
|
588
637
|
*/
|
|
589
638
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
590
639
|
/**
|
|
591
|
-
* If true, the
|
|
640
|
+
* If true, the top navigation bar within the ThoughtSpot app
|
|
592
641
|
* is displayed. By default, the navigation bar is hidden.
|
|
593
|
-
* This flag also
|
|
642
|
+
* This flag also controls the homepage left navigation bar.
|
|
594
643
|
*/
|
|
595
644
|
showPrimaryNavbar?: boolean;
|
|
596
645
|
/**
|
|
597
|
-
*
|
|
598
|
-
* If showPrimaryNavbar is true,
|
|
599
|
-
* nav-
|
|
600
|
-
*
|
|
646
|
+
* Control the visibility of the left navigation bar on the Homepage.
|
|
647
|
+
* If showPrimaryNavbar is true, that is, if the Global and Homepage
|
|
648
|
+
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
649
|
+
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
601
650
|
*
|
|
602
651
|
* @default false
|
|
603
652
|
* @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
604
653
|
*/
|
|
605
654
|
hideHomepageLeftNav?: boolean;
|
|
606
655
|
/**
|
|
607
|
-
*
|
|
608
|
-
*
|
|
656
|
+
* Control the visibility of the help (?) and profile buttons on the
|
|
657
|
+
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
609
658
|
*/
|
|
610
659
|
disableProfileAndHelp?: boolean;
|
|
611
660
|
/**
|
|
612
|
-
*
|
|
613
|
-
*
|
|
661
|
+
* Control the visibility of the application switcher button on the nav-bar.
|
|
662
|
+
* By default, the application switcher is shown.
|
|
614
663
|
*/
|
|
615
664
|
hideApplicationSwitcher?: boolean;
|
|
616
665
|
/**
|
|
617
|
-
*
|
|
618
|
-
*
|
|
666
|
+
* Control the visibility of the Org switcher button on the nav-bar.
|
|
667
|
+
* By default, the Org switcher button is shown.
|
|
619
668
|
*/
|
|
620
669
|
hideOrgSwitcher?: boolean;
|
|
621
670
|
/**
|
|
622
|
-
* A URL path
|
|
671
|
+
* A URL path to the embedded application page
|
|
623
672
|
* If both path and pageId attributes are defined, the path definition
|
|
624
673
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
625
674
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
626
675
|
*
|
|
627
|
-
* For eg, if you want the component to open to a specific
|
|
676
|
+
* For eg, if you want the component to open to a specific Liveboard
|
|
628
677
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
629
678
|
*
|
|
630
679
|
* @example
|
|
@@ -789,8 +838,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
789
838
|
*/
|
|
790
839
|
fullHeight?: boolean;
|
|
791
840
|
/**
|
|
792
|
-
* This is the minimum height(in pixels) for a full
|
|
793
|
-
* Setting this height helps
|
|
841
|
+
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
842
|
+
* Setting this height helps resolve issues with empty Liveboards and
|
|
794
843
|
* other screens navigable from a Liveboard.
|
|
795
844
|
*
|
|
796
845
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
@@ -803,7 +852,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
803
852
|
enableVizTransformations?: boolean;
|
|
804
853
|
/**
|
|
805
854
|
* The Liveboard to display in the embedded view.
|
|
806
|
-
* Use either
|
|
855
|
+
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
807
856
|
*
|
|
808
857
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
809
858
|
*/
|
|
@@ -822,79 +871,84 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
822
871
|
* If set to true, all filter chips from a
|
|
823
872
|
* Liveboard page will be read-only (no X buttons)
|
|
824
873
|
*
|
|
825
|
-
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
874
|
+
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
826
875
|
*/
|
|
827
876
|
preventLiveboardFilterRemoval?: boolean;
|
|
828
877
|
/**
|
|
829
|
-
* Array of
|
|
830
|
-
*
|
|
878
|
+
* Array of visualization IDs which should be visible when the Liveboard
|
|
879
|
+
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
831
880
|
* event.
|
|
832
881
|
*
|
|
833
882
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
834
883
|
*/
|
|
835
884
|
visibleVizs?: string[];
|
|
836
885
|
/**
|
|
837
|
-
* To support backward
|
|
886
|
+
* To support backward compatibility
|
|
838
887
|
*
|
|
839
888
|
* @hidden
|
|
840
889
|
*/
|
|
841
890
|
preventPinboardFilterRemoval?: boolean;
|
|
842
891
|
/**
|
|
843
|
-
* Render embedded Liveboards and visualizations in the
|
|
892
|
+
* Render embedded Liveboards and visualizations in the
|
|
893
|
+
* new Liveboard experience mode.
|
|
844
894
|
*
|
|
845
895
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
846
896
|
*/
|
|
847
897
|
liveboardV2?: boolean;
|
|
848
898
|
/**
|
|
849
|
-
*
|
|
899
|
+
* Set a Liveboard tab as an active tab.
|
|
900
|
+
* Specify the tab ID.
|
|
850
901
|
*
|
|
851
902
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
852
903
|
*/
|
|
853
904
|
activeTabId?: string;
|
|
854
905
|
/**
|
|
855
|
-
*
|
|
906
|
+
* Show or hide the tab panel of the embedded Liveboard.
|
|
856
907
|
*
|
|
857
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
908
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
858
909
|
*/
|
|
859
910
|
hideTabPanel?: boolean;
|
|
860
911
|
/**
|
|
861
|
-
* Show or hide Liveboard header
|
|
912
|
+
* Show or hide the Liveboard header.
|
|
862
913
|
*
|
|
863
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
914
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
864
915
|
* @default false
|
|
865
916
|
*/
|
|
866
917
|
hideLiveboardHeader?: boolean;
|
|
867
918
|
/**
|
|
868
|
-
* Show or hide Liveboard title
|
|
919
|
+
* Show or hide the Liveboard title.
|
|
869
920
|
*
|
|
870
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
921
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
871
922
|
* @default false
|
|
872
923
|
*/
|
|
873
924
|
showLiveboardTitle?: boolean;
|
|
874
925
|
/**
|
|
875
|
-
* Show or hide Liveboard description
|
|
926
|
+
* Show or hide the Liveboard description.
|
|
876
927
|
*
|
|
877
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
928
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
878
929
|
* @default false
|
|
879
930
|
*/
|
|
880
931
|
showLiveboardDescription?: boolean;
|
|
881
932
|
/**
|
|
882
|
-
*
|
|
933
|
+
* Control the position and visibility of
|
|
934
|
+
* the Liveboard header as the users scroll down the
|
|
935
|
+
* embedded Liveboard page.
|
|
883
936
|
*
|
|
884
937
|
* @example
|
|
885
938
|
* ```js
|
|
886
939
|
* const embed = new LiveboardEmbed('#embed', {
|
|
887
|
-
* ... // other
|
|
940
|
+
* ... // other Liveboard view config
|
|
888
941
|
* isLiveboardHeaderSticky: true,
|
|
889
942
|
* });
|
|
890
943
|
* ```
|
|
891
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
944
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
892
945
|
*/
|
|
893
946
|
isLiveboardHeaderSticky?: boolean;
|
|
894
947
|
}
|
|
895
948
|
/**
|
|
896
|
-
* Embed a ThoughtSpot Liveboard or
|
|
897
|
-
* waits for the authentication to complete, so
|
|
949
|
+
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
950
|
+
* waits for the authentication to complete, so you need not wait for
|
|
951
|
+
* `AuthStatus.SUCCESS`.
|
|
898
952
|
*
|
|
899
953
|
* @example
|
|
900
954
|
* ```js
|
|
@@ -967,7 +1021,7 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
|
|
|
967
1021
|
* @summary ThoughtSpot Visual Embed SDK
|
|
968
1022
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
969
1023
|
*/
|
|
970
|
-
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, };
|
|
1024
|
+
export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, };
|
|
971
1025
|
|
|
972
1026
|
/**
|
|
973
1027
|
* Copyright (c) 2023
|
|
@@ -998,10 +1052,14 @@ export declare enum AuthType {
|
|
|
998
1052
|
*/
|
|
999
1053
|
None = "None",
|
|
1000
1054
|
/**
|
|
1001
|
-
* Passthrough SSO to the embedded
|
|
1055
|
+
* Passthrough SSO to the embedded application within the iframe. Requires least
|
|
1002
1056
|
* configuration, but may not be supported by all IDPs. This will behave like `None`
|
|
1003
1057
|
* if SSO is not configured on ThoughtSpot.
|
|
1004
1058
|
*
|
|
1059
|
+
* To use this:
|
|
1060
|
+
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1061
|
+
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1062
|
+
*
|
|
1005
1063
|
* @example
|
|
1006
1064
|
* ```js
|
|
1007
1065
|
* init({
|
|
@@ -1009,12 +1067,7 @@ export declare enum AuthType {
|
|
|
1009
1067
|
* authType: AuthType.EmbeddedSSO,
|
|
1010
1068
|
* });
|
|
1011
1069
|
* ```
|
|
1012
|
-
*
|
|
1013
|
-
*
|
|
1014
|
-
* To use this:
|
|
1015
|
-
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1016
|
-
* eg. If you are using okta as IdP, you can enable iFrame embedding.
|
|
1017
|
-
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
1070
|
+
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
1018
1071
|
*/
|
|
1019
1072
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1020
1073
|
/**
|
|
@@ -1033,10 +1086,10 @@ export declare enum AuthType {
|
|
|
1033
1086
|
SAML = "SSO_SAML",
|
|
1034
1087
|
/**
|
|
1035
1088
|
* SSO using SAML
|
|
1036
|
-
*
|
|
1037
|
-
*
|
|
1089
|
+
* Makes the host application redirect to the SAML IdP. Use this
|
|
1090
|
+
* if your IdP does not allow itself to be embedded.
|
|
1038
1091
|
*
|
|
1039
|
-
* This redirects the host application to the SAML
|
|
1092
|
+
* This redirects the host application to the SAML IdP. The host application
|
|
1040
1093
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1041
1094
|
*
|
|
1042
1095
|
* @example
|
|
@@ -1047,7 +1100,7 @@ export declare enum AuthType {
|
|
|
1047
1100
|
* });
|
|
1048
1101
|
* ```
|
|
1049
1102
|
*
|
|
1050
|
-
* This opens the SAML
|
|
1103
|
+
* This opens the SAML IdP in a popup window. The popup is triggered
|
|
1051
1104
|
* when the user clicks the trigger button. The popup window will be
|
|
1052
1105
|
* closed automatically after authentication.
|
|
1053
1106
|
* @example
|
|
@@ -1061,8 +1114,8 @@ export declare enum AuthType {
|
|
|
1061
1114
|
* });
|
|
1062
1115
|
* ```
|
|
1063
1116
|
*
|
|
1064
|
-
* Can also use event to trigger the popup flow. Works the same
|
|
1065
|
-
* as above example.
|
|
1117
|
+
* Can also use the event to trigger the popup flow. Works the same
|
|
1118
|
+
* as the above example.
|
|
1066
1119
|
* @example
|
|
1067
1120
|
* ```js
|
|
1068
1121
|
* const authEE = init({
|
|
@@ -1086,7 +1139,7 @@ export declare enum AuthType {
|
|
|
1086
1139
|
OIDC = "SSO_OIDC",
|
|
1087
1140
|
/**
|
|
1088
1141
|
* SSO using OIDC
|
|
1089
|
-
* Will make the host application redirect to the OIDC
|
|
1142
|
+
* Will make the host application redirect to the OIDC IdP.
|
|
1090
1143
|
* See code samples in {@link SAMLRedirect}.
|
|
1091
1144
|
*/
|
|
1092
1145
|
OIDCRedirect = "SSO_OIDC",
|
|
@@ -1098,8 +1151,8 @@ export declare enum AuthType {
|
|
|
1098
1151
|
*/
|
|
1099
1152
|
AuthServer = "AuthServer",
|
|
1100
1153
|
/**
|
|
1101
|
-
* Trusted authentication server
|
|
1102
|
-
* which returns a bearer token, generated using the secret_key obtained
|
|
1154
|
+
* Trusted authentication server. Use your own authentication server
|
|
1155
|
+
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1103
1156
|
* from ThoughtSpot.
|
|
1104
1157
|
*
|
|
1105
1158
|
* @example
|
|
@@ -1116,11 +1169,11 @@ export declare enum AuthType {
|
|
|
1116
1169
|
*/
|
|
1117
1170
|
TrustedAuthToken = "AuthServer",
|
|
1118
1171
|
/**
|
|
1119
|
-
* Trusted authentication server Cookieless, Use
|
|
1120
|
-
* server which returns a bearer token, generated using the secret_key
|
|
1172
|
+
* Trusted authentication server Cookieless, Use your own authentication
|
|
1173
|
+
* server which returns a bearer token, generated using the `secret_key`
|
|
1121
1174
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1122
|
-
* approach, recommended to
|
|
1123
|
-
* implemented by some browsers
|
|
1175
|
+
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1176
|
+
* implemented by some browsers.
|
|
1124
1177
|
*
|
|
1125
1178
|
* @example
|
|
1126
1179
|
* ```js
|
|
@@ -1133,7 +1186,7 @@ export declare enum AuthType {
|
|
|
1133
1186
|
* .then((data) => data.token);
|
|
1134
1187
|
* }
|
|
1135
1188
|
* ```
|
|
1136
|
-
* @version SDK: 1.22.0|
|
|
1189
|
+
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1137
1190
|
*/
|
|
1138
1191
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1139
1192
|
/**
|
|
@@ -1255,13 +1308,19 @@ export interface EmbedConfig {
|
|
|
1255
1308
|
* The ThoughtSpot cluster hostname or IP address.
|
|
1256
1309
|
*/
|
|
1257
1310
|
thoughtSpotHost: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* If true, all the iframe links will have /v2 added automatically.
|
|
1313
|
+
* If false, all the iframe links will have /v1 added automatically.
|
|
1314
|
+
* If undefined, nothing will be added
|
|
1315
|
+
*/
|
|
1316
|
+
enableReactShell?: boolean | undefined;
|
|
1258
1317
|
/**
|
|
1259
1318
|
* The authentication mechanism to use.
|
|
1260
1319
|
*/
|
|
1261
1320
|
authType: AuthType;
|
|
1262
1321
|
/**
|
|
1263
1322
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
1264
|
-
* authentication token. A GET request is made to the
|
|
1323
|
+
* authentication token. A `GET` request is made to the
|
|
1265
1324
|
* authentication API endpoint, which returns the token
|
|
1266
1325
|
* as a plaintext response. For trusted authentication,
|
|
1267
1326
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
@@ -1274,8 +1333,8 @@ export interface EmbedConfig {
|
|
|
1274
1333
|
* attribute is required.
|
|
1275
1334
|
*
|
|
1276
1335
|
* It is advisable to fetch a new token inside this method and not
|
|
1277
|
-
* reuse
|
|
1278
|
-
* called again and if it is called with an older token the authentication
|
|
1336
|
+
* reuse the old issued token. When auth expires this method is
|
|
1337
|
+
* called again and if it is called with an older token, the authentication
|
|
1279
1338
|
* will not succeed.
|
|
1280
1339
|
*/
|
|
1281
1340
|
getAuthToken?: () => Promise<string>;
|
|
@@ -1285,7 +1344,7 @@ export interface EmbedConfig {
|
|
|
1285
1344
|
*/
|
|
1286
1345
|
username?: string;
|
|
1287
1346
|
/**
|
|
1288
|
-
* [Basic] The ThoughtSpot login password corresponding to the
|
|
1347
|
+
* [Basic] The ThoughtSpot login password corresponding to the username
|
|
1289
1348
|
*
|
|
1290
1349
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1291
1350
|
* strongly advised not to use this authentication method in production.
|
|
@@ -1293,7 +1352,7 @@ export interface EmbedConfig {
|
|
|
1293
1352
|
password?: string;
|
|
1294
1353
|
/**
|
|
1295
1354
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1296
|
-
* open the SAML auth flow in a popup, instead of redirecting browser in
|
|
1355
|
+
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1297
1356
|
* place.
|
|
1298
1357
|
*
|
|
1299
1358
|
* @default false
|
|
@@ -1302,91 +1361,93 @@ export interface EmbedConfig {
|
|
|
1302
1361
|
noRedirect?: boolean;
|
|
1303
1362
|
/**
|
|
1304
1363
|
* [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
|
|
1305
|
-
* the SAML auth flow in a popup, instead of redirecting browser in place.
|
|
1364
|
+
* the SAML auth flow in a popup, instead of redirecting the browser in place.
|
|
1306
1365
|
*
|
|
1307
|
-
* Need to use this with authTriggerContainer
|
|
1308
|
-
* the AuthEvent.TRIGGER_SSO_POPUP event on a user interaction.
|
|
1366
|
+
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1367
|
+
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1309
1368
|
*
|
|
1310
1369
|
* @default false
|
|
1311
1370
|
* @version SDK: 1.18.0
|
|
1312
1371
|
*/
|
|
1313
1372
|
inPopup?: boolean;
|
|
1314
1373
|
/**
|
|
1315
|
-
* [SSO] For SSO Authentication, one can supply an optional path param
|
|
1316
|
-
*
|
|
1374
|
+
* [SSO] For SSO Authentication, one can supply an optional path param;
|
|
1375
|
+
* This will be the path on the host origin where the SAML flow will be
|
|
1317
1376
|
* terminated.
|
|
1318
1377
|
*
|
|
1319
1378
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1320
1379
|
*
|
|
1321
|
-
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
|
|
1380
|
+
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1322
1381
|
*/
|
|
1323
1382
|
redirectPath?: string;
|
|
1324
1383
|
/** @internal */
|
|
1325
1384
|
basepath?: string;
|
|
1326
1385
|
/**
|
|
1327
|
-
*
|
|
1328
|
-
*
|
|
1329
|
-
*
|
|
1386
|
+
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1387
|
+
* should be encoded in base64. This provides additional security to
|
|
1388
|
+
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1330
1389
|
*
|
|
1331
1390
|
* @default false
|
|
1332
1391
|
*/
|
|
1333
1392
|
shouldEncodeUrlQueryParams?: boolean;
|
|
1334
1393
|
/**
|
|
1335
|
-
* Suppress cookie access alert when third
|
|
1336
|
-
* user's browser. Third
|
|
1337
|
-
*
|
|
1338
|
-
* encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1394
|
+
* Suppress cookie access alert when third-party cookies are blocked by the
|
|
1395
|
+
* user's browser. Third-party cookie blocking is the default behaviour on
|
|
1396
|
+
* some web browsers like Safari. If you set this attribute to `true`,
|
|
1397
|
+
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1339
1398
|
* in this case.
|
|
1340
1399
|
*
|
|
1341
1400
|
* @default false
|
|
1342
1401
|
*/
|
|
1343
1402
|
suppressNoCookieAccessAlert?: boolean;
|
|
1344
1403
|
/**
|
|
1345
|
-
* Ignore cookie access alert when third
|
|
1404
|
+
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
1346
1405
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
1347
|
-
*
|
|
1406
|
+
* persists even in the case of a non-logged-in user.
|
|
1348
1407
|
*
|
|
1349
1408
|
* @default false
|
|
1350
1409
|
*/
|
|
1351
1410
|
ignoreNoCookieAccess?: boolean;
|
|
1352
1411
|
/**
|
|
1353
|
-
* Re-login
|
|
1412
|
+
* Re-login a user with the previous login options
|
|
1413
|
+
* when a user session expires.
|
|
1354
1414
|
*
|
|
1355
1415
|
* @default false
|
|
1356
1416
|
*/
|
|
1357
1417
|
autoLogin?: boolean;
|
|
1358
1418
|
/**
|
|
1359
1419
|
* Disable redirection to the login page when the embedded session expires
|
|
1360
|
-
* This flag is typically used alongside the combination of
|
|
1361
|
-
* AuthType.AuthServer} and auto
|
|
1420
|
+
* This flag is typically used alongside the combination of authentication modes such
|
|
1421
|
+
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
1422
|
+
* EmbedConfig.autoLogin}
|
|
1362
1423
|
*
|
|
1363
1424
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1364
1425
|
* @default false
|
|
1365
1426
|
*/
|
|
1366
1427
|
disableLoginRedirect?: boolean;
|
|
1367
1428
|
/**
|
|
1368
|
-
* This message is displayed
|
|
1429
|
+
* This message is displayed in the embedded view when a user login fails.
|
|
1369
1430
|
*
|
|
1370
1431
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1371
1432
|
*/
|
|
1372
1433
|
loginFailedMessage?: string;
|
|
1373
1434
|
/**
|
|
1374
|
-
* Calls the prefetch method internally when set to true
|
|
1435
|
+
* Calls the prefetch method internally when set to `true`
|
|
1375
1436
|
*
|
|
1376
1437
|
* @default false
|
|
1377
1438
|
*/
|
|
1378
1439
|
callPrefetch?: boolean;
|
|
1379
1440
|
/**
|
|
1380
|
-
* When there are multiple
|
|
1381
|
-
*
|
|
1382
|
-
*
|
|
1441
|
+
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1442
|
+
* to start after the previous embed's render is complete. This helps improve
|
|
1443
|
+
* performance by decreasing the load on the browser.
|
|
1383
1444
|
*
|
|
1384
1445
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1385
1446
|
* @default false
|
|
1386
1447
|
*/
|
|
1387
1448
|
queueMultiRenders?: boolean;
|
|
1388
1449
|
/**
|
|
1389
|
-
* Dynamic CSS
|
|
1450
|
+
* Dynamic CSS URL to be injected in the loaded application.
|
|
1390
1451
|
* You would also need to set `style-src` in the CSP settings.
|
|
1391
1452
|
*
|
|
1392
1453
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -1394,9 +1455,9 @@ export interface EmbedConfig {
|
|
|
1394
1455
|
*/
|
|
1395
1456
|
customCssUrl?: string;
|
|
1396
1457
|
/**
|
|
1397
|
-
* [AuthServer|Basic] Detect if
|
|
1458
|
+
* [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
|
|
1398
1459
|
* additional call. This is slower and should be avoided. Listen to the
|
|
1399
|
-
* NO_COOKIE_ACCESS event to handle the situation.
|
|
1460
|
+
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
1400
1461
|
*
|
|
1401
1462
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1402
1463
|
* involves an extra network call.
|
|
@@ -1405,26 +1466,26 @@ export interface EmbedConfig {
|
|
|
1405
1466
|
*/
|
|
1406
1467
|
detectCookieAccessSlow?: boolean;
|
|
1407
1468
|
/**
|
|
1408
|
-
* Hide beta alert warning message for SearchEmbed.
|
|
1469
|
+
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1409
1470
|
*
|
|
1410
1471
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
1411
1472
|
*/
|
|
1412
1473
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1413
1474
|
/**
|
|
1414
|
-
* Hide beta alert warning message for SageEmbed.
|
|
1475
|
+
* Hide `beta` alert warning message for SageEmbed.
|
|
1415
1476
|
*
|
|
1416
1477
|
*/
|
|
1417
1478
|
suppressSageEmbedBetaWarning?: boolean;
|
|
1418
1479
|
/**
|
|
1419
1480
|
* Custom style params for embed Config.
|
|
1420
1481
|
*
|
|
1421
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
|
|
1482
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1422
1483
|
*/
|
|
1423
1484
|
customizations?: CustomisationsInterface;
|
|
1424
1485
|
/**
|
|
1425
|
-
* For inPopup SAMLRedirect or OIDCRedirect
|
|
1426
|
-
* click to trigger the flow.
|
|
1427
|
-
* for that button.
|
|
1486
|
+
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1487
|
+
* button that the user can click to trigger the flow.
|
|
1488
|
+
* This attribute sets a containing element for that button.
|
|
1428
1489
|
*
|
|
1429
1490
|
* @example
|
|
1430
1491
|
* ```js
|
|
@@ -1434,11 +1495,11 @@ export interface EmbedConfig {
|
|
|
1434
1495
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1435
1496
|
* })
|
|
1436
1497
|
* ```
|
|
1437
|
-
* @version SDK: 1.17.0 | ThoughtSpot:
|
|
1498
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1438
1499
|
*/
|
|
1439
1500
|
authTriggerContainer?: string | HTMLElement;
|
|
1440
1501
|
/**
|
|
1441
|
-
* Specify that we want to use the AuthEvent.TRIGGER_SSO_POPUP event to trigger
|
|
1502
|
+
* Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger
|
|
1442
1503
|
* SAML popup. This is useful when you want to trigger the popup on a custom user
|
|
1443
1504
|
* action.
|
|
1444
1505
|
*
|
|
@@ -1446,20 +1507,22 @@ export interface EmbedConfig {
|
|
|
1446
1507
|
useEventForSAMLPopup?: boolean;
|
|
1447
1508
|
/**
|
|
1448
1509
|
* Text to show in the button which triggers the popup auth flow.
|
|
1449
|
-
* Default:
|
|
1510
|
+
* Default: `Authorize`.
|
|
1450
1511
|
*
|
|
1451
|
-
* @version SDK: 1.17.0 | ThoughtSpot:
|
|
1512
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1452
1513
|
*/
|
|
1453
1514
|
authTriggerText?: string;
|
|
1454
1515
|
/**
|
|
1455
|
-
*
|
|
1516
|
+
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
1517
|
+
* access to the embedded application users
|
|
1518
|
+
* outside of the iframe.
|
|
1456
1519
|
*
|
|
1457
1520
|
* @default true
|
|
1458
1521
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1459
1522
|
*/
|
|
1460
1523
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1461
1524
|
/**
|
|
1462
|
-
* Host config
|
|
1525
|
+
* Host config in case embedded app is inside TS app itself
|
|
1463
1526
|
*
|
|
1464
1527
|
* @hidden
|
|
1465
1528
|
*/
|
|
@@ -1481,21 +1544,35 @@ export interface EmbedConfig {
|
|
|
1481
1544
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
1482
1545
|
*/
|
|
1483
1546
|
suppressErrorAlerts?: boolean;
|
|
1547
|
+
/**
|
|
1548
|
+
* Log level for the SDK.
|
|
1549
|
+
* @default LogLevel.ERROR
|
|
1550
|
+
*
|
|
1551
|
+
* @example
|
|
1552
|
+
* ```js
|
|
1553
|
+
* init({
|
|
1554
|
+
* ...embedConfig,
|
|
1555
|
+
* logLevel: LogLevel.SILENT
|
|
1556
|
+
* })
|
|
1557
|
+
* ```
|
|
1558
|
+
* @version SDK: 1.26.3 | ThoughtSpot: 9.10.0.cl
|
|
1559
|
+
*/
|
|
1560
|
+
logLevel?: LogLevel;
|
|
1484
1561
|
}
|
|
1485
1562
|
export interface LayoutConfig {
|
|
1486
1563
|
}
|
|
1487
1564
|
/**
|
|
1488
|
-
* Embedded
|
|
1565
|
+
* Embedded iframe configuration
|
|
1489
1566
|
*
|
|
1490
1567
|
* @group Embed components
|
|
1491
1568
|
*/
|
|
1492
1569
|
export interface FrameParams {
|
|
1493
1570
|
/**
|
|
1494
|
-
* The width of the
|
|
1571
|
+
* The width of the iframe (unit is pixels if numeric).
|
|
1495
1572
|
*/
|
|
1496
1573
|
width?: number | string;
|
|
1497
1574
|
/**
|
|
1498
|
-
* The height of the
|
|
1575
|
+
* The height of the iframe (unit is pixels if numeric).
|
|
1499
1576
|
*/
|
|
1500
1577
|
height?: number | string;
|
|
1501
1578
|
/**
|
|
@@ -1596,7 +1673,6 @@ export interface ViewConfig {
|
|
|
1596
1673
|
*/
|
|
1597
1674
|
runtimeParameters?: RuntimeParameter[];
|
|
1598
1675
|
/**
|
|
1599
|
-
/**
|
|
1600
1676
|
* The locale/language to use for the embedded view.
|
|
1601
1677
|
*
|
|
1602
1678
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
@@ -1696,31 +1772,29 @@ export interface ViewConfig {
|
|
|
1696
1772
|
*/
|
|
1697
1773
|
reorderedHomepageModules?: HomepageModule[];
|
|
1698
1774
|
/**
|
|
1699
|
-
* The list of tab IDs to show in the embedded.
|
|
1700
|
-
* Only
|
|
1701
|
-
* Use this to show an tabID.
|
|
1775
|
+
* The list of tab IDs to show in the embedded Liveboard.
|
|
1776
|
+
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
1702
1777
|
*
|
|
1703
|
-
* Use either
|
|
1778
|
+
* Use either `visibleTabs` or `hiddenTabs`.
|
|
1704
1779
|
*
|
|
1705
1780
|
* @example
|
|
1706
1781
|
* ```js
|
|
1707
|
-
*
|
|
1708
|
-
* ... // other liveboard view config
|
|
1709
|
-
* visibleTabs: [
|
|
1782
|
+
* visibleTabs: [
|
|
1710
1783
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
1711
|
-
*
|
|
1712
|
-
* });
|
|
1784
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
1713
1785
|
* ```
|
|
1714
1786
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1715
1787
|
*/
|
|
1716
1788
|
visibleTabs?: string[];
|
|
1717
1789
|
/**
|
|
1718
|
-
* homepageLeftNavItems :
|
|
1719
|
-
* There are 8 home
|
|
1720
|
-
*
|
|
1721
|
-
* eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
|
|
1790
|
+
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
1791
|
+
* There are 8 eight home navigation list items.
|
|
1792
|
+
* To hide these items, specify the string in the array.
|
|
1722
1793
|
*
|
|
1723
|
-
*
|
|
1794
|
+
* ```js
|
|
1795
|
+
* hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
|
|
1796
|
+
* ```
|
|
1797
|
+
* @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
|
|
1724
1798
|
*/
|
|
1725
1799
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
1726
1800
|
/**
|
|
@@ -1736,7 +1810,7 @@ export interface ViewConfig {
|
|
|
1736
1810
|
* });
|
|
1737
1811
|
* embed.showPreRender();
|
|
1738
1812
|
* ```
|
|
1739
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
1813
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1740
1814
|
*/
|
|
1741
1815
|
preRenderId?: string;
|
|
1742
1816
|
/**
|
|
@@ -1769,7 +1843,7 @@ export type MessagePayload = {
|
|
|
1769
1843
|
status?: string;
|
|
1770
1844
|
};
|
|
1771
1845
|
/**
|
|
1772
|
-
* MessageOptions: By
|
|
1846
|
+
* MessageOptions: By providing options, getting specific event start / end based on
|
|
1773
1847
|
* option
|
|
1774
1848
|
*
|
|
1775
1849
|
* @group Events
|
|
@@ -1777,7 +1851,7 @@ export type MessagePayload = {
|
|
|
1777
1851
|
export type MessageOptions = {
|
|
1778
1852
|
/**
|
|
1779
1853
|
* A boolean value indicating that start status events of this type
|
|
1780
|
-
* will be dispatched
|
|
1854
|
+
* will be dispatched.
|
|
1781
1855
|
*/
|
|
1782
1856
|
start?: boolean;
|
|
1783
1857
|
};
|
|
@@ -1797,7 +1871,7 @@ responder?: (data: any) => void) => void;
|
|
|
1797
1871
|
*/
|
|
1798
1872
|
export type MessageCallbackObj = {
|
|
1799
1873
|
/**
|
|
1800
|
-
* options: It contains start,
|
|
1874
|
+
* options: It contains start, a boolean value indicating that start
|
|
1801
1875
|
* status events of this type will be dispatched
|
|
1802
1876
|
*/
|
|
1803
1877
|
options: MessageOptions;
|
|
@@ -1869,7 +1943,7 @@ export declare enum RuntimeFilterOp {
|
|
|
1869
1943
|
IN = "IN"
|
|
1870
1944
|
}
|
|
1871
1945
|
/**
|
|
1872
|
-
* Home page module that can be
|
|
1946
|
+
* Home page module that can be hidden
|
|
1873
1947
|
*/
|
|
1874
1948
|
export declare enum HomepageModule {
|
|
1875
1949
|
/**
|
|
@@ -1885,7 +1959,7 @@ export declare enum HomepageModule {
|
|
|
1885
1959
|
*/
|
|
1886
1960
|
Favorite = "FAVORITE",
|
|
1887
1961
|
/**
|
|
1888
|
-
* List of answers and
|
|
1962
|
+
* List of answers and Liveboards
|
|
1889
1963
|
*/
|
|
1890
1964
|
MyLibrary = "MY_LIBRARY",
|
|
1891
1965
|
/**
|
|
@@ -1918,7 +1992,7 @@ export interface RuntimeFilter {
|
|
|
1918
1992
|
values: (number | boolean | string)[];
|
|
1919
1993
|
}
|
|
1920
1994
|
/**
|
|
1921
|
-
* A filter that can be applied to ThoughtSpot
|
|
1995
|
+
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
1922
1996
|
* visualizations at runtime.
|
|
1923
1997
|
*/
|
|
1924
1998
|
export interface RuntimeParameter {
|
|
@@ -1954,6 +2028,14 @@ export interface RuntimeParameter {
|
|
|
1954
2028
|
export declare enum EmbedEvent {
|
|
1955
2029
|
/**
|
|
1956
2030
|
* Rendering has initialized.
|
|
2031
|
+
* @example
|
|
2032
|
+
*```js
|
|
2033
|
+
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2034
|
+
* //show a loader
|
|
2035
|
+
* function showLoader() {
|
|
2036
|
+
* document.getElementById("loader");
|
|
2037
|
+
* }
|
|
2038
|
+
*```
|
|
1957
2039
|
*
|
|
1958
2040
|
* @returns timestamp - The timestamp when the event was generated.
|
|
1959
2041
|
*/
|
|
@@ -1961,69 +2043,162 @@ export declare enum EmbedEvent {
|
|
|
1961
2043
|
/**
|
|
1962
2044
|
* Authentication has either succeeded or failed.
|
|
1963
2045
|
*
|
|
2046
|
+
* @example
|
|
2047
|
+
*```js
|
|
2048
|
+
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2049
|
+
* console.log('AuthInit', payload);
|
|
2050
|
+
* })
|
|
2051
|
+
*```
|
|
2052
|
+
*
|
|
1964
2053
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
1965
2054
|
*/
|
|
1966
2055
|
AuthInit = "authInit",
|
|
1967
2056
|
/**
|
|
1968
2057
|
* The embed object container has loaded.
|
|
1969
|
-
*
|
|
1970
2058
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2059
|
+
* @example
|
|
2060
|
+
*```js
|
|
2061
|
+
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2062
|
+
* //hide loader
|
|
2063
|
+
* function hideLoader() {
|
|
2064
|
+
* document.getElementById("loader");
|
|
2065
|
+
* }
|
|
2066
|
+
*```
|
|
1971
2067
|
*/
|
|
1972
2068
|
Load = "load",
|
|
1973
2069
|
/**
|
|
1974
2070
|
* Data pertaining to answer or Liveboard is received
|
|
1975
|
-
*
|
|
1976
2071
|
* @return data - The answer or Liveboard data
|
|
2072
|
+
* @example
|
|
2073
|
+
*```js
|
|
2074
|
+
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2075
|
+
* console.log('data', payload);
|
|
2076
|
+
* })
|
|
2077
|
+
*```
|
|
1977
2078
|
* @important
|
|
1978
2079
|
*/
|
|
1979
2080
|
Data = "data",
|
|
1980
2081
|
/**
|
|
1981
|
-
* Search/
|
|
2082
|
+
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
1982
2083
|
*
|
|
1983
2084
|
* @hidden
|
|
1984
2085
|
*/
|
|
1985
2086
|
FiltersChanged = "filtersChanged",
|
|
1986
2087
|
/**
|
|
1987
2088
|
* Search query has been updated by the user.
|
|
2089
|
+
*
|
|
2090
|
+
* @example
|
|
2091
|
+
*```js
|
|
2092
|
+
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2093
|
+
*```
|
|
2094
|
+
*
|
|
1988
2095
|
*/
|
|
1989
2096
|
QueryChanged = "queryChanged",
|
|
1990
2097
|
/**
|
|
1991
|
-
* A drill
|
|
2098
|
+
* A drill-down operation has been performed.
|
|
1992
2099
|
*
|
|
1993
2100
|
* @returns additionalFilters - Any additional filters applied
|
|
1994
2101
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
1995
2102
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2103
|
+
*
|
|
2104
|
+
* @example
|
|
2105
|
+
*```js
|
|
2106
|
+
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
2107
|
+
* points: {
|
|
2108
|
+
* clickedPoint,
|
|
2109
|
+
* selectedPoints: selectedPoint
|
|
2110
|
+
* },
|
|
2111
|
+
* autoDrillDown: true,
|
|
2112
|
+
* })
|
|
2113
|
+
*```
|
|
2114
|
+
* In this example, `VizPointDoubleClick` event is used for
|
|
2115
|
+
* triggering the `DrillDown` event when an area or specific
|
|
2116
|
+
* data point on a table or chart is double-clicked.
|
|
2117
|
+
*
|
|
2118
|
+
* @example
|
|
2119
|
+
*```js
|
|
2120
|
+
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2121
|
+
* console.log(payload);
|
|
2122
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
2123
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
2124
|
+
* console.log('>>> called', clickedPoint);
|
|
2125
|
+
* embed.trigger(HostEvent.DrillDown, {
|
|
2126
|
+
* points: {
|
|
2127
|
+
* clickedPoint,
|
|
2128
|
+
* selectedPoints: selectedPoint
|
|
2129
|
+
* },
|
|
2130
|
+
* autoDrillDown: true,
|
|
2131
|
+
* })
|
|
2132
|
+
* })
|
|
2133
|
+
*```
|
|
2134
|
+
*
|
|
1996
2135
|
*/
|
|
1997
2136
|
Drilldown = "drillDown",
|
|
1998
2137
|
/**
|
|
1999
2138
|
* One or more data sources have been selected.
|
|
2000
|
-
*
|
|
2001
2139
|
* @returns dataSourceIds - the list of data sources
|
|
2140
|
+
*
|
|
2141
|
+
* @example
|
|
2142
|
+
* ```js
|
|
2143
|
+
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
2144
|
+
* console.log('DataSourceSelected', payload);
|
|
2145
|
+
* })
|
|
2146
|
+
* ```
|
|
2147
|
+
*
|
|
2002
2148
|
*/
|
|
2003
2149
|
DataSourceSelected = "dataSourceSelected",
|
|
2004
2150
|
/**
|
|
2005
2151
|
* One or more data columns have been selected.
|
|
2006
|
-
*
|
|
2007
2152
|
* @returns columnIds - the list of columns
|
|
2008
2153
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2154
|
+
*
|
|
2155
|
+
* @example
|
|
2156
|
+
* ```js
|
|
2157
|
+
* appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
|
|
2158
|
+
* console.log('AddRemoveColumns', payload);
|
|
2159
|
+
* })
|
|
2160
|
+
* ```
|
|
2161
|
+
*
|
|
2009
2162
|
*/
|
|
2010
2163
|
AddRemoveColumns = "addRemoveColumns",
|
|
2011
2164
|
/**
|
|
2012
|
-
* A custom action has been triggered
|
|
2165
|
+
* A custom action has been triggered.
|
|
2166
|
+
*
|
|
2167
|
+
* @returns actionId - ID of the custom action
|
|
2168
|
+
* @returns data - Response payload with the Answer or Liveboard data
|
|
2013
2169
|
*
|
|
2014
|
-
* @
|
|
2015
|
-
*
|
|
2170
|
+
* @example
|
|
2171
|
+
* ```js
|
|
2172
|
+
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
2173
|
+
* const data = payload.data;
|
|
2174
|
+
* if (data.id === 'insert Custom Action ID here') {
|
|
2175
|
+
* console.log('Custom Action event:', data.embedAnswerData);
|
|
2176
|
+
* }
|
|
2177
|
+
* })
|
|
2178
|
+
* ```
|
|
2016
2179
|
*/
|
|
2017
2180
|
CustomAction = "customAction",
|
|
2018
2181
|
/**
|
|
2019
|
-
* Listen to double
|
|
2182
|
+
* Listen to double click actions on a visualization.
|
|
2183
|
+
*
|
|
2184
|
+
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
2020
2185
|
*
|
|
2021
|
-
* @return ContextMenuInputPoints - data point that is double clicked
|
|
2022
2186
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2187
|
+
*
|
|
2188
|
+
* @example
|
|
2189
|
+
* ```js
|
|
2190
|
+
* livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
|
|
2191
|
+
* console.log('VizPointDoubleClick', payload)
|
|
2192
|
+
* })
|
|
2193
|
+
* ```
|
|
2023
2194
|
*/
|
|
2024
2195
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
2025
2196
|
/**
|
|
2026
|
-
* Listen to clicks on a visualization in a
|
|
2197
|
+
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
2198
|
+
*
|
|
2199
|
+
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
2200
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2201
|
+
* @important
|
|
2027
2202
|
*
|
|
2028
2203
|
* @example
|
|
2029
2204
|
* ```js
|
|
@@ -2037,25 +2212,46 @@ export declare enum EmbedEvent {
|
|
|
2037
2212
|
* )
|
|
2038
2213
|
* });
|
|
2039
2214
|
* ```
|
|
2040
|
-
* @return viz, clickedPoint - metadata about point that is clicked
|
|
2041
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2042
|
-
* @important
|
|
2043
2215
|
*/
|
|
2044
2216
|
VizPointClick = "vizPointClick",
|
|
2045
2217
|
/**
|
|
2046
2218
|
* An error has occurred.
|
|
2047
2219
|
*
|
|
2048
2220
|
* @returns error - An error object or message
|
|
2221
|
+
*
|
|
2222
|
+
* @example
|
|
2223
|
+
* ```js
|
|
2224
|
+
* SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
|
|
2225
|
+
* //show error messaage
|
|
2226
|
+
* function showErrorMsg() {
|
|
2227
|
+
* document.getElementById("error");
|
|
2228
|
+
* ```
|
|
2229
|
+
*
|
|
2049
2230
|
*/
|
|
2050
2231
|
Error = "Error",
|
|
2051
2232
|
/**
|
|
2052
|
-
* The embedded object has sent an alert
|
|
2233
|
+
* The embedded object has sent an alert.
|
|
2053
2234
|
*
|
|
2054
2235
|
* @returns alert - An alert object
|
|
2236
|
+
*
|
|
2237
|
+
* @example
|
|
2238
|
+
* ```js
|
|
2239
|
+
* searchEmbed.on(EmbedEvent.Alert)
|
|
2240
|
+
* ```
|
|
2241
|
+
*
|
|
2055
2242
|
*/
|
|
2056
2243
|
Alert = "alert",
|
|
2057
2244
|
/**
|
|
2058
2245
|
* The ThoughtSpot auth session has expired.
|
|
2246
|
+
*
|
|
2247
|
+
* @example
|
|
2248
|
+
*```js
|
|
2249
|
+
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
2250
|
+
* //show auth expired banner
|
|
2251
|
+
* function showAuthExpired() {
|
|
2252
|
+
* document.getElementById("authExpiredBanner");
|
|
2253
|
+
* }
|
|
2254
|
+
*```
|
|
2059
2255
|
*/
|
|
2060
2256
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2061
2257
|
/**
|
|
@@ -2085,14 +2281,28 @@ export declare enum EmbedEvent {
|
|
|
2085
2281
|
*/
|
|
2086
2282
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
2087
2283
|
/**
|
|
2088
|
-
* Emitted when
|
|
2089
|
-
*
|
|
2284
|
+
* Emitted when the **Get Data** action is initiated.
|
|
2285
|
+
* Applicable to `SearchBarEmbed` only.
|
|
2090
2286
|
*
|
|
2091
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.
|
|
2287
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2288
|
+
*
|
|
2289
|
+
* @example
|
|
2290
|
+
*```js
|
|
2291
|
+
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
2292
|
+
* .then(data => {
|
|
2293
|
+
* console.log('Answer Data:', data);
|
|
2294
|
+
* })
|
|
2295
|
+
*```
|
|
2092
2296
|
*/
|
|
2093
2297
|
GetDataClick = "getDataClick",
|
|
2094
2298
|
/**
|
|
2095
2299
|
* Detects the route change.
|
|
2300
|
+
*
|
|
2301
|
+
* @example
|
|
2302
|
+
*```js
|
|
2303
|
+
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
2304
|
+
* console.log('data', payload))
|
|
2305
|
+
*```
|
|
2096
2306
|
*/
|
|
2097
2307
|
RouteChange = "ROUTE_CHANGE",
|
|
2098
2308
|
/**
|
|
@@ -2102,10 +2312,15 @@ export declare enum EmbedEvent {
|
|
|
2102
2312
|
*/
|
|
2103
2313
|
V1Data = "exportVizDataToParent",
|
|
2104
2314
|
/**
|
|
2105
|
-
* Emitted when the embed does not have cookie access. This
|
|
2106
|
-
*
|
|
2315
|
+
* Emitted when the embed does not have cookie access. This happens
|
|
2316
|
+
* when Safari and other Web browsers block third-party cookies
|
|
2317
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
2107
2318
|
*
|
|
2108
|
-
* @
|
|
2319
|
+
* @example
|
|
2320
|
+
*```js
|
|
2321
|
+
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
2322
|
+
*```
|
|
2323
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
2109
2324
|
*/
|
|
2110
2325
|
NoCookieAccess = "noCookieAccess",
|
|
2111
2326
|
/**
|
|
@@ -2117,239 +2332,539 @@ export declare enum EmbedEvent {
|
|
|
2117
2332
|
SAMLComplete = "samlComplete",
|
|
2118
2333
|
/**
|
|
2119
2334
|
* Emitted when any modal is opened in the app
|
|
2120
|
-
*
|
|
2121
2335
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2336
|
+
*
|
|
2337
|
+
* @example
|
|
2338
|
+
*```js
|
|
2339
|
+
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
2340
|
+
* console.log('dialog open', payload);
|
|
2341
|
+
* })
|
|
2342
|
+
*```
|
|
2122
2343
|
*/
|
|
2123
2344
|
DialogOpen = "dialog-open",
|
|
2124
2345
|
/**
|
|
2125
2346
|
* Emitted when any modal is closed in the app
|
|
2126
|
-
*
|
|
2127
2347
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2348
|
+
*
|
|
2349
|
+
* @example
|
|
2350
|
+
*```js
|
|
2351
|
+
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
2352
|
+
* console.log('dialog close', payload);
|
|
2353
|
+
* })
|
|
2354
|
+
*```
|
|
2128
2355
|
*/
|
|
2129
2356
|
DialogClose = "dialog-close",
|
|
2130
2357
|
/**
|
|
2131
2358
|
* Emitted when the Liveboard shell loads.
|
|
2132
2359
|
* You can use this event as a hook to trigger
|
|
2133
2360
|
* other events on the rendered Liveboard.
|
|
2134
|
-
*
|
|
2135
2361
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2362
|
+
*
|
|
2363
|
+
* @example
|
|
2364
|
+
*```js
|
|
2365
|
+
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
2366
|
+
console.log('Liveboard is rendered', payload);
|
|
2367
|
+
})
|
|
2368
|
+
*```
|
|
2369
|
+
* The following example shows how to trigger
|
|
2370
|
+
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
2371
|
+
*
|
|
2372
|
+
* @example
|
|
2373
|
+
*```js
|
|
2374
|
+
* const embedRef = useEmbedRef();
|
|
2375
|
+
* const onLiveboardRendered = () => {
|
|
2376
|
+
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
2377
|
+
* };
|
|
2378
|
+
*```
|
|
2136
2379
|
*/
|
|
2137
2380
|
LiveboardRendered = "PinboardRendered",
|
|
2138
2381
|
/**
|
|
2139
2382
|
* This can be used to register an event listener which
|
|
2140
2383
|
* is triggered on all events.
|
|
2141
|
-
*
|
|
2142
2384
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2385
|
+
*
|
|
2386
|
+
* @example
|
|
2387
|
+
*```js
|
|
2388
|
+
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
2389
|
+
* console.log('Embed Events', payload)
|
|
2390
|
+
* })
|
|
2391
|
+
*```
|
|
2143
2392
|
*/
|
|
2144
2393
|
ALL = "*",
|
|
2145
2394
|
/**
|
|
2146
2395
|
* Emitted when an Answer is saved in the app
|
|
2147
|
-
*
|
|
2148
2396
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2397
|
+
* @example
|
|
2398
|
+
*```js
|
|
2399
|
+
* //trigger when action starts
|
|
2400
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2401
|
+
* console.log('Save', payload)
|
|
2402
|
+
* }, {
|
|
2403
|
+
* start: true
|
|
2404
|
+
* })
|
|
2405
|
+
* //trigger when action ends
|
|
2406
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2407
|
+
* console.log('Save', payload)
|
|
2408
|
+
* })
|
|
2409
|
+
*```
|
|
2149
2410
|
*/
|
|
2150
2411
|
Save = "save",
|
|
2151
2412
|
/**
|
|
2152
2413
|
* Emitted when the download action is triggered on an answer
|
|
2153
2414
|
*
|
|
2415
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
2416
|
+
* To fire an event when a download action is initiated on a chart or table,
|
|
2417
|
+
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
2418
|
+
* or `EmbedEvent.DownloadAsXLSX`
|
|
2419
|
+
*
|
|
2154
2420
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2421
|
+
*
|
|
2422
|
+
* @example
|
|
2423
|
+
*```js
|
|
2424
|
+
* liveboardEmbed.trigger(HostEvent.Download, {
|
|
2425
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2426
|
+
* })
|
|
2427
|
+
*```
|
|
2155
2428
|
*/
|
|
2156
2429
|
Download = "download",
|
|
2157
2430
|
/**
|
|
2158
2431
|
* Emitted when the download action is triggered on an answer
|
|
2159
|
-
*
|
|
2160
2432
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
2433
|
+
*
|
|
2434
|
+
* @example
|
|
2435
|
+
*```js
|
|
2436
|
+
* //trigger when action starts
|
|
2437
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2438
|
+
* console.log('download PNG', payload)}, {start: true })
|
|
2439
|
+
* //trigger when action ends
|
|
2440
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2441
|
+
* console.log('download PNG', payload)})
|
|
2442
|
+
*```
|
|
2443
|
+
*
|
|
2161
2444
|
*/
|
|
2162
2445
|
DownloadAsPng = "downloadAsPng",
|
|
2163
2446
|
/**
|
|
2164
2447
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
2165
2448
|
*
|
|
2166
2449
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2450
|
+
*
|
|
2451
|
+
* @example
|
|
2452
|
+
*```js
|
|
2453
|
+
* //trigger when action starts
|
|
2454
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2455
|
+
* console.log('download PDF', payload)}, {start: true })
|
|
2456
|
+
* //trigger when action ends
|
|
2457
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2458
|
+
* console.log('download PDF', payload)})
|
|
2459
|
+
*```
|
|
2460
|
+
*
|
|
2167
2461
|
*/
|
|
2168
2462
|
DownloadAsPdf = "downloadAsPdf",
|
|
2169
2463
|
/**
|
|
2170
2464
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
2171
2465
|
*
|
|
2172
2466
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2467
|
+
* @example
|
|
2468
|
+
*```js
|
|
2469
|
+
* //trigger when action starts
|
|
2470
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2471
|
+
* console.log('download CSV', payload)}, {start: true })
|
|
2472
|
+
* //trigger when action ends
|
|
2473
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2474
|
+
* console.log('download CSV', payload)})
|
|
2475
|
+
*```
|
|
2173
2476
|
*/
|
|
2174
2477
|
DownloadAsCsv = "downloadAsCsv",
|
|
2175
2478
|
/**
|
|
2176
2479
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
2177
2480
|
*
|
|
2178
2481
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2482
|
+
*
|
|
2483
|
+
* @example
|
|
2484
|
+
*```js
|
|
2485
|
+
* //trigger when action starts
|
|
2486
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2487
|
+
* console.log('download Xlsx', payload)}, { start: true })
|
|
2488
|
+
* //trigger when action ends
|
|
2489
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2490
|
+
* console.log('download Xlsx', payload)})
|
|
2491
|
+
*```
|
|
2179
2492
|
*/
|
|
2180
2493
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
2181
2494
|
/**
|
|
2182
|
-
* Emitted when an
|
|
2495
|
+
* Emitted when an Answer is deleted in the app
|
|
2183
2496
|
*
|
|
2184
2497
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2498
|
+
*
|
|
2499
|
+
* @example
|
|
2500
|
+
*```js
|
|
2501
|
+
* //trigger when action starts
|
|
2502
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2503
|
+
* console.log('delete answer', payload)}, {start: true })
|
|
2504
|
+
* //trigger when action is completed
|
|
2505
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2506
|
+
* console.log('delete answer', payload)})
|
|
2507
|
+
*```
|
|
2185
2508
|
*/
|
|
2186
2509
|
AnswerDelete = "answerDelete",
|
|
2187
2510
|
/**
|
|
2188
2511
|
* Emitted when an answer is pinned to a Liveboard
|
|
2189
2512
|
*
|
|
2190
2513
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2514
|
+
* @example
|
|
2515
|
+
*```js
|
|
2516
|
+
* //trigger when action starts
|
|
2517
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2518
|
+
* console.log('pin', payload)
|
|
2519
|
+
* }, {
|
|
2520
|
+
* start: true
|
|
2521
|
+
* })
|
|
2522
|
+
* //trigger when action ends
|
|
2523
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2524
|
+
* console.log('pin', payload)
|
|
2525
|
+
* })
|
|
2526
|
+
*```
|
|
2191
2527
|
*/
|
|
2192
2528
|
Pin = "pin",
|
|
2193
2529
|
/**
|
|
2194
2530
|
* Emitted when SpotIQ analysis is triggered
|
|
2195
2531
|
*
|
|
2196
2532
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2533
|
+
* @example
|
|
2534
|
+
*```js
|
|
2535
|
+
* //trigger when action starts
|
|
2536
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2537
|
+
* console.log('SpotIQAnalyze', payload)
|
|
2538
|
+
* }, {
|
|
2539
|
+
* start: true
|
|
2540
|
+
* })
|
|
2541
|
+
* //trigger when action ends
|
|
2542
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2543
|
+
* console.log('SpotIQ analyze', payload)
|
|
2544
|
+
* })
|
|
2545
|
+
*```
|
|
2197
2546
|
*/
|
|
2198
2547
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2199
2548
|
/**
|
|
2200
2549
|
* Emitted when a user shares an object with another user or group
|
|
2201
2550
|
*
|
|
2202
2551
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2552
|
+
*
|
|
2553
|
+
* @example
|
|
2554
|
+
*```js
|
|
2555
|
+
* //trigger when action starts
|
|
2556
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2557
|
+
* console.log('Share', payload)
|
|
2558
|
+
* }, {
|
|
2559
|
+
* start: true
|
|
2560
|
+
* })
|
|
2561
|
+
* //trigger when action ends
|
|
2562
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2563
|
+
* console.log('Share', payload)
|
|
2564
|
+
* })
|
|
2565
|
+
*```
|
|
2203
2566
|
*/
|
|
2204
2567
|
Share = "share",
|
|
2205
2568
|
/**
|
|
2206
|
-
* Emitted when a user clicks the Include action to include a specific value or
|
|
2207
|
-
* on a chart or table
|
|
2569
|
+
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
2570
|
+
* data on a chart or table.
|
|
2208
2571
|
*
|
|
2209
2572
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2573
|
+
* @example
|
|
2574
|
+
*```js
|
|
2575
|
+
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
2576
|
+
* console.log('Drill include', payload);
|
|
2577
|
+
* })
|
|
2578
|
+
*```
|
|
2210
2579
|
*/
|
|
2211
2580
|
DrillInclude = "context-menu-item-include",
|
|
2212
2581
|
/**
|
|
2213
|
-
* Emitted when a user clicks the Exclude action to exclude a specific value or
|
|
2214
|
-
* on a chart or table
|
|
2582
|
+
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
2583
|
+
* data on a chart or table
|
|
2215
2584
|
*
|
|
2216
2585
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2586
|
+
* @example
|
|
2587
|
+
*```js
|
|
2588
|
+
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
2589
|
+
* console.log('Drill exclude', payload);
|
|
2590
|
+
* })
|
|
2591
|
+
*```
|
|
2217
2592
|
*/
|
|
2218
2593
|
DrillExclude = "context-menu-item-exclude",
|
|
2219
2594
|
/**
|
|
2220
|
-
* Emitted when
|
|
2595
|
+
* Emitted when a column value is copied in the embedded app.
|
|
2221
2596
|
*
|
|
2222
2597
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2598
|
+
* @example
|
|
2599
|
+
*```js
|
|
2600
|
+
* seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
2601
|
+
* console.log('copy to clipboard', payload);
|
|
2602
|
+
* })
|
|
2603
|
+
*```
|
|
2223
2604
|
*/
|
|
2224
2605
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2225
2606
|
/**
|
|
2226
|
-
* Emitted when a user clicks the Update TML action
|
|
2607
|
+
* Emitted when a user clicks the **Update TML** action
|
|
2227
2608
|
*
|
|
2228
2609
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2610
|
+
* @example
|
|
2611
|
+
*```js
|
|
2612
|
+
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
2613
|
+
* })
|
|
2614
|
+
*```
|
|
2229
2615
|
*/
|
|
2230
2616
|
UpdateTML = "updateTSL",
|
|
2231
2617
|
/**
|
|
2232
|
-
* Emitted when a user clicks the Edit TML action
|
|
2618
|
+
* Emitted when a user clicks the **Edit TML** action
|
|
2233
2619
|
*
|
|
2234
2620
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2621
|
+
* @example
|
|
2622
|
+
*```js
|
|
2623
|
+
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
2624
|
+
* console.log('Edit TML', payload);
|
|
2625
|
+
* })
|
|
2626
|
+
*```
|
|
2235
2627
|
*/
|
|
2236
2628
|
EditTML = "editTSL",
|
|
2237
2629
|
/**
|
|
2238
|
-
* Emitted when
|
|
2239
|
-
*
|
|
2630
|
+
* Emitted when the **Export TML** action is triggered on an
|
|
2631
|
+
* an embedded object in the app
|
|
2240
2632
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2633
|
+
* @example
|
|
2634
|
+
*```js
|
|
2635
|
+
* //trigger when action starts
|
|
2636
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2637
|
+
* console.log('Export TML', payload)}, { start: true })
|
|
2638
|
+
* //trigger when action ends
|
|
2639
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2640
|
+
* console.log('Export TML', payload)})
|
|
2641
|
+
*```
|
|
2241
2642
|
*/
|
|
2242
2643
|
ExportTML = "exportTSL",
|
|
2243
2644
|
/**
|
|
2244
|
-
* Emitted when an
|
|
2645
|
+
* Emitted when an Answer is saved as a View.
|
|
2245
2646
|
*
|
|
2246
2647
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2648
|
+
* @example
|
|
2649
|
+
*```js
|
|
2650
|
+
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
2651
|
+
* console.log('View', payload);
|
|
2652
|
+
* })
|
|
2653
|
+
*```
|
|
2247
2654
|
*/
|
|
2248
2655
|
SaveAsView = "saveAsView",
|
|
2249
2656
|
/**
|
|
2250
|
-
* Emitted when
|
|
2657
|
+
* Emitted when the user creates a copy of an Answer
|
|
2251
2658
|
*
|
|
2252
2659
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2660
|
+
* @example
|
|
2661
|
+
*```js
|
|
2662
|
+
* //trigger when action starts
|
|
2663
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2664
|
+
* console.log('Copy and edit', payload)}, {start: true })
|
|
2665
|
+
* //trigger when action ends
|
|
2666
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2667
|
+
* console.log('Copy and edit', payload)})
|
|
2668
|
+
*```
|
|
2253
2669
|
*/
|
|
2254
2670
|
CopyAEdit = "copyAEdit",
|
|
2255
2671
|
/**
|
|
2256
|
-
* Emitted when a user clicks Show underlying data on an
|
|
2672
|
+
* Emitted when a user clicks Show underlying data on an Answer
|
|
2257
2673
|
*
|
|
2258
2674
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2675
|
+
* @example
|
|
2676
|
+
*```js
|
|
2677
|
+
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
2678
|
+
* console.log('show data', payload);
|
|
2679
|
+
* })
|
|
2680
|
+
*```
|
|
2259
2681
|
*/
|
|
2260
2682
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2261
2683
|
/**
|
|
2262
|
-
* Emitted when an answer is switched to a chart or table view
|
|
2684
|
+
* Emitted when an answer is switched to a chart or table view.
|
|
2263
2685
|
*
|
|
2264
2686
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2687
|
+
* @example
|
|
2688
|
+
*```js
|
|
2689
|
+
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
2690
|
+
* console.log('switch view', payload);
|
|
2691
|
+
* })
|
|
2692
|
+
*```
|
|
2265
2693
|
*/
|
|
2266
2694
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2267
2695
|
/**
|
|
2268
|
-
* Internal event to communicate the initial settings back to the
|
|
2696
|
+
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
2269
2697
|
*
|
|
2270
2698
|
* @hidden
|
|
2271
2699
|
*/
|
|
2272
2700
|
APP_INIT = "appInit",
|
|
2273
2701
|
/**
|
|
2274
|
-
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
2702
|
+
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
2275
2703
|
*
|
|
2276
2704
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2705
|
+
* @example
|
|
2706
|
+
*```js
|
|
2707
|
+
* liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
2708
|
+
* console.log('Liveboard details', payload);
|
|
2709
|
+
* })
|
|
2710
|
+
*```
|
|
2277
2711
|
*/
|
|
2278
2712
|
LiveboardInfo = "pinboardInfo",
|
|
2279
2713
|
/**
|
|
2280
2714
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
2281
2715
|
*
|
|
2282
2716
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2717
|
+
* @example
|
|
2718
|
+
*```js
|
|
2719
|
+
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
2720
|
+
* console.log('favorites', payload);
|
|
2721
|
+
* })
|
|
2722
|
+
*```
|
|
2283
2723
|
*/
|
|
2284
2724
|
AddToFavorites = "addToFavorites",
|
|
2285
2725
|
/**
|
|
2286
|
-
* Emitted when a user clicks Schedule on a Liveboard
|
|
2726
|
+
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
2287
2727
|
*
|
|
2288
2728
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2729
|
+
* @example
|
|
2730
|
+
*```js
|
|
2731
|
+
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
2732
|
+
* console.log(`Liveboard schedule', payload);
|
|
2733
|
+
* })
|
|
2734
|
+
*```
|
|
2289
2735
|
*/
|
|
2290
2736
|
Schedule = "subscription",
|
|
2291
2737
|
/**
|
|
2292
|
-
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
2738
|
+
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
2293
2739
|
*
|
|
2294
2740
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2741
|
+
* @example
|
|
2742
|
+
*```js
|
|
2743
|
+
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
2744
|
+
* console.log(`Liveboard edit', payload);
|
|
2745
|
+
* })
|
|
2746
|
+
*```
|
|
2295
2747
|
*/
|
|
2296
2748
|
Edit = "edit",
|
|
2297
2749
|
/**
|
|
2298
|
-
* Emitted when a user clicks Make a copy on a Liveboard
|
|
2750
|
+
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
2299
2751
|
*
|
|
2300
2752
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2753
|
+
* @example
|
|
2754
|
+
*```js
|
|
2755
|
+
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
2756
|
+
* console.log(`Copy', payload);
|
|
2757
|
+
* })
|
|
2758
|
+
*```
|
|
2301
2759
|
*/
|
|
2302
2760
|
MakeACopy = "makeACopy",
|
|
2303
2761
|
/**
|
|
2304
|
-
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
2762
|
+
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
2305
2763
|
*
|
|
2306
2764
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2765
|
+
* @example
|
|
2766
|
+
*```js
|
|
2767
|
+
* liveboardEmbed.trigger(HostEvent.Present)
|
|
2768
|
+
*```
|
|
2769
|
+
*
|
|
2770
|
+
* @example
|
|
2771
|
+
*```js
|
|
2772
|
+
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
2773
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2774
|
+
* })
|
|
2775
|
+
*```
|
|
2307
2776
|
*/
|
|
2308
2777
|
Present = "present",
|
|
2309
2778
|
/**
|
|
2310
|
-
* Emitted when a user clicks Delete on a
|
|
2779
|
+
* Emitted when a user clicks **Delete** on a visualization
|
|
2311
2780
|
*
|
|
2312
2781
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2782
|
+
* @example
|
|
2783
|
+
*```js
|
|
2784
|
+
* liveboardEmbed.trigger(HostEvent.Delete,
|
|
2785
|
+
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2786
|
+
*```
|
|
2787
|
+
*
|
|
2313
2788
|
*/
|
|
2314
2789
|
Delete = "delete",
|
|
2315
2790
|
/**
|
|
2316
2791
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2317
2792
|
*
|
|
2318
2793
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2794
|
+
*
|
|
2795
|
+
* @example
|
|
2796
|
+
*```js
|
|
2797
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList)
|
|
2798
|
+
*```
|
|
2799
|
+
*
|
|
2319
2800
|
*/
|
|
2320
2801
|
SchedulesList = "schedule-list",
|
|
2321
2802
|
/**
|
|
2322
|
-
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
2803
|
+
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
2323
2804
|
*
|
|
2324
2805
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2806
|
+
*
|
|
2807
|
+
* @example
|
|
2808
|
+
*```js
|
|
2809
|
+
* liveboardEmbed.trigger(HostEvent.Cancel)
|
|
2810
|
+
*```
|
|
2811
|
+
*
|
|
2325
2812
|
*/
|
|
2326
2813
|
Cancel = "cancel",
|
|
2327
2814
|
/**
|
|
2328
|
-
* Emitted when a user clicks Explore on a visualization
|
|
2815
|
+
* Emitted when a user clicks **Explore** on a visualization
|
|
2329
2816
|
*
|
|
2330
2817
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2818
|
+
*
|
|
2819
|
+
* @example
|
|
2820
|
+
*```js
|
|
2821
|
+
* liveboardEmbed.trigger(HostEvent.Explore, {
|
|
2822
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2823
|
+
*```
|
|
2824
|
+
*
|
|
2331
2825
|
*/
|
|
2332
2826
|
Explore = "explore",
|
|
2333
2827
|
/**
|
|
2334
|
-
* Emitted when a user clicks Copy link action on a visualization
|
|
2828
|
+
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2335
2829
|
*
|
|
2336
2830
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2831
|
+
*
|
|
2832
|
+
* @example
|
|
2833
|
+
*```js
|
|
2834
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
2835
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2836
|
+
*```
|
|
2837
|
+
*
|
|
2337
2838
|
*/
|
|
2338
2839
|
CopyLink = "embedDocument",
|
|
2339
2840
|
/**
|
|
2340
|
-
* Emitted when a user interacts with cross filters on a visualization or
|
|
2841
|
+
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
2842
|
+
*
|
|
2843
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2844
|
+
*
|
|
2845
|
+
* @example
|
|
2846
|
+
*```js
|
|
2847
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
2848
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2849
|
+
*```
|
|
2341
2850
|
*
|
|
2342
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2343
2851
|
*/
|
|
2344
2852
|
CrossFilterChanged = "cross-filter-changed",
|
|
2345
2853
|
/**
|
|
2346
2854
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2347
2855
|
*
|
|
2348
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2856
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2857
|
+
*
|
|
2858
|
+
* @example
|
|
2859
|
+
*```js
|
|
2860
|
+
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
2861
|
+
* console.log('VizPointClick', payload)
|
|
2862
|
+
* })
|
|
2863
|
+
*```
|
|
2349
2864
|
*/
|
|
2350
2865
|
VizPointRightClick = "vizPointRightClick",
|
|
2351
2866
|
/**
|
|
2352
|
-
* Emitted when a user clicks
|
|
2867
|
+
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2353
2868
|
*
|
|
2354
2869
|
* @hidden
|
|
2355
2870
|
*/
|
|
@@ -2357,52 +2872,53 @@ export declare enum EmbedEvent {
|
|
|
2357
2872
|
/**
|
|
2358
2873
|
* @hidden
|
|
2359
2874
|
* Emitted when a user changes any filter on a Liveboard.
|
|
2360
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2875
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
2361
2876
|
*/
|
|
2362
2877
|
FilterChanged = "filterChanged",
|
|
2363
2878
|
/**
|
|
2364
|
-
* Emitted when a user
|
|
2879
|
+
* Emitted when a user clicks the **Go** button on the Search page
|
|
2365
2880
|
*
|
|
2366
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2881
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2367
2882
|
*/
|
|
2368
2883
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2369
2884
|
/**
|
|
2370
|
-
*
|
|
2885
|
+
* Emitted when a user selects a data source.
|
|
2886
|
+
*
|
|
2887
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2371
2888
|
*
|
|
2372
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2373
2889
|
*/
|
|
2374
2890
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2375
2891
|
/**
|
|
2376
|
-
* Emitted when a user updates a connection
|
|
2892
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2377
2893
|
*
|
|
2378
|
-
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2894
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2379
2895
|
*/
|
|
2380
2896
|
UpdateConnection = "updateConnection",
|
|
2381
2897
|
/**
|
|
2382
|
-
* Emitted when a user updates a connection
|
|
2898
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2383
2899
|
*
|
|
2384
|
-
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2900
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2385
2901
|
*/
|
|
2386
2902
|
CreateConnection = "createConnection",
|
|
2387
2903
|
/**
|
|
2388
2904
|
* Emitted when name, status (private or public) or filter values of a
|
|
2389
|
-
*
|
|
2905
|
+
* Personalised view is updated.
|
|
2390
2906
|
*
|
|
2391
2907
|
* @returns viewName: string
|
|
2392
2908
|
* @returns viewId: string
|
|
2393
2909
|
* @returns liveboardId: string
|
|
2394
2910
|
* @returns isPublic: boolean
|
|
2395
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2911
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2396
2912
|
*/
|
|
2397
2913
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2398
2914
|
/**
|
|
2399
|
-
* Emitted when a
|
|
2915
|
+
* Emitted when a Personalised view is saved.
|
|
2400
2916
|
*
|
|
2401
2917
|
* @returns viewName: string
|
|
2402
2918
|
* @returns viewId: string
|
|
2403
2919
|
* @returns liveboardId: string
|
|
2404
2920
|
* @returns isPublic: boolean
|
|
2405
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2921
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2406
2922
|
*/
|
|
2407
2923
|
SavePersonalisedView = "savePersonalisedView",
|
|
2408
2924
|
/**
|
|
@@ -2412,7 +2928,7 @@ export declare enum EmbedEvent {
|
|
|
2412
2928
|
* @returns viewId: string
|
|
2413
2929
|
* @returns liveboardId: string
|
|
2414
2930
|
* @returns isPublic: boolean
|
|
2415
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2931
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2416
2932
|
*/
|
|
2417
2933
|
ResetLiveboard = "resetLiveboard",
|
|
2418
2934
|
/**
|
|
@@ -2420,11 +2936,11 @@ export declare enum EmbedEvent {
|
|
|
2420
2936
|
*
|
|
2421
2937
|
* @returns views: string[]
|
|
2422
2938
|
* @returns liveboardId: string
|
|
2423
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2939
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2424
2940
|
*/
|
|
2425
2941
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
2426
2942
|
/**
|
|
2427
|
-
*
|
|
2943
|
+
* Emitted when a user creates a new worksheet
|
|
2428
2944
|
*
|
|
2429
2945
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2430
2946
|
*/
|
|
@@ -2454,15 +2970,16 @@ export declare enum EmbedEvent {
|
|
|
2454
2970
|
*/
|
|
2455
2971
|
export declare enum HostEvent {
|
|
2456
2972
|
/**
|
|
2457
|
-
* Triggers a search
|
|
2458
|
-
*
|
|
2973
|
+
* Triggers a search operation with the search tokens specified in
|
|
2974
|
+
* the search query string.
|
|
2975
|
+
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2459
2976
|
* Includes the following properties:
|
|
2460
2977
|
*
|
|
2461
|
-
* @param -
|
|
2978
|
+
* @param - `searchQuery` - query string with search tokens
|
|
2979
|
+
* @param - `dataSources` - Data source GUID to Search on
|
|
2462
2980
|
* - Although an array, only a single source
|
|
2463
2981
|
* is supported.
|
|
2464
|
-
* @param -
|
|
2465
|
-
* @param - execute - executes the existing / updated query
|
|
2982
|
+
* @param - `execute` - executes search and updates the existing query
|
|
2466
2983
|
* @example
|
|
2467
2984
|
* ```js
|
|
2468
2985
|
* searchembed.trigger(HostEvent.Search, {
|
|
@@ -2482,6 +2999,10 @@ export declare enum HostEvent {
|
|
|
2482
2999
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
2483
3000
|
* by. If not provided it will auto drill by the configured
|
|
2484
3001
|
* column.
|
|
3002
|
+
* @param - autoDrillDown - Optional. If true, the drill down will be
|
|
3003
|
+
* done automatically on the most popular column.
|
|
3004
|
+
* @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
|
|
3005
|
+
* in case of a liveboard.
|
|
2485
3006
|
* @example
|
|
2486
3007
|
* ```js
|
|
2487
3008
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -2498,6 +3019,25 @@ export declare enum HostEvent {
|
|
|
2498
3019
|
* });
|
|
2499
3020
|
* })
|
|
2500
3021
|
* ```
|
|
3022
|
+
* @example
|
|
3023
|
+
* ```js
|
|
3024
|
+
* // Works with TS 9.8.0 and above
|
|
3025
|
+
*
|
|
3026
|
+
* liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3027
|
+
* console.log(payload);
|
|
3028
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
3029
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
3030
|
+
* console.log('>>> called', clickedPoint);
|
|
3031
|
+
* liveboardEmbed.trigger(HostEvent.DrillDown, {
|
|
3032
|
+
* points: {
|
|
3033
|
+
* clickedPoint,
|
|
3034
|
+
* selectedPoints: selectedPoint
|
|
3035
|
+
* },
|
|
3036
|
+
* autoDrillDown: true,
|
|
3037
|
+
* vizId: payload.data.vizId
|
|
3038
|
+
* });
|
|
3039
|
+
* })
|
|
3040
|
+
* ```
|
|
2501
3041
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2502
3042
|
*/
|
|
2503
3043
|
DrillDown = "triggerDrillDown",
|
|
@@ -2514,7 +3054,7 @@ export declare enum HostEvent {
|
|
|
2514
3054
|
*/
|
|
2515
3055
|
Reload = "reload",
|
|
2516
3056
|
/**
|
|
2517
|
-
*
|
|
3057
|
+
* Display specific visualizations on a Liveboard.
|
|
2518
3058
|
*
|
|
2519
3059
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2520
3060
|
* in this parameter will be hidden.
|
|
@@ -2528,7 +3068,7 @@ export declare enum HostEvent {
|
|
|
2528
3068
|
*/
|
|
2529
3069
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2530
3070
|
/**
|
|
2531
|
-
* Set
|
|
3071
|
+
* Set a Liveboard tab as an active tab.
|
|
2532
3072
|
*
|
|
2533
3073
|
* @param - tabId - string of id of Tab to show
|
|
2534
3074
|
* @example
|
|
@@ -2541,7 +3081,7 @@ export declare enum HostEvent {
|
|
|
2541
3081
|
*/
|
|
2542
3082
|
SetActiveTab = "SetActiveTab",
|
|
2543
3083
|
/**
|
|
2544
|
-
*
|
|
3084
|
+
* Update runtime filters applied on a Saved Answer or Liveboard. The
|
|
2545
3085
|
* runtime filters passed here are appended to the existing runtime
|
|
2546
3086
|
* filters.
|
|
2547
3087
|
* Pass an array of runtime filters with the following attributes:
|
|
@@ -2567,10 +3107,12 @@ export declare enum HostEvent {
|
|
|
2567
3107
|
*/
|
|
2568
3108
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
2569
3109
|
/**
|
|
2570
|
-
* Navigate to a specific page in the embedded application
|
|
3110
|
+
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2571
3111
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2572
3112
|
*
|
|
2573
|
-
* @param - path - the path to navigate to
|
|
3113
|
+
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
3114
|
+
* be a number; for example, `1`, `-1`.
|
|
3115
|
+
*
|
|
2574
3116
|
* @example
|
|
2575
3117
|
* ```js
|
|
2576
3118
|
* appEmbed.navigateToPage(-1)
|
|
@@ -2579,7 +3121,7 @@ export declare enum HostEvent {
|
|
|
2579
3121
|
*/
|
|
2580
3122
|
Navigate = "Navigate",
|
|
2581
3123
|
/**
|
|
2582
|
-
*
|
|
3124
|
+
* Open the filter panel for a particular column.
|
|
2583
3125
|
* Works with Search and Liveboard embed.
|
|
2584
3126
|
*
|
|
2585
3127
|
* @param - { columnId: string,
|
|
@@ -2597,7 +3139,7 @@ export declare enum HostEvent {
|
|
|
2597
3139
|
*/
|
|
2598
3140
|
OpenFilter = "openFilter",
|
|
2599
3141
|
/**
|
|
2600
|
-
*
|
|
3142
|
+
* Add columns to the current search query.
|
|
2601
3143
|
*
|
|
2602
3144
|
* @param - { columnIds: string[] }
|
|
2603
3145
|
* @example
|
|
@@ -2608,7 +3150,7 @@ export declare enum HostEvent {
|
|
|
2608
3150
|
*/
|
|
2609
3151
|
AddColumns = "addColumns",
|
|
2610
3152
|
/**
|
|
2611
|
-
*
|
|
3153
|
+
* Remove a column from the current search query.
|
|
2612
3154
|
*
|
|
2613
3155
|
* @param - { columnId: string }
|
|
2614
3156
|
* @example
|
|
@@ -2619,27 +3161,29 @@ export declare enum HostEvent {
|
|
|
2619
3161
|
*/
|
|
2620
3162
|
RemoveColumn = "removeColumn",
|
|
2621
3163
|
/**
|
|
2622
|
-
*
|
|
3164
|
+
* Get the transient state of a Liveboard as encoded content.
|
|
3165
|
+
* This includes unsaved and ad hoc changes such as
|
|
3166
|
+
* Liveboard filters, runtime filters applied on visualizations on a
|
|
3167
|
+
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
3168
|
+
* sorting, toggling of legends, and data drill down.
|
|
2623
3169
|
*
|
|
2624
3170
|
* @example
|
|
2625
3171
|
* ```js
|
|
2626
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
3172
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
3173
|
+
* data=>console.log(data))
|
|
2627
3174
|
* ```
|
|
2628
3175
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
2629
3176
|
*/
|
|
2630
3177
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2631
3178
|
/**
|
|
2632
|
-
*
|
|
3179
|
+
* Trigger the **Pin** action on an embedded object
|
|
2633
3180
|
*
|
|
2634
3181
|
* @param - Liveboard embed takes the `vizId` as a
|
|
2635
|
-
* key. Can be left undefined when embedding Search, full app or
|
|
3182
|
+
* key. Can be left undefined when embedding Search, full app, or
|
|
2636
3183
|
* a visualization.
|
|
2637
3184
|
* @example
|
|
2638
3185
|
* ```js
|
|
2639
|
-
*
|
|
2640
|
-
* ```
|
|
2641
|
-
* ```js
|
|
2642
|
-
* vizEmbed.trigger(HostEvent.Pin)
|
|
3186
|
+
* appEmbed.trigger(HostEvent.Pin)
|
|
2643
3187
|
* ```
|
|
2644
3188
|
* ```js
|
|
2645
3189
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
@@ -2648,17 +3192,18 @@ export declare enum HostEvent {
|
|
|
2648
3192
|
*/
|
|
2649
3193
|
Pin = "pin",
|
|
2650
3194
|
/**
|
|
2651
|
-
*
|
|
3195
|
+
* Trigger the **Show Liveboard details** action
|
|
3196
|
+
* on an embedded Liveboard.
|
|
2652
3197
|
*
|
|
2653
3198
|
* @example
|
|
2654
|
-
|
|
2655
|
-
*
|
|
2656
|
-
|
|
3199
|
+
*```js
|
|
3200
|
+
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
3201
|
+
*```
|
|
2657
3202
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2658
3203
|
*/
|
|
2659
3204
|
LiveboardInfo = "pinboardInfo",
|
|
2660
3205
|
/**
|
|
2661
|
-
*
|
|
3206
|
+
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2662
3207
|
*
|
|
2663
3208
|
* @example
|
|
2664
3209
|
* ```js
|
|
@@ -2668,7 +3213,7 @@ export declare enum HostEvent {
|
|
|
2668
3213
|
*/
|
|
2669
3214
|
Schedule = "subscription",
|
|
2670
3215
|
/**
|
|
2671
|
-
*
|
|
3216
|
+
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2672
3217
|
*
|
|
2673
3218
|
* @example
|
|
2674
3219
|
* ```js
|
|
@@ -2678,7 +3223,7 @@ export declare enum HostEvent {
|
|
|
2678
3223
|
*/
|
|
2679
3224
|
SchedulesList = "schedule-list",
|
|
2680
3225
|
/**
|
|
2681
|
-
*
|
|
3226
|
+
* Trigger the **Export TML** action on an embedded Liveboard.
|
|
2682
3227
|
*
|
|
2683
3228
|
* @example
|
|
2684
3229
|
* ```js
|
|
@@ -2688,7 +3233,7 @@ export declare enum HostEvent {
|
|
|
2688
3233
|
*/
|
|
2689
3234
|
ExportTML = "exportTSL",
|
|
2690
3235
|
/**
|
|
2691
|
-
*
|
|
3236
|
+
* Trigger the **Edit TML** action on an embedded Liveboard.
|
|
2692
3237
|
*
|
|
2693
3238
|
* @example
|
|
2694
3239
|
* ```js
|
|
@@ -2698,7 +3243,7 @@ export declare enum HostEvent {
|
|
|
2698
3243
|
*/
|
|
2699
3244
|
EditTML = "editTSL",
|
|
2700
3245
|
/**
|
|
2701
|
-
*
|
|
3246
|
+
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
2702
3247
|
*
|
|
2703
3248
|
* @example
|
|
2704
3249
|
* ```js
|
|
@@ -2708,7 +3253,7 @@ export declare enum HostEvent {
|
|
|
2708
3253
|
*/
|
|
2709
3254
|
UpdateTML = "updateTSL",
|
|
2710
3255
|
/**
|
|
2711
|
-
*
|
|
3256
|
+
* Trigger the **Download PDF** action on an embedded Liveboard.
|
|
2712
3257
|
*
|
|
2713
3258
|
* @example
|
|
2714
3259
|
* ```js
|
|
@@ -2718,8 +3263,8 @@ export declare enum HostEvent {
|
|
|
2718
3263
|
*/
|
|
2719
3264
|
DownloadAsPdf = "downloadAsPdf",
|
|
2720
3265
|
/**
|
|
2721
|
-
*
|
|
2722
|
-
* visualization page
|
|
3266
|
+
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
3267
|
+
* visualization page.
|
|
2723
3268
|
*
|
|
2724
3269
|
* @example
|
|
2725
3270
|
* ```js
|
|
@@ -2735,7 +3280,7 @@ export declare enum HostEvent {
|
|
|
2735
3280
|
*/
|
|
2736
3281
|
MakeACopy = "makeACopy",
|
|
2737
3282
|
/**
|
|
2738
|
-
*
|
|
3283
|
+
* Trigger the **Delete** action for a Liveboard.
|
|
2739
3284
|
*
|
|
2740
3285
|
* @example
|
|
2741
3286
|
* ```js
|
|
@@ -2745,7 +3290,7 @@ export declare enum HostEvent {
|
|
|
2745
3290
|
*/
|
|
2746
3291
|
Remove = "delete",
|
|
2747
3292
|
/**
|
|
2748
|
-
*
|
|
3293
|
+
* Trigger the **Explore** action on a visualization.
|
|
2749
3294
|
*
|
|
2750
3295
|
* @param - an object with `vizId` as a key
|
|
2751
3296
|
* @example
|
|
@@ -2756,7 +3301,7 @@ export declare enum HostEvent {
|
|
|
2756
3301
|
*/
|
|
2757
3302
|
Explore = "explore",
|
|
2758
3303
|
/**
|
|
2759
|
-
*
|
|
3304
|
+
* Trigger the **Create alert** action on a visualization
|
|
2760
3305
|
*
|
|
2761
3306
|
* @param - an object with `vizId` as a key
|
|
2762
3307
|
* @example
|
|
@@ -2769,7 +3314,7 @@ export declare enum HostEvent {
|
|
|
2769
3314
|
*/
|
|
2770
3315
|
CreateMonitor = "createMonitor",
|
|
2771
3316
|
/**
|
|
2772
|
-
*
|
|
3317
|
+
* Trigger the **Manage alerts** action on a visualization
|
|
2773
3318
|
*
|
|
2774
3319
|
* @param - an object with `vizId` as a key
|
|
2775
3320
|
* @example
|
|
@@ -2782,7 +3327,7 @@ export declare enum HostEvent {
|
|
|
2782
3327
|
*/
|
|
2783
3328
|
ManageMonitor = "manageMonitor",
|
|
2784
3329
|
/**
|
|
2785
|
-
*
|
|
3330
|
+
* Trigger the **Edit** action on a Liveboard or visualization
|
|
2786
3331
|
*
|
|
2787
3332
|
* @param - object - To trigger the action for a specific visualization
|
|
2788
3333
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
@@ -2803,7 +3348,7 @@ export declare enum HostEvent {
|
|
|
2803
3348
|
*/
|
|
2804
3349
|
Edit = "edit",
|
|
2805
3350
|
/**
|
|
2806
|
-
*
|
|
3351
|
+
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
2807
3352
|
*
|
|
2808
3353
|
* @param - object - to trigger the action for a
|
|
2809
3354
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
@@ -2821,7 +3366,7 @@ export declare enum HostEvent {
|
|
|
2821
3366
|
*/
|
|
2822
3367
|
CopyLink = "embedDocument",
|
|
2823
3368
|
/**
|
|
2824
|
-
*
|
|
3369
|
+
* Trigger the **Present** action on a Liveboard or visualization
|
|
2825
3370
|
*
|
|
2826
3371
|
* @param - object - to trigger the action for a specific visualization
|
|
2827
3372
|
* in Liveboard embed, pass in `vizId` as a key
|
|
@@ -2839,7 +3384,7 @@ export declare enum HostEvent {
|
|
|
2839
3384
|
*/
|
|
2840
3385
|
Present = "present",
|
|
2841
3386
|
/**
|
|
2842
|
-
*
|
|
3387
|
+
* Get TML for the current search.
|
|
2843
3388
|
*
|
|
2844
3389
|
* @example
|
|
2845
3390
|
* ```js
|
|
@@ -2854,7 +3399,7 @@ export declare enum HostEvent {
|
|
|
2854
3399
|
*/
|
|
2855
3400
|
GetTML = "getTML",
|
|
2856
3401
|
/**
|
|
2857
|
-
*
|
|
3402
|
+
* Trigger the **Show underlying data** action on visualization or search
|
|
2858
3403
|
*
|
|
2859
3404
|
* @param - an object with vizId as a key
|
|
2860
3405
|
* @example
|
|
@@ -2872,7 +3417,9 @@ export declare enum HostEvent {
|
|
|
2872
3417
|
*/
|
|
2873
3418
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2874
3419
|
/**
|
|
2875
|
-
*
|
|
3420
|
+
* Trigger the **Delete** action for a visualization
|
|
3421
|
+
* in an embedded Liveboard, or a chart or table
|
|
3422
|
+
* generated from Search.
|
|
2876
3423
|
*
|
|
2877
3424
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
2878
3425
|
* Can be left empty if embedding Search or visualization.
|
|
@@ -2882,16 +3429,13 @@ export declare enum HostEvent {
|
|
|
2882
3429
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2883
3430
|
* ```
|
|
2884
3431
|
* ```js
|
|
2885
|
-
* vizEmbed.trigger(HostEvent.Delete)
|
|
2886
|
-
* ```
|
|
2887
|
-
* ```js
|
|
2888
3432
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
2889
3433
|
* ```
|
|
2890
3434
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2891
3435
|
*/
|
|
2892
3436
|
Delete = "onDeleteAnswer",
|
|
2893
3437
|
/**
|
|
2894
|
-
*
|
|
3438
|
+
* Trigger the **SpotIQ analyze** action on visualization
|
|
2895
3439
|
* or search.
|
|
2896
3440
|
*
|
|
2897
3441
|
* @param - Liveboard embed takes `vizId` as a
|
|
@@ -2912,7 +3456,7 @@ export declare enum HostEvent {
|
|
|
2912
3456
|
*/
|
|
2913
3457
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2914
3458
|
/**
|
|
2915
|
-
*
|
|
3459
|
+
* Trigger the **Download** action on charts in
|
|
2916
3460
|
* the embedded view.
|
|
2917
3461
|
*
|
|
2918
3462
|
* @example
|
|
@@ -2921,17 +3465,15 @@ export declare enum HostEvent {
|
|
|
2921
3465
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2922
3466
|
* ```
|
|
2923
3467
|
* ```js
|
|
2924
|
-
*
|
|
2925
|
-
* ```
|
|
2926
|
-
* ```js
|
|
2927
|
-
* searchEmbed.trigger(HostEvent.Download)
|
|
3468
|
+
* embed.trigger(HostEvent.Download)
|
|
2928
3469
|
* ```
|
|
2929
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
3470
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
3471
|
+
* Use {@link DownloadAsPng}
|
|
2930
3472
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2931
3473
|
*/
|
|
2932
3474
|
Download = "downloadAsPng",
|
|
2933
3475
|
/**
|
|
2934
|
-
*
|
|
3476
|
+
* Trigger the **Download** > **PNG** action on
|
|
2935
3477
|
* charts in the embedded view.
|
|
2936
3478
|
*
|
|
2937
3479
|
* @example
|
|
@@ -2947,7 +3489,7 @@ export declare enum HostEvent {
|
|
|
2947
3489
|
*/
|
|
2948
3490
|
DownloadAsPng = "downloadAsPng",
|
|
2949
3491
|
/**
|
|
2950
|
-
*
|
|
3492
|
+
* Trigger the **Download** > **CSV** action on tables in
|
|
2951
3493
|
* the embedded view.
|
|
2952
3494
|
*
|
|
2953
3495
|
* @example
|
|
@@ -2965,7 +3507,7 @@ export declare enum HostEvent {
|
|
|
2965
3507
|
*/
|
|
2966
3508
|
DownloadAsCsv = "downloadAsCSV",
|
|
2967
3509
|
/**
|
|
2968
|
-
*
|
|
3510
|
+
* Trigger the **Download** > **XLSX** action on tables
|
|
2969
3511
|
* in the embedded view.
|
|
2970
3512
|
*
|
|
2971
3513
|
* @example
|
|
@@ -2983,7 +3525,7 @@ export declare enum HostEvent {
|
|
|
2983
3525
|
*/
|
|
2984
3526
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
2985
3527
|
/**
|
|
2986
|
-
*
|
|
3528
|
+
* Trigger the **Share** action on an embedded
|
|
2987
3529
|
* Liveboard or Answer.
|
|
2988
3530
|
*
|
|
2989
3531
|
* @example
|
|
@@ -2997,7 +3539,7 @@ export declare enum HostEvent {
|
|
|
2997
3539
|
*/
|
|
2998
3540
|
Share = "share",
|
|
2999
3541
|
/**
|
|
3000
|
-
*
|
|
3542
|
+
* Trigger the **Save** action on a Liveboard or Answer.
|
|
3001
3543
|
* Saves the changes.
|
|
3002
3544
|
*
|
|
3003
3545
|
* @example
|
|
@@ -3011,7 +3553,7 @@ export declare enum HostEvent {
|
|
|
3011
3553
|
*/
|
|
3012
3554
|
Save = "save",
|
|
3013
3555
|
/**
|
|
3014
|
-
*
|
|
3556
|
+
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
3015
3557
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
3016
3558
|
*
|
|
3017
3559
|
* @param - an object with `vizId` as a key
|
|
@@ -3027,7 +3569,7 @@ export declare enum HostEvent {
|
|
|
3027
3569
|
*/
|
|
3028
3570
|
SyncToSheets = "sync-to-sheets",
|
|
3029
3571
|
/**
|
|
3030
|
-
*
|
|
3572
|
+
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
3031
3573
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
3032
3574
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
3033
3575
|
*
|
|
@@ -3044,7 +3586,7 @@ export declare enum HostEvent {
|
|
|
3044
3586
|
*/
|
|
3045
3587
|
SyncToOtherApps = "sync-to-other-apps",
|
|
3046
3588
|
/**
|
|
3047
|
-
*
|
|
3589
|
+
* Trigger the **Manage pipelines** action on an embedded
|
|
3048
3590
|
* visualization or Answer.
|
|
3049
3591
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
3050
3592
|
*
|
|
@@ -3061,18 +3603,21 @@ export declare enum HostEvent {
|
|
|
3061
3603
|
*/
|
|
3062
3604
|
ManagePipelines = "manage-pipeline",
|
|
3063
3605
|
/**
|
|
3064
|
-
*
|
|
3606
|
+
* Reset search operation on the Search or Answer page.
|
|
3065
3607
|
*
|
|
3066
3608
|
* @example
|
|
3067
3609
|
* ```js
|
|
3068
3610
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
3069
3611
|
* ```
|
|
3612
|
+
* ```js
|
|
3613
|
+
* appEmbed.trigger(HostEvent.ResetSearch)
|
|
3614
|
+
* ```
|
|
3070
3615
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
3071
3616
|
*/
|
|
3072
3617
|
ResetSearch = "resetSearch",
|
|
3073
3618
|
/**
|
|
3074
3619
|
* @hidden
|
|
3075
|
-
*
|
|
3620
|
+
* Get the currents visible and runtime filters applied on a Liveboard
|
|
3076
3621
|
* @example
|
|
3077
3622
|
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
3078
3623
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
@@ -3080,7 +3625,7 @@ export declare enum HostEvent {
|
|
|
3080
3625
|
GetFilters = "getFilters",
|
|
3081
3626
|
/**
|
|
3082
3627
|
* @hidden
|
|
3083
|
-
*
|
|
3628
|
+
* Update the visible filters on the Liveboard.
|
|
3084
3629
|
* @param - filter: filter object containing column name and filter operation and values
|
|
3085
3630
|
* @example
|
|
3086
3631
|
*
|
|
@@ -3093,7 +3638,7 @@ export declare enum HostEvent {
|
|
|
3093
3638
|
*/
|
|
3094
3639
|
UpdateFilters = "updateFilters",
|
|
3095
3640
|
/**
|
|
3096
|
-
* Get
|
|
3641
|
+
* Get tab details for the current Liveboard.
|
|
3097
3642
|
*
|
|
3098
3643
|
* @example
|
|
3099
3644
|
* ```js
|
|
@@ -3107,9 +3652,9 @@ export declare enum HostEvent {
|
|
|
3107
3652
|
*/
|
|
3108
3653
|
GetTabs = "getTabs",
|
|
3109
3654
|
/**
|
|
3110
|
-
* Set the visible
|
|
3655
|
+
* Set the visible tabs on a Liveboard.
|
|
3111
3656
|
*
|
|
3112
|
-
* @param - an array of ids of
|
|
3657
|
+
* @param - an array of ids of tabs to show, the IDs not passed
|
|
3113
3658
|
* will be hidden.
|
|
3114
3659
|
* @example
|
|
3115
3660
|
* ```js
|
|
@@ -3123,8 +3668,8 @@ export declare enum HostEvent {
|
|
|
3123
3668
|
/**
|
|
3124
3669
|
* Set the hidden tabs on a Liveboard.
|
|
3125
3670
|
*
|
|
3126
|
-
* @param - an array of
|
|
3127
|
-
*
|
|
3671
|
+
* @param - an array of the IDs of the tabs to hide.
|
|
3672
|
+
* The IDs not passed will be shown.
|
|
3128
3673
|
* @example
|
|
3129
3674
|
* ```js
|
|
3130
3675
|
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
@@ -3135,9 +3680,12 @@ export declare enum HostEvent {
|
|
|
3135
3680
|
*/
|
|
3136
3681
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
3137
3682
|
/**
|
|
3138
|
-
* Updates the search query for
|
|
3683
|
+
* Updates the search query string for Natural Language Search operations.
|
|
3684
|
+
*
|
|
3685
|
+
* @param - `queryString`: Text string in Natural Language format
|
|
3686
|
+
*
|
|
3687
|
+
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
3139
3688
|
*
|
|
3140
|
-
* @param - searchOptions: an object queryString and option to execute the query.
|
|
3141
3689
|
* @example
|
|
3142
3690
|
* ```js
|
|
3143
3691
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -3145,7 +3693,7 @@ export declare enum HostEvent {
|
|
|
3145
3693
|
* executeSearch: true,
|
|
3146
3694
|
* })
|
|
3147
3695
|
* ```
|
|
3148
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
3696
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3149
3697
|
*/
|
|
3150
3698
|
UpdateSageQuery = "updateSageQuery",
|
|
3151
3699
|
/**
|
|
@@ -3158,24 +3706,25 @@ export declare enum HostEvent {
|
|
|
3158
3706
|
* vizId: '123', // For Liveboard Visualization.
|
|
3159
3707
|
* })
|
|
3160
3708
|
* ```
|
|
3709
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
3161
3710
|
*/
|
|
3162
3711
|
GetAnswerSession = "getAnswerSession"
|
|
3163
3712
|
}
|
|
3164
3713
|
/**
|
|
3165
3714
|
* The different visual modes that the data sources panel within
|
|
3166
|
-
* search could appear in,
|
|
3715
|
+
* search could appear in, such as hidden, collapsed, or expanded.
|
|
3167
3716
|
*/
|
|
3168
3717
|
export declare enum DataSourceVisualMode {
|
|
3169
3718
|
/**
|
|
3170
|
-
*
|
|
3719
|
+
* The data source panel is hidden.
|
|
3171
3720
|
*/
|
|
3172
3721
|
Hidden = "hide",
|
|
3173
3722
|
/**
|
|
3174
|
-
*
|
|
3723
|
+
* The data source panel is collapsed, but the user can manually expand it.
|
|
3175
3724
|
*/
|
|
3176
3725
|
Collapsed = "collapse",
|
|
3177
3726
|
/**
|
|
3178
|
-
*
|
|
3727
|
+
* The data source panel is expanded, but the user can manually collapse it.
|
|
3179
3728
|
*/
|
|
3180
3729
|
Expanded = "expand"
|
|
3181
3730
|
}
|
|
@@ -3251,7 +3800,10 @@ export declare enum Param {
|
|
|
3251
3800
|
LiveboardHeaderSticky = "isLiveboardHeaderSticky",
|
|
3252
3801
|
IsProductTour = "isProductTour",
|
|
3253
3802
|
HideSearchBarTitle = "hideSearchBarTitle",
|
|
3254
|
-
HideSageAnswerHeader = "hideSageAnswerHeader"
|
|
3803
|
+
HideSageAnswerHeader = "hideSageAnswerHeader",
|
|
3804
|
+
HideSearchBar = "hideSearchBar",
|
|
3805
|
+
ClientLogLevel = "clientLogLevel",
|
|
3806
|
+
OverrideNativeConsole = "overrideConsoleLogs"
|
|
3255
3807
|
}
|
|
3256
3808
|
/**
|
|
3257
3809
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3311,9 +3863,11 @@ export declare enum Action {
|
|
|
3311
3863
|
SaveAsView = "saveAsView",
|
|
3312
3864
|
/**
|
|
3313
3865
|
* The **Make a copy** action on a Liveboard or Answer
|
|
3314
|
-
* page.
|
|
3315
|
-
*
|
|
3316
|
-
*
|
|
3866
|
+
* page. Creates a copy of the Liveboard.
|
|
3867
|
+
* In LiveboardEmbed, the **Make a copy** action is not available for
|
|
3868
|
+
* visualizations in the embedded Liveboard view.
|
|
3869
|
+
* In AppEmbed, the **Make a copy** action is available on both
|
|
3870
|
+
* Liveboards and visualizations.
|
|
3317
3871
|
*
|
|
3318
3872
|
* @example
|
|
3319
3873
|
* ```js
|
|
@@ -3497,7 +4051,7 @@ export declare enum Action {
|
|
|
3497
4051
|
*/
|
|
3498
4052
|
DownloadAsPdf = "downloadAsPdf",
|
|
3499
4053
|
/**
|
|
3500
|
-
* The **Download**
|
|
4054
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3501
4055
|
* or Answer page.
|
|
3502
4056
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3503
4057
|
*
|
|
@@ -4028,6 +4582,7 @@ export declare enum Action {
|
|
|
4028
4582
|
*/
|
|
4029
4583
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
4030
4584
|
/**
|
|
4585
|
+
*
|
|
4031
4586
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4032
4587
|
*/
|
|
4033
4588
|
RequestVerification = "requestVerification",
|
|
@@ -4163,6 +4718,14 @@ export interface CustomActionPayload {
|
|
|
4163
4718
|
session: SessionInterface;
|
|
4164
4719
|
vizId?: string;
|
|
4165
4720
|
}
|
|
4721
|
+
export declare enum LogLevel {
|
|
4722
|
+
SILENT = "SILENT",
|
|
4723
|
+
ERROR = "ERROR",
|
|
4724
|
+
WARN = "WARN",
|
|
4725
|
+
INFO = "INFO",
|
|
4726
|
+
DEBUG = "DEBUG",
|
|
4727
|
+
TRACE = "TRACE"
|
|
4728
|
+
}
|
|
4166
4729
|
|
|
4167
4730
|
/**
|
|
4168
4731
|
* Copyright (c) 2022
|
|
@@ -4653,8 +5216,8 @@ export declare enum AuthStatus {
|
|
|
4653
5216
|
*/
|
|
4654
5217
|
LOGOUT = "LOGOUT",
|
|
4655
5218
|
/**
|
|
4656
|
-
* Emitted when inPopup
|
|
4657
|
-
*
|
|
5219
|
+
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
5220
|
+
* popup is waiting to be triggered either programmatically
|
|
4658
5221
|
* or by the trigger button.
|
|
4659
5222
|
*
|
|
4660
5223
|
* @version SDK: 1.19.0
|
|
@@ -4699,8 +5262,8 @@ export interface AuthEventEmitter {
|
|
|
4699
5262
|
*/
|
|
4700
5263
|
export declare enum AuthEvent {
|
|
4701
5264
|
/**
|
|
4702
|
-
* Manually trigger the SSO popup. This is useful
|
|
4703
|
-
* authStatus
|
|
5265
|
+
* Manually trigger the SSO popup. This is useful when
|
|
5266
|
+
* authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true
|
|
4704
5267
|
*/
|
|
4705
5268
|
TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
|
|
4706
5269
|
}
|
|
@@ -5152,8 +5715,7 @@ interface UnderlyingDataPoint {
|
|
|
5152
5715
|
* const data = await underlying.fetchData(0, 100);
|
|
5153
5716
|
* })
|
|
5154
5717
|
* ```
|
|
5155
|
-
* @version
|
|
5156
|
-
* ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
|
|
5718
|
+
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
5157
5719
|
* @group Events
|
|
5158
5720
|
*/
|
|
5159
5721
|
export declare class AnswerService {
|
|
@@ -5187,8 +5749,7 @@ export declare class AnswerService {
|
|
|
5187
5749
|
* const data = await underlying.fetchData(0, 100);
|
|
5188
5750
|
* })
|
|
5189
5751
|
* ```
|
|
5190
|
-
* @version
|
|
5191
|
-
* ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
|
|
5752
|
+
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
5192
5753
|
*/
|
|
5193
5754
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
5194
5755
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
@@ -5206,10 +5767,11 @@ export {};
|
|
|
5206
5767
|
export declare const getEmbedConfig: () => EmbedConfig;
|
|
5207
5768
|
/**
|
|
5208
5769
|
* Sets the configuration embed was initialized with.
|
|
5770
|
+
* And returns the new configuration.
|
|
5209
5771
|
*
|
|
5210
5772
|
* @param newConfig The configuration to set.
|
|
5211
5773
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
5212
5774
|
* @group Global methods
|
|
5213
5775
|
*/
|
|
5214
|
-
export declare const setEmbedConfig: (newConfig: EmbedConfig) =>
|
|
5776
|
+
export declare const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
|
|
5215
5777
|
|