@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
|
@@ -234,7 +234,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
|
|
|
234
234
|
* @summary ThoughtSpot Visual Embed SDK
|
|
235
235
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
236
236
|
*/
|
|
237
|
-
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, };
|
|
237
|
+
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, };
|
|
238
238
|
|
|
239
239
|
/**
|
|
240
240
|
* @group Embed components
|
|
@@ -242,25 +242,41 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
242
242
|
export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
243
243
|
/**
|
|
244
244
|
* The array of data source GUIDs to set on load.
|
|
245
|
-
* Only a single
|
|
245
|
+
* Only a single data source is supported currently.
|
|
246
246
|
*
|
|
247
|
-
* @deprecated Use dataSource instead
|
|
247
|
+
* @deprecated Use `dataSource` instead
|
|
248
248
|
*/
|
|
249
249
|
dataSources?: string[];
|
|
250
250
|
/**
|
|
251
251
|
* The array of data source GUIDs to set on load.
|
|
252
252
|
*
|
|
253
|
-
* @version: SDK: 1.19.0
|
|
253
|
+
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
254
254
|
*/
|
|
255
255
|
dataSource?: string;
|
|
256
256
|
/**
|
|
257
|
-
*
|
|
257
|
+
* Boolean to define if the last selected data source should be used
|
|
258
258
|
*
|
|
259
|
-
* @version: SDK: 1.24.0
|
|
259
|
+
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
260
260
|
*/
|
|
261
261
|
useLastSelectedSources?: boolean;
|
|
262
262
|
/**
|
|
263
|
-
* Configuration for search options
|
|
263
|
+
* Configuration for search options.
|
|
264
|
+
* Includes the following properties:
|
|
265
|
+
*
|
|
266
|
+
* `searchTokenString`: Search tokens to pass in the query.
|
|
267
|
+
*
|
|
268
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
269
|
+
* If it is executed, the focus is placed on the results.
|
|
270
|
+
* If it’s not executed, the focus is placed at the end of
|
|
271
|
+
* the token string in the search bar.
|
|
272
|
+
*
|
|
273
|
+
* @example
|
|
274
|
+
* ```js
|
|
275
|
+
* searchOptions: {
|
|
276
|
+
* searchTokenString: '[quantity purchased] [region]',
|
|
277
|
+
* executeSearch: true,
|
|
278
|
+
* }
|
|
279
|
+
* ```
|
|
264
280
|
*/
|
|
265
281
|
searchOptions?: SearchOptions;
|
|
266
282
|
}
|
|
@@ -296,14 +312,14 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
296
312
|
*/
|
|
297
313
|
export interface SearchOptions {
|
|
298
314
|
/**
|
|
299
|
-
* The query string to
|
|
315
|
+
* The query string to pass for Natural Language Search.
|
|
300
316
|
*/
|
|
301
317
|
searchQuery: string;
|
|
302
318
|
/**
|
|
303
|
-
* Boolean to
|
|
304
|
-
*
|
|
305
|
-
*
|
|
306
|
-
* the
|
|
319
|
+
* Boolean to define if the search should be executed or not.
|
|
320
|
+
* If it is executed, the focus is placed on the results.
|
|
321
|
+
* If it’s not executed, the focus is placed at the end of
|
|
322
|
+
* the token string in the search bar.
|
|
307
323
|
*/
|
|
308
324
|
executeSearch?: boolean;
|
|
309
325
|
}
|
|
@@ -311,16 +327,16 @@ export interface SearchOptions {
|
|
|
311
327
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
312
328
|
* GPT and LLM.
|
|
313
329
|
*
|
|
314
|
-
* @version: SDK: 1.23.0 | ThoughtSpot: 9.
|
|
330
|
+
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
315
331
|
* @group Embed components
|
|
316
332
|
*/
|
|
317
333
|
export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
318
334
|
/**
|
|
319
|
-
* If set to true, a list of
|
|
335
|
+
* If set to true, a list of Liveboard and Answers related
|
|
320
336
|
* to the natural language search will be shown below the
|
|
321
337
|
* AI generated answer.
|
|
322
338
|
*
|
|
323
|
-
* @deprecated Currently
|
|
339
|
+
* @deprecated Currently Liveboard and Answers related
|
|
324
340
|
* to the natural language search will not be shown for sage
|
|
325
341
|
* embed
|
|
326
342
|
*/
|
|
@@ -337,63 +353,81 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
337
353
|
*/
|
|
338
354
|
isProductTour?: boolean;
|
|
339
355
|
/**
|
|
340
|
-
*
|
|
356
|
+
* Show or hide the search bar title.
|
|
341
357
|
*
|
|
342
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
358
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
343
359
|
*/
|
|
344
360
|
hideSearchBarTitle?: boolean;
|
|
345
361
|
/**
|
|
346
|
-
*
|
|
347
|
-
*
|
|
362
|
+
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
363
|
+
* at the top of the Answer page.
|
|
348
364
|
*
|
|
349
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
365
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
350
366
|
*/
|
|
351
367
|
hideSageAnswerHeader?: boolean;
|
|
352
368
|
/**
|
|
353
|
-
*
|
|
369
|
+
* Disable the worksheet selection option.
|
|
354
370
|
*
|
|
355
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.9.0.
|
|
371
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
356
372
|
*/
|
|
357
373
|
disableWorksheetChange?: boolean;
|
|
358
374
|
/**
|
|
359
|
-
*
|
|
375
|
+
* Hide the worksheet selection panel.
|
|
376
|
+
*
|
|
377
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
360
378
|
*/
|
|
361
379
|
hideWorksheetSelector?: boolean;
|
|
362
380
|
/**
|
|
363
|
-
*
|
|
364
|
-
* default false
|
|
381
|
+
* Show or hide autocomplete suggestions for the search query string.
|
|
365
382
|
*
|
|
366
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.9.0.
|
|
383
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
367
384
|
*/
|
|
368
385
|
hideAutocompleteSuggestions?: boolean;
|
|
369
386
|
/**
|
|
370
|
-
*
|
|
387
|
+
* Show or hide autocomplete suggestions for the search query string.
|
|
371
388
|
*
|
|
372
|
-
* @deprecated
|
|
373
|
-
*
|
|
389
|
+
* @deprecated
|
|
390
|
+
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
391
|
+
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
374
392
|
*/
|
|
375
393
|
showObjectSuggestions?: boolean;
|
|
376
394
|
/**
|
|
377
|
-
*
|
|
378
|
-
*
|
|
395
|
+
* Show or hide sample questions.
|
|
396
|
+
* The sample questions are autogenerated based on the worksheet
|
|
397
|
+
* selected for the search operation.
|
|
379
398
|
*
|
|
380
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
399
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
381
400
|
*/
|
|
382
401
|
hideSampleQuestions?: boolean;
|
|
383
402
|
/**
|
|
384
|
-
* The data source GUID to set on load.
|
|
403
|
+
* The data source GUID (Worksheet GUID) to set on load.
|
|
385
404
|
*/
|
|
386
405
|
dataSource?: string;
|
|
387
406
|
/**
|
|
388
|
-
*
|
|
407
|
+
* Includes the following properties:
|
|
389
408
|
*
|
|
390
|
-
*
|
|
409
|
+
* `searchQuery`: The search query string to pass in the search bar.
|
|
410
|
+
* Supports Natural Language Search queries.
|
|
411
|
+
*
|
|
412
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
413
|
+
* If it is executed, the focus is placed on the results.
|
|
414
|
+
* If it’s not executed, the focus is placed at the end of
|
|
415
|
+
* the token string in the search bar.
|
|
416
|
+
*
|
|
417
|
+
* @example
|
|
418
|
+
* ```js
|
|
419
|
+
* searchOptions: {
|
|
420
|
+
* searchQuery: 'average sales by country and product type',
|
|
421
|
+
* executeSearch: true,
|
|
422
|
+
* }
|
|
423
|
+
* ```
|
|
424
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
391
425
|
*/
|
|
392
426
|
searchOptions?: SearchOptions;
|
|
393
427
|
}
|
|
394
428
|
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
395
429
|
/**
|
|
396
|
-
* Embed ThoughtSpot LLM and GPT
|
|
430
|
+
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
397
431
|
*
|
|
398
432
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
399
433
|
* @group Embed components
|
|
@@ -430,18 +464,19 @@ export declare class SageEmbed extends V1Embed {
|
|
|
430
464
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
431
465
|
*/
|
|
432
466
|
/**
|
|
433
|
-
* Configuration for search options
|
|
467
|
+
* Configuration for search options.
|
|
468
|
+
*
|
|
434
469
|
*/
|
|
435
470
|
export interface SearchOptions {
|
|
436
471
|
/**
|
|
437
|
-
*
|
|
472
|
+
* Search tokens to pass in the query.
|
|
438
473
|
*/
|
|
439
474
|
searchTokenString: string;
|
|
440
475
|
/**
|
|
441
|
-
* Boolean to
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
* the
|
|
476
|
+
* Boolean to define if the search should be executed or not.
|
|
477
|
+
* If it is executed, the focus is placed on the results.
|
|
478
|
+
* If it’s not executed, the focus is placed at the end of
|
|
479
|
+
* the token string in the search bar.
|
|
445
480
|
*/
|
|
446
481
|
executeSearch?: boolean;
|
|
447
482
|
}
|
|
@@ -457,19 +492,15 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
457
492
|
*/
|
|
458
493
|
collapseDataSources?: boolean;
|
|
459
494
|
/**
|
|
460
|
-
*
|
|
495
|
+
* Show or hide the data sources panel.
|
|
461
496
|
*/
|
|
462
497
|
hideDataSources?: boolean;
|
|
463
498
|
/**
|
|
464
|
-
*
|
|
499
|
+
* Show or hide the charts and tables in search answers.
|
|
465
500
|
* This attribute can be used to create a custom visualization
|
|
466
501
|
* using raw answer data.
|
|
467
502
|
*/
|
|
468
503
|
hideResults?: boolean;
|
|
469
|
-
/**
|
|
470
|
-
* If set to true, expands all the data sources panel.
|
|
471
|
-
*/
|
|
472
|
-
expandAllDataSource?: boolean;
|
|
473
504
|
/**
|
|
474
505
|
* If set to true, the Search Assist feature is enabled.
|
|
475
506
|
*
|
|
@@ -483,9 +514,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
483
514
|
forceTable?: boolean;
|
|
484
515
|
/**
|
|
485
516
|
* The array of data source GUIDs to set on load.
|
|
486
|
-
* Only a single
|
|
517
|
+
* Only a single data source is supported currently.
|
|
487
518
|
*
|
|
488
|
-
* @deprecated Use dataSource instead
|
|
519
|
+
* @deprecated Use `dataSource` instead.
|
|
489
520
|
*/
|
|
490
521
|
dataSources?: string[];
|
|
491
522
|
/**
|
|
@@ -497,11 +528,29 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
497
528
|
/**
|
|
498
529
|
* The initial search query to load the answer with.
|
|
499
530
|
*
|
|
500
|
-
* @deprecated
|
|
531
|
+
* @deprecated
|
|
532
|
+
*
|
|
533
|
+
* Use {@link searchOptions} instead.
|
|
501
534
|
*/
|
|
502
535
|
searchQuery?: string;
|
|
503
536
|
/**
|
|
504
|
-
* Configuration for search options
|
|
537
|
+
* Configuration for search options.
|
|
538
|
+
* Includes the following properties:
|
|
539
|
+
*
|
|
540
|
+
* `searchTokenString`: Search tokens to pass in the query.
|
|
541
|
+
*
|
|
542
|
+
* `executeSearch`: Boolean to define if the search should be executed or not.
|
|
543
|
+
* If it is executed, the focus is placed on the results.
|
|
544
|
+
* If it’s not executed, the focus is placed at the end of
|
|
545
|
+
* the token string in the search bar.
|
|
546
|
+
*
|
|
547
|
+
* @example
|
|
548
|
+
* ```js
|
|
549
|
+
* searchOptions: {
|
|
550
|
+
* searchTokenString: '[quantity purchased] [region]',
|
|
551
|
+
* executeSearch: true,
|
|
552
|
+
* }
|
|
553
|
+
* ```
|
|
505
554
|
*/
|
|
506
555
|
searchOptions?: SearchOptions;
|
|
507
556
|
/**
|
|
@@ -509,10 +558,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
509
558
|
*/
|
|
510
559
|
answerId?: string;
|
|
511
560
|
/**
|
|
512
|
-
* If set to true, search page will render without the Search Bar
|
|
561
|
+
* If set to true, the search page will render without the Search Bar
|
|
513
562
|
* The chart/table should still be visible.
|
|
514
563
|
*
|
|
515
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
564
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
516
565
|
*/
|
|
517
566
|
hideSearchBar?: boolean;
|
|
518
567
|
/**
|
|
@@ -599,43 +648,43 @@ export declare enum Page {
|
|
|
599
648
|
*/
|
|
600
649
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
601
650
|
/**
|
|
602
|
-
* If true, the
|
|
651
|
+
* If true, the top navigation bar within the ThoughtSpot app
|
|
603
652
|
* is displayed. By default, the navigation bar is hidden.
|
|
604
|
-
* This flag also
|
|
653
|
+
* This flag also controls the homepage left navigation bar.
|
|
605
654
|
*/
|
|
606
655
|
showPrimaryNavbar?: boolean;
|
|
607
656
|
/**
|
|
608
|
-
*
|
|
609
|
-
* If showPrimaryNavbar is true,
|
|
610
|
-
* nav-
|
|
611
|
-
*
|
|
657
|
+
* Control the visibility of the left navigation bar on the Homepage.
|
|
658
|
+
* If showPrimaryNavbar is true, that is, if the Global and Homepage
|
|
659
|
+
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
660
|
+
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
612
661
|
*
|
|
613
662
|
* @default false
|
|
614
663
|
* @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
615
664
|
*/
|
|
616
665
|
hideHomepageLeftNav?: boolean;
|
|
617
666
|
/**
|
|
618
|
-
*
|
|
619
|
-
*
|
|
667
|
+
* Control the visibility of the help (?) and profile buttons on the
|
|
668
|
+
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
620
669
|
*/
|
|
621
670
|
disableProfileAndHelp?: boolean;
|
|
622
671
|
/**
|
|
623
|
-
*
|
|
624
|
-
*
|
|
672
|
+
* Control the visibility of the application switcher button on the nav-bar.
|
|
673
|
+
* By default, the application switcher is shown.
|
|
625
674
|
*/
|
|
626
675
|
hideApplicationSwitcher?: boolean;
|
|
627
676
|
/**
|
|
628
|
-
*
|
|
629
|
-
*
|
|
677
|
+
* Control the visibility of the Org switcher button on the nav-bar.
|
|
678
|
+
* By default, the Org switcher button is shown.
|
|
630
679
|
*/
|
|
631
680
|
hideOrgSwitcher?: boolean;
|
|
632
681
|
/**
|
|
633
|
-
* A URL path
|
|
682
|
+
* A URL path to the embedded application page
|
|
634
683
|
* If both path and pageId attributes are defined, the path definition
|
|
635
684
|
* takes precedence. This is the path post the `#/` in the URL of the standalone
|
|
636
685
|
* ThoughtSpot app. Use this to open the embedded view to a specific path.
|
|
637
686
|
*
|
|
638
|
-
* For eg, if you want the component to open to a specific
|
|
687
|
+
* For eg, if you want the component to open to a specific Liveboard
|
|
639
688
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
640
689
|
*
|
|
641
690
|
* @example
|
|
@@ -800,8 +849,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
800
849
|
*/
|
|
801
850
|
fullHeight?: boolean;
|
|
802
851
|
/**
|
|
803
|
-
* This is the minimum height(in pixels) for a full
|
|
804
|
-
* Setting this height helps
|
|
852
|
+
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
853
|
+
* Setting this height helps resolve issues with empty Liveboards and
|
|
805
854
|
* other screens navigable from a Liveboard.
|
|
806
855
|
*
|
|
807
856
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
@@ -814,7 +863,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
814
863
|
enableVizTransformations?: boolean;
|
|
815
864
|
/**
|
|
816
865
|
* The Liveboard to display in the embedded view.
|
|
817
|
-
* Use either
|
|
866
|
+
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
818
867
|
*
|
|
819
868
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
820
869
|
*/
|
|
@@ -833,79 +882,84 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
833
882
|
* If set to true, all filter chips from a
|
|
834
883
|
* Liveboard page will be read-only (no X buttons)
|
|
835
884
|
*
|
|
836
|
-
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
885
|
+
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
837
886
|
*/
|
|
838
887
|
preventLiveboardFilterRemoval?: boolean;
|
|
839
888
|
/**
|
|
840
|
-
* Array of
|
|
841
|
-
*
|
|
889
|
+
* Array of visualization IDs which should be visible when the Liveboard
|
|
890
|
+
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
842
891
|
* event.
|
|
843
892
|
*
|
|
844
893
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
845
894
|
*/
|
|
846
895
|
visibleVizs?: string[];
|
|
847
896
|
/**
|
|
848
|
-
* To support backward
|
|
897
|
+
* To support backward compatibility
|
|
849
898
|
*
|
|
850
899
|
* @hidden
|
|
851
900
|
*/
|
|
852
901
|
preventPinboardFilterRemoval?: boolean;
|
|
853
902
|
/**
|
|
854
|
-
* Render embedded Liveboards and visualizations in the
|
|
903
|
+
* Render embedded Liveboards and visualizations in the
|
|
904
|
+
* new Liveboard experience mode.
|
|
855
905
|
*
|
|
856
906
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
857
907
|
*/
|
|
858
908
|
liveboardV2?: boolean;
|
|
859
909
|
/**
|
|
860
|
-
*
|
|
910
|
+
* Set a Liveboard tab as an active tab.
|
|
911
|
+
* Specify the tab ID.
|
|
861
912
|
*
|
|
862
913
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
863
914
|
*/
|
|
864
915
|
activeTabId?: string;
|
|
865
916
|
/**
|
|
866
|
-
*
|
|
917
|
+
* Show or hide the tab panel of the embedded Liveboard.
|
|
867
918
|
*
|
|
868
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
919
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
869
920
|
*/
|
|
870
921
|
hideTabPanel?: boolean;
|
|
871
922
|
/**
|
|
872
|
-
* Show or hide Liveboard header
|
|
923
|
+
* Show or hide the Liveboard header.
|
|
873
924
|
*
|
|
874
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
925
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
875
926
|
* @default false
|
|
876
927
|
*/
|
|
877
928
|
hideLiveboardHeader?: boolean;
|
|
878
929
|
/**
|
|
879
|
-
* Show or hide Liveboard title
|
|
930
|
+
* Show or hide the Liveboard title.
|
|
880
931
|
*
|
|
881
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
932
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
882
933
|
* @default false
|
|
883
934
|
*/
|
|
884
935
|
showLiveboardTitle?: boolean;
|
|
885
936
|
/**
|
|
886
|
-
* Show or hide Liveboard description
|
|
937
|
+
* Show or hide the Liveboard description.
|
|
887
938
|
*
|
|
888
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
939
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
889
940
|
* @default false
|
|
890
941
|
*/
|
|
891
942
|
showLiveboardDescription?: boolean;
|
|
892
943
|
/**
|
|
893
|
-
*
|
|
944
|
+
* Control the position and visibility of
|
|
945
|
+
* the Liveboard header as the users scroll down the
|
|
946
|
+
* embedded Liveboard page.
|
|
894
947
|
*
|
|
895
948
|
* @example
|
|
896
949
|
* ```js
|
|
897
950
|
* const embed = new LiveboardEmbed('#embed', {
|
|
898
|
-
* ... // other
|
|
951
|
+
* ... // other Liveboard view config
|
|
899
952
|
* isLiveboardHeaderSticky: true,
|
|
900
953
|
* });
|
|
901
954
|
* ```
|
|
902
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
955
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
903
956
|
*/
|
|
904
957
|
isLiveboardHeaderSticky?: boolean;
|
|
905
958
|
}
|
|
906
959
|
/**
|
|
907
|
-
* Embed a ThoughtSpot Liveboard or
|
|
908
|
-
* waits for the authentication to complete, so
|
|
960
|
+
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
961
|
+
* waits for the authentication to complete, so you need not wait for
|
|
962
|
+
* `AuthStatus.SUCCESS`.
|
|
909
963
|
*
|
|
910
964
|
* @example
|
|
911
965
|
* ```js
|
|
@@ -1152,8 +1206,8 @@ export declare enum AuthStatus {
|
|
|
1152
1206
|
*/
|
|
1153
1207
|
LOGOUT = "LOGOUT",
|
|
1154
1208
|
/**
|
|
1155
|
-
* Emitted when inPopup
|
|
1156
|
-
*
|
|
1209
|
+
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
1210
|
+
* popup is waiting to be triggered either programmatically
|
|
1157
1211
|
* or by the trigger button.
|
|
1158
1212
|
*
|
|
1159
1213
|
* @version SDK: 1.19.0
|
|
@@ -1198,8 +1252,8 @@ export interface AuthEventEmitter {
|
|
|
1198
1252
|
*/
|
|
1199
1253
|
export declare enum AuthEvent {
|
|
1200
1254
|
/**
|
|
1201
|
-
* Manually trigger the SSO popup. This is useful
|
|
1202
|
-
* authStatus
|
|
1255
|
+
* Manually trigger the SSO popup. This is useful when
|
|
1256
|
+
* authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true
|
|
1203
1257
|
*/
|
|
1204
1258
|
TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
|
|
1205
1259
|
}
|
|
@@ -1308,10 +1362,14 @@ export declare enum AuthType {
|
|
|
1308
1362
|
*/
|
|
1309
1363
|
None = "None",
|
|
1310
1364
|
/**
|
|
1311
|
-
* Passthrough SSO to the embedded
|
|
1365
|
+
* Passthrough SSO to the embedded application within the iframe. Requires least
|
|
1312
1366
|
* configuration, but may not be supported by all IDPs. This will behave like `None`
|
|
1313
1367
|
* if SSO is not configured on ThoughtSpot.
|
|
1314
1368
|
*
|
|
1369
|
+
* To use this:
|
|
1370
|
+
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1371
|
+
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1372
|
+
*
|
|
1315
1373
|
* @example
|
|
1316
1374
|
* ```js
|
|
1317
1375
|
* init({
|
|
@@ -1319,12 +1377,7 @@ export declare enum AuthType {
|
|
|
1319
1377
|
* authType: AuthType.EmbeddedSSO,
|
|
1320
1378
|
* });
|
|
1321
1379
|
* ```
|
|
1322
|
-
*
|
|
1323
|
-
*
|
|
1324
|
-
* To use this:
|
|
1325
|
-
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1326
|
-
* eg. If you are using okta as IdP, you can enable iFrame embedding.
|
|
1327
|
-
* @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
|
|
1380
|
+
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
1328
1381
|
*/
|
|
1329
1382
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1330
1383
|
/**
|
|
@@ -1343,10 +1396,10 @@ export declare enum AuthType {
|
|
|
1343
1396
|
SAML = "SSO_SAML",
|
|
1344
1397
|
/**
|
|
1345
1398
|
* SSO using SAML
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1399
|
+
* Makes the host application redirect to the SAML IdP. Use this
|
|
1400
|
+
* if your IdP does not allow itself to be embedded.
|
|
1348
1401
|
*
|
|
1349
|
-
* This redirects the host application to the SAML
|
|
1402
|
+
* This redirects the host application to the SAML IdP. The host application
|
|
1350
1403
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1351
1404
|
*
|
|
1352
1405
|
* @example
|
|
@@ -1357,7 +1410,7 @@ export declare enum AuthType {
|
|
|
1357
1410
|
* });
|
|
1358
1411
|
* ```
|
|
1359
1412
|
*
|
|
1360
|
-
* This opens the SAML
|
|
1413
|
+
* This opens the SAML IdP in a popup window. The popup is triggered
|
|
1361
1414
|
* when the user clicks the trigger button. The popup window will be
|
|
1362
1415
|
* closed automatically after authentication.
|
|
1363
1416
|
* @example
|
|
@@ -1371,8 +1424,8 @@ export declare enum AuthType {
|
|
|
1371
1424
|
* });
|
|
1372
1425
|
* ```
|
|
1373
1426
|
*
|
|
1374
|
-
* Can also use event to trigger the popup flow. Works the same
|
|
1375
|
-
* as above example.
|
|
1427
|
+
* Can also use the event to trigger the popup flow. Works the same
|
|
1428
|
+
* as the above example.
|
|
1376
1429
|
* @example
|
|
1377
1430
|
* ```js
|
|
1378
1431
|
* const authEE = init({
|
|
@@ -1396,7 +1449,7 @@ export declare enum AuthType {
|
|
|
1396
1449
|
OIDC = "SSO_OIDC",
|
|
1397
1450
|
/**
|
|
1398
1451
|
* SSO using OIDC
|
|
1399
|
-
* Will make the host application redirect to the OIDC
|
|
1452
|
+
* Will make the host application redirect to the OIDC IdP.
|
|
1400
1453
|
* See code samples in {@link SAMLRedirect}.
|
|
1401
1454
|
*/
|
|
1402
1455
|
OIDCRedirect = "SSO_OIDC",
|
|
@@ -1408,8 +1461,8 @@ export declare enum AuthType {
|
|
|
1408
1461
|
*/
|
|
1409
1462
|
AuthServer = "AuthServer",
|
|
1410
1463
|
/**
|
|
1411
|
-
* Trusted authentication server
|
|
1412
|
-
* which returns a bearer token, generated using the secret_key obtained
|
|
1464
|
+
* Trusted authentication server. Use your own authentication server
|
|
1465
|
+
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1413
1466
|
* from ThoughtSpot.
|
|
1414
1467
|
*
|
|
1415
1468
|
* @example
|
|
@@ -1426,11 +1479,11 @@ export declare enum AuthType {
|
|
|
1426
1479
|
*/
|
|
1427
1480
|
TrustedAuthToken = "AuthServer",
|
|
1428
1481
|
/**
|
|
1429
|
-
* Trusted authentication server Cookieless, Use
|
|
1430
|
-
* server which returns a bearer token, generated using the secret_key
|
|
1482
|
+
* Trusted authentication server Cookieless, Use your own authentication
|
|
1483
|
+
* server which returns a bearer token, generated using the `secret_key`
|
|
1431
1484
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1432
|
-
* approach, recommended to
|
|
1433
|
-
* implemented by some browsers
|
|
1485
|
+
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1486
|
+
* implemented by some browsers.
|
|
1434
1487
|
*
|
|
1435
1488
|
* @example
|
|
1436
1489
|
* ```js
|
|
@@ -1443,7 +1496,7 @@ export declare enum AuthType {
|
|
|
1443
1496
|
* .then((data) => data.token);
|
|
1444
1497
|
* }
|
|
1445
1498
|
* ```
|
|
1446
|
-
* @version SDK: 1.22.0|
|
|
1499
|
+
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1447
1500
|
*/
|
|
1448
1501
|
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
1449
1502
|
/**
|
|
@@ -1565,13 +1618,19 @@ export interface EmbedConfig {
|
|
|
1565
1618
|
* The ThoughtSpot cluster hostname or IP address.
|
|
1566
1619
|
*/
|
|
1567
1620
|
thoughtSpotHost: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* If true, all the iframe links will have /v2 added automatically.
|
|
1623
|
+
* If false, all the iframe links will have /v1 added automatically.
|
|
1624
|
+
* If undefined, nothing will be added
|
|
1625
|
+
*/
|
|
1626
|
+
enableReactShell?: boolean | undefined;
|
|
1568
1627
|
/**
|
|
1569
1628
|
* The authentication mechanism to use.
|
|
1570
1629
|
*/
|
|
1571
1630
|
authType: AuthType;
|
|
1572
1631
|
/**
|
|
1573
1632
|
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
1574
|
-
* authentication token. A GET request is made to the
|
|
1633
|
+
* authentication token. A `GET` request is made to the
|
|
1575
1634
|
* authentication API endpoint, which returns the token
|
|
1576
1635
|
* as a plaintext response. For trusted authentication,
|
|
1577
1636
|
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
@@ -1584,8 +1643,8 @@ export interface EmbedConfig {
|
|
|
1584
1643
|
* attribute is required.
|
|
1585
1644
|
*
|
|
1586
1645
|
* It is advisable to fetch a new token inside this method and not
|
|
1587
|
-
* reuse
|
|
1588
|
-
* called again and if it is called with an older token the authentication
|
|
1646
|
+
* reuse the old issued token. When auth expires this method is
|
|
1647
|
+
* called again and if it is called with an older token, the authentication
|
|
1589
1648
|
* will not succeed.
|
|
1590
1649
|
*/
|
|
1591
1650
|
getAuthToken?: () => Promise<string>;
|
|
@@ -1595,7 +1654,7 @@ export interface EmbedConfig {
|
|
|
1595
1654
|
*/
|
|
1596
1655
|
username?: string;
|
|
1597
1656
|
/**
|
|
1598
|
-
* [Basic] The ThoughtSpot login password corresponding to the
|
|
1657
|
+
* [Basic] The ThoughtSpot login password corresponding to the username
|
|
1599
1658
|
*
|
|
1600
1659
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1601
1660
|
* strongly advised not to use this authentication method in production.
|
|
@@ -1603,7 +1662,7 @@ export interface EmbedConfig {
|
|
|
1603
1662
|
password?: string;
|
|
1604
1663
|
/**
|
|
1605
1664
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1606
|
-
* open the SAML auth flow in a popup, instead of redirecting browser in
|
|
1665
|
+
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1607
1666
|
* place.
|
|
1608
1667
|
*
|
|
1609
1668
|
* @default false
|
|
@@ -1612,91 +1671,93 @@ export interface EmbedConfig {
|
|
|
1612
1671
|
noRedirect?: boolean;
|
|
1613
1672
|
/**
|
|
1614
1673
|
* [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
|
|
1615
|
-
* the SAML auth flow in a popup, instead of redirecting browser in place.
|
|
1674
|
+
* the SAML auth flow in a popup, instead of redirecting the browser in place.
|
|
1616
1675
|
*
|
|
1617
|
-
* Need to use this with authTriggerContainer
|
|
1618
|
-
* the AuthEvent.TRIGGER_SSO_POPUP event on a user interaction.
|
|
1676
|
+
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1677
|
+
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1619
1678
|
*
|
|
1620
1679
|
* @default false
|
|
1621
1680
|
* @version SDK: 1.18.0
|
|
1622
1681
|
*/
|
|
1623
1682
|
inPopup?: boolean;
|
|
1624
1683
|
/**
|
|
1625
|
-
* [SSO] For SSO Authentication, one can supply an optional path param
|
|
1626
|
-
*
|
|
1684
|
+
* [SSO] For SSO Authentication, one can supply an optional path param;
|
|
1685
|
+
* This will be the path on the host origin where the SAML flow will be
|
|
1627
1686
|
* terminated.
|
|
1628
1687
|
*
|
|
1629
1688
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1630
1689
|
*
|
|
1631
|
-
* @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1.sw
|
|
1690
|
+
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1632
1691
|
*/
|
|
1633
1692
|
redirectPath?: string;
|
|
1634
1693
|
/** @internal */
|
|
1635
1694
|
basepath?: string;
|
|
1636
1695
|
/**
|
|
1637
|
-
*
|
|
1638
|
-
*
|
|
1639
|
-
*
|
|
1696
|
+
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1697
|
+
* should be encoded in base64. This provides additional security to
|
|
1698
|
+
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1640
1699
|
*
|
|
1641
1700
|
* @default false
|
|
1642
1701
|
*/
|
|
1643
1702
|
shouldEncodeUrlQueryParams?: boolean;
|
|
1644
1703
|
/**
|
|
1645
|
-
* Suppress cookie access alert when third
|
|
1646
|
-
* user's browser. Third
|
|
1647
|
-
*
|
|
1648
|
-
* encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1704
|
+
* Suppress cookie access alert when third-party cookies are blocked by the
|
|
1705
|
+
* user's browser. Third-party cookie blocking is the default behaviour on
|
|
1706
|
+
* some web browsers like Safari. If you set this attribute to `true`,
|
|
1707
|
+
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1649
1708
|
* in this case.
|
|
1650
1709
|
*
|
|
1651
1710
|
* @default false
|
|
1652
1711
|
*/
|
|
1653
1712
|
suppressNoCookieAccessAlert?: boolean;
|
|
1654
1713
|
/**
|
|
1655
|
-
* Ignore cookie access alert when third
|
|
1714
|
+
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
1656
1715
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
1657
|
-
*
|
|
1716
|
+
* persists even in the case of a non-logged-in user.
|
|
1658
1717
|
*
|
|
1659
1718
|
* @default false
|
|
1660
1719
|
*/
|
|
1661
1720
|
ignoreNoCookieAccess?: boolean;
|
|
1662
1721
|
/**
|
|
1663
|
-
* Re-login
|
|
1722
|
+
* Re-login a user with the previous login options
|
|
1723
|
+
* when a user session expires.
|
|
1664
1724
|
*
|
|
1665
1725
|
* @default false
|
|
1666
1726
|
*/
|
|
1667
1727
|
autoLogin?: boolean;
|
|
1668
1728
|
/**
|
|
1669
1729
|
* Disable redirection to the login page when the embedded session expires
|
|
1670
|
-
* This flag is typically used alongside the combination of
|
|
1671
|
-
* AuthType.AuthServer} and auto
|
|
1730
|
+
* This flag is typically used alongside the combination of authentication modes such
|
|
1731
|
+
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
1732
|
+
* EmbedConfig.autoLogin}
|
|
1672
1733
|
*
|
|
1673
1734
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1674
1735
|
* @default false
|
|
1675
1736
|
*/
|
|
1676
1737
|
disableLoginRedirect?: boolean;
|
|
1677
1738
|
/**
|
|
1678
|
-
* This message is displayed
|
|
1739
|
+
* This message is displayed in the embedded view when a user login fails.
|
|
1679
1740
|
*
|
|
1680
1741
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1681
1742
|
*/
|
|
1682
1743
|
loginFailedMessage?: string;
|
|
1683
1744
|
/**
|
|
1684
|
-
* Calls the prefetch method internally when set to true
|
|
1745
|
+
* Calls the prefetch method internally when set to `true`
|
|
1685
1746
|
*
|
|
1686
1747
|
* @default false
|
|
1687
1748
|
*/
|
|
1688
1749
|
callPrefetch?: boolean;
|
|
1689
1750
|
/**
|
|
1690
|
-
* When there are multiple
|
|
1691
|
-
*
|
|
1692
|
-
*
|
|
1751
|
+
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1752
|
+
* to start after the previous embed's render is complete. This helps improve
|
|
1753
|
+
* performance by decreasing the load on the browser.
|
|
1693
1754
|
*
|
|
1694
1755
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1695
1756
|
* @default false
|
|
1696
1757
|
*/
|
|
1697
1758
|
queueMultiRenders?: boolean;
|
|
1698
1759
|
/**
|
|
1699
|
-
* Dynamic CSS
|
|
1760
|
+
* Dynamic CSS URL to be injected in the loaded application.
|
|
1700
1761
|
* You would also need to set `style-src` in the CSP settings.
|
|
1701
1762
|
*
|
|
1702
1763
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
@@ -1704,9 +1765,9 @@ export interface EmbedConfig {
|
|
|
1704
1765
|
*/
|
|
1705
1766
|
customCssUrl?: string;
|
|
1706
1767
|
/**
|
|
1707
|
-
* [AuthServer|Basic] Detect if
|
|
1768
|
+
* [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
|
|
1708
1769
|
* additional call. This is slower and should be avoided. Listen to the
|
|
1709
|
-
* NO_COOKIE_ACCESS event to handle the situation.
|
|
1770
|
+
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
1710
1771
|
*
|
|
1711
1772
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1712
1773
|
* involves an extra network call.
|
|
@@ -1715,26 +1776,26 @@ export interface EmbedConfig {
|
|
|
1715
1776
|
*/
|
|
1716
1777
|
detectCookieAccessSlow?: boolean;
|
|
1717
1778
|
/**
|
|
1718
|
-
* Hide beta alert warning message for SearchEmbed.
|
|
1779
|
+
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1719
1780
|
*
|
|
1720
1781
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
1721
1782
|
*/
|
|
1722
1783
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
1723
1784
|
/**
|
|
1724
|
-
* Hide beta alert warning message for SageEmbed.
|
|
1785
|
+
* Hide `beta` alert warning message for SageEmbed.
|
|
1725
1786
|
*
|
|
1726
1787
|
*/
|
|
1727
1788
|
suppressSageEmbedBetaWarning?: boolean;
|
|
1728
1789
|
/**
|
|
1729
1790
|
* Custom style params for embed Config.
|
|
1730
1791
|
*
|
|
1731
|
-
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
|
|
1792
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1732
1793
|
*/
|
|
1733
1794
|
customizations?: CustomisationsInterface;
|
|
1734
1795
|
/**
|
|
1735
|
-
* For inPopup SAMLRedirect or OIDCRedirect
|
|
1736
|
-
* click to trigger the flow.
|
|
1737
|
-
* for that button.
|
|
1796
|
+
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1797
|
+
* button that the user can click to trigger the flow.
|
|
1798
|
+
* This attribute sets a containing element for that button.
|
|
1738
1799
|
*
|
|
1739
1800
|
* @example
|
|
1740
1801
|
* ```js
|
|
@@ -1744,11 +1805,11 @@ export interface EmbedConfig {
|
|
|
1744
1805
|
* authTriggerContainer: '#auth-trigger-container'
|
|
1745
1806
|
* })
|
|
1746
1807
|
* ```
|
|
1747
|
-
* @version SDK: 1.17.0 | ThoughtSpot:
|
|
1808
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1748
1809
|
*/
|
|
1749
1810
|
authTriggerContainer?: string | HTMLElement;
|
|
1750
1811
|
/**
|
|
1751
|
-
* Specify that we want to use the AuthEvent.TRIGGER_SSO_POPUP event to trigger
|
|
1812
|
+
* Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger
|
|
1752
1813
|
* SAML popup. This is useful when you want to trigger the popup on a custom user
|
|
1753
1814
|
* action.
|
|
1754
1815
|
*
|
|
@@ -1756,20 +1817,22 @@ export interface EmbedConfig {
|
|
|
1756
1817
|
useEventForSAMLPopup?: boolean;
|
|
1757
1818
|
/**
|
|
1758
1819
|
* Text to show in the button which triggers the popup auth flow.
|
|
1759
|
-
* Default:
|
|
1820
|
+
* Default: `Authorize`.
|
|
1760
1821
|
*
|
|
1761
|
-
* @version SDK: 1.17.0 | ThoughtSpot:
|
|
1822
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1762
1823
|
*/
|
|
1763
1824
|
authTriggerText?: string;
|
|
1764
1825
|
/**
|
|
1765
|
-
*
|
|
1826
|
+
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
1827
|
+
* access to the embedded application users
|
|
1828
|
+
* outside of the iframe.
|
|
1766
1829
|
*
|
|
1767
1830
|
* @default true
|
|
1768
1831
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1769
1832
|
*/
|
|
1770
1833
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1771
1834
|
/**
|
|
1772
|
-
* Host config
|
|
1835
|
+
* Host config in case embedded app is inside TS app itself
|
|
1773
1836
|
*
|
|
1774
1837
|
* @hidden
|
|
1775
1838
|
*/
|
|
@@ -1791,21 +1854,35 @@ export interface EmbedConfig {
|
|
|
1791
1854
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
1792
1855
|
*/
|
|
1793
1856
|
suppressErrorAlerts?: boolean;
|
|
1857
|
+
/**
|
|
1858
|
+
* Log level for the SDK.
|
|
1859
|
+
* @default LogLevel.ERROR
|
|
1860
|
+
*
|
|
1861
|
+
* @example
|
|
1862
|
+
* ```js
|
|
1863
|
+
* init({
|
|
1864
|
+
* ...embedConfig,
|
|
1865
|
+
* logLevel: LogLevel.SILENT
|
|
1866
|
+
* })
|
|
1867
|
+
* ```
|
|
1868
|
+
* @version SDK: 1.26.3 | ThoughtSpot: 9.10.0.cl
|
|
1869
|
+
*/
|
|
1870
|
+
logLevel?: LogLevel;
|
|
1794
1871
|
}
|
|
1795
1872
|
export interface LayoutConfig {
|
|
1796
1873
|
}
|
|
1797
1874
|
/**
|
|
1798
|
-
* Embedded
|
|
1875
|
+
* Embedded iframe configuration
|
|
1799
1876
|
*
|
|
1800
1877
|
* @group Embed components
|
|
1801
1878
|
*/
|
|
1802
1879
|
export interface FrameParams {
|
|
1803
1880
|
/**
|
|
1804
|
-
* The width of the
|
|
1881
|
+
* The width of the iframe (unit is pixels if numeric).
|
|
1805
1882
|
*/
|
|
1806
1883
|
width?: number | string;
|
|
1807
1884
|
/**
|
|
1808
|
-
* The height of the
|
|
1885
|
+
* The height of the iframe (unit is pixels if numeric).
|
|
1809
1886
|
*/
|
|
1810
1887
|
height?: number | string;
|
|
1811
1888
|
/**
|
|
@@ -1906,7 +1983,6 @@ export interface ViewConfig {
|
|
|
1906
1983
|
*/
|
|
1907
1984
|
runtimeParameters?: RuntimeParameter[];
|
|
1908
1985
|
/**
|
|
1909
|
-
/**
|
|
1910
1986
|
* The locale/language to use for the embedded view.
|
|
1911
1987
|
*
|
|
1912
1988
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
@@ -2006,31 +2082,29 @@ export interface ViewConfig {
|
|
|
2006
2082
|
*/
|
|
2007
2083
|
reorderedHomepageModules?: HomepageModule[];
|
|
2008
2084
|
/**
|
|
2009
|
-
* The list of tab IDs to show in the embedded.
|
|
2010
|
-
* Only
|
|
2011
|
-
* Use this to show an tabID.
|
|
2085
|
+
* The list of tab IDs to show in the embedded Liveboard.
|
|
2086
|
+
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2012
2087
|
*
|
|
2013
|
-
* Use either
|
|
2088
|
+
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2014
2089
|
*
|
|
2015
2090
|
* @example
|
|
2016
2091
|
* ```js
|
|
2017
|
-
*
|
|
2018
|
-
* ... // other liveboard view config
|
|
2019
|
-
* visibleTabs: [
|
|
2092
|
+
* visibleTabs: [
|
|
2020
2093
|
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2021
|
-
*
|
|
2022
|
-
* });
|
|
2094
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
2023
2095
|
* ```
|
|
2024
2096
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2025
2097
|
*/
|
|
2026
2098
|
visibleTabs?: string[];
|
|
2027
2099
|
/**
|
|
2028
|
-
* homepageLeftNavItems :
|
|
2029
|
-
* There are 8 home
|
|
2030
|
-
*
|
|
2031
|
-
* eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
|
|
2100
|
+
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2101
|
+
* There are 8 eight home navigation list items.
|
|
2102
|
+
* To hide these items, specify the string in the array.
|
|
2032
2103
|
*
|
|
2033
|
-
*
|
|
2104
|
+
* ```js
|
|
2105
|
+
* hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
|
|
2106
|
+
* ```
|
|
2107
|
+
* @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
|
|
2034
2108
|
*/
|
|
2035
2109
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
2036
2110
|
/**
|
|
@@ -2046,7 +2120,7 @@ export interface ViewConfig {
|
|
|
2046
2120
|
* });
|
|
2047
2121
|
* embed.showPreRender();
|
|
2048
2122
|
* ```
|
|
2049
|
-
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
2123
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
2050
2124
|
*/
|
|
2051
2125
|
preRenderId?: string;
|
|
2052
2126
|
/**
|
|
@@ -2079,7 +2153,7 @@ export type MessagePayload = {
|
|
|
2079
2153
|
status?: string;
|
|
2080
2154
|
};
|
|
2081
2155
|
/**
|
|
2082
|
-
* MessageOptions: By
|
|
2156
|
+
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2083
2157
|
* option
|
|
2084
2158
|
*
|
|
2085
2159
|
* @group Events
|
|
@@ -2087,7 +2161,7 @@ export type MessagePayload = {
|
|
|
2087
2161
|
export type MessageOptions = {
|
|
2088
2162
|
/**
|
|
2089
2163
|
* A boolean value indicating that start status events of this type
|
|
2090
|
-
* will be dispatched
|
|
2164
|
+
* will be dispatched.
|
|
2091
2165
|
*/
|
|
2092
2166
|
start?: boolean;
|
|
2093
2167
|
};
|
|
@@ -2107,7 +2181,7 @@ responder?: (data: any) => void) => void;
|
|
|
2107
2181
|
*/
|
|
2108
2182
|
export type MessageCallbackObj = {
|
|
2109
2183
|
/**
|
|
2110
|
-
* options: It contains start,
|
|
2184
|
+
* options: It contains start, a boolean value indicating that start
|
|
2111
2185
|
* status events of this type will be dispatched
|
|
2112
2186
|
*/
|
|
2113
2187
|
options: MessageOptions;
|
|
@@ -2179,7 +2253,7 @@ export declare enum RuntimeFilterOp {
|
|
|
2179
2253
|
IN = "IN"
|
|
2180
2254
|
}
|
|
2181
2255
|
/**
|
|
2182
|
-
* Home page module that can be
|
|
2256
|
+
* Home page module that can be hidden
|
|
2183
2257
|
*/
|
|
2184
2258
|
export declare enum HomepageModule {
|
|
2185
2259
|
/**
|
|
@@ -2195,7 +2269,7 @@ export declare enum HomepageModule {
|
|
|
2195
2269
|
*/
|
|
2196
2270
|
Favorite = "FAVORITE",
|
|
2197
2271
|
/**
|
|
2198
|
-
* List of answers and
|
|
2272
|
+
* List of answers and Liveboards
|
|
2199
2273
|
*/
|
|
2200
2274
|
MyLibrary = "MY_LIBRARY",
|
|
2201
2275
|
/**
|
|
@@ -2228,7 +2302,7 @@ export interface RuntimeFilter {
|
|
|
2228
2302
|
values: (number | boolean | string)[];
|
|
2229
2303
|
}
|
|
2230
2304
|
/**
|
|
2231
|
-
* A filter that can be applied to ThoughtSpot
|
|
2305
|
+
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
2232
2306
|
* visualizations at runtime.
|
|
2233
2307
|
*/
|
|
2234
2308
|
export interface RuntimeParameter {
|
|
@@ -2264,6 +2338,14 @@ export interface RuntimeParameter {
|
|
|
2264
2338
|
export declare enum EmbedEvent {
|
|
2265
2339
|
/**
|
|
2266
2340
|
* Rendering has initialized.
|
|
2341
|
+
* @example
|
|
2342
|
+
*```js
|
|
2343
|
+
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
2344
|
+
* //show a loader
|
|
2345
|
+
* function showLoader() {
|
|
2346
|
+
* document.getElementById("loader");
|
|
2347
|
+
* }
|
|
2348
|
+
*```
|
|
2267
2349
|
*
|
|
2268
2350
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2269
2351
|
*/
|
|
@@ -2271,69 +2353,162 @@ export declare enum EmbedEvent {
|
|
|
2271
2353
|
/**
|
|
2272
2354
|
* Authentication has either succeeded or failed.
|
|
2273
2355
|
*
|
|
2356
|
+
* @example
|
|
2357
|
+
*```js
|
|
2358
|
+
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
2359
|
+
* console.log('AuthInit', payload);
|
|
2360
|
+
* })
|
|
2361
|
+
*```
|
|
2362
|
+
*
|
|
2274
2363
|
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
2275
2364
|
*/
|
|
2276
2365
|
AuthInit = "authInit",
|
|
2277
2366
|
/**
|
|
2278
2367
|
* The embed object container has loaded.
|
|
2279
|
-
*
|
|
2280
2368
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2369
|
+
* @example
|
|
2370
|
+
*```js
|
|
2371
|
+
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
2372
|
+
* //hide loader
|
|
2373
|
+
* function hideLoader() {
|
|
2374
|
+
* document.getElementById("loader");
|
|
2375
|
+
* }
|
|
2376
|
+
*```
|
|
2281
2377
|
*/
|
|
2282
2378
|
Load = "load",
|
|
2283
2379
|
/**
|
|
2284
2380
|
* Data pertaining to answer or Liveboard is received
|
|
2285
|
-
*
|
|
2286
2381
|
* @return data - The answer or Liveboard data
|
|
2382
|
+
* @example
|
|
2383
|
+
*```js
|
|
2384
|
+
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
2385
|
+
* console.log('data', payload);
|
|
2386
|
+
* })
|
|
2387
|
+
*```
|
|
2287
2388
|
* @important
|
|
2288
2389
|
*/
|
|
2289
2390
|
Data = "data",
|
|
2290
2391
|
/**
|
|
2291
|
-
* Search/
|
|
2392
|
+
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2292
2393
|
*
|
|
2293
2394
|
* @hidden
|
|
2294
2395
|
*/
|
|
2295
2396
|
FiltersChanged = "filtersChanged",
|
|
2296
2397
|
/**
|
|
2297
2398
|
* Search query has been updated by the user.
|
|
2399
|
+
*
|
|
2400
|
+
* @example
|
|
2401
|
+
*```js
|
|
2402
|
+
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
2403
|
+
*```
|
|
2404
|
+
*
|
|
2298
2405
|
*/
|
|
2299
2406
|
QueryChanged = "queryChanged",
|
|
2300
2407
|
/**
|
|
2301
|
-
* A drill
|
|
2408
|
+
* A drill-down operation has been performed.
|
|
2302
2409
|
*
|
|
2303
2410
|
* @returns additionalFilters - Any additional filters applied
|
|
2304
2411
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2305
2412
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2413
|
+
*
|
|
2414
|
+
* @example
|
|
2415
|
+
*```js
|
|
2416
|
+
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
2417
|
+
* points: {
|
|
2418
|
+
* clickedPoint,
|
|
2419
|
+
* selectedPoints: selectedPoint
|
|
2420
|
+
* },
|
|
2421
|
+
* autoDrillDown: true,
|
|
2422
|
+
* })
|
|
2423
|
+
*```
|
|
2424
|
+
* In this example, `VizPointDoubleClick` event is used for
|
|
2425
|
+
* triggering the `DrillDown` event when an area or specific
|
|
2426
|
+
* data point on a table or chart is double-clicked.
|
|
2427
|
+
*
|
|
2428
|
+
* @example
|
|
2429
|
+
*```js
|
|
2430
|
+
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2431
|
+
* console.log(payload);
|
|
2432
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
2433
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
2434
|
+
* console.log('>>> called', clickedPoint);
|
|
2435
|
+
* embed.trigger(HostEvent.DrillDown, {
|
|
2436
|
+
* points: {
|
|
2437
|
+
* clickedPoint,
|
|
2438
|
+
* selectedPoints: selectedPoint
|
|
2439
|
+
* },
|
|
2440
|
+
* autoDrillDown: true,
|
|
2441
|
+
* })
|
|
2442
|
+
* })
|
|
2443
|
+
*```
|
|
2444
|
+
*
|
|
2306
2445
|
*/
|
|
2307
2446
|
Drilldown = "drillDown",
|
|
2308
2447
|
/**
|
|
2309
2448
|
* One or more data sources have been selected.
|
|
2310
|
-
*
|
|
2311
2449
|
* @returns dataSourceIds - the list of data sources
|
|
2450
|
+
*
|
|
2451
|
+
* @example
|
|
2452
|
+
* ```js
|
|
2453
|
+
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
2454
|
+
* console.log('DataSourceSelected', payload);
|
|
2455
|
+
* })
|
|
2456
|
+
* ```
|
|
2457
|
+
*
|
|
2312
2458
|
*/
|
|
2313
2459
|
DataSourceSelected = "dataSourceSelected",
|
|
2314
2460
|
/**
|
|
2315
2461
|
* One or more data columns have been selected.
|
|
2316
|
-
*
|
|
2317
2462
|
* @returns columnIds - the list of columns
|
|
2318
2463
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2464
|
+
*
|
|
2465
|
+
* @example
|
|
2466
|
+
* ```js
|
|
2467
|
+
* appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
|
|
2468
|
+
* console.log('AddRemoveColumns', payload);
|
|
2469
|
+
* })
|
|
2470
|
+
* ```
|
|
2471
|
+
*
|
|
2319
2472
|
*/
|
|
2320
2473
|
AddRemoveColumns = "addRemoveColumns",
|
|
2321
2474
|
/**
|
|
2322
|
-
* A custom action has been triggered
|
|
2475
|
+
* A custom action has been triggered.
|
|
2476
|
+
*
|
|
2477
|
+
* @returns actionId - ID of the custom action
|
|
2478
|
+
* @returns data - Response payload with the Answer or Liveboard data
|
|
2323
2479
|
*
|
|
2324
|
-
* @
|
|
2325
|
-
*
|
|
2480
|
+
* @example
|
|
2481
|
+
* ```js
|
|
2482
|
+
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
2483
|
+
* const data = payload.data;
|
|
2484
|
+
* if (data.id === 'insert Custom Action ID here') {
|
|
2485
|
+
* console.log('Custom Action event:', data.embedAnswerData);
|
|
2486
|
+
* }
|
|
2487
|
+
* })
|
|
2488
|
+
* ```
|
|
2326
2489
|
*/
|
|
2327
2490
|
CustomAction = "customAction",
|
|
2328
2491
|
/**
|
|
2329
|
-
* Listen to double
|
|
2492
|
+
* Listen to double click actions on a visualization.
|
|
2493
|
+
*
|
|
2494
|
+
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
2330
2495
|
*
|
|
2331
|
-
* @return ContextMenuInputPoints - data point that is double clicked
|
|
2332
2496
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2497
|
+
*
|
|
2498
|
+
* @example
|
|
2499
|
+
* ```js
|
|
2500
|
+
* livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
|
|
2501
|
+
* console.log('VizPointDoubleClick', payload)
|
|
2502
|
+
* })
|
|
2503
|
+
* ```
|
|
2333
2504
|
*/
|
|
2334
2505
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
2335
2506
|
/**
|
|
2336
|
-
* Listen to clicks on a visualization in a
|
|
2507
|
+
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
2508
|
+
*
|
|
2509
|
+
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
2510
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2511
|
+
* @important
|
|
2337
2512
|
*
|
|
2338
2513
|
* @example
|
|
2339
2514
|
* ```js
|
|
@@ -2347,25 +2522,46 @@ export declare enum EmbedEvent {
|
|
|
2347
2522
|
* )
|
|
2348
2523
|
* });
|
|
2349
2524
|
* ```
|
|
2350
|
-
* @return viz, clickedPoint - metadata about point that is clicked
|
|
2351
|
-
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2352
|
-
* @important
|
|
2353
2525
|
*/
|
|
2354
2526
|
VizPointClick = "vizPointClick",
|
|
2355
2527
|
/**
|
|
2356
2528
|
* An error has occurred.
|
|
2357
2529
|
*
|
|
2358
2530
|
* @returns error - An error object or message
|
|
2531
|
+
*
|
|
2532
|
+
* @example
|
|
2533
|
+
* ```js
|
|
2534
|
+
* SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
|
|
2535
|
+
* //show error messaage
|
|
2536
|
+
* function showErrorMsg() {
|
|
2537
|
+
* document.getElementById("error");
|
|
2538
|
+
* ```
|
|
2539
|
+
*
|
|
2359
2540
|
*/
|
|
2360
2541
|
Error = "Error",
|
|
2361
2542
|
/**
|
|
2362
|
-
* The embedded object has sent an alert
|
|
2543
|
+
* The embedded object has sent an alert.
|
|
2363
2544
|
*
|
|
2364
2545
|
* @returns alert - An alert object
|
|
2546
|
+
*
|
|
2547
|
+
* @example
|
|
2548
|
+
* ```js
|
|
2549
|
+
* searchEmbed.on(EmbedEvent.Alert)
|
|
2550
|
+
* ```
|
|
2551
|
+
*
|
|
2365
2552
|
*/
|
|
2366
2553
|
Alert = "alert",
|
|
2367
2554
|
/**
|
|
2368
2555
|
* The ThoughtSpot auth session has expired.
|
|
2556
|
+
*
|
|
2557
|
+
* @example
|
|
2558
|
+
*```js
|
|
2559
|
+
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
2560
|
+
* //show auth expired banner
|
|
2561
|
+
* function showAuthExpired() {
|
|
2562
|
+
* document.getElementById("authExpiredBanner");
|
|
2563
|
+
* }
|
|
2564
|
+
*```
|
|
2369
2565
|
*/
|
|
2370
2566
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2371
2567
|
/**
|
|
@@ -2395,14 +2591,28 @@ export declare enum EmbedEvent {
|
|
|
2395
2591
|
*/
|
|
2396
2592
|
EmbedIframeCenter = "EmbedIframeCenter",
|
|
2397
2593
|
/**
|
|
2398
|
-
* Emitted when
|
|
2399
|
-
*
|
|
2594
|
+
* Emitted when the **Get Data** action is initiated.
|
|
2595
|
+
* Applicable to `SearchBarEmbed` only.
|
|
2400
2596
|
*
|
|
2401
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.
|
|
2597
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2598
|
+
*
|
|
2599
|
+
* @example
|
|
2600
|
+
*```js
|
|
2601
|
+
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
2602
|
+
* .then(data => {
|
|
2603
|
+
* console.log('Answer Data:', data);
|
|
2604
|
+
* })
|
|
2605
|
+
*```
|
|
2402
2606
|
*/
|
|
2403
2607
|
GetDataClick = "getDataClick",
|
|
2404
2608
|
/**
|
|
2405
2609
|
* Detects the route change.
|
|
2610
|
+
*
|
|
2611
|
+
* @example
|
|
2612
|
+
*```js
|
|
2613
|
+
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
2614
|
+
* console.log('data', payload))
|
|
2615
|
+
*```
|
|
2406
2616
|
*/
|
|
2407
2617
|
RouteChange = "ROUTE_CHANGE",
|
|
2408
2618
|
/**
|
|
@@ -2412,10 +2622,15 @@ export declare enum EmbedEvent {
|
|
|
2412
2622
|
*/
|
|
2413
2623
|
V1Data = "exportVizDataToParent",
|
|
2414
2624
|
/**
|
|
2415
|
-
* Emitted when the embed does not have cookie access. This
|
|
2416
|
-
*
|
|
2625
|
+
* Emitted when the embed does not have cookie access. This happens
|
|
2626
|
+
* when Safari and other Web browsers block third-party cookies
|
|
2627
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
2417
2628
|
*
|
|
2418
|
-
* @
|
|
2629
|
+
* @example
|
|
2630
|
+
*```js
|
|
2631
|
+
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
2632
|
+
*```
|
|
2633
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
2419
2634
|
*/
|
|
2420
2635
|
NoCookieAccess = "noCookieAccess",
|
|
2421
2636
|
/**
|
|
@@ -2427,239 +2642,539 @@ export declare enum EmbedEvent {
|
|
|
2427
2642
|
SAMLComplete = "samlComplete",
|
|
2428
2643
|
/**
|
|
2429
2644
|
* Emitted when any modal is opened in the app
|
|
2430
|
-
*
|
|
2431
2645
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2646
|
+
*
|
|
2647
|
+
* @example
|
|
2648
|
+
*```js
|
|
2649
|
+
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
2650
|
+
* console.log('dialog open', payload);
|
|
2651
|
+
* })
|
|
2652
|
+
*```
|
|
2432
2653
|
*/
|
|
2433
2654
|
DialogOpen = "dialog-open",
|
|
2434
2655
|
/**
|
|
2435
2656
|
* Emitted when any modal is closed in the app
|
|
2436
|
-
*
|
|
2437
2657
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2658
|
+
*
|
|
2659
|
+
* @example
|
|
2660
|
+
*```js
|
|
2661
|
+
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
2662
|
+
* console.log('dialog close', payload);
|
|
2663
|
+
* })
|
|
2664
|
+
*```
|
|
2438
2665
|
*/
|
|
2439
2666
|
DialogClose = "dialog-close",
|
|
2440
2667
|
/**
|
|
2441
2668
|
* Emitted when the Liveboard shell loads.
|
|
2442
2669
|
* You can use this event as a hook to trigger
|
|
2443
2670
|
* other events on the rendered Liveboard.
|
|
2444
|
-
*
|
|
2445
2671
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2672
|
+
*
|
|
2673
|
+
* @example
|
|
2674
|
+
*```js
|
|
2675
|
+
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
2676
|
+
console.log('Liveboard is rendered', payload);
|
|
2677
|
+
})
|
|
2678
|
+
*```
|
|
2679
|
+
* The following example shows how to trigger
|
|
2680
|
+
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
2681
|
+
*
|
|
2682
|
+
* @example
|
|
2683
|
+
*```js
|
|
2684
|
+
* const embedRef = useEmbedRef();
|
|
2685
|
+
* const onLiveboardRendered = () => {
|
|
2686
|
+
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
2687
|
+
* };
|
|
2688
|
+
*```
|
|
2446
2689
|
*/
|
|
2447
2690
|
LiveboardRendered = "PinboardRendered",
|
|
2448
2691
|
/**
|
|
2449
2692
|
* This can be used to register an event listener which
|
|
2450
2693
|
* is triggered on all events.
|
|
2451
|
-
*
|
|
2452
2694
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2695
|
+
*
|
|
2696
|
+
* @example
|
|
2697
|
+
*```js
|
|
2698
|
+
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
2699
|
+
* console.log('Embed Events', payload)
|
|
2700
|
+
* })
|
|
2701
|
+
*```
|
|
2453
2702
|
*/
|
|
2454
2703
|
ALL = "*",
|
|
2455
2704
|
/**
|
|
2456
2705
|
* Emitted when an Answer is saved in the app
|
|
2457
|
-
*
|
|
2458
2706
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2707
|
+
* @example
|
|
2708
|
+
*```js
|
|
2709
|
+
* //trigger when action starts
|
|
2710
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2711
|
+
* console.log('Save', payload)
|
|
2712
|
+
* }, {
|
|
2713
|
+
* start: true
|
|
2714
|
+
* })
|
|
2715
|
+
* //trigger when action ends
|
|
2716
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
2717
|
+
* console.log('Save', payload)
|
|
2718
|
+
* })
|
|
2719
|
+
*```
|
|
2459
2720
|
*/
|
|
2460
2721
|
Save = "save",
|
|
2461
2722
|
/**
|
|
2462
2723
|
* Emitted when the download action is triggered on an answer
|
|
2463
2724
|
*
|
|
2725
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
2726
|
+
* To fire an event when a download action is initiated on a chart or table,
|
|
2727
|
+
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
2728
|
+
* or `EmbedEvent.DownloadAsXLSX`
|
|
2729
|
+
*
|
|
2464
2730
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2731
|
+
*
|
|
2732
|
+
* @example
|
|
2733
|
+
*```js
|
|
2734
|
+
* liveboardEmbed.trigger(HostEvent.Download, {
|
|
2735
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2736
|
+
* })
|
|
2737
|
+
*```
|
|
2465
2738
|
*/
|
|
2466
2739
|
Download = "download",
|
|
2467
2740
|
/**
|
|
2468
2741
|
* Emitted when the download action is triggered on an answer
|
|
2469
|
-
*
|
|
2470
2742
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
2743
|
+
*
|
|
2744
|
+
* @example
|
|
2745
|
+
*```js
|
|
2746
|
+
* //trigger when action starts
|
|
2747
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2748
|
+
* console.log('download PNG', payload)}, {start: true })
|
|
2749
|
+
* //trigger when action ends
|
|
2750
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
2751
|
+
* console.log('download PNG', payload)})
|
|
2752
|
+
*```
|
|
2753
|
+
*
|
|
2471
2754
|
*/
|
|
2472
2755
|
DownloadAsPng = "downloadAsPng",
|
|
2473
2756
|
/**
|
|
2474
2757
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
2475
2758
|
*
|
|
2476
2759
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2760
|
+
*
|
|
2761
|
+
* @example
|
|
2762
|
+
*```js
|
|
2763
|
+
* //trigger when action starts
|
|
2764
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2765
|
+
* console.log('download PDF', payload)}, {start: true })
|
|
2766
|
+
* //trigger when action ends
|
|
2767
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
2768
|
+
* console.log('download PDF', payload)})
|
|
2769
|
+
*```
|
|
2770
|
+
*
|
|
2477
2771
|
*/
|
|
2478
2772
|
DownloadAsPdf = "downloadAsPdf",
|
|
2479
2773
|
/**
|
|
2480
2774
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
2481
2775
|
*
|
|
2482
2776
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2777
|
+
* @example
|
|
2778
|
+
*```js
|
|
2779
|
+
* //trigger when action starts
|
|
2780
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2781
|
+
* console.log('download CSV', payload)}, {start: true })
|
|
2782
|
+
* //trigger when action ends
|
|
2783
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
2784
|
+
* console.log('download CSV', payload)})
|
|
2785
|
+
*```
|
|
2483
2786
|
*/
|
|
2484
2787
|
DownloadAsCsv = "downloadAsCsv",
|
|
2485
2788
|
/**
|
|
2486
2789
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
2487
2790
|
*
|
|
2488
2791
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2792
|
+
*
|
|
2793
|
+
* @example
|
|
2794
|
+
*```js
|
|
2795
|
+
* //trigger when action starts
|
|
2796
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2797
|
+
* console.log('download Xlsx', payload)}, { start: true })
|
|
2798
|
+
* //trigger when action ends
|
|
2799
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
2800
|
+
* console.log('download Xlsx', payload)})
|
|
2801
|
+
*```
|
|
2489
2802
|
*/
|
|
2490
2803
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
2491
2804
|
/**
|
|
2492
|
-
* Emitted when an
|
|
2805
|
+
* Emitted when an Answer is deleted in the app
|
|
2493
2806
|
*
|
|
2494
2807
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2808
|
+
*
|
|
2809
|
+
* @example
|
|
2810
|
+
*```js
|
|
2811
|
+
* //trigger when action starts
|
|
2812
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2813
|
+
* console.log('delete answer', payload)}, {start: true })
|
|
2814
|
+
* //trigger when action is completed
|
|
2815
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
2816
|
+
* console.log('delete answer', payload)})
|
|
2817
|
+
*```
|
|
2495
2818
|
*/
|
|
2496
2819
|
AnswerDelete = "answerDelete",
|
|
2497
2820
|
/**
|
|
2498
2821
|
* Emitted when an answer is pinned to a Liveboard
|
|
2499
2822
|
*
|
|
2500
2823
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2824
|
+
* @example
|
|
2825
|
+
*```js
|
|
2826
|
+
* //trigger when action starts
|
|
2827
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2828
|
+
* console.log('pin', payload)
|
|
2829
|
+
* }, {
|
|
2830
|
+
* start: true
|
|
2831
|
+
* })
|
|
2832
|
+
* //trigger when action ends
|
|
2833
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
2834
|
+
* console.log('pin', payload)
|
|
2835
|
+
* })
|
|
2836
|
+
*```
|
|
2501
2837
|
*/
|
|
2502
2838
|
Pin = "pin",
|
|
2503
2839
|
/**
|
|
2504
2840
|
* Emitted when SpotIQ analysis is triggered
|
|
2505
2841
|
*
|
|
2506
2842
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2843
|
+
* @example
|
|
2844
|
+
*```js
|
|
2845
|
+
* //trigger when action starts
|
|
2846
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2847
|
+
* console.log('SpotIQAnalyze', payload)
|
|
2848
|
+
* }, {
|
|
2849
|
+
* start: true
|
|
2850
|
+
* })
|
|
2851
|
+
* //trigger when action ends
|
|
2852
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
2853
|
+
* console.log('SpotIQ analyze', payload)
|
|
2854
|
+
* })
|
|
2855
|
+
*```
|
|
2507
2856
|
*/
|
|
2508
2857
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
2509
2858
|
/**
|
|
2510
2859
|
* Emitted when a user shares an object with another user or group
|
|
2511
2860
|
*
|
|
2512
2861
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2862
|
+
*
|
|
2863
|
+
* @example
|
|
2864
|
+
*```js
|
|
2865
|
+
* //trigger when action starts
|
|
2866
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2867
|
+
* console.log('Share', payload)
|
|
2868
|
+
* }, {
|
|
2869
|
+
* start: true
|
|
2870
|
+
* })
|
|
2871
|
+
* //trigger when action ends
|
|
2872
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
2873
|
+
* console.log('Share', payload)
|
|
2874
|
+
* })
|
|
2875
|
+
*```
|
|
2513
2876
|
*/
|
|
2514
2877
|
Share = "share",
|
|
2515
2878
|
/**
|
|
2516
|
-
* Emitted when a user clicks the Include action to include a specific value or
|
|
2517
|
-
* on a chart or table
|
|
2879
|
+
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
2880
|
+
* data on a chart or table.
|
|
2518
2881
|
*
|
|
2519
2882
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2883
|
+
* @example
|
|
2884
|
+
*```js
|
|
2885
|
+
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
2886
|
+
* console.log('Drill include', payload);
|
|
2887
|
+
* })
|
|
2888
|
+
*```
|
|
2520
2889
|
*/
|
|
2521
2890
|
DrillInclude = "context-menu-item-include",
|
|
2522
2891
|
/**
|
|
2523
|
-
* Emitted when a user clicks the Exclude action to exclude a specific value or
|
|
2524
|
-
* on a chart or table
|
|
2892
|
+
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
2893
|
+
* data on a chart or table
|
|
2525
2894
|
*
|
|
2526
2895
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2896
|
+
* @example
|
|
2897
|
+
*```js
|
|
2898
|
+
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
2899
|
+
* console.log('Drill exclude', payload);
|
|
2900
|
+
* })
|
|
2901
|
+
*```
|
|
2527
2902
|
*/
|
|
2528
2903
|
DrillExclude = "context-menu-item-exclude",
|
|
2529
2904
|
/**
|
|
2530
|
-
* Emitted when
|
|
2905
|
+
* Emitted when a column value is copied in the embedded app.
|
|
2531
2906
|
*
|
|
2532
2907
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2908
|
+
* @example
|
|
2909
|
+
*```js
|
|
2910
|
+
* seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
2911
|
+
* console.log('copy to clipboard', payload);
|
|
2912
|
+
* })
|
|
2913
|
+
*```
|
|
2533
2914
|
*/
|
|
2534
2915
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
2535
2916
|
/**
|
|
2536
|
-
* Emitted when a user clicks the Update TML action
|
|
2917
|
+
* Emitted when a user clicks the **Update TML** action
|
|
2537
2918
|
*
|
|
2538
2919
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2920
|
+
* @example
|
|
2921
|
+
*```js
|
|
2922
|
+
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
2923
|
+
* })
|
|
2924
|
+
*```
|
|
2539
2925
|
*/
|
|
2540
2926
|
UpdateTML = "updateTSL",
|
|
2541
2927
|
/**
|
|
2542
|
-
* Emitted when a user clicks the Edit TML action
|
|
2928
|
+
* Emitted when a user clicks the **Edit TML** action
|
|
2543
2929
|
*
|
|
2544
2930
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2931
|
+
* @example
|
|
2932
|
+
*```js
|
|
2933
|
+
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
2934
|
+
* console.log('Edit TML', payload);
|
|
2935
|
+
* })
|
|
2936
|
+
*```
|
|
2545
2937
|
*/
|
|
2546
2938
|
EditTML = "editTSL",
|
|
2547
2939
|
/**
|
|
2548
|
-
* Emitted when
|
|
2549
|
-
*
|
|
2940
|
+
* Emitted when the **Export TML** action is triggered on an
|
|
2941
|
+
* an embedded object in the app
|
|
2550
2942
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2943
|
+
* @example
|
|
2944
|
+
*```js
|
|
2945
|
+
* //trigger when action starts
|
|
2946
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2947
|
+
* console.log('Export TML', payload)}, { start: true })
|
|
2948
|
+
* //trigger when action ends
|
|
2949
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
2950
|
+
* console.log('Export TML', payload)})
|
|
2951
|
+
*```
|
|
2551
2952
|
*/
|
|
2552
2953
|
ExportTML = "exportTSL",
|
|
2553
2954
|
/**
|
|
2554
|
-
* Emitted when an
|
|
2955
|
+
* Emitted when an Answer is saved as a View.
|
|
2555
2956
|
*
|
|
2556
2957
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2958
|
+
* @example
|
|
2959
|
+
*```js
|
|
2960
|
+
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
2961
|
+
* console.log('View', payload);
|
|
2962
|
+
* })
|
|
2963
|
+
*```
|
|
2557
2964
|
*/
|
|
2558
2965
|
SaveAsView = "saveAsView",
|
|
2559
2966
|
/**
|
|
2560
|
-
* Emitted when
|
|
2967
|
+
* Emitted when the user creates a copy of an Answer
|
|
2561
2968
|
*
|
|
2562
2969
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2970
|
+
* @example
|
|
2971
|
+
*```js
|
|
2972
|
+
* //trigger when action starts
|
|
2973
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2974
|
+
* console.log('Copy and edit', payload)}, {start: true })
|
|
2975
|
+
* //trigger when action ends
|
|
2976
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
2977
|
+
* console.log('Copy and edit', payload)})
|
|
2978
|
+
*```
|
|
2563
2979
|
*/
|
|
2564
2980
|
CopyAEdit = "copyAEdit",
|
|
2565
2981
|
/**
|
|
2566
|
-
* Emitted when a user clicks Show underlying data on an
|
|
2982
|
+
* Emitted when a user clicks Show underlying data on an Answer
|
|
2567
2983
|
*
|
|
2568
2984
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2985
|
+
* @example
|
|
2986
|
+
*```js
|
|
2987
|
+
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
2988
|
+
* console.log('show data', payload);
|
|
2989
|
+
* })
|
|
2990
|
+
*```
|
|
2569
2991
|
*/
|
|
2570
2992
|
ShowUnderlyingData = "showUnderlyingData",
|
|
2571
2993
|
/**
|
|
2572
|
-
* Emitted when an answer is switched to a chart or table view
|
|
2994
|
+
* Emitted when an answer is switched to a chart or table view.
|
|
2573
2995
|
*
|
|
2574
2996
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2997
|
+
* @example
|
|
2998
|
+
*```js
|
|
2999
|
+
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3000
|
+
* console.log('switch view', payload);
|
|
3001
|
+
* })
|
|
3002
|
+
*```
|
|
2575
3003
|
*/
|
|
2576
3004
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
2577
3005
|
/**
|
|
2578
|
-
* Internal event to communicate the initial settings back to the
|
|
3006
|
+
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
2579
3007
|
*
|
|
2580
3008
|
* @hidden
|
|
2581
3009
|
*/
|
|
2582
3010
|
APP_INIT = "appInit",
|
|
2583
3011
|
/**
|
|
2584
|
-
* Emitted when a user clicks Show Liveboard details on a Liveboard
|
|
3012
|
+
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
2585
3013
|
*
|
|
2586
3014
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3015
|
+
* @example
|
|
3016
|
+
*```js
|
|
3017
|
+
* liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
3018
|
+
* console.log('Liveboard details', payload);
|
|
3019
|
+
* })
|
|
3020
|
+
*```
|
|
2587
3021
|
*/
|
|
2588
3022
|
LiveboardInfo = "pinboardInfo",
|
|
2589
3023
|
/**
|
|
2590
3024
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
2591
3025
|
*
|
|
2592
3026
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3027
|
+
* @example
|
|
3028
|
+
*```js
|
|
3029
|
+
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
3030
|
+
* console.log('favorites', payload);
|
|
3031
|
+
* })
|
|
3032
|
+
*```
|
|
2593
3033
|
*/
|
|
2594
3034
|
AddToFavorites = "addToFavorites",
|
|
2595
3035
|
/**
|
|
2596
|
-
* Emitted when a user clicks Schedule on a Liveboard
|
|
3036
|
+
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
2597
3037
|
*
|
|
2598
3038
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3039
|
+
* @example
|
|
3040
|
+
*```js
|
|
3041
|
+
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
3042
|
+
* console.log(`Liveboard schedule', payload);
|
|
3043
|
+
* })
|
|
3044
|
+
*```
|
|
2599
3045
|
*/
|
|
2600
3046
|
Schedule = "subscription",
|
|
2601
3047
|
/**
|
|
2602
|
-
* Emitted when a user clicks Edit on a Liveboard or visualization
|
|
3048
|
+
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
2603
3049
|
*
|
|
2604
3050
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3051
|
+
* @example
|
|
3052
|
+
*```js
|
|
3053
|
+
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
3054
|
+
* console.log(`Liveboard edit', payload);
|
|
3055
|
+
* })
|
|
3056
|
+
*```
|
|
2605
3057
|
*/
|
|
2606
3058
|
Edit = "edit",
|
|
2607
3059
|
/**
|
|
2608
|
-
* Emitted when a user clicks Make a copy on a Liveboard
|
|
3060
|
+
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
2609
3061
|
*
|
|
2610
3062
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3063
|
+
* @example
|
|
3064
|
+
*```js
|
|
3065
|
+
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
3066
|
+
* console.log(`Copy', payload);
|
|
3067
|
+
* })
|
|
3068
|
+
*```
|
|
2611
3069
|
*/
|
|
2612
3070
|
MakeACopy = "makeACopy",
|
|
2613
3071
|
/**
|
|
2614
|
-
* Emitted when a user clicks Present on a Liveboard or visualization
|
|
3072
|
+
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
2615
3073
|
*
|
|
2616
3074
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3075
|
+
* @example
|
|
3076
|
+
*```js
|
|
3077
|
+
* liveboardEmbed.trigger(HostEvent.Present)
|
|
3078
|
+
*```
|
|
3079
|
+
*
|
|
3080
|
+
* @example
|
|
3081
|
+
*```js
|
|
3082
|
+
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
3083
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3084
|
+
* })
|
|
3085
|
+
*```
|
|
2617
3086
|
*/
|
|
2618
3087
|
Present = "present",
|
|
2619
3088
|
/**
|
|
2620
|
-
* Emitted when a user clicks Delete on a
|
|
3089
|
+
* Emitted when a user clicks **Delete** on a visualization
|
|
2621
3090
|
*
|
|
2622
3091
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3092
|
+
* @example
|
|
3093
|
+
*```js
|
|
3094
|
+
* liveboardEmbed.trigger(HostEvent.Delete,
|
|
3095
|
+
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3096
|
+
*```
|
|
3097
|
+
*
|
|
2623
3098
|
*/
|
|
2624
3099
|
Delete = "delete",
|
|
2625
3100
|
/**
|
|
2626
3101
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2627
3102
|
*
|
|
2628
3103
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3104
|
+
*
|
|
3105
|
+
* @example
|
|
3106
|
+
*```js
|
|
3107
|
+
* liveboardEmbed.trigger(HostEvent.SchedulesList)
|
|
3108
|
+
*```
|
|
3109
|
+
*
|
|
2629
3110
|
*/
|
|
2630
3111
|
SchedulesList = "schedule-list",
|
|
2631
3112
|
/**
|
|
2632
|
-
* Emitted when a user clicks Cancel in edit mode on a Liveboard
|
|
3113
|
+
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
2633
3114
|
*
|
|
2634
3115
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3116
|
+
*
|
|
3117
|
+
* @example
|
|
3118
|
+
*```js
|
|
3119
|
+
* liveboardEmbed.trigger(HostEvent.Cancel)
|
|
3120
|
+
*```
|
|
3121
|
+
*
|
|
2635
3122
|
*/
|
|
2636
3123
|
Cancel = "cancel",
|
|
2637
3124
|
/**
|
|
2638
|
-
* Emitted when a user clicks Explore on a visualization
|
|
3125
|
+
* Emitted when a user clicks **Explore** on a visualization
|
|
2639
3126
|
*
|
|
2640
3127
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3128
|
+
*
|
|
3129
|
+
* @example
|
|
3130
|
+
*```js
|
|
3131
|
+
* liveboardEmbed.trigger(HostEvent.Explore, {
|
|
3132
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3133
|
+
*```
|
|
3134
|
+
*
|
|
2641
3135
|
*/
|
|
2642
3136
|
Explore = "explore",
|
|
2643
3137
|
/**
|
|
2644
|
-
* Emitted when a user clicks Copy link action on a visualization
|
|
3138
|
+
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2645
3139
|
*
|
|
2646
3140
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3141
|
+
*
|
|
3142
|
+
* @example
|
|
3143
|
+
*```js
|
|
3144
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {
|
|
3145
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3146
|
+
*```
|
|
3147
|
+
*
|
|
2647
3148
|
*/
|
|
2648
3149
|
CopyLink = "embedDocument",
|
|
2649
3150
|
/**
|
|
2650
|
-
* Emitted when a user interacts with cross filters on a visualization or
|
|
3151
|
+
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3152
|
+
*
|
|
3153
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3154
|
+
*
|
|
3155
|
+
* @example
|
|
3156
|
+
*```js
|
|
3157
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
3158
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3159
|
+
*```
|
|
2651
3160
|
*
|
|
2652
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2653
3161
|
*/
|
|
2654
3162
|
CrossFilterChanged = "cross-filter-changed",
|
|
2655
3163
|
/**
|
|
2656
3164
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2657
3165
|
*
|
|
2658
|
-
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3166
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3167
|
+
*
|
|
3168
|
+
* @example
|
|
3169
|
+
*```js
|
|
3170
|
+
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
3171
|
+
* console.log('VizPointClick', payload)
|
|
3172
|
+
* })
|
|
3173
|
+
*```
|
|
2659
3174
|
*/
|
|
2660
3175
|
VizPointRightClick = "vizPointRightClick",
|
|
2661
3176
|
/**
|
|
2662
|
-
* Emitted when a user clicks
|
|
3177
|
+
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2663
3178
|
*
|
|
2664
3179
|
* @hidden
|
|
2665
3180
|
*/
|
|
@@ -2667,52 +3182,53 @@ export declare enum EmbedEvent {
|
|
|
2667
3182
|
/**
|
|
2668
3183
|
* @hidden
|
|
2669
3184
|
* Emitted when a user changes any filter on a Liveboard.
|
|
2670
|
-
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3185
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
2671
3186
|
*/
|
|
2672
3187
|
FilterChanged = "filterChanged",
|
|
2673
3188
|
/**
|
|
2674
|
-
* Emitted when a user
|
|
3189
|
+
* Emitted when a user clicks the **Go** button on the Search page
|
|
2675
3190
|
*
|
|
2676
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3191
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2677
3192
|
*/
|
|
2678
3193
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2679
3194
|
/**
|
|
2680
|
-
*
|
|
3195
|
+
* Emitted when a user selects a data source.
|
|
3196
|
+
*
|
|
3197
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2681
3198
|
*
|
|
2682
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2683
3199
|
*/
|
|
2684
3200
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2685
3201
|
/**
|
|
2686
|
-
* Emitted when a user updates a connection
|
|
3202
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2687
3203
|
*
|
|
2688
|
-
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3204
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2689
3205
|
*/
|
|
2690
3206
|
UpdateConnection = "updateConnection",
|
|
2691
3207
|
/**
|
|
2692
|
-
* Emitted when a user updates a connection
|
|
3208
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2693
3209
|
*
|
|
2694
|
-
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3210
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2695
3211
|
*/
|
|
2696
3212
|
CreateConnection = "createConnection",
|
|
2697
3213
|
/**
|
|
2698
3214
|
* Emitted when name, status (private or public) or filter values of a
|
|
2699
|
-
*
|
|
3215
|
+
* Personalised view is updated.
|
|
2700
3216
|
*
|
|
2701
3217
|
* @returns viewName: string
|
|
2702
3218
|
* @returns viewId: string
|
|
2703
3219
|
* @returns liveboardId: string
|
|
2704
3220
|
* @returns isPublic: boolean
|
|
2705
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3221
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2706
3222
|
*/
|
|
2707
3223
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2708
3224
|
/**
|
|
2709
|
-
* Emitted when a
|
|
3225
|
+
* Emitted when a Personalised view is saved.
|
|
2710
3226
|
*
|
|
2711
3227
|
* @returns viewName: string
|
|
2712
3228
|
* @returns viewId: string
|
|
2713
3229
|
* @returns liveboardId: string
|
|
2714
3230
|
* @returns isPublic: boolean
|
|
2715
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3231
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2716
3232
|
*/
|
|
2717
3233
|
SavePersonalisedView = "savePersonalisedView",
|
|
2718
3234
|
/**
|
|
@@ -2722,7 +3238,7 @@ export declare enum EmbedEvent {
|
|
|
2722
3238
|
* @returns viewId: string
|
|
2723
3239
|
* @returns liveboardId: string
|
|
2724
3240
|
* @returns isPublic: boolean
|
|
2725
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3241
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2726
3242
|
*/
|
|
2727
3243
|
ResetLiveboard = "resetLiveboard",
|
|
2728
3244
|
/**
|
|
@@ -2730,11 +3246,11 @@ export declare enum EmbedEvent {
|
|
|
2730
3246
|
*
|
|
2731
3247
|
* @returns views: string[]
|
|
2732
3248
|
* @returns liveboardId: string
|
|
2733
|
-
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3249
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2734
3250
|
*/
|
|
2735
3251
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
2736
3252
|
/**
|
|
2737
|
-
*
|
|
3253
|
+
* Emitted when a user creates a new worksheet
|
|
2738
3254
|
*
|
|
2739
3255
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2740
3256
|
*/
|
|
@@ -2764,15 +3280,16 @@ export declare enum EmbedEvent {
|
|
|
2764
3280
|
*/
|
|
2765
3281
|
export declare enum HostEvent {
|
|
2766
3282
|
/**
|
|
2767
|
-
* Triggers a search
|
|
2768
|
-
*
|
|
3283
|
+
* Triggers a search operation with the search tokens specified in
|
|
3284
|
+
* the search query string.
|
|
3285
|
+
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2769
3286
|
* Includes the following properties:
|
|
2770
3287
|
*
|
|
2771
|
-
* @param -
|
|
3288
|
+
* @param - `searchQuery` - query string with search tokens
|
|
3289
|
+
* @param - `dataSources` - Data source GUID to Search on
|
|
2772
3290
|
* - Although an array, only a single source
|
|
2773
3291
|
* is supported.
|
|
2774
|
-
* @param -
|
|
2775
|
-
* @param - execute - executes the existing / updated query
|
|
3292
|
+
* @param - `execute` - executes search and updates the existing query
|
|
2776
3293
|
* @example
|
|
2777
3294
|
* ```js
|
|
2778
3295
|
* searchembed.trigger(HostEvent.Search, {
|
|
@@ -2792,6 +3309,10 @@ export declare enum HostEvent {
|
|
|
2792
3309
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
2793
3310
|
* by. If not provided it will auto drill by the configured
|
|
2794
3311
|
* column.
|
|
3312
|
+
* @param - autoDrillDown - Optional. If true, the drill down will be
|
|
3313
|
+
* done automatically on the most popular column.
|
|
3314
|
+
* @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
|
|
3315
|
+
* in case of a liveboard.
|
|
2795
3316
|
* @example
|
|
2796
3317
|
* ```js
|
|
2797
3318
|
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
@@ -2808,6 +3329,25 @@ export declare enum HostEvent {
|
|
|
2808
3329
|
* });
|
|
2809
3330
|
* })
|
|
2810
3331
|
* ```
|
|
3332
|
+
* @example
|
|
3333
|
+
* ```js
|
|
3334
|
+
* // Works with TS 9.8.0 and above
|
|
3335
|
+
*
|
|
3336
|
+
* liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
3337
|
+
* console.log(payload);
|
|
3338
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
3339
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
3340
|
+
* console.log('>>> called', clickedPoint);
|
|
3341
|
+
* liveboardEmbed.trigger(HostEvent.DrillDown, {
|
|
3342
|
+
* points: {
|
|
3343
|
+
* clickedPoint,
|
|
3344
|
+
* selectedPoints: selectedPoint
|
|
3345
|
+
* },
|
|
3346
|
+
* autoDrillDown: true,
|
|
3347
|
+
* vizId: payload.data.vizId
|
|
3348
|
+
* });
|
|
3349
|
+
* })
|
|
3350
|
+
* ```
|
|
2811
3351
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2812
3352
|
*/
|
|
2813
3353
|
DrillDown = "triggerDrillDown",
|
|
@@ -2824,7 +3364,7 @@ export declare enum HostEvent {
|
|
|
2824
3364
|
*/
|
|
2825
3365
|
Reload = "reload",
|
|
2826
3366
|
/**
|
|
2827
|
-
*
|
|
3367
|
+
* Display specific visualizations on a Liveboard.
|
|
2828
3368
|
*
|
|
2829
3369
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2830
3370
|
* in this parameter will be hidden.
|
|
@@ -2838,7 +3378,7 @@ export declare enum HostEvent {
|
|
|
2838
3378
|
*/
|
|
2839
3379
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2840
3380
|
/**
|
|
2841
|
-
* Set
|
|
3381
|
+
* Set a Liveboard tab as an active tab.
|
|
2842
3382
|
*
|
|
2843
3383
|
* @param - tabId - string of id of Tab to show
|
|
2844
3384
|
* @example
|
|
@@ -2851,7 +3391,7 @@ export declare enum HostEvent {
|
|
|
2851
3391
|
*/
|
|
2852
3392
|
SetActiveTab = "SetActiveTab",
|
|
2853
3393
|
/**
|
|
2854
|
-
*
|
|
3394
|
+
* Update runtime filters applied on a Saved Answer or Liveboard. The
|
|
2855
3395
|
* runtime filters passed here are appended to the existing runtime
|
|
2856
3396
|
* filters.
|
|
2857
3397
|
* Pass an array of runtime filters with the following attributes:
|
|
@@ -2877,10 +3417,12 @@ export declare enum HostEvent {
|
|
|
2877
3417
|
*/
|
|
2878
3418
|
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
2879
3419
|
/**
|
|
2880
|
-
* Navigate to a specific page in the embedded application
|
|
3420
|
+
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2881
3421
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2882
3422
|
*
|
|
2883
|
-
* @param - path - the path to navigate to
|
|
3423
|
+
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
3424
|
+
* be a number; for example, `1`, `-1`.
|
|
3425
|
+
*
|
|
2884
3426
|
* @example
|
|
2885
3427
|
* ```js
|
|
2886
3428
|
* appEmbed.navigateToPage(-1)
|
|
@@ -2889,7 +3431,7 @@ export declare enum HostEvent {
|
|
|
2889
3431
|
*/
|
|
2890
3432
|
Navigate = "Navigate",
|
|
2891
3433
|
/**
|
|
2892
|
-
*
|
|
3434
|
+
* Open the filter panel for a particular column.
|
|
2893
3435
|
* Works with Search and Liveboard embed.
|
|
2894
3436
|
*
|
|
2895
3437
|
* @param - { columnId: string,
|
|
@@ -2907,7 +3449,7 @@ export declare enum HostEvent {
|
|
|
2907
3449
|
*/
|
|
2908
3450
|
OpenFilter = "openFilter",
|
|
2909
3451
|
/**
|
|
2910
|
-
*
|
|
3452
|
+
* Add columns to the current search query.
|
|
2911
3453
|
*
|
|
2912
3454
|
* @param - { columnIds: string[] }
|
|
2913
3455
|
* @example
|
|
@@ -2918,7 +3460,7 @@ export declare enum HostEvent {
|
|
|
2918
3460
|
*/
|
|
2919
3461
|
AddColumns = "addColumns",
|
|
2920
3462
|
/**
|
|
2921
|
-
*
|
|
3463
|
+
* Remove a column from the current search query.
|
|
2922
3464
|
*
|
|
2923
3465
|
* @param - { columnId: string }
|
|
2924
3466
|
* @example
|
|
@@ -2929,27 +3471,29 @@ export declare enum HostEvent {
|
|
|
2929
3471
|
*/
|
|
2930
3472
|
RemoveColumn = "removeColumn",
|
|
2931
3473
|
/**
|
|
2932
|
-
*
|
|
3474
|
+
* Get the transient state of a Liveboard as encoded content.
|
|
3475
|
+
* This includes unsaved and ad hoc changes such as
|
|
3476
|
+
* Liveboard filters, runtime filters applied on visualizations on a
|
|
3477
|
+
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
3478
|
+
* sorting, toggling of legends, and data drill down.
|
|
2933
3479
|
*
|
|
2934
3480
|
* @example
|
|
2935
3481
|
* ```js
|
|
2936
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
3482
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
3483
|
+
* data=>console.log(data))
|
|
2937
3484
|
* ```
|
|
2938
3485
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
2939
3486
|
*/
|
|
2940
3487
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2941
3488
|
/**
|
|
2942
|
-
*
|
|
3489
|
+
* Trigger the **Pin** action on an embedded object
|
|
2943
3490
|
*
|
|
2944
3491
|
* @param - Liveboard embed takes the `vizId` as a
|
|
2945
|
-
* key. Can be left undefined when embedding Search, full app or
|
|
3492
|
+
* key. Can be left undefined when embedding Search, full app, or
|
|
2946
3493
|
* a visualization.
|
|
2947
3494
|
* @example
|
|
2948
3495
|
* ```js
|
|
2949
|
-
*
|
|
2950
|
-
* ```
|
|
2951
|
-
* ```js
|
|
2952
|
-
* vizEmbed.trigger(HostEvent.Pin)
|
|
3496
|
+
* appEmbed.trigger(HostEvent.Pin)
|
|
2953
3497
|
* ```
|
|
2954
3498
|
* ```js
|
|
2955
3499
|
* searchEmbed.trigger(HostEvent.Pin)
|
|
@@ -2958,17 +3502,18 @@ export declare enum HostEvent {
|
|
|
2958
3502
|
*/
|
|
2959
3503
|
Pin = "pin",
|
|
2960
3504
|
/**
|
|
2961
|
-
*
|
|
3505
|
+
* Trigger the **Show Liveboard details** action
|
|
3506
|
+
* on an embedded Liveboard.
|
|
2962
3507
|
*
|
|
2963
3508
|
* @example
|
|
2964
|
-
|
|
2965
|
-
*
|
|
2966
|
-
|
|
3509
|
+
*```js
|
|
3510
|
+
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
3511
|
+
*```
|
|
2967
3512
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2968
3513
|
*/
|
|
2969
3514
|
LiveboardInfo = "pinboardInfo",
|
|
2970
3515
|
/**
|
|
2971
|
-
*
|
|
3516
|
+
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2972
3517
|
*
|
|
2973
3518
|
* @example
|
|
2974
3519
|
* ```js
|
|
@@ -2978,7 +3523,7 @@ export declare enum HostEvent {
|
|
|
2978
3523
|
*/
|
|
2979
3524
|
Schedule = "subscription",
|
|
2980
3525
|
/**
|
|
2981
|
-
*
|
|
3526
|
+
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2982
3527
|
*
|
|
2983
3528
|
* @example
|
|
2984
3529
|
* ```js
|
|
@@ -2988,7 +3533,7 @@ export declare enum HostEvent {
|
|
|
2988
3533
|
*/
|
|
2989
3534
|
SchedulesList = "schedule-list",
|
|
2990
3535
|
/**
|
|
2991
|
-
*
|
|
3536
|
+
* Trigger the **Export TML** action on an embedded Liveboard.
|
|
2992
3537
|
*
|
|
2993
3538
|
* @example
|
|
2994
3539
|
* ```js
|
|
@@ -2998,7 +3543,7 @@ export declare enum HostEvent {
|
|
|
2998
3543
|
*/
|
|
2999
3544
|
ExportTML = "exportTSL",
|
|
3000
3545
|
/**
|
|
3001
|
-
*
|
|
3546
|
+
* Trigger the **Edit TML** action on an embedded Liveboard.
|
|
3002
3547
|
*
|
|
3003
3548
|
* @example
|
|
3004
3549
|
* ```js
|
|
@@ -3008,7 +3553,7 @@ export declare enum HostEvent {
|
|
|
3008
3553
|
*/
|
|
3009
3554
|
EditTML = "editTSL",
|
|
3010
3555
|
/**
|
|
3011
|
-
*
|
|
3556
|
+
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
3012
3557
|
*
|
|
3013
3558
|
* @example
|
|
3014
3559
|
* ```js
|
|
@@ -3018,7 +3563,7 @@ export declare enum HostEvent {
|
|
|
3018
3563
|
*/
|
|
3019
3564
|
UpdateTML = "updateTSL",
|
|
3020
3565
|
/**
|
|
3021
|
-
*
|
|
3566
|
+
* Trigger the **Download PDF** action on an embedded Liveboard.
|
|
3022
3567
|
*
|
|
3023
3568
|
* @example
|
|
3024
3569
|
* ```js
|
|
@@ -3028,8 +3573,8 @@ export declare enum HostEvent {
|
|
|
3028
3573
|
*/
|
|
3029
3574
|
DownloadAsPdf = "downloadAsPdf",
|
|
3030
3575
|
/**
|
|
3031
|
-
*
|
|
3032
|
-
* visualization page
|
|
3576
|
+
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
3577
|
+
* visualization page.
|
|
3033
3578
|
*
|
|
3034
3579
|
* @example
|
|
3035
3580
|
* ```js
|
|
@@ -3045,7 +3590,7 @@ export declare enum HostEvent {
|
|
|
3045
3590
|
*/
|
|
3046
3591
|
MakeACopy = "makeACopy",
|
|
3047
3592
|
/**
|
|
3048
|
-
*
|
|
3593
|
+
* Trigger the **Delete** action for a Liveboard.
|
|
3049
3594
|
*
|
|
3050
3595
|
* @example
|
|
3051
3596
|
* ```js
|
|
@@ -3055,7 +3600,7 @@ export declare enum HostEvent {
|
|
|
3055
3600
|
*/
|
|
3056
3601
|
Remove = "delete",
|
|
3057
3602
|
/**
|
|
3058
|
-
*
|
|
3603
|
+
* Trigger the **Explore** action on a visualization.
|
|
3059
3604
|
*
|
|
3060
3605
|
* @param - an object with `vizId` as a key
|
|
3061
3606
|
* @example
|
|
@@ -3066,7 +3611,7 @@ export declare enum HostEvent {
|
|
|
3066
3611
|
*/
|
|
3067
3612
|
Explore = "explore",
|
|
3068
3613
|
/**
|
|
3069
|
-
*
|
|
3614
|
+
* Trigger the **Create alert** action on a visualization
|
|
3070
3615
|
*
|
|
3071
3616
|
* @param - an object with `vizId` as a key
|
|
3072
3617
|
* @example
|
|
@@ -3079,7 +3624,7 @@ export declare enum HostEvent {
|
|
|
3079
3624
|
*/
|
|
3080
3625
|
CreateMonitor = "createMonitor",
|
|
3081
3626
|
/**
|
|
3082
|
-
*
|
|
3627
|
+
* Trigger the **Manage alerts** action on a visualization
|
|
3083
3628
|
*
|
|
3084
3629
|
* @param - an object with `vizId` as a key
|
|
3085
3630
|
* @example
|
|
@@ -3092,7 +3637,7 @@ export declare enum HostEvent {
|
|
|
3092
3637
|
*/
|
|
3093
3638
|
ManageMonitor = "manageMonitor",
|
|
3094
3639
|
/**
|
|
3095
|
-
*
|
|
3640
|
+
* Trigger the **Edit** action on a Liveboard or visualization
|
|
3096
3641
|
*
|
|
3097
3642
|
* @param - object - To trigger the action for a specific visualization
|
|
3098
3643
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
@@ -3113,7 +3658,7 @@ export declare enum HostEvent {
|
|
|
3113
3658
|
*/
|
|
3114
3659
|
Edit = "edit",
|
|
3115
3660
|
/**
|
|
3116
|
-
*
|
|
3661
|
+
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
3117
3662
|
*
|
|
3118
3663
|
* @param - object - to trigger the action for a
|
|
3119
3664
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
@@ -3131,7 +3676,7 @@ export declare enum HostEvent {
|
|
|
3131
3676
|
*/
|
|
3132
3677
|
CopyLink = "embedDocument",
|
|
3133
3678
|
/**
|
|
3134
|
-
*
|
|
3679
|
+
* Trigger the **Present** action on a Liveboard or visualization
|
|
3135
3680
|
*
|
|
3136
3681
|
* @param - object - to trigger the action for a specific visualization
|
|
3137
3682
|
* in Liveboard embed, pass in `vizId` as a key
|
|
@@ -3149,7 +3694,7 @@ export declare enum HostEvent {
|
|
|
3149
3694
|
*/
|
|
3150
3695
|
Present = "present",
|
|
3151
3696
|
/**
|
|
3152
|
-
*
|
|
3697
|
+
* Get TML for the current search.
|
|
3153
3698
|
*
|
|
3154
3699
|
* @example
|
|
3155
3700
|
* ```js
|
|
@@ -3164,7 +3709,7 @@ export declare enum HostEvent {
|
|
|
3164
3709
|
*/
|
|
3165
3710
|
GetTML = "getTML",
|
|
3166
3711
|
/**
|
|
3167
|
-
*
|
|
3712
|
+
* Trigger the **Show underlying data** action on visualization or search
|
|
3168
3713
|
*
|
|
3169
3714
|
* @param - an object with vizId as a key
|
|
3170
3715
|
* @example
|
|
@@ -3182,7 +3727,9 @@ export declare enum HostEvent {
|
|
|
3182
3727
|
*/
|
|
3183
3728
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3184
3729
|
/**
|
|
3185
|
-
*
|
|
3730
|
+
* Trigger the **Delete** action for a visualization
|
|
3731
|
+
* in an embedded Liveboard, or a chart or table
|
|
3732
|
+
* generated from Search.
|
|
3186
3733
|
*
|
|
3187
3734
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
3188
3735
|
* Can be left empty if embedding Search or visualization.
|
|
@@ -3192,16 +3739,13 @@ export declare enum HostEvent {
|
|
|
3192
3739
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3193
3740
|
* ```
|
|
3194
3741
|
* ```js
|
|
3195
|
-
* vizEmbed.trigger(HostEvent.Delete)
|
|
3196
|
-
* ```
|
|
3197
|
-
* ```js
|
|
3198
3742
|
* searchEmbed.trigger(HostEvent.Delete)
|
|
3199
3743
|
* ```
|
|
3200
3744
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3201
3745
|
*/
|
|
3202
3746
|
Delete = "onDeleteAnswer",
|
|
3203
3747
|
/**
|
|
3204
|
-
*
|
|
3748
|
+
* Trigger the **SpotIQ analyze** action on visualization
|
|
3205
3749
|
* or search.
|
|
3206
3750
|
*
|
|
3207
3751
|
* @param - Liveboard embed takes `vizId` as a
|
|
@@ -3222,7 +3766,7 @@ export declare enum HostEvent {
|
|
|
3222
3766
|
*/
|
|
3223
3767
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3224
3768
|
/**
|
|
3225
|
-
*
|
|
3769
|
+
* Trigger the **Download** action on charts in
|
|
3226
3770
|
* the embedded view.
|
|
3227
3771
|
*
|
|
3228
3772
|
* @example
|
|
@@ -3231,17 +3775,15 @@ export declare enum HostEvent {
|
|
|
3231
3775
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3232
3776
|
* ```
|
|
3233
3777
|
* ```js
|
|
3234
|
-
*
|
|
3235
|
-
* ```
|
|
3236
|
-
* ```js
|
|
3237
|
-
* searchEmbed.trigger(HostEvent.Download)
|
|
3778
|
+
* embed.trigger(HostEvent.Download)
|
|
3238
3779
|
* ```
|
|
3239
|
-
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
3780
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
3781
|
+
* Use {@link DownloadAsPng}
|
|
3240
3782
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3241
3783
|
*/
|
|
3242
3784
|
Download = "downloadAsPng",
|
|
3243
3785
|
/**
|
|
3244
|
-
*
|
|
3786
|
+
* Trigger the **Download** > **PNG** action on
|
|
3245
3787
|
* charts in the embedded view.
|
|
3246
3788
|
*
|
|
3247
3789
|
* @example
|
|
@@ -3257,7 +3799,7 @@ export declare enum HostEvent {
|
|
|
3257
3799
|
*/
|
|
3258
3800
|
DownloadAsPng = "downloadAsPng",
|
|
3259
3801
|
/**
|
|
3260
|
-
*
|
|
3802
|
+
* Trigger the **Download** > **CSV** action on tables in
|
|
3261
3803
|
* the embedded view.
|
|
3262
3804
|
*
|
|
3263
3805
|
* @example
|
|
@@ -3275,7 +3817,7 @@ export declare enum HostEvent {
|
|
|
3275
3817
|
*/
|
|
3276
3818
|
DownloadAsCsv = "downloadAsCSV",
|
|
3277
3819
|
/**
|
|
3278
|
-
*
|
|
3820
|
+
* Trigger the **Download** > **XLSX** action on tables
|
|
3279
3821
|
* in the embedded view.
|
|
3280
3822
|
*
|
|
3281
3823
|
* @example
|
|
@@ -3293,7 +3835,7 @@ export declare enum HostEvent {
|
|
|
3293
3835
|
*/
|
|
3294
3836
|
DownloadAsXlsx = "downloadAsXLSX",
|
|
3295
3837
|
/**
|
|
3296
|
-
*
|
|
3838
|
+
* Trigger the **Share** action on an embedded
|
|
3297
3839
|
* Liveboard or Answer.
|
|
3298
3840
|
*
|
|
3299
3841
|
* @example
|
|
@@ -3307,7 +3849,7 @@ export declare enum HostEvent {
|
|
|
3307
3849
|
*/
|
|
3308
3850
|
Share = "share",
|
|
3309
3851
|
/**
|
|
3310
|
-
*
|
|
3852
|
+
* Trigger the **Save** action on a Liveboard or Answer.
|
|
3311
3853
|
* Saves the changes.
|
|
3312
3854
|
*
|
|
3313
3855
|
* @example
|
|
@@ -3321,7 +3863,7 @@ export declare enum HostEvent {
|
|
|
3321
3863
|
*/
|
|
3322
3864
|
Save = "save",
|
|
3323
3865
|
/**
|
|
3324
|
-
*
|
|
3866
|
+
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
3325
3867
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
3326
3868
|
*
|
|
3327
3869
|
* @param - an object with `vizId` as a key
|
|
@@ -3337,7 +3879,7 @@ export declare enum HostEvent {
|
|
|
3337
3879
|
*/
|
|
3338
3880
|
SyncToSheets = "sync-to-sheets",
|
|
3339
3881
|
/**
|
|
3340
|
-
*
|
|
3882
|
+
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
3341
3883
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
3342
3884
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
3343
3885
|
*
|
|
@@ -3354,7 +3896,7 @@ export declare enum HostEvent {
|
|
|
3354
3896
|
*/
|
|
3355
3897
|
SyncToOtherApps = "sync-to-other-apps",
|
|
3356
3898
|
/**
|
|
3357
|
-
*
|
|
3899
|
+
* Trigger the **Manage pipelines** action on an embedded
|
|
3358
3900
|
* visualization or Answer.
|
|
3359
3901
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
3360
3902
|
*
|
|
@@ -3371,18 +3913,21 @@ export declare enum HostEvent {
|
|
|
3371
3913
|
*/
|
|
3372
3914
|
ManagePipelines = "manage-pipeline",
|
|
3373
3915
|
/**
|
|
3374
|
-
*
|
|
3916
|
+
* Reset search operation on the Search or Answer page.
|
|
3375
3917
|
*
|
|
3376
3918
|
* @example
|
|
3377
3919
|
* ```js
|
|
3378
3920
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
3379
3921
|
* ```
|
|
3922
|
+
* ```js
|
|
3923
|
+
* appEmbed.trigger(HostEvent.ResetSearch)
|
|
3924
|
+
* ```
|
|
3380
3925
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
3381
3926
|
*/
|
|
3382
3927
|
ResetSearch = "resetSearch",
|
|
3383
3928
|
/**
|
|
3384
3929
|
* @hidden
|
|
3385
|
-
*
|
|
3930
|
+
* Get the currents visible and runtime filters applied on a Liveboard
|
|
3386
3931
|
* @example
|
|
3387
3932
|
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
3388
3933
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
@@ -3390,7 +3935,7 @@ export declare enum HostEvent {
|
|
|
3390
3935
|
GetFilters = "getFilters",
|
|
3391
3936
|
/**
|
|
3392
3937
|
* @hidden
|
|
3393
|
-
*
|
|
3938
|
+
* Update the visible filters on the Liveboard.
|
|
3394
3939
|
* @param - filter: filter object containing column name and filter operation and values
|
|
3395
3940
|
* @example
|
|
3396
3941
|
*
|
|
@@ -3403,7 +3948,7 @@ export declare enum HostEvent {
|
|
|
3403
3948
|
*/
|
|
3404
3949
|
UpdateFilters = "updateFilters",
|
|
3405
3950
|
/**
|
|
3406
|
-
* Get
|
|
3951
|
+
* Get tab details for the current Liveboard.
|
|
3407
3952
|
*
|
|
3408
3953
|
* @example
|
|
3409
3954
|
* ```js
|
|
@@ -3417,9 +3962,9 @@ export declare enum HostEvent {
|
|
|
3417
3962
|
*/
|
|
3418
3963
|
GetTabs = "getTabs",
|
|
3419
3964
|
/**
|
|
3420
|
-
* Set the visible
|
|
3965
|
+
* Set the visible tabs on a Liveboard.
|
|
3421
3966
|
*
|
|
3422
|
-
* @param - an array of ids of
|
|
3967
|
+
* @param - an array of ids of tabs to show, the IDs not passed
|
|
3423
3968
|
* will be hidden.
|
|
3424
3969
|
* @example
|
|
3425
3970
|
* ```js
|
|
@@ -3433,8 +3978,8 @@ export declare enum HostEvent {
|
|
|
3433
3978
|
/**
|
|
3434
3979
|
* Set the hidden tabs on a Liveboard.
|
|
3435
3980
|
*
|
|
3436
|
-
* @param - an array of
|
|
3437
|
-
*
|
|
3981
|
+
* @param - an array of the IDs of the tabs to hide.
|
|
3982
|
+
* The IDs not passed will be shown.
|
|
3438
3983
|
* @example
|
|
3439
3984
|
* ```js
|
|
3440
3985
|
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
@@ -3445,9 +3990,12 @@ export declare enum HostEvent {
|
|
|
3445
3990
|
*/
|
|
3446
3991
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
3447
3992
|
/**
|
|
3448
|
-
* Updates the search query for
|
|
3993
|
+
* Updates the search query string for Natural Language Search operations.
|
|
3994
|
+
*
|
|
3995
|
+
* @param - `queryString`: Text string in Natural Language format
|
|
3996
|
+
*
|
|
3997
|
+
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
3449
3998
|
*
|
|
3450
|
-
* @param - searchOptions: an object queryString and option to execute the query.
|
|
3451
3999
|
* @example
|
|
3452
4000
|
* ```js
|
|
3453
4001
|
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
@@ -3455,7 +4003,7 @@ export declare enum HostEvent {
|
|
|
3455
4003
|
* executeSearch: true,
|
|
3456
4004
|
* })
|
|
3457
4005
|
* ```
|
|
3458
|
-
* @version SDK: 1.26.0 | Thoughtspot: 9.
|
|
4006
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3459
4007
|
*/
|
|
3460
4008
|
UpdateSageQuery = "updateSageQuery",
|
|
3461
4009
|
/**
|
|
@@ -3468,24 +4016,25 @@ export declare enum HostEvent {
|
|
|
3468
4016
|
* vizId: '123', // For Liveboard Visualization.
|
|
3469
4017
|
* })
|
|
3470
4018
|
* ```
|
|
4019
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
3471
4020
|
*/
|
|
3472
4021
|
GetAnswerSession = "getAnswerSession"
|
|
3473
4022
|
}
|
|
3474
4023
|
/**
|
|
3475
4024
|
* The different visual modes that the data sources panel within
|
|
3476
|
-
* search could appear in,
|
|
4025
|
+
* search could appear in, such as hidden, collapsed, or expanded.
|
|
3477
4026
|
*/
|
|
3478
4027
|
export declare enum DataSourceVisualMode {
|
|
3479
4028
|
/**
|
|
3480
|
-
*
|
|
4029
|
+
* The data source panel is hidden.
|
|
3481
4030
|
*/
|
|
3482
4031
|
Hidden = "hide",
|
|
3483
4032
|
/**
|
|
3484
|
-
*
|
|
4033
|
+
* The data source panel is collapsed, but the user can manually expand it.
|
|
3485
4034
|
*/
|
|
3486
4035
|
Collapsed = "collapse",
|
|
3487
4036
|
/**
|
|
3488
|
-
*
|
|
4037
|
+
* The data source panel is expanded, but the user can manually collapse it.
|
|
3489
4038
|
*/
|
|
3490
4039
|
Expanded = "expand"
|
|
3491
4040
|
}
|
|
@@ -3561,7 +4110,10 @@ export declare enum Param {
|
|
|
3561
4110
|
LiveboardHeaderSticky = "isLiveboardHeaderSticky",
|
|
3562
4111
|
IsProductTour = "isProductTour",
|
|
3563
4112
|
HideSearchBarTitle = "hideSearchBarTitle",
|
|
3564
|
-
HideSageAnswerHeader = "hideSageAnswerHeader"
|
|
4113
|
+
HideSageAnswerHeader = "hideSageAnswerHeader",
|
|
4114
|
+
HideSearchBar = "hideSearchBar",
|
|
4115
|
+
ClientLogLevel = "clientLogLevel",
|
|
4116
|
+
OverrideNativeConsole = "overrideConsoleLogs"
|
|
3565
4117
|
}
|
|
3566
4118
|
/**
|
|
3567
4119
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3621,9 +4173,11 @@ export declare enum Action {
|
|
|
3621
4173
|
SaveAsView = "saveAsView",
|
|
3622
4174
|
/**
|
|
3623
4175
|
* The **Make a copy** action on a Liveboard or Answer
|
|
3624
|
-
* page.
|
|
3625
|
-
*
|
|
3626
|
-
*
|
|
4176
|
+
* page. Creates a copy of the Liveboard.
|
|
4177
|
+
* In LiveboardEmbed, the **Make a copy** action is not available for
|
|
4178
|
+
* visualizations in the embedded Liveboard view.
|
|
4179
|
+
* In AppEmbed, the **Make a copy** action is available on both
|
|
4180
|
+
* Liveboards and visualizations.
|
|
3627
4181
|
*
|
|
3628
4182
|
* @example
|
|
3629
4183
|
* ```js
|
|
@@ -3807,7 +4361,7 @@ export declare enum Action {
|
|
|
3807
4361
|
*/
|
|
3808
4362
|
DownloadAsPdf = "downloadAsPdf",
|
|
3809
4363
|
/**
|
|
3810
|
-
* The **Download**
|
|
4364
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3811
4365
|
* or Answer page.
|
|
3812
4366
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3813
4367
|
*
|
|
@@ -4338,6 +4892,7 @@ export declare enum Action {
|
|
|
4338
4892
|
*/
|
|
4339
4893
|
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
4340
4894
|
/**
|
|
4895
|
+
*
|
|
4341
4896
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4342
4897
|
*/
|
|
4343
4898
|
RequestVerification = "requestVerification",
|
|
@@ -4473,6 +5028,14 @@ export interface CustomActionPayload {
|
|
|
4473
5028
|
session: SessionInterface;
|
|
4474
5029
|
vizId?: string;
|
|
4475
5030
|
}
|
|
5031
|
+
export declare enum LogLevel {
|
|
5032
|
+
SILENT = "SILENT",
|
|
5033
|
+
ERROR = "ERROR",
|
|
5034
|
+
WARN = "WARN",
|
|
5035
|
+
INFO = "INFO",
|
|
5036
|
+
DEBUG = "DEBUG",
|
|
5037
|
+
TRACE = "TRACE"
|
|
5038
|
+
}
|
|
4476
5039
|
|
|
4477
5040
|
/**
|
|
4478
5041
|
* The list of customization css variables. These
|
|
@@ -4846,8 +5409,7 @@ interface UnderlyingDataPoint {
|
|
|
4846
5409
|
* const data = await underlying.fetchData(0, 100);
|
|
4847
5410
|
* })
|
|
4848
5411
|
* ```
|
|
4849
|
-
* @version
|
|
4850
|
-
* ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
|
|
5412
|
+
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
4851
5413
|
* @group Events
|
|
4852
5414
|
*/
|
|
4853
5415
|
export declare class AnswerService {
|
|
@@ -4881,8 +5443,7 @@ export declare class AnswerService {
|
|
|
4881
5443
|
* const data = await underlying.fetchData(0, 100);
|
|
4882
5444
|
* })
|
|
4883
5445
|
* ```
|
|
4884
|
-
* @version
|
|
4885
|
-
* ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
|
|
5446
|
+
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
4886
5447
|
*/
|
|
4887
5448
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
4888
5449
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
@@ -4900,12 +5461,13 @@ export {};
|
|
|
4900
5461
|
export declare const getEmbedConfig: () => EmbedConfig;
|
|
4901
5462
|
/**
|
|
4902
5463
|
* Sets the configuration embed was initialized with.
|
|
5464
|
+
* And returns the new configuration.
|
|
4903
5465
|
*
|
|
4904
5466
|
* @param newConfig The configuration to set.
|
|
4905
5467
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
4906
5468
|
* @group Global methods
|
|
4907
5469
|
*/
|
|
4908
|
-
export declare const setEmbedConfig: (newConfig: EmbedConfig) =>
|
|
5470
|
+
export declare const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
|
|
4909
5471
|
|
|
4910
5472
|
/**
|
|
4911
5473
|
* Copyright (c) 2022
|