@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.40.1-alpha.3
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/cjs/package.json +7 -6
- package/cjs/src/css-variables.d.ts +316 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +6 -1
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +27 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +72 -5
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.d.ts +0 -1
- package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/cjs/src/embed/bodyless-conversation.js +3 -7
- package/cjs/src/embed/bodyless-conversation.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +63 -3
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +11 -8
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +102 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +11 -3
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +25 -34
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +204 -29
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +0 -1
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +6 -10
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +0 -1
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +7 -11
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +0 -1
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +8 -7
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +22 -9
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +77 -60
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +175 -3
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +190 -55
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +157 -52
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/liveboardService/liveboardService.d.ts +21 -6
- package/cjs/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
- package/cjs/src/utils/liveboardService/liveboardService.js +21 -6
- package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
- package/cjs/src/utils/processData.d.ts.map +1 -1
- package/cjs/src/utils/processData.js +10 -0
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +11 -0
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/dist/{index-D1pyb7RG.js → es/index-BwesxE_h.js} +0 -2
- package/dist/es/index.js +17539 -0
- package/dist/es/react/index.js +24039 -0
- package/dist/es/react/src/auth.d.ts +171 -0
- package/dist/es/react/src/auth.d.ts.map +1 -0
- package/dist/es/react/src/auth.spec.d.ts +15 -0
- package/dist/es/react/src/auth.spec.d.ts.map +1 -0
- package/dist/es/react/src/authToken.d.ts +17 -0
- package/dist/es/react/src/authToken.d.ts.map +1 -0
- package/dist/es/react/src/authToken.spec.d.ts +2 -0
- package/dist/es/react/src/authToken.spec.d.ts.map +1 -0
- package/dist/es/react/src/config.d.ts +21 -0
- package/dist/es/react/src/config.d.ts.map +1 -0
- package/dist/es/react/src/config.spec.d.ts +5 -0
- package/dist/es/react/src/config.spec.d.ts.map +1 -0
- package/dist/es/react/src/css-variables.d.ts +384 -0
- package/dist/es/react/src/css-variables.d.ts.map +1 -0
- package/dist/es/react/src/embed/app.d.ts +478 -0
- package/dist/es/react/src/embed/app.d.ts.map +1 -0
- package/dist/es/react/src/embed/app.spec.d.ts +2 -0
- package/dist/es/react/src/embed/app.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/base.d.ts +136 -0
- package/dist/es/react/src/embed/base.d.ts.map +1 -0
- package/dist/es/react/src/embed/base.spec.d.ts +2 -0
- package/dist/es/react/src/embed/base.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/bodyless-conversation.d.ts +26 -0
- package/dist/es/react/src/embed/bodyless-conversation.d.ts.map +1 -0
- package/dist/es/react/src/embed/bodyless-conversation.spec.d.ts +2 -0
- package/dist/es/react/src/embed/bodyless-conversation.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/conversation.d.ts +43 -0
- package/dist/es/react/src/embed/conversation.d.ts.map +1 -0
- package/dist/es/react/src/embed/conversation.spec.d.ts +2 -0
- package/dist/es/react/src/embed/conversation.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/embed.spec.d.ts +2 -0
- package/dist/es/react/src/embed/embed.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/embedConfig.d.ts +17 -0
- package/dist/es/react/src/embed/embedConfig.d.ts.map +1 -0
- package/dist/es/react/src/embed/events.spec.d.ts +2 -0
- package/dist/es/react/src/embed/events.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/liveboard.d.ts +379 -0
- package/dist/es/react/src/embed/liveboard.d.ts.map +1 -0
- package/dist/es/react/src/embed/liveboard.spec.d.ts +2 -0
- package/dist/es/react/src/embed/liveboard.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/pinboard.spec.d.ts +2 -0
- package/dist/es/react/src/embed/pinboard.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/sage.d.ts +148 -0
- package/dist/es/react/src/embed/sage.d.ts.map +1 -0
- package/dist/es/react/src/embed/sage.spec.d.ts +2 -0
- package/dist/es/react/src/embed/sage.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/search-bar.d.ts +93 -0
- package/dist/es/react/src/embed/search-bar.d.ts.map +1 -0
- package/dist/es/react/src/embed/search.d.ts +282 -0
- package/dist/es/react/src/embed/search.d.ts.map +1 -0
- package/dist/es/react/src/embed/search.spec.d.ts +2 -0
- package/dist/es/react/src/embed/search.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/ts-embed-trigger.spec.d.ts +2 -0
- package/dist/es/react/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
- package/dist/es/react/src/embed/ts-embed.d.ts +374 -0
- package/dist/es/react/src/embed/ts-embed.d.ts.map +1 -0
- package/dist/es/react/src/embed/ts-embed.spec.d.ts +2 -0
- package/dist/es/react/src/embed/ts-embed.spec.d.ts.map +1 -0
- package/dist/es/react/src/errors.d.ts +19 -0
- package/dist/es/react/src/errors.d.ts.map +1 -0
- package/dist/es/react/src/index.d.ts +29 -0
- package/dist/es/react/src/index.d.ts.map +1 -0
- package/dist/es/react/src/mixpanel-service.d.ts +35 -0
- package/dist/es/react/src/mixpanel-service.d.ts.map +1 -0
- package/dist/es/react/src/mixpanel-service.spec.d.ts +2 -0
- package/dist/es/react/src/mixpanel-service.spec.d.ts.map +1 -0
- package/dist/es/react/src/react/all-types-export.d.ts +3 -0
- package/dist/es/react/src/react/all-types-export.d.ts.map +1 -0
- package/dist/es/react/src/react/all-types-export.spec.d.ts +2 -0
- package/dist/es/react/src/react/all-types-export.spec.d.ts.map +1 -0
- package/dist/es/react/src/react/index.d.ts +254 -0
- package/dist/es/react/src/react/index.d.ts.map +1 -0
- package/dist/es/react/src/react/index.spec.d.ts +3 -0
- package/dist/es/react/src/react/index.spec.d.ts.map +1 -0
- package/dist/es/react/src/react/util.d.ts +19 -0
- package/dist/es/react/src/react/util.d.ts.map +1 -0
- package/dist/es/react/src/test/test-utils.d.ts +61 -0
- package/dist/es/react/src/test/test-utils.d.ts.map +1 -0
- package/dist/es/react/src/tokenizedFetch.d.ts +18 -0
- package/dist/es/react/src/tokenizedFetch.d.ts.map +1 -0
- package/dist/es/react/src/types.d.ts +4363 -0
- package/dist/es/react/src/types.d.ts.map +1 -0
- package/dist/es/react/src/utils/authService/authService.d.ts +45 -0
- package/dist/es/react/src/utils/authService/authService.d.ts.map +1 -0
- package/dist/es/react/src/utils/authService/authService.spec.d.ts +2 -0
- package/dist/es/react/src/utils/authService/authService.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/authService/index.d.ts +3 -0
- package/dist/es/react/src/utils/authService/index.d.ts.map +1 -0
- package/dist/es/react/src/utils/authService/tokenizedAuthService.d.ts +22 -0
- package/dist/es/react/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
- package/dist/es/react/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
- package/dist/es/react/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/global-styles.d.ts +2 -0
- package/dist/es/react/src/utils/global-styles.d.ts.map +1 -0
- package/dist/es/react/src/utils/global-styles.spec.d.ts +2 -0
- package/dist/es/react/src/utils/global-styles.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/answerService/answer-queries.d.ts +10 -0
- package/dist/es/react/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/answerService/answerService.d.ts +180 -0
- package/dist/es/react/src/utils/graphql/answerService/answerService.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/answerService/answerService.spec.d.ts +2 -0
- package/dist/es/react/src/utils/graphql/answerService/answerService.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/graphql-request.d.ts +15 -0
- package/dist/es/react/src/utils/graphql/graphql-request.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/graphql-request.spec.d.ts +2 -0
- package/dist/es/react/src/utils/graphql/graphql-request.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/nlsService/conversation-queries.d.ts +3 -0
- package/dist/es/react/src/utils/graphql/nlsService/conversation-queries.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/nlsService/conversation-service.d.ts +12 -0
- package/dist/es/react/src/utils/graphql/nlsService/conversation-service.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/nlsService/nls-answer-queries.d.ts +2 -0
- package/dist/es/react/src/utils/graphql/nlsService/nls-answer-queries.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/nlsService/nls-answer-service.d.ts +17 -0
- package/dist/es/react/src/utils/graphql/nlsService/nls-answer-service.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/nlsService/nls-answer-service.spec.d.ts +2 -0
- package/dist/es/react/src/utils/graphql/nlsService/nls-answer-service.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/preview-service.d.ts +9 -0
- package/dist/es/react/src/utils/graphql/preview-service.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/preview-service.spec.d.ts +2 -0
- package/dist/es/react/src/utils/graphql/preview-service.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/sourceService.d.ts +8 -0
- package/dist/es/react/src/utils/graphql/sourceService.d.ts.map +1 -0
- package/dist/es/react/src/utils/graphql/sourceService.spec.d.ts +2 -0
- package/dist/es/react/src/utils/graphql/sourceService.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/liveboardService/liveboardService.d.ts +16 -0
- package/dist/es/react/src/utils/liveboardService/liveboardService.d.ts.map +1 -0
- package/dist/es/react/src/utils/liveboardService/liveboardService.spec.d.ts +2 -0
- package/dist/es/react/src/utils/liveboardService/liveboardService.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/logger.d.ts +18 -0
- package/dist/es/react/src/utils/logger.d.ts.map +1 -0
- package/dist/es/react/src/utils/logger.spec.d.ts +25 -0
- package/dist/es/react/src/utils/logger.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/processData.d.ts +22 -0
- package/dist/es/react/src/utils/processData.d.ts.map +1 -0
- package/dist/es/react/src/utils/processData.spec.d.ts +2 -0
- package/dist/es/react/src/utils/processData.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/processTrigger.d.ts +16 -0
- package/dist/es/react/src/utils/processTrigger.d.ts.map +1 -0
- package/dist/es/react/src/utils/processTrigger.spec.d.ts +2 -0
- package/dist/es/react/src/utils/processTrigger.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/reporting.d.ts +16 -0
- package/dist/es/react/src/utils/reporting.d.ts.map +1 -0
- package/dist/es/react/src/utils/reporting.spec.d.ts +2 -0
- package/dist/es/react/src/utils/reporting.spec.d.ts.map +1 -0
- package/dist/es/react/src/utils/sessionInfoService.d.ts +66 -0
- package/dist/es/react/src/utils/sessionInfoService.d.ts.map +1 -0
- package/dist/es/react/src/utils.d.ts +104 -0
- package/dist/es/react/src/utils.d.ts.map +1 -0
- package/dist/es/react/src/utils.spec.d.ts +2 -0
- package/dist/es/react/src/utils.spec.d.ts.map +1 -0
- package/dist/es/src/auth.d.ts +171 -0
- package/dist/es/src/auth.d.ts.map +1 -0
- package/dist/es/src/auth.spec.d.ts +15 -0
- package/dist/es/src/auth.spec.d.ts.map +1 -0
- package/dist/es/src/authToken.d.ts +17 -0
- package/dist/es/src/authToken.d.ts.map +1 -0
- package/dist/es/src/authToken.spec.d.ts +2 -0
- package/dist/es/src/authToken.spec.d.ts.map +1 -0
- package/dist/es/src/config.d.ts +21 -0
- package/dist/es/src/config.d.ts.map +1 -0
- package/dist/es/src/config.spec.d.ts +5 -0
- package/dist/es/src/config.spec.d.ts.map +1 -0
- package/dist/es/src/css-variables.d.ts +384 -0
- package/dist/es/src/css-variables.d.ts.map +1 -0
- package/dist/es/src/embed/app.d.ts +478 -0
- package/dist/es/src/embed/app.d.ts.map +1 -0
- package/dist/es/src/embed/app.spec.d.ts +2 -0
- package/dist/es/src/embed/app.spec.d.ts.map +1 -0
- package/dist/es/src/embed/base.d.ts +136 -0
- package/dist/es/src/embed/base.d.ts.map +1 -0
- package/dist/es/src/embed/base.spec.d.ts +2 -0
- package/dist/es/src/embed/base.spec.d.ts.map +1 -0
- package/dist/es/src/embed/bodyless-conversation.d.ts +26 -0
- package/dist/es/src/embed/bodyless-conversation.d.ts.map +1 -0
- package/dist/es/src/embed/bodyless-conversation.spec.d.ts +2 -0
- package/dist/es/src/embed/bodyless-conversation.spec.d.ts.map +1 -0
- package/dist/es/src/embed/conversation.d.ts +43 -0
- package/dist/es/src/embed/conversation.d.ts.map +1 -0
- package/dist/es/src/embed/conversation.spec.d.ts +2 -0
- package/dist/es/src/embed/conversation.spec.d.ts.map +1 -0
- package/dist/es/src/embed/embed.spec.d.ts +2 -0
- package/dist/es/src/embed/embed.spec.d.ts.map +1 -0
- package/dist/es/src/embed/embedConfig.d.ts +17 -0
- package/dist/es/src/embed/embedConfig.d.ts.map +1 -0
- package/dist/es/src/embed/events.spec.d.ts +2 -0
- package/dist/es/src/embed/events.spec.d.ts.map +1 -0
- package/dist/es/src/embed/liveboard.d.ts +379 -0
- package/dist/es/src/embed/liveboard.d.ts.map +1 -0
- package/dist/es/src/embed/liveboard.spec.d.ts +2 -0
- package/dist/es/src/embed/liveboard.spec.d.ts.map +1 -0
- package/dist/es/src/embed/pinboard.spec.d.ts +2 -0
- package/dist/es/src/embed/pinboard.spec.d.ts.map +1 -0
- package/dist/es/src/embed/sage.d.ts +148 -0
- package/dist/es/src/embed/sage.d.ts.map +1 -0
- package/dist/es/src/embed/sage.spec.d.ts +2 -0
- package/dist/es/src/embed/sage.spec.d.ts.map +1 -0
- package/dist/es/src/embed/search-bar.d.ts +93 -0
- package/dist/es/src/embed/search-bar.d.ts.map +1 -0
- package/dist/es/src/embed/search.d.ts +282 -0
- package/dist/es/src/embed/search.d.ts.map +1 -0
- package/dist/es/src/embed/search.spec.d.ts +2 -0
- package/dist/es/src/embed/search.spec.d.ts.map +1 -0
- package/dist/es/src/embed/ts-embed-trigger.spec.d.ts +2 -0
- package/dist/es/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
- package/dist/es/src/embed/ts-embed.d.ts +374 -0
- package/dist/es/src/embed/ts-embed.d.ts.map +1 -0
- package/dist/es/src/embed/ts-embed.spec.d.ts +2 -0
- package/dist/es/src/embed/ts-embed.spec.d.ts.map +1 -0
- package/dist/es/src/errors.d.ts +19 -0
- package/dist/es/src/errors.d.ts.map +1 -0
- package/dist/es/src/index.d.ts +29 -0
- package/dist/es/src/index.d.ts.map +1 -0
- package/dist/es/src/mixpanel-service.d.ts +35 -0
- package/dist/es/src/mixpanel-service.d.ts.map +1 -0
- package/dist/es/src/mixpanel-service.spec.d.ts +2 -0
- package/dist/es/src/mixpanel-service.spec.d.ts.map +1 -0
- package/dist/es/src/react/all-types-export.d.ts +3 -0
- package/dist/es/src/react/all-types-export.d.ts.map +1 -0
- package/dist/es/src/react/all-types-export.spec.d.ts +2 -0
- package/dist/es/src/react/all-types-export.spec.d.ts.map +1 -0
- package/dist/es/src/react/index.d.ts +254 -0
- package/dist/es/src/react/index.d.ts.map +1 -0
- package/dist/es/src/react/index.spec.d.ts +3 -0
- package/dist/es/src/react/index.spec.d.ts.map +1 -0
- package/dist/es/src/react/util.d.ts +19 -0
- package/dist/es/src/react/util.d.ts.map +1 -0
- package/dist/es/src/test/test-utils.d.ts +61 -0
- package/dist/es/src/test/test-utils.d.ts.map +1 -0
- package/dist/es/src/tokenizedFetch.d.ts +18 -0
- package/dist/es/src/tokenizedFetch.d.ts.map +1 -0
- package/dist/es/src/types.d.ts +4363 -0
- package/dist/es/src/types.d.ts.map +1 -0
- package/dist/es/src/utils/authService/authService.d.ts +45 -0
- package/dist/es/src/utils/authService/authService.d.ts.map +1 -0
- package/dist/es/src/utils/authService/authService.spec.d.ts +2 -0
- package/dist/es/src/utils/authService/authService.spec.d.ts.map +1 -0
- package/dist/es/src/utils/authService/index.d.ts +3 -0
- package/dist/es/src/utils/authService/index.d.ts.map +1 -0
- package/dist/es/src/utils/authService/tokenizedAuthService.d.ts +22 -0
- package/dist/es/src/utils/authService/tokenizedAuthService.d.ts.map +1 -0
- package/dist/es/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
- package/dist/es/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
- package/dist/es/src/utils/global-styles.d.ts +2 -0
- package/dist/es/src/utils/global-styles.d.ts.map +1 -0
- package/dist/es/src/utils/global-styles.spec.d.ts +2 -0
- package/dist/es/src/utils/global-styles.spec.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/answerService/answer-queries.d.ts +10 -0
- package/dist/es/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/answerService/answerService.d.ts +180 -0
- package/dist/es/src/utils/graphql/answerService/answerService.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/answerService/answerService.spec.d.ts +2 -0
- package/dist/es/src/utils/graphql/answerService/answerService.spec.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/graphql-request.d.ts +15 -0
- package/dist/es/src/utils/graphql/graphql-request.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/graphql-request.spec.d.ts +2 -0
- package/dist/es/src/utils/graphql/graphql-request.spec.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/nlsService/conversation-queries.d.ts +3 -0
- package/dist/es/src/utils/graphql/nlsService/conversation-queries.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/nlsService/conversation-service.d.ts +12 -0
- package/dist/es/src/utils/graphql/nlsService/conversation-service.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/nlsService/nls-answer-queries.d.ts +2 -0
- package/dist/es/src/utils/graphql/nlsService/nls-answer-queries.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/nlsService/nls-answer-service.d.ts +17 -0
- package/dist/es/src/utils/graphql/nlsService/nls-answer-service.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/nlsService/nls-answer-service.spec.d.ts +2 -0
- package/dist/es/src/utils/graphql/nlsService/nls-answer-service.spec.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/preview-service.d.ts +9 -0
- package/dist/es/src/utils/graphql/preview-service.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/preview-service.spec.d.ts +2 -0
- package/dist/es/src/utils/graphql/preview-service.spec.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/sourceService.d.ts +8 -0
- package/dist/es/src/utils/graphql/sourceService.d.ts.map +1 -0
- package/dist/es/src/utils/graphql/sourceService.spec.d.ts +2 -0
- package/dist/es/src/utils/graphql/sourceService.spec.d.ts.map +1 -0
- package/dist/es/src/utils/liveboardService/liveboardService.d.ts +16 -0
- package/dist/es/src/utils/liveboardService/liveboardService.d.ts.map +1 -0
- package/dist/es/src/utils/liveboardService/liveboardService.spec.d.ts +2 -0
- package/dist/es/src/utils/liveboardService/liveboardService.spec.d.ts.map +1 -0
- package/dist/es/src/utils/logger.d.ts +18 -0
- package/dist/es/src/utils/logger.d.ts.map +1 -0
- package/dist/es/src/utils/logger.spec.d.ts +25 -0
- package/dist/es/src/utils/logger.spec.d.ts.map +1 -0
- package/dist/es/src/utils/processData.d.ts +22 -0
- package/dist/es/src/utils/processData.d.ts.map +1 -0
- package/dist/es/src/utils/processData.spec.d.ts +2 -0
- package/dist/es/src/utils/processData.spec.d.ts.map +1 -0
- package/dist/es/src/utils/processTrigger.d.ts +16 -0
- package/dist/es/src/utils/processTrigger.d.ts.map +1 -0
- package/dist/es/src/utils/processTrigger.spec.d.ts +2 -0
- package/dist/es/src/utils/processTrigger.spec.d.ts.map +1 -0
- package/dist/es/src/utils/reporting.d.ts +16 -0
- package/dist/es/src/utils/reporting.d.ts.map +1 -0
- package/dist/es/src/utils/reporting.spec.d.ts +2 -0
- package/dist/es/src/utils/reporting.spec.d.ts.map +1 -0
- package/dist/es/src/utils/sessionInfoService.d.ts +66 -0
- package/dist/es/src/utils/sessionInfoService.d.ts.map +1 -0
- package/dist/es/src/utils.d.ts +104 -0
- package/dist/es/src/utils.d.ts.map +1 -0
- package/dist/es/src/utils.spec.d.ts +2 -0
- package/dist/es/src/utils.spec.d.ts.map +1 -0
- package/dist/{index-CmEQfuE3.js → index-B0uCTBbm.js} +1 -1
- package/dist/src/css-variables.d.ts +316 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +6 -1
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/bodyless-conversation.d.ts +0 -1
- package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +63 -3
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +11 -3
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +0 -1
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +0 -1
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +0 -1
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +22 -9
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +190 -55
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/liveboardService/liveboardService.d.ts +21 -6
- package/dist/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
- package/dist/src/utils/processData.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +333 -193
- package/dist/tsembed-react.js +332 -192
- package/dist/tsembed.es.js +354 -199
- package/dist/tsembed.js +353 -198
- package/dist/visual-embed-sdk-react-full.d.ts +619 -77
- package/dist/visual-embed-sdk-react.d.ts +619 -77
- package/dist/visual-embed-sdk.d.ts +619 -77
- package/lib/package.json +7 -6
- package/lib/src/css-variables.d.ts +316 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +6 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +27 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +72 -5
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.d.ts +0 -1
- package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/lib/src/embed/bodyless-conversation.js +3 -7
- package/lib/src/embed/bodyless-conversation.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +63 -3
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +12 -9
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +104 -2
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +11 -3
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +25 -34
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +204 -29
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +0 -1
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +6 -10
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +0 -1
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +7 -11
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +0 -1
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +8 -7
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +22 -9
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +77 -60
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +175 -3
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +190 -55
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +157 -52
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/liveboardService/liveboardService.d.ts +21 -6
- package/lib/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
- package/lib/src/utils/liveboardService/liveboardService.js +21 -6
- package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
- package/lib/src/utils/processData.d.ts.map +1 -1
- package/lib/src/utils/processData.js +10 -0
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +11 -0
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +620 -78
- package/package.json +7 -6
- package/src/css-variables.ts +396 -1
- package/src/embed/app.spec.ts +102 -5
- package/src/embed/app.ts +29 -0
- package/src/embed/bodyless-conversation.ts +3 -9
- package/src/embed/conversation.spec.ts +131 -5
- package/src/embed/conversation.ts +87 -23
- package/src/embed/liveboard.spec.ts +263 -32
- package/src/embed/liveboard.ts +26 -39
- package/src/embed/sage.ts +6 -11
- package/src/embed/search-bar.tsx +7 -14
- package/src/embed/search.ts +7 -18
- package/src/embed/ts-embed.spec.ts +346 -114
- package/src/embed/ts-embed.ts +83 -71
- package/src/types.ts +190 -55
- package/src/utils/liveboardService/liveboardService.ts +21 -6
- package/src/utils/processData.spec.ts +12 -0
- package/src/utils/processData.ts +10 -0
- package/dist/index-DeFzsyFF.js +0 -7371
- package/dist/index-Dpf0rd6w.js +0 -7371
- package/dist/index-UuEbsISo.js +0 -7447
- package/dist/index-e3Uw3YFO.js +0 -7371
- package/dist/index-k7pkZMhx.js +0 -7371
|
@@ -0,0 +1,4363 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright (c) 2023
|
|
3
|
+
*
|
|
4
|
+
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
5
|
+
* @summary Type definitions for Embed SDK
|
|
6
|
+
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
7
|
+
*/
|
|
8
|
+
import { CustomCssVariables } from './css-variables';
|
|
9
|
+
import type { SessionInterface } from './utils/graphql/answerService/answerService';
|
|
10
|
+
/**
|
|
11
|
+
* The authentication mechanism for allowing access to the
|
|
12
|
+
* the embedded app
|
|
13
|
+
* @group Authentication / Init
|
|
14
|
+
*/
|
|
15
|
+
export declare enum AuthType {
|
|
16
|
+
/**
|
|
17
|
+
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
18
|
+
* `Passthrough`.
|
|
19
|
+
* @example
|
|
20
|
+
* ```js
|
|
21
|
+
* init({
|
|
22
|
+
* // ...
|
|
23
|
+
* authType: AuthType.None,
|
|
24
|
+
* });
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
None = "None",
|
|
28
|
+
/**
|
|
29
|
+
* Passthrough SSO to the embedded application within the iframe. Requires least
|
|
30
|
+
* configuration, but may not be supported by all IDPs. This will behave like `None`
|
|
31
|
+
* if SSO is not configured on ThoughtSpot.
|
|
32
|
+
*
|
|
33
|
+
* To use this:
|
|
34
|
+
* Your SAML or OpenID provider must allow iframe redirects.
|
|
35
|
+
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
36
|
+
* @example
|
|
37
|
+
* ```js
|
|
38
|
+
* init({
|
|
39
|
+
* // ...
|
|
40
|
+
* authType: AuthType.EmbeddedSSO,
|
|
41
|
+
* });
|
|
42
|
+
* ```
|
|
43
|
+
* @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl
|
|
44
|
+
*/
|
|
45
|
+
EmbeddedSSO = "EmbeddedSSO",
|
|
46
|
+
/**
|
|
47
|
+
* SSO using SAML
|
|
48
|
+
* @deprecated Use {@link SAMLRedirect} instead
|
|
49
|
+
* @hidden
|
|
50
|
+
*/
|
|
51
|
+
SSO = "SSO_SAML",
|
|
52
|
+
/**
|
|
53
|
+
* SSO using SAML
|
|
54
|
+
* @deprecated Use {@link SAMLRedirect} instead
|
|
55
|
+
* @hidden
|
|
56
|
+
*/
|
|
57
|
+
SAML = "SSO_SAML",
|
|
58
|
+
/**
|
|
59
|
+
* SSO using SAML
|
|
60
|
+
* Makes the host application redirect to the SAML IdP. Use this
|
|
61
|
+
* if your IdP does not allow itself to be embedded.
|
|
62
|
+
*
|
|
63
|
+
* This redirects the host application to the SAML IdP. The host application
|
|
64
|
+
* will be redirected back to the ThoughtSpot app after authentication.
|
|
65
|
+
* @example
|
|
66
|
+
* ```js
|
|
67
|
+
* init({
|
|
68
|
+
* // ...
|
|
69
|
+
* authType: AuthType.SAMLRedirect,
|
|
70
|
+
* });
|
|
71
|
+
* ```
|
|
72
|
+
*
|
|
73
|
+
* This opens the SAML IdP in a popup window. The popup is triggered
|
|
74
|
+
* when the user clicks the trigger button. The popup window will be
|
|
75
|
+
* closed automatically after authentication.
|
|
76
|
+
* @example
|
|
77
|
+
* ```js
|
|
78
|
+
* init({
|
|
79
|
+
* // ...
|
|
80
|
+
* authType: AuthType.SAMLRedirect,
|
|
81
|
+
* authTriggerText: 'Login with SAML',
|
|
82
|
+
* authTriggerContainer: '#embed-container',
|
|
83
|
+
* inPopup: true,
|
|
84
|
+
* });
|
|
85
|
+
* ```
|
|
86
|
+
*
|
|
87
|
+
* Can also use the event to trigger the popup flow. Works the same
|
|
88
|
+
* as the above example.
|
|
89
|
+
* @example
|
|
90
|
+
* ```js
|
|
91
|
+
* const authEE = init({
|
|
92
|
+
* // ...
|
|
93
|
+
* authType: AuthType.SAMLRedirect,
|
|
94
|
+
* inPopup: true,
|
|
95
|
+
* });
|
|
96
|
+
*
|
|
97
|
+
* someButtonOnYourPage.addEventListener('click', () => {
|
|
98
|
+
* authEE.emit(AuthEvent.TRIGGER_SSO_POPUP);
|
|
99
|
+
* });
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
SAMLRedirect = "SSO_SAML",
|
|
103
|
+
/**
|
|
104
|
+
* SSO using OIDC
|
|
105
|
+
* @hidden
|
|
106
|
+
* @deprecated Use {@link OIDCRedirect} instead
|
|
107
|
+
*/
|
|
108
|
+
OIDC = "SSO_OIDC",
|
|
109
|
+
/**
|
|
110
|
+
* SSO using OIDC
|
|
111
|
+
* Will make the host application redirect to the OIDC IdP.
|
|
112
|
+
* See code samples in {@link SAMLRedirect}.
|
|
113
|
+
*/
|
|
114
|
+
OIDCRedirect = "SSO_OIDC",
|
|
115
|
+
/**
|
|
116
|
+
* Trusted authentication server
|
|
117
|
+
* @hidden
|
|
118
|
+
* @deprecated Use {@link TrustedAuth} instead
|
|
119
|
+
*/
|
|
120
|
+
AuthServer = "AuthServer",
|
|
121
|
+
/**
|
|
122
|
+
* Trusted authentication server. Use your own authentication server
|
|
123
|
+
* which returns a bearer token, generated using the `secret_key` obtained
|
|
124
|
+
* from ThoughtSpot.
|
|
125
|
+
* @example
|
|
126
|
+
* ```js
|
|
127
|
+
* init({
|
|
128
|
+
* // ...
|
|
129
|
+
* authType: AuthType.TrustedAuthToken,
|
|
130
|
+
* getAuthToken: () => {
|
|
131
|
+
* return fetch('https://my-backend.app/ts-token')
|
|
132
|
+
* .then((response) => response.json())
|
|
133
|
+
* .then((data) => data.token);
|
|
134
|
+
* }
|
|
135
|
+
* });
|
|
136
|
+
* ```
|
|
137
|
+
*/
|
|
138
|
+
TrustedAuthToken = "AuthServer",
|
|
139
|
+
/**
|
|
140
|
+
* Trusted authentication server Cookieless, Use your own authentication
|
|
141
|
+
* server which returns a bearer token, generated using the `secret_key`
|
|
142
|
+
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
143
|
+
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
144
|
+
* implemented by some browsers.
|
|
145
|
+
* @example
|
|
146
|
+
* ```js
|
|
147
|
+
* init({
|
|
148
|
+
* // ...
|
|
149
|
+
* authType: AuthType.TrustedAuthTokenCookieless,
|
|
150
|
+
* getAuthToken: () => {
|
|
151
|
+
* return fetch('https://my-backend.app/ts-token')
|
|
152
|
+
* .then((response) => response.json())
|
|
153
|
+
* .then((data) => data.token);
|
|
154
|
+
* }
|
|
155
|
+
* ```
|
|
156
|
+
* @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
157
|
+
*/
|
|
158
|
+
TrustedAuthTokenCookieless = "AuthServerCookieless",
|
|
159
|
+
/**
|
|
160
|
+
* Use the ThoughtSpot login API to authenticate to the cluster directly.
|
|
161
|
+
*
|
|
162
|
+
* Warning: This feature is primarily intended for developer testing. It is
|
|
163
|
+
* strongly advised not to use this authentication method in production.
|
|
164
|
+
*/
|
|
165
|
+
Basic = "Basic"
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
*
|
|
169
|
+
* This option does not apply to the classic homepage experience.
|
|
170
|
+
* To access the updated modular homepage,
|
|
171
|
+
* set `modularHomeExperience` to `true`
|
|
172
|
+
* (available as Early Access feature in 9.12.5.cl).
|
|
173
|
+
*
|
|
174
|
+
*/
|
|
175
|
+
export declare enum HomeLeftNavItem {
|
|
176
|
+
/**
|
|
177
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
178
|
+
*/
|
|
179
|
+
SearchData = "search-data",
|
|
180
|
+
/**
|
|
181
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
182
|
+
*/
|
|
183
|
+
Home = "insights-home",
|
|
184
|
+
/**
|
|
185
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
186
|
+
*/
|
|
187
|
+
Liveboards = "liveboards",
|
|
188
|
+
/**
|
|
189
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
190
|
+
*/
|
|
191
|
+
Answers = "answers",
|
|
192
|
+
/**
|
|
193
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
194
|
+
*/
|
|
195
|
+
MonitorSubscription = "monitor-alerts",
|
|
196
|
+
/**
|
|
197
|
+
* @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
|
|
198
|
+
*/
|
|
199
|
+
SpotIQAnalysis = "spotiq-analysis",
|
|
200
|
+
/**
|
|
201
|
+
* @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
|
|
202
|
+
*/
|
|
203
|
+
LiveboardSchedules = "liveboard-schedules"
|
|
204
|
+
}
|
|
205
|
+
export type DOMSelector = string | HTMLElement;
|
|
206
|
+
/**
|
|
207
|
+
* inline customCSS within the {@link CustomisationsInterface}.
|
|
208
|
+
* Use {@link CustomCssVariables} or css rules.
|
|
209
|
+
*/
|
|
210
|
+
export interface customCssInterface {
|
|
211
|
+
/**
|
|
212
|
+
* The custom css variables, which can be set.
|
|
213
|
+
* The allowed list is in the CustomCssVariables
|
|
214
|
+
* interface.
|
|
215
|
+
* Or here: https://try-everywhere.thoughtspot.cloud/resources/static/css/custom_variables.css
|
|
216
|
+
*/
|
|
217
|
+
variables?: CustomCssVariables;
|
|
218
|
+
/**
|
|
219
|
+
* Can be used to define a custom font face
|
|
220
|
+
* like:
|
|
221
|
+
* @example
|
|
222
|
+
* ```js
|
|
223
|
+
* rules_UNSTABLE?: {
|
|
224
|
+
* "@font-face": {
|
|
225
|
+
* "font-family": "custom-font",
|
|
226
|
+
* "src": url("/path/")
|
|
227
|
+
* };
|
|
228
|
+
* };
|
|
229
|
+
* ```
|
|
230
|
+
*
|
|
231
|
+
* Also, custom css rules outside of variables.
|
|
232
|
+
* @example
|
|
233
|
+
* ```js
|
|
234
|
+
* rules_UNSTABLE?: {
|
|
235
|
+
* ".thoughtspot_class_name": {
|
|
236
|
+
* "border-radius": "10px",
|
|
237
|
+
* margin: "20px"
|
|
238
|
+
* };
|
|
239
|
+
* };
|
|
240
|
+
* ```
|
|
241
|
+
*/
|
|
242
|
+
rules_UNSTABLE?: {
|
|
243
|
+
[selector: string]: {
|
|
244
|
+
[declaration: string]: string;
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Styles within the {@link CustomisationsInterface}.
|
|
250
|
+
*/
|
|
251
|
+
export interface CustomStyles {
|
|
252
|
+
customCSSUrl?: string;
|
|
253
|
+
customCSS?: customCssInterface;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Configuration to define the customization on the Embedded
|
|
257
|
+
* Thoughtspot components.
|
|
258
|
+
* You can customize styles, text strings, and icons.
|
|
259
|
+
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
260
|
+
* @example
|
|
261
|
+
* ```js
|
|
262
|
+
* init({
|
|
263
|
+
* // ...
|
|
264
|
+
* customizations: {
|
|
265
|
+
* style: {
|
|
266
|
+
* customCSS: {
|
|
267
|
+
* variables: {},
|
|
268
|
+
* rules_UNSTABLE: {}
|
|
269
|
+
* }
|
|
270
|
+
* },
|
|
271
|
+
* content: {
|
|
272
|
+
* strings: {
|
|
273
|
+
* 'LIVEBOARDS': 'Dashboards',
|
|
274
|
+
* 'ANSWERS': 'Visualizations',
|
|
275
|
+
* 'Edit': 'Modify',
|
|
276
|
+
* 'Show underlying data': 'Show source data',
|
|
277
|
+
* 'SpotIQ': 'Insights',
|
|
278
|
+
* 'Monitor': 'Alerts',
|
|
279
|
+
* }
|
|
280
|
+
* },
|
|
281
|
+
* iconSpriteUrl: 'https://my-custom-icon-sprite.svg'
|
|
282
|
+
* }
|
|
283
|
+
* })
|
|
284
|
+
* ```
|
|
285
|
+
*/
|
|
286
|
+
export interface CustomisationsInterface {
|
|
287
|
+
style?: CustomStyles;
|
|
288
|
+
content?: {
|
|
289
|
+
/**
|
|
290
|
+
* @version SDK: 1.26.0 | 9.7.0.cl
|
|
291
|
+
*/
|
|
292
|
+
strings?: Record<string, any>;
|
|
293
|
+
[key: string]: any;
|
|
294
|
+
};
|
|
295
|
+
iconSpriteUrl?: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* The configuration object for embedding ThoughtSpot content.
|
|
299
|
+
* It includes the ThoughtSpot hostname or IP address,
|
|
300
|
+
* the type of authentication, and the authentication endpoint
|
|
301
|
+
* if a trusted authentication server is used.
|
|
302
|
+
* @group Authentication / Init
|
|
303
|
+
*/
|
|
304
|
+
export interface EmbedConfig {
|
|
305
|
+
/**
|
|
306
|
+
* The ThoughtSpot cluster hostname or IP address.
|
|
307
|
+
*/
|
|
308
|
+
thoughtSpotHost: string;
|
|
309
|
+
/**
|
|
310
|
+
* The authentication mechanism to use.
|
|
311
|
+
*/
|
|
312
|
+
authType: AuthType;
|
|
313
|
+
/**
|
|
314
|
+
* [AuthServer] The trusted authentication endpoint to use to get the
|
|
315
|
+
* authentication token. A `GET` request is made to the
|
|
316
|
+
* authentication API endpoint, which returns the token
|
|
317
|
+
* as a plaintext response. For trusted authentication,
|
|
318
|
+
* the `authEndpoint` or `getAuthToken` attribute is required.
|
|
319
|
+
*/
|
|
320
|
+
authEndpoint?: string;
|
|
321
|
+
/**
|
|
322
|
+
* [AuthServer] A function that invokes the trusted authentication endpoint
|
|
323
|
+
* and returns a Promise that resolves to the `auth token` string.
|
|
324
|
+
* For trusted authentication, the `authEndpoint` or `getAuthToken`
|
|
325
|
+
* attribute is required.
|
|
326
|
+
*
|
|
327
|
+
* It is advisable to fetch a new token inside this method and not
|
|
328
|
+
* reuse the old issued token. When auth expires this method is
|
|
329
|
+
* called again and if it is called with an older token, the authentication
|
|
330
|
+
* will not succeed.
|
|
331
|
+
*/
|
|
332
|
+
getAuthToken?: () => Promise<string>;
|
|
333
|
+
/**
|
|
334
|
+
* [AuthServer / Basic] The user name of the ThoughtSpot user. This
|
|
335
|
+
* attribute is required for trusted authentication.
|
|
336
|
+
*/
|
|
337
|
+
username?: string;
|
|
338
|
+
/**
|
|
339
|
+
* [Basic] The ThoughtSpot login password corresponding to the username
|
|
340
|
+
*
|
|
341
|
+
* Warning: This feature is primarily intended for developer testing. It is
|
|
342
|
+
* strongly advised not to use this authentication method in production.
|
|
343
|
+
*/
|
|
344
|
+
password?: string;
|
|
345
|
+
/**
|
|
346
|
+
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
347
|
+
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
348
|
+
* place.
|
|
349
|
+
* @default false
|
|
350
|
+
* @deprecated
|
|
351
|
+
*/
|
|
352
|
+
noRedirect?: boolean;
|
|
353
|
+
/**
|
|
354
|
+
* [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
|
|
355
|
+
* the SAML auth flow in a popup, instead of redirecting the browser in place.
|
|
356
|
+
*
|
|
357
|
+
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
358
|
+
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
359
|
+
* @default false
|
|
360
|
+
* @version SDK: 1.18.0
|
|
361
|
+
*/
|
|
362
|
+
inPopup?: boolean;
|
|
363
|
+
/**
|
|
364
|
+
* [SSO] For SSO Authentication, one can supply an optional path param;
|
|
365
|
+
* This will be the path on the host origin where the SAML flow will be
|
|
366
|
+
* terminated.
|
|
367
|
+
*
|
|
368
|
+
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
369
|
+
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
370
|
+
*/
|
|
371
|
+
redirectPath?: string;
|
|
372
|
+
/** @internal */
|
|
373
|
+
basepath?: string;
|
|
374
|
+
/**
|
|
375
|
+
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
376
|
+
* should be encoded in base64. This provides additional security to
|
|
377
|
+
* Thoughtspot clusters against cross-site scripting attacks.
|
|
378
|
+
* @default false
|
|
379
|
+
*/
|
|
380
|
+
shouldEncodeUrlQueryParams?: boolean;
|
|
381
|
+
/**
|
|
382
|
+
* Suppress cookie access alert when third-party cookies are blocked by the
|
|
383
|
+
* user's browser. Third-party cookie blocking is the default behaviour on
|
|
384
|
+
* some web browsers like Safari. If you set this attribute to `true`,
|
|
385
|
+
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
386
|
+
* in this case.
|
|
387
|
+
* @default false
|
|
388
|
+
*/
|
|
389
|
+
suppressNoCookieAccessAlert?: boolean;
|
|
390
|
+
/**
|
|
391
|
+
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
392
|
+
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
393
|
+
* persists even in the case of a non-logged-in user.
|
|
394
|
+
* @default false
|
|
395
|
+
*/
|
|
396
|
+
ignoreNoCookieAccess?: boolean;
|
|
397
|
+
/**
|
|
398
|
+
* Re-login a user with the previous login options
|
|
399
|
+
* when a user session expires.
|
|
400
|
+
* @default false
|
|
401
|
+
*/
|
|
402
|
+
autoLogin?: boolean;
|
|
403
|
+
/**
|
|
404
|
+
* Disable redirection to the login page when the embedded session expires
|
|
405
|
+
* This flag is typically used alongside the combination of authentication modes such
|
|
406
|
+
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
407
|
+
* EmbedConfig.autoLogin}
|
|
408
|
+
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
409
|
+
* @default false
|
|
410
|
+
*/
|
|
411
|
+
disableLoginRedirect?: boolean;
|
|
412
|
+
/**
|
|
413
|
+
* This message is displayed in the embedded view when a user login fails.
|
|
414
|
+
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
415
|
+
*/
|
|
416
|
+
loginFailedMessage?: string;
|
|
417
|
+
/**
|
|
418
|
+
* Calls the prefetch method internally when set to `true`
|
|
419
|
+
* @default false
|
|
420
|
+
*/
|
|
421
|
+
callPrefetch?: boolean;
|
|
422
|
+
/**
|
|
423
|
+
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
424
|
+
* to start after the previous embed's render is complete. This helps improve
|
|
425
|
+
* performance by decreasing the load on the browser.
|
|
426
|
+
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
427
|
+
* @default false
|
|
428
|
+
*/
|
|
429
|
+
queueMultiRenders?: boolean;
|
|
430
|
+
/**
|
|
431
|
+
* [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
|
|
432
|
+
* additional call. This is slower and should be avoided. Listen to the
|
|
433
|
+
* `NO_COOKIE_ACCESS` event to handle the situation.
|
|
434
|
+
*
|
|
435
|
+
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
436
|
+
* involves an extra network call.
|
|
437
|
+
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
438
|
+
*/
|
|
439
|
+
detectCookieAccessSlow?: boolean;
|
|
440
|
+
/**
|
|
441
|
+
* Hide the `beta` alert warning message for SearchEmbed.
|
|
442
|
+
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
443
|
+
*/
|
|
444
|
+
suppressSearchEmbedBetaWarning?: boolean;
|
|
445
|
+
/**
|
|
446
|
+
* Hide `beta` alert warning message for SageEmbed.
|
|
447
|
+
*
|
|
448
|
+
*/
|
|
449
|
+
suppressSageEmbedBetaWarning?: boolean;
|
|
450
|
+
/**
|
|
451
|
+
* Custom style params for embed Config.
|
|
452
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
453
|
+
*/
|
|
454
|
+
customizations?: CustomisationsInterface;
|
|
455
|
+
/**
|
|
456
|
+
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
457
|
+
* button that the user can click to trigger the flow.
|
|
458
|
+
* This attribute sets a containing element for that button.
|
|
459
|
+
* @example
|
|
460
|
+
* ```js
|
|
461
|
+
* init({
|
|
462
|
+
* authType: AuthType.SAMLRedirect,
|
|
463
|
+
* inPopup: true,
|
|
464
|
+
* authTriggerContainer: '#auth-trigger-container'
|
|
465
|
+
* })
|
|
466
|
+
* ```
|
|
467
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
468
|
+
*/
|
|
469
|
+
authTriggerContainer?: string | HTMLElement;
|
|
470
|
+
/**
|
|
471
|
+
* Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger
|
|
472
|
+
* SAML popup. This is useful when you want to trigger the popup on a custom user
|
|
473
|
+
* action.
|
|
474
|
+
*
|
|
475
|
+
*/
|
|
476
|
+
useEventForSAMLPopup?: boolean;
|
|
477
|
+
/**
|
|
478
|
+
* Text to show in the button which triggers the popup auth flow.
|
|
479
|
+
* Default: `Authorize`.
|
|
480
|
+
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
481
|
+
*/
|
|
482
|
+
authTriggerText?: string;
|
|
483
|
+
/**
|
|
484
|
+
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
485
|
+
* access to the embedded application users
|
|
486
|
+
* outside of the iframe.
|
|
487
|
+
* @default true
|
|
488
|
+
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
489
|
+
*/
|
|
490
|
+
blockNonEmbedFullAppAccess?: boolean;
|
|
491
|
+
/**
|
|
492
|
+
* Host config in case embedded app is inside TS app itself
|
|
493
|
+
* @hidden
|
|
494
|
+
*/
|
|
495
|
+
hostConfig?: {
|
|
496
|
+
hostUserGuid: string;
|
|
497
|
+
hostClusterId: string;
|
|
498
|
+
hostClusterName: string;
|
|
499
|
+
};
|
|
500
|
+
/**
|
|
501
|
+
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
502
|
+
* is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
|
|
503
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
504
|
+
*/
|
|
505
|
+
pendoTrackingKey?: string;
|
|
506
|
+
/**
|
|
507
|
+
* If passed as true all alerts will be suppressed in the embedded app.
|
|
508
|
+
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
509
|
+
*/
|
|
510
|
+
suppressErrorAlerts?: boolean;
|
|
511
|
+
/**
|
|
512
|
+
* Log level for the SDK.
|
|
513
|
+
* @default LogLevel.ERROR
|
|
514
|
+
* @example
|
|
515
|
+
* ```js
|
|
516
|
+
* init({
|
|
517
|
+
* ...embedConfig,
|
|
518
|
+
* logLevel: LogLevel.SILENT
|
|
519
|
+
* })
|
|
520
|
+
* ```
|
|
521
|
+
* @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
|
|
522
|
+
*/
|
|
523
|
+
logLevel?: LogLevel;
|
|
524
|
+
/**
|
|
525
|
+
* Disables the Mixpanel tracking from the SDK.
|
|
526
|
+
* @version SDK: 1.27.9
|
|
527
|
+
*/
|
|
528
|
+
disableSDKTracking?: boolean;
|
|
529
|
+
/**
|
|
530
|
+
* Overrides default/user preffered locale for date formatting
|
|
531
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
532
|
+
*/
|
|
533
|
+
dateFormatLocale?: string;
|
|
534
|
+
/**
|
|
535
|
+
* Overrides default/user preffered locale for number formatting
|
|
536
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
537
|
+
*/
|
|
538
|
+
numberFormatLocale?: string;
|
|
539
|
+
/**
|
|
540
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
541
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
542
|
+
*/
|
|
543
|
+
currencyFormat?: string;
|
|
544
|
+
/**
|
|
545
|
+
* This flag is used to disable the token verification in the SDK.
|
|
546
|
+
* Enabling this flag will also disable the caching of the token.
|
|
547
|
+
* @hidden
|
|
548
|
+
* @example
|
|
549
|
+
* ```js
|
|
550
|
+
* init({
|
|
551
|
+
* ...embedConfig,
|
|
552
|
+
* disableTokenVerification : true
|
|
553
|
+
* })
|
|
554
|
+
* ```
|
|
555
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
556
|
+
*/
|
|
557
|
+
disableTokenVerification?: boolean;
|
|
558
|
+
/**
|
|
559
|
+
* This flag is used to disable showing the login failure page in the embedded app.
|
|
560
|
+
* @version SDK 1.32.3 | Thoughtspot: *
|
|
561
|
+
*/
|
|
562
|
+
disableLoginFailurePage?: boolean;
|
|
563
|
+
}
|
|
564
|
+
export interface LayoutConfig {
|
|
565
|
+
}
|
|
566
|
+
/**
|
|
567
|
+
* Embedded iframe configuration
|
|
568
|
+
* @group Embed components
|
|
569
|
+
*/
|
|
570
|
+
export interface FrameParams {
|
|
571
|
+
/**
|
|
572
|
+
* The width of the iframe (unit is pixels if numeric).
|
|
573
|
+
*/
|
|
574
|
+
width?: number | string;
|
|
575
|
+
/**
|
|
576
|
+
* The height of the iframe (unit is pixels if numeric).
|
|
577
|
+
*/
|
|
578
|
+
height?: number | string;
|
|
579
|
+
/**
|
|
580
|
+
* Set to 'lazy' to enable lazy loading of the embedded TS frame.
|
|
581
|
+
* This will defer loading of the frame until it comes into the
|
|
582
|
+
* viewport. This is useful for performance optimization.
|
|
583
|
+
*/
|
|
584
|
+
loading?: 'lazy' | 'eager' | 'auto';
|
|
585
|
+
/**
|
|
586
|
+
* This parameters will be passed on the iframe
|
|
587
|
+
* as is.
|
|
588
|
+
*/
|
|
589
|
+
[key: string]: string | number | boolean | undefined;
|
|
590
|
+
}
|
|
591
|
+
/**
|
|
592
|
+
* The configuration object for an embedded view.
|
|
593
|
+
*/
|
|
594
|
+
export interface ViewConfig {
|
|
595
|
+
/**
|
|
596
|
+
* @hidden
|
|
597
|
+
*/
|
|
598
|
+
layoutConfig?: LayoutConfig;
|
|
599
|
+
/**
|
|
600
|
+
* The width and height dimensions to render an embedded
|
|
601
|
+
* object inside your app. Specify the values in pixels or percentage.
|
|
602
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
603
|
+
* @example
|
|
604
|
+
* ```js
|
|
605
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
606
|
+
* ... // other liveboard view config
|
|
607
|
+
* frameParams: {
|
|
608
|
+
* width: '500px' | '50%',
|
|
609
|
+
* height: '400px' | '60%',
|
|
610
|
+
* },
|
|
611
|
+
* });
|
|
612
|
+
* ```
|
|
613
|
+
*/
|
|
614
|
+
frameParams?: FrameParams;
|
|
615
|
+
/**
|
|
616
|
+
* @hidden
|
|
617
|
+
*/
|
|
618
|
+
theme?: string;
|
|
619
|
+
/**
|
|
620
|
+
* @hidden
|
|
621
|
+
*/
|
|
622
|
+
styleSheet__unstable?: string;
|
|
623
|
+
/**
|
|
624
|
+
* The list of actions to disable from the primary menu, more menu
|
|
625
|
+
* (...), and the contextual menu. These actions will be disabled
|
|
626
|
+
* for the user.
|
|
627
|
+
* Use this to disable actions.
|
|
628
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
629
|
+
* @example
|
|
630
|
+
* ```js
|
|
631
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
632
|
+
* ... // other liveboard view config
|
|
633
|
+
* disabledActions: [Action.Download, Action.Save]
|
|
634
|
+
* });
|
|
635
|
+
* ```
|
|
636
|
+
*/
|
|
637
|
+
disabledActions?: Action[];
|
|
638
|
+
/**
|
|
639
|
+
* The tooltip to display for disabled actions.
|
|
640
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
641
|
+
* @example
|
|
642
|
+
* ```js
|
|
643
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
644
|
+
* ... // other liveboard view config
|
|
645
|
+
* disabledActions: [Action.Download, Action.Save]
|
|
646
|
+
* disabledActionReason: "Reason for disabling",
|
|
647
|
+
* });
|
|
648
|
+
* ```
|
|
649
|
+
*/
|
|
650
|
+
disabledActionReason?: string;
|
|
651
|
+
/**
|
|
652
|
+
* The list of actions to hide from the embedded.
|
|
653
|
+
* This actions will be hidden from the user.
|
|
654
|
+
* Use this to hide an action.
|
|
655
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
656
|
+
* @example
|
|
657
|
+
* ```js
|
|
658
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
659
|
+
* ... // other liveboard view config
|
|
660
|
+
* hiddenActions: [Action.Download, Action.Export]
|
|
661
|
+
* });
|
|
662
|
+
* ```
|
|
663
|
+
* @important
|
|
664
|
+
*/
|
|
665
|
+
hiddenActions?: Action[];
|
|
666
|
+
/**
|
|
667
|
+
* The list of actions to display from the primary menu, more menu
|
|
668
|
+
* (...), and the contextual menu. These will be only actions that
|
|
669
|
+
* are visible to the user.
|
|
670
|
+
* Use this to hide all actions except the ones you want to show.
|
|
671
|
+
*
|
|
672
|
+
* Use either this or hiddenActions.
|
|
673
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
674
|
+
* @important
|
|
675
|
+
* @example
|
|
676
|
+
* ```js
|
|
677
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
678
|
+
* ... // other liveboard view config
|
|
679
|
+
* visibleActions: [Action.Download, Action.Export]
|
|
680
|
+
* });
|
|
681
|
+
* ```
|
|
682
|
+
*/
|
|
683
|
+
visibleActions?: Action[];
|
|
684
|
+
/**
|
|
685
|
+
* Show alert messages and toast messages in the embedded
|
|
686
|
+
* view in full app embed.
|
|
687
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
688
|
+
* @example
|
|
689
|
+
* ```js
|
|
690
|
+
* const embed = new AppEmbed('#embed-container', {
|
|
691
|
+
* ... // other options
|
|
692
|
+
* showAlerts:true,
|
|
693
|
+
* })
|
|
694
|
+
* ```
|
|
695
|
+
*/
|
|
696
|
+
showAlerts?: boolean;
|
|
697
|
+
/**
|
|
698
|
+
* The list of runtime filters to apply to a search answer,
|
|
699
|
+
* visualization, or Liveboard.
|
|
700
|
+
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
701
|
+
* @example
|
|
702
|
+
* ```js
|
|
703
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
704
|
+
* ... // other options
|
|
705
|
+
* runtimeFilters: [
|
|
706
|
+
* {
|
|
707
|
+
* columnName: 'value',
|
|
708
|
+
* operator: RuntimeFilterOp.EQ,
|
|
709
|
+
* values: ['string' | 123 | true],
|
|
710
|
+
* },
|
|
711
|
+
* ],
|
|
712
|
+
* })
|
|
713
|
+
* ```
|
|
714
|
+
*/
|
|
715
|
+
runtimeFilters?: RuntimeFilter[];
|
|
716
|
+
/**
|
|
717
|
+
* The list of parameter override to apply to a search answer,
|
|
718
|
+
* visualization, or Liveboard.
|
|
719
|
+
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
720
|
+
* @example
|
|
721
|
+
* ```js
|
|
722
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
723
|
+
* ... // other options
|
|
724
|
+
* runtimeParameters: [
|
|
725
|
+
* {
|
|
726
|
+
* name: 'value',
|
|
727
|
+
* value: 'string' | 123 | true,
|
|
728
|
+
* },
|
|
729
|
+
* ],
|
|
730
|
+
* })
|
|
731
|
+
* ```
|
|
732
|
+
*/
|
|
733
|
+
runtimeParameters?: RuntimeParameter[];
|
|
734
|
+
/**
|
|
735
|
+
* The locale/language to use for the embedded view.
|
|
736
|
+
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
737
|
+
* @example
|
|
738
|
+
* ```js
|
|
739
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
740
|
+
* ... // other options
|
|
741
|
+
* locale:'en',
|
|
742
|
+
* })
|
|
743
|
+
* ```
|
|
744
|
+
*/
|
|
745
|
+
locale?: string;
|
|
746
|
+
/**
|
|
747
|
+
* This is an object (key/val) of override flags which will be applied
|
|
748
|
+
* to the internal embedded object. This can be used to add any
|
|
749
|
+
* URL flag.
|
|
750
|
+
* Warning: This option is for advanced use only and is used internally
|
|
751
|
+
* to control embed behavior in non-regular ways. We do not publish the
|
|
752
|
+
* list of supported keys and values associated with each.
|
|
753
|
+
* @example
|
|
754
|
+
* ```js
|
|
755
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
756
|
+
* ... // other liveboard view config
|
|
757
|
+
* additionalFlags: {
|
|
758
|
+
* flag1: 'value1',
|
|
759
|
+
* flag2: 'value2'
|
|
760
|
+
* }
|
|
761
|
+
* });
|
|
762
|
+
* ```
|
|
763
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
764
|
+
*/
|
|
765
|
+
additionalFlags?: {
|
|
766
|
+
[key: string]: string | number | boolean;
|
|
767
|
+
};
|
|
768
|
+
/**
|
|
769
|
+
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
770
|
+
* You would also need to set `style-src` in the CSP settings.
|
|
771
|
+
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
772
|
+
* @default ''
|
|
773
|
+
*/
|
|
774
|
+
customizations?: CustomisationsInterface;
|
|
775
|
+
/**
|
|
776
|
+
* Insert as a sibling of the target container, instead of appending to a
|
|
777
|
+
* child inside it.
|
|
778
|
+
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
779
|
+
* @example
|
|
780
|
+
* ```js
|
|
781
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
782
|
+
* ... // other options
|
|
783
|
+
* insertAsSibling:true,
|
|
784
|
+
* })
|
|
785
|
+
* ```
|
|
786
|
+
*/
|
|
787
|
+
insertAsSibling?: boolean;
|
|
788
|
+
/**
|
|
789
|
+
* flag to set ContextMenu Trigger to either left or right click.
|
|
790
|
+
* @example
|
|
791
|
+
* ```js
|
|
792
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
793
|
+
* ... // other options
|
|
794
|
+
* contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
|
|
795
|
+
* })
|
|
796
|
+
* ```
|
|
797
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
798
|
+
*/
|
|
799
|
+
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
800
|
+
/**
|
|
801
|
+
* Flag to override openNew tab context menu link
|
|
802
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
803
|
+
* @example
|
|
804
|
+
* ```js
|
|
805
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
806
|
+
* ... // other options
|
|
807
|
+
* linkOverride:false,
|
|
808
|
+
* })
|
|
809
|
+
* ```
|
|
810
|
+
*/
|
|
811
|
+
linkOverride?: boolean;
|
|
812
|
+
/**
|
|
813
|
+
* flag to enable insert into slides action
|
|
814
|
+
* @hidden
|
|
815
|
+
* @private
|
|
816
|
+
*/
|
|
817
|
+
insertInToSlide?: boolean;
|
|
818
|
+
/**
|
|
819
|
+
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
820
|
+
* if available and matches the configuration.
|
|
821
|
+
* @version SDK: 1.22.0
|
|
822
|
+
* @hidden
|
|
823
|
+
*
|
|
824
|
+
* See [docs]() on how to create a prerender pool.
|
|
825
|
+
*/
|
|
826
|
+
usePrerenderedIfAvailable?: boolean;
|
|
827
|
+
/**
|
|
828
|
+
* Boolean to exclude runtimeFilters in the URL
|
|
829
|
+
* By default it is true, this flag removes runtime filters from the URL
|
|
830
|
+
* when set to false, runtime filters will be included in the URL.
|
|
831
|
+
*
|
|
832
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
833
|
+
* embedded view.
|
|
834
|
+
* @default false
|
|
835
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
836
|
+
*/
|
|
837
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
838
|
+
/**
|
|
839
|
+
* The list of tab IDs to hide from the embedded.
|
|
840
|
+
* This Tabs will be hidden from their respective LBs.
|
|
841
|
+
* Use this to hide an tabID.
|
|
842
|
+
* @example
|
|
843
|
+
* ```js
|
|
844
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
845
|
+
* ... // other liveboard view config
|
|
846
|
+
* hiddenTabs: [
|
|
847
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
848
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726']
|
|
849
|
+
* });
|
|
850
|
+
* ```
|
|
851
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
852
|
+
*/
|
|
853
|
+
hiddenTabs?: string[];
|
|
854
|
+
/**
|
|
855
|
+
* Hide the home page modules
|
|
856
|
+
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
857
|
+
*
|
|
858
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
859
|
+
* To access the updated modular homepage, set
|
|
860
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
861
|
+
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
862
|
+
* @example
|
|
863
|
+
* ```js
|
|
864
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
865
|
+
* ... // other options
|
|
866
|
+
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
867
|
+
* })
|
|
868
|
+
* ```
|
|
869
|
+
*/
|
|
870
|
+
hiddenHomepageModules?: HomepageModule[];
|
|
871
|
+
/**
|
|
872
|
+
* reordering the home page modules
|
|
873
|
+
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
874
|
+
*
|
|
875
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
876
|
+
* To access the updated modular homepage, set
|
|
877
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
878
|
+
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
879
|
+
* @example
|
|
880
|
+
* ```js
|
|
881
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
882
|
+
* ... // other options
|
|
883
|
+
* reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
|
|
884
|
+
* })
|
|
885
|
+
* ```
|
|
886
|
+
*/
|
|
887
|
+
reorderedHomepageModules?: HomepageModule[];
|
|
888
|
+
/**
|
|
889
|
+
* The list of tab IDs to show in the embedded Liveboard.
|
|
890
|
+
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
891
|
+
*
|
|
892
|
+
* Use either `visibleTabs` or `hiddenTabs`.
|
|
893
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
894
|
+
* @example
|
|
895
|
+
* ```js
|
|
896
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
897
|
+
* ... // other options
|
|
898
|
+
* visibleTabs: [
|
|
899
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
900
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'
|
|
901
|
+
* ]
|
|
902
|
+
* })
|
|
903
|
+
* ```
|
|
904
|
+
*/
|
|
905
|
+
visibleTabs?: string[];
|
|
906
|
+
/**
|
|
907
|
+
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
908
|
+
* There are 8 eight home navigation list items.
|
|
909
|
+
* To hide these items, specify the string in the array.
|
|
910
|
+
* @example
|
|
911
|
+
* ```js
|
|
912
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
913
|
+
* ... // other options
|
|
914
|
+
* hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
|
|
915
|
+
* })
|
|
916
|
+
* ```
|
|
917
|
+
*
|
|
918
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
919
|
+
* To access the updated modular homepage, set
|
|
920
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
921
|
+
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
922
|
+
*/
|
|
923
|
+
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
924
|
+
/**
|
|
925
|
+
* PreRender id to be used for PreRendering the embed.
|
|
926
|
+
* Use PreRender to render the embed in the background and then
|
|
927
|
+
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
928
|
+
* @example
|
|
929
|
+
* ```js
|
|
930
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
931
|
+
* ... // other liveboard view config
|
|
932
|
+
* preRenderId: "preRenderId-123"
|
|
933
|
+
* });
|
|
934
|
+
* embed.showPreRender();
|
|
935
|
+
* ```
|
|
936
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
937
|
+
*/
|
|
938
|
+
preRenderId?: string;
|
|
939
|
+
/**
|
|
940
|
+
* Determines whether the PreRender component should not dynamically track the size
|
|
941
|
+
* of its embedding element and adjust its own size accordingly.
|
|
942
|
+
* Enabling this option allows the PreRender component to automatically adapt
|
|
943
|
+
* its dimensions based on changes to the size of the embedding element.
|
|
944
|
+
* @type {boolean}
|
|
945
|
+
* @default false
|
|
946
|
+
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
947
|
+
* @example
|
|
948
|
+
* ```js
|
|
949
|
+
* // Disable tracking PreRender size in the configuration
|
|
950
|
+
* const config = {
|
|
951
|
+
* doNotTrackPreRenderSize: true,
|
|
952
|
+
* };
|
|
953
|
+
*
|
|
954
|
+
* // Instantiate an object with the configuration
|
|
955
|
+
* const myComponent = new MyComponent(config);
|
|
956
|
+
* ```
|
|
957
|
+
*/
|
|
958
|
+
doNotTrackPreRenderSize?: boolean;
|
|
959
|
+
/**
|
|
960
|
+
* For internal tracking of the embed component type.
|
|
961
|
+
* @hidden
|
|
962
|
+
*/
|
|
963
|
+
embedComponentType?: string;
|
|
964
|
+
/**
|
|
965
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
966
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
967
|
+
*
|
|
968
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
969
|
+
* embedded view.
|
|
970
|
+
* @default false
|
|
971
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
972
|
+
*/
|
|
973
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
974
|
+
/**
|
|
975
|
+
* Enable the V2 shell. This can provide performance benefits
|
|
976
|
+
* due to a lighterweight shell.
|
|
977
|
+
* @example
|
|
978
|
+
* ```js
|
|
979
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
980
|
+
* liveboardId: '123',
|
|
981
|
+
* enableV2Shell_experimental: true
|
|
982
|
+
* });
|
|
983
|
+
* ```
|
|
984
|
+
* @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
|
|
985
|
+
*/
|
|
986
|
+
enableV2Shell_experimental?: boolean;
|
|
987
|
+
/**
|
|
988
|
+
* To set the initial state of the search bar in case of saved-answers.
|
|
989
|
+
* @default true
|
|
990
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
991
|
+
* @example
|
|
992
|
+
* ```js
|
|
993
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
994
|
+
* liveboardId: '123',
|
|
995
|
+
* collapseSearchBar: true
|
|
996
|
+
* });
|
|
997
|
+
*/
|
|
998
|
+
collapseSearchBar?: boolean;
|
|
999
|
+
/**
|
|
1000
|
+
* This flag can be used to disable links inside the embedded app,
|
|
1001
|
+
* and disables redirection of links in a new tab.
|
|
1002
|
+
* @example
|
|
1003
|
+
* ```js
|
|
1004
|
+
* const embed = new LiveboardEmbed('#embed', {
|
|
1005
|
+
* disableRedirectionLinksInNewTab: true
|
|
1006
|
+
* });
|
|
1007
|
+
* ```
|
|
1008
|
+
* @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
|
|
1009
|
+
*/
|
|
1010
|
+
disableRedirectionLinksInNewTab?: boolean;
|
|
1011
|
+
/**
|
|
1012
|
+
* Flag to control Data panel experience
|
|
1013
|
+
* @default true
|
|
1014
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
1015
|
+
* @example
|
|
1016
|
+
* ```js
|
|
1017
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1018
|
+
* ... // other options
|
|
1019
|
+
* dataPanelV2: true,
|
|
1020
|
+
* })
|
|
1021
|
+
* ```
|
|
1022
|
+
*/
|
|
1023
|
+
dataPanelV2?: boolean;
|
|
1024
|
+
/**
|
|
1025
|
+
* To enable custom column groups in data panel v2
|
|
1026
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1027
|
+
* @default false
|
|
1028
|
+
* @example
|
|
1029
|
+
* ```js
|
|
1030
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
1031
|
+
* ... // other options
|
|
1032
|
+
* enableCustomColumnGroups: true,
|
|
1033
|
+
* });
|
|
1034
|
+
* ```
|
|
1035
|
+
*/
|
|
1036
|
+
enableCustomColumnGroups?: boolean;
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
1040
|
+
* @group Events
|
|
1041
|
+
*/
|
|
1042
|
+
export type MessagePayload = {
|
|
1043
|
+
type: string;
|
|
1044
|
+
data: any;
|
|
1045
|
+
status?: string;
|
|
1046
|
+
};
|
|
1047
|
+
/**
|
|
1048
|
+
* MessageOptions: By providing options, getting specific event start / end based on
|
|
1049
|
+
* option
|
|
1050
|
+
* @group Events
|
|
1051
|
+
*/
|
|
1052
|
+
export type MessageOptions = {
|
|
1053
|
+
/**
|
|
1054
|
+
* A boolean value indicating that start status events of this type
|
|
1055
|
+
* will be dispatched.
|
|
1056
|
+
*/
|
|
1057
|
+
start?: boolean;
|
|
1058
|
+
};
|
|
1059
|
+
/**
|
|
1060
|
+
* MessageCallback: Embed event message callback
|
|
1061
|
+
* @group Events
|
|
1062
|
+
*/
|
|
1063
|
+
export type MessageCallback = (payload: MessagePayload,
|
|
1064
|
+
/**
|
|
1065
|
+
* responder: Message callback function triggered when embed event
|
|
1066
|
+
* initiated
|
|
1067
|
+
*/
|
|
1068
|
+
responder?: (data: any) => void) => void;
|
|
1069
|
+
/**
|
|
1070
|
+
* MessageCallbackObj: contains message options & callback function
|
|
1071
|
+
*/
|
|
1072
|
+
export type MessageCallbackObj = {
|
|
1073
|
+
/**
|
|
1074
|
+
* options: It contains start, a boolean value indicating that start
|
|
1075
|
+
* status events of this type will be dispatched
|
|
1076
|
+
*/
|
|
1077
|
+
options: MessageOptions;
|
|
1078
|
+
callback: MessageCallback;
|
|
1079
|
+
};
|
|
1080
|
+
export type GenericCallbackFn = (...args: any[]) => any;
|
|
1081
|
+
export type QueryParams = {
|
|
1082
|
+
[key: string]: string;
|
|
1083
|
+
};
|
|
1084
|
+
/**
|
|
1085
|
+
* A map of the supported runtime filter operations
|
|
1086
|
+
*/
|
|
1087
|
+
export declare enum RuntimeFilterOp {
|
|
1088
|
+
/**
|
|
1089
|
+
* Equals
|
|
1090
|
+
*/
|
|
1091
|
+
EQ = "EQ",
|
|
1092
|
+
/**
|
|
1093
|
+
* Does not equal
|
|
1094
|
+
*/
|
|
1095
|
+
NE = "NE",
|
|
1096
|
+
/**
|
|
1097
|
+
* Less than
|
|
1098
|
+
*/
|
|
1099
|
+
LT = "LT",
|
|
1100
|
+
/**
|
|
1101
|
+
* Less than or equal to
|
|
1102
|
+
*/
|
|
1103
|
+
LE = "LE",
|
|
1104
|
+
/**
|
|
1105
|
+
* Greater than
|
|
1106
|
+
*/
|
|
1107
|
+
GT = "GT",
|
|
1108
|
+
/**
|
|
1109
|
+
* Greater than or equal to
|
|
1110
|
+
*/
|
|
1111
|
+
GE = "GE",
|
|
1112
|
+
/**
|
|
1113
|
+
* Contains
|
|
1114
|
+
*/
|
|
1115
|
+
CONTAINS = "CONTAINS",
|
|
1116
|
+
/**
|
|
1117
|
+
* Begins with
|
|
1118
|
+
*/
|
|
1119
|
+
BEGINS_WITH = "BEGINS_WITH",
|
|
1120
|
+
/**
|
|
1121
|
+
* Ends with
|
|
1122
|
+
*/
|
|
1123
|
+
ENDS_WITH = "ENDS_WITH",
|
|
1124
|
+
/**
|
|
1125
|
+
* Between, inclusive of higher value
|
|
1126
|
+
*/
|
|
1127
|
+
BW_INC_MAX = "BW_INC_MAX",
|
|
1128
|
+
/**
|
|
1129
|
+
* Between, inclusive of lower value
|
|
1130
|
+
*/
|
|
1131
|
+
BW_INC_MIN = "BW_INC_MIN",
|
|
1132
|
+
/**
|
|
1133
|
+
* Between, inclusive of both higher and lower value
|
|
1134
|
+
*/
|
|
1135
|
+
BW_INC = "BW_INC",
|
|
1136
|
+
/**
|
|
1137
|
+
* Between, non-inclusive
|
|
1138
|
+
*/
|
|
1139
|
+
BW = "BW",
|
|
1140
|
+
/**
|
|
1141
|
+
* Is included in this list of values
|
|
1142
|
+
*/
|
|
1143
|
+
IN = "IN",
|
|
1144
|
+
/**
|
|
1145
|
+
* Is not included in this list of values
|
|
1146
|
+
*/
|
|
1147
|
+
NOT_IN = "NOT_IN"
|
|
1148
|
+
}
|
|
1149
|
+
/**
|
|
1150
|
+
* Home page module that can be hidden.
|
|
1151
|
+
* **Note**: This option does not apply to the classic homepage.
|
|
1152
|
+
* To access the updated modular homepage, set
|
|
1153
|
+
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1154
|
+
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1155
|
+
*/
|
|
1156
|
+
export declare enum HomepageModule {
|
|
1157
|
+
/**
|
|
1158
|
+
* Search bar
|
|
1159
|
+
*/
|
|
1160
|
+
Search = "SEARCH",
|
|
1161
|
+
/**
|
|
1162
|
+
* kPI watchlist module
|
|
1163
|
+
*/
|
|
1164
|
+
Watchlist = "WATCHLIST",
|
|
1165
|
+
/**
|
|
1166
|
+
* favorite objects
|
|
1167
|
+
*/
|
|
1168
|
+
Favorite = "FAVORITE",
|
|
1169
|
+
/**
|
|
1170
|
+
* List of answers and Liveboards
|
|
1171
|
+
*/
|
|
1172
|
+
MyLibrary = "MY_LIBRARY",
|
|
1173
|
+
/**
|
|
1174
|
+
* Trending list
|
|
1175
|
+
*/
|
|
1176
|
+
Trending = "TRENDING",
|
|
1177
|
+
/**
|
|
1178
|
+
* Learning videos
|
|
1179
|
+
*/
|
|
1180
|
+
Learning = "LEARNING"
|
|
1181
|
+
}
|
|
1182
|
+
/**
|
|
1183
|
+
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
1184
|
+
* visualizations at runtime.
|
|
1185
|
+
*/
|
|
1186
|
+
export interface RuntimeFilter {
|
|
1187
|
+
/**
|
|
1188
|
+
* The name of the column to filter on (case-sensitive)
|
|
1189
|
+
*/
|
|
1190
|
+
columnName: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* The operator to apply
|
|
1193
|
+
*/
|
|
1194
|
+
operator: RuntimeFilterOp;
|
|
1195
|
+
/**
|
|
1196
|
+
* The list of operands. Some operators like EQ, LE accept
|
|
1197
|
+
* a single operand, whereas other operators like BW and IN accept multiple
|
|
1198
|
+
* operands.
|
|
1199
|
+
*/
|
|
1200
|
+
values: (number | boolean | string | bigint)[];
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
1204
|
+
* visualizations at runtime.
|
|
1205
|
+
*/
|
|
1206
|
+
export interface RuntimeParameter {
|
|
1207
|
+
/**
|
|
1208
|
+
* The name of the runtime parameter to filter on (case-sensitive)
|
|
1209
|
+
*/
|
|
1210
|
+
name: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Values
|
|
1213
|
+
*/
|
|
1214
|
+
value: number | boolean | string;
|
|
1215
|
+
}
|
|
1216
|
+
/**
|
|
1217
|
+
* Event types emitted by the embedded ThoughtSpot application.
|
|
1218
|
+
*
|
|
1219
|
+
* To add an event listener use the corresponding
|
|
1220
|
+
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
1221
|
+
* @example
|
|
1222
|
+
* ```js
|
|
1223
|
+
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
1224
|
+
* // Or
|
|
1225
|
+
* // const { EmbedEvent } = window.tsembed;
|
|
1226
|
+
*
|
|
1227
|
+
* // create the liveboard embed.
|
|
1228
|
+
*
|
|
1229
|
+
* liveboardEmbed.on(EmbedEvent.Drilldown, (drilldown) => {
|
|
1230
|
+
* console.log('Drilldown event', drilldown);
|
|
1231
|
+
* }));
|
|
1232
|
+
* ```
|
|
1233
|
+
*
|
|
1234
|
+
* If you are using React components for embedding, you can register to any
|
|
1235
|
+
* events from the `EmbedEvent` list by using the `on<EventName>` convention.
|
|
1236
|
+
* For example,`onAlert`, `onCopyToClipboard` and so on.
|
|
1237
|
+
* @example
|
|
1238
|
+
* ```js
|
|
1239
|
+
* // ...
|
|
1240
|
+
* const MyComponent = ({ dataSources }) => {
|
|
1241
|
+
* const onLoad = () => {
|
|
1242
|
+
* console.log(EmbedEvent.Load, {});
|
|
1243
|
+
* };
|
|
1244
|
+
*
|
|
1245
|
+
* return (
|
|
1246
|
+
* <SearchEmbed
|
|
1247
|
+
* dataSources={dataSources}
|
|
1248
|
+
* onLoad = {logEvent("Load")}
|
|
1249
|
+
* />
|
|
1250
|
+
* );
|
|
1251
|
+
* };
|
|
1252
|
+
* ```
|
|
1253
|
+
* @group Events
|
|
1254
|
+
*/
|
|
1255
|
+
export declare enum EmbedEvent {
|
|
1256
|
+
/**
|
|
1257
|
+
* Rendering has initialized.
|
|
1258
|
+
* @example
|
|
1259
|
+
*```js
|
|
1260
|
+
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
1261
|
+
* //show a loader
|
|
1262
|
+
* function showLoader() {
|
|
1263
|
+
* document.getElementById("loader");
|
|
1264
|
+
* }
|
|
1265
|
+
*```
|
|
1266
|
+
* @returns timestamp - The timestamp when the event was generated.
|
|
1267
|
+
*/
|
|
1268
|
+
Init = "init",
|
|
1269
|
+
/**
|
|
1270
|
+
* Authentication has either succeeded or failed.
|
|
1271
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1272
|
+
* @example
|
|
1273
|
+
*```js
|
|
1274
|
+
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
1275
|
+
* console.log('AuthInit', payload);
|
|
1276
|
+
* })
|
|
1277
|
+
*```
|
|
1278
|
+
* @returns isLoggedIn - A Boolean specifying whether authentication was successful.
|
|
1279
|
+
*/
|
|
1280
|
+
AuthInit = "authInit",
|
|
1281
|
+
/**
|
|
1282
|
+
* The embed object container has loaded.
|
|
1283
|
+
* @returns timestamp - The timestamp when the event was generated.
|
|
1284
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1285
|
+
* @example
|
|
1286
|
+
*```js
|
|
1287
|
+
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
1288
|
+
* //hide loader
|
|
1289
|
+
* function hideLoader() {
|
|
1290
|
+
* document.getElementById("loader");
|
|
1291
|
+
* }
|
|
1292
|
+
*```
|
|
1293
|
+
*/
|
|
1294
|
+
Load = "load",
|
|
1295
|
+
/**
|
|
1296
|
+
* Data pertaining to answer or Liveboard is received
|
|
1297
|
+
* @return data - The answer or Liveboard data
|
|
1298
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1299
|
+
* @example
|
|
1300
|
+
*```js
|
|
1301
|
+
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
1302
|
+
* console.log('data', payload);
|
|
1303
|
+
* })
|
|
1304
|
+
*```
|
|
1305
|
+
* @important
|
|
1306
|
+
*/
|
|
1307
|
+
Data = "data",
|
|
1308
|
+
/**
|
|
1309
|
+
* Search query has been updated by the user.
|
|
1310
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1311
|
+
* @example
|
|
1312
|
+
*```js
|
|
1313
|
+
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
1314
|
+
*```
|
|
1315
|
+
*/
|
|
1316
|
+
QueryChanged = "queryChanged",
|
|
1317
|
+
/**
|
|
1318
|
+
* A drill-down operation has been performed.
|
|
1319
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1320
|
+
* @returns additionalFilters - Any additional filters applied
|
|
1321
|
+
* @returns drillDownColumns - The columns on which drill down was performed
|
|
1322
|
+
* @returns nonFilteredColumns - The columns that were not filtered
|
|
1323
|
+
* @example
|
|
1324
|
+
*```js
|
|
1325
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
1326
|
+
* points: {
|
|
1327
|
+
* clickedPoint,
|
|
1328
|
+
* selectedPoints: selectedPoint
|
|
1329
|
+
* },
|
|
1330
|
+
* autoDrillDown: true,
|
|
1331
|
+
* })
|
|
1332
|
+
*```
|
|
1333
|
+
* In this example, `VizPointDoubleClick` event is used for
|
|
1334
|
+
* triggering the `DrillDown` event when an area or specific
|
|
1335
|
+
* data point on a table or chart is double-clicked.
|
|
1336
|
+
* @example
|
|
1337
|
+
*```js
|
|
1338
|
+
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
1339
|
+
* console.log(payload);
|
|
1340
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
1341
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
1342
|
+
* console.log('>>> called', clickedPoint);
|
|
1343
|
+
* embed.trigger(HostEvent.DrillDown, {
|
|
1344
|
+
* points: {
|
|
1345
|
+
* clickedPoint,
|
|
1346
|
+
* selectedPoints: selectedPoint
|
|
1347
|
+
* },
|
|
1348
|
+
* autoDrillDown: true,
|
|
1349
|
+
* })
|
|
1350
|
+
* })
|
|
1351
|
+
*```
|
|
1352
|
+
*/
|
|
1353
|
+
Drilldown = "drillDown",
|
|
1354
|
+
/**
|
|
1355
|
+
* One or more data sources have been selected.
|
|
1356
|
+
* @returns dataSourceIds - the list of data sources
|
|
1357
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1358
|
+
* @example
|
|
1359
|
+
* ```js
|
|
1360
|
+
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
1361
|
+
* console.log('DataSourceSelected', payload);
|
|
1362
|
+
* })
|
|
1363
|
+
* ```
|
|
1364
|
+
*/
|
|
1365
|
+
DataSourceSelected = "dataSourceSelected",
|
|
1366
|
+
/**
|
|
1367
|
+
* One or more data columns have been selected.
|
|
1368
|
+
* @returns columnIds - the list of columns
|
|
1369
|
+
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1370
|
+
* @example
|
|
1371
|
+
* ```js
|
|
1372
|
+
* appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
|
|
1373
|
+
* console.log('AddRemoveColumns', payload);
|
|
1374
|
+
* })
|
|
1375
|
+
* ```
|
|
1376
|
+
*/
|
|
1377
|
+
AddRemoveColumns = "addRemoveColumns",
|
|
1378
|
+
/**
|
|
1379
|
+
* A custom action has been triggered.
|
|
1380
|
+
* @returns actionId - ID of the custom action
|
|
1381
|
+
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
1382
|
+
* Answer or Liveboard data
|
|
1383
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1384
|
+
* @example
|
|
1385
|
+
* ```js
|
|
1386
|
+
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
1387
|
+
* const data = payload.data;
|
|
1388
|
+
* if (data.id === 'insert Custom Action ID here') {
|
|
1389
|
+
* console.log('Custom Action event:', data.embedAnswerData);
|
|
1390
|
+
* }
|
|
1391
|
+
* })
|
|
1392
|
+
* ```
|
|
1393
|
+
*/
|
|
1394
|
+
CustomAction = "customAction",
|
|
1395
|
+
/**
|
|
1396
|
+
* Listen to double click actions on a visualization.
|
|
1397
|
+
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
1398
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1399
|
+
* @example
|
|
1400
|
+
* ```js
|
|
1401
|
+
* livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
|
|
1402
|
+
* console.log('VizPointDoubleClick', payload);
|
|
1403
|
+
* })
|
|
1404
|
+
* ```
|
|
1405
|
+
*/
|
|
1406
|
+
VizPointDoubleClick = "vizPointDoubleClick",
|
|
1407
|
+
/**
|
|
1408
|
+
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
1409
|
+
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
1410
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1411
|
+
* @important
|
|
1412
|
+
* @example
|
|
1413
|
+
* ```js
|
|
1414
|
+
* embed.on(EmbedEvent.VizPointClick, ({data}) => {
|
|
1415
|
+
* console.log(
|
|
1416
|
+
* data.vizId, // viz id
|
|
1417
|
+
* data.clickedPoint.selectedAttributes[0].value,
|
|
1418
|
+
* data.clickedPoint.selectedAttributes[0].column.name,
|
|
1419
|
+
* data.clickedPoint.selectedMeasures[0].value,
|
|
1420
|
+
* data.clickedPoint.selectedMeasures[0].column.name,
|
|
1421
|
+
* )
|
|
1422
|
+
* });
|
|
1423
|
+
* ```
|
|
1424
|
+
*/
|
|
1425
|
+
VizPointClick = "vizPointClick",
|
|
1426
|
+
/**
|
|
1427
|
+
* An error has occurred. This event is fired for the following error types:
|
|
1428
|
+
*
|
|
1429
|
+
* `API` - API call failure error.
|
|
1430
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
1431
|
+
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
1432
|
+
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
1433
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
1434
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
1435
|
+
*
|
|
1436
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
1437
|
+
* @returns error - An error object or message
|
|
1438
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1439
|
+
* @example
|
|
1440
|
+
* ```js
|
|
1441
|
+
* // API error
|
|
1442
|
+
* SearchEmbed.on(EmbedEvent.Error, (error) => {
|
|
1443
|
+
* console.log(error);
|
|
1444
|
+
* // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } }
|
|
1445
|
+
* });
|
|
1446
|
+
* ```
|
|
1447
|
+
* @example
|
|
1448
|
+
* ```js
|
|
1449
|
+
* // Fullscreen error (Errors during presenting of a liveboard)
|
|
1450
|
+
* LiveboardEmbed.on(EmbedEvent.Error, (error) => {
|
|
1451
|
+
* console.log(error);
|
|
1452
|
+
* // { type: "Error", data: { errorType: "FULLSCREEN", error: {
|
|
1453
|
+
* // message: "Fullscreen API is not enabled",
|
|
1454
|
+
* // stack: "..."
|
|
1455
|
+
* // } }}
|
|
1456
|
+
* })
|
|
1457
|
+
* ```
|
|
1458
|
+
*/
|
|
1459
|
+
Error = "Error",
|
|
1460
|
+
/**
|
|
1461
|
+
* The embedded object has sent an alert.
|
|
1462
|
+
* @returns alert - An alert object
|
|
1463
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1464
|
+
* @example
|
|
1465
|
+
* ```js
|
|
1466
|
+
* searchEmbed.on(EmbedEvent.Alert)
|
|
1467
|
+
* ```
|
|
1468
|
+
*/
|
|
1469
|
+
Alert = "alert",
|
|
1470
|
+
/**
|
|
1471
|
+
* The ThoughtSpot auth session has expired.
|
|
1472
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1473
|
+
* @example
|
|
1474
|
+
*```js
|
|
1475
|
+
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
1476
|
+
* //show auth expired banner
|
|
1477
|
+
* function showAuthExpired() {
|
|
1478
|
+
* document.getElementById("authExpiredBanner");
|
|
1479
|
+
* }
|
|
1480
|
+
*```
|
|
1481
|
+
*/
|
|
1482
|
+
AuthExpire = "ThoughtspotAuthExpired",
|
|
1483
|
+
/**
|
|
1484
|
+
* ThoughtSpot failed to validate the auth session.
|
|
1485
|
+
* @hidden
|
|
1486
|
+
*/
|
|
1487
|
+
AuthFailure = "ThoughtspotAuthFailure",
|
|
1488
|
+
/**
|
|
1489
|
+
* ThoughtSpot failed to validate the auth session.
|
|
1490
|
+
* @hidden
|
|
1491
|
+
*/
|
|
1492
|
+
AuthLogout = "ThoughtspotAuthLogout",
|
|
1493
|
+
/**
|
|
1494
|
+
* The height of the embedded Liveboard or visualization has been computed.
|
|
1495
|
+
* @returns data - The height of the embedded Liveboard or visualization
|
|
1496
|
+
* @hidden
|
|
1497
|
+
*/
|
|
1498
|
+
EmbedHeight = "EMBED_HEIGHT",
|
|
1499
|
+
/**
|
|
1500
|
+
* The center of visible iframe viewport is calculated.
|
|
1501
|
+
* @returns data - The center of the visible Iframe viewport.
|
|
1502
|
+
* @hidden
|
|
1503
|
+
*/
|
|
1504
|
+
EmbedIframeCenter = "EmbedIframeCenter",
|
|
1505
|
+
/**
|
|
1506
|
+
* Emitted when the **Get Data** action is initiated.
|
|
1507
|
+
* Applicable to `SearchBarEmbed` only.
|
|
1508
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1509
|
+
* @example
|
|
1510
|
+
*```js
|
|
1511
|
+
* searchbarEmbed.on(EmbedEvent.GetDataClick)
|
|
1512
|
+
* .then(data => {
|
|
1513
|
+
* console.log('Answer Data:', data);
|
|
1514
|
+
* })
|
|
1515
|
+
*```
|
|
1516
|
+
*/
|
|
1517
|
+
GetDataClick = "getDataClick",
|
|
1518
|
+
/**
|
|
1519
|
+
* Detects the route change.
|
|
1520
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
1521
|
+
* @example
|
|
1522
|
+
*```js
|
|
1523
|
+
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
1524
|
+
* console.log('data', payload))
|
|
1525
|
+
*```
|
|
1526
|
+
*/
|
|
1527
|
+
RouteChange = "ROUTE_CHANGE",
|
|
1528
|
+
/**
|
|
1529
|
+
* The v1 event type for Data
|
|
1530
|
+
* @hidden
|
|
1531
|
+
*/
|
|
1532
|
+
V1Data = "exportVizDataToParent",
|
|
1533
|
+
/**
|
|
1534
|
+
* Emitted when the embed does not have cookie access. This happens
|
|
1535
|
+
* when Safari and other Web browsers block third-party cookies
|
|
1536
|
+
* are blocked by default. `NoCookieAccess` can trigger
|
|
1537
|
+
* @example
|
|
1538
|
+
*```js
|
|
1539
|
+
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
1540
|
+
*```
|
|
1541
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw
|
|
1542
|
+
*/
|
|
1543
|
+
NoCookieAccess = "noCookieAccess",
|
|
1544
|
+
/**
|
|
1545
|
+
* Emitted when SAML is complete
|
|
1546
|
+
* @private
|
|
1547
|
+
* @hidden
|
|
1548
|
+
*/
|
|
1549
|
+
SAMLComplete = "samlComplete",
|
|
1550
|
+
/**
|
|
1551
|
+
* Emitted when any modal is opened in the app
|
|
1552
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1553
|
+
* @example
|
|
1554
|
+
*```js
|
|
1555
|
+
* appEmbed.on(EmbedEvent.DialogOpen, payload => {
|
|
1556
|
+
* console.log('dialog open', payload);
|
|
1557
|
+
* })
|
|
1558
|
+
*```
|
|
1559
|
+
*/
|
|
1560
|
+
DialogOpen = "dialog-open",
|
|
1561
|
+
/**
|
|
1562
|
+
* Emitted when any modal is closed in the app
|
|
1563
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1564
|
+
* @example
|
|
1565
|
+
*```js
|
|
1566
|
+
* appEmbed.on(EmbedEvent.DialogClose, payload => {
|
|
1567
|
+
* console.log('dialog close', payload);
|
|
1568
|
+
* })
|
|
1569
|
+
*```
|
|
1570
|
+
*/
|
|
1571
|
+
DialogClose = "dialog-close",
|
|
1572
|
+
/**
|
|
1573
|
+
* Emitted when the Liveboard shell loads.
|
|
1574
|
+
* You can use this event as a hook to trigger
|
|
1575
|
+
* other events on the rendered Liveboard.
|
|
1576
|
+
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1577
|
+
* @example
|
|
1578
|
+
*```js
|
|
1579
|
+
* liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
|
|
1580
|
+
console.log('Liveboard is rendered', payload);
|
|
1581
|
+
})
|
|
1582
|
+
*```
|
|
1583
|
+
* The following example shows how to trigger
|
|
1584
|
+
* `SetVisibleVizs` event using LiveboardRendered embed event:
|
|
1585
|
+
* @example
|
|
1586
|
+
*```js
|
|
1587
|
+
* const embedRef = useEmbedRef();
|
|
1588
|
+
* const onLiveboardRendered = () => {
|
|
1589
|
+
* embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
1590
|
+
* };
|
|
1591
|
+
*```
|
|
1592
|
+
*/
|
|
1593
|
+
LiveboardRendered = "PinboardRendered",
|
|
1594
|
+
/**
|
|
1595
|
+
* Emits all events.
|
|
1596
|
+
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1597
|
+
* @example
|
|
1598
|
+
*```js
|
|
1599
|
+
* appEmbed.on(EmbedEvent.ALL, payload => {
|
|
1600
|
+
* console.log('Embed Events', payload)
|
|
1601
|
+
* })
|
|
1602
|
+
*```
|
|
1603
|
+
*/
|
|
1604
|
+
ALL = "*",
|
|
1605
|
+
/**
|
|
1606
|
+
* Emitted when an Answer is saved in the app
|
|
1607
|
+
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1608
|
+
* @example
|
|
1609
|
+
*```js
|
|
1610
|
+
* //Emit when action starts
|
|
1611
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1612
|
+
* console.log('Save', payload)
|
|
1613
|
+
* }, {
|
|
1614
|
+
* start: true
|
|
1615
|
+
* })
|
|
1616
|
+
* //emit when action ends
|
|
1617
|
+
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1618
|
+
* console.log('Save', payload)
|
|
1619
|
+
* })
|
|
1620
|
+
*```
|
|
1621
|
+
*/
|
|
1622
|
+
Save = "save",
|
|
1623
|
+
/**
|
|
1624
|
+
* Emitted when the download action is triggered on an answer
|
|
1625
|
+
*
|
|
1626
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
1627
|
+
* To fire an event when a download action is initiated on a chart or table,
|
|
1628
|
+
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
1629
|
+
* or `EmbedEvent.DownloadAsXLSX`
|
|
1630
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1631
|
+
* @example
|
|
1632
|
+
*```js
|
|
1633
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
1634
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1635
|
+
* })
|
|
1636
|
+
*```
|
|
1637
|
+
*/
|
|
1638
|
+
Download = "download",
|
|
1639
|
+
/**
|
|
1640
|
+
* Emitted when the download action is triggered on an answer
|
|
1641
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1642
|
+
* @example
|
|
1643
|
+
*```js
|
|
1644
|
+
* //emit when action starts
|
|
1645
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1646
|
+
* console.log('download PNG', payload)}, {start: true })
|
|
1647
|
+
* //emit when action ends
|
|
1648
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1649
|
+
* console.log('download PNG', payload)})
|
|
1650
|
+
*```
|
|
1651
|
+
*/
|
|
1652
|
+
DownloadAsPng = "downloadAsPng",
|
|
1653
|
+
/**
|
|
1654
|
+
* Emitted when the Download as PDF action is triggered on an answer
|
|
1655
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1656
|
+
* @example
|
|
1657
|
+
*```js
|
|
1658
|
+
* //emit when action starts
|
|
1659
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1660
|
+
* console.log('download PDF', payload)}, {start: true })
|
|
1661
|
+
* //emit when action ends
|
|
1662
|
+
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1663
|
+
* console.log('download PDF', payload)})
|
|
1664
|
+
*```
|
|
1665
|
+
*/
|
|
1666
|
+
DownloadAsPdf = "downloadAsPdf",
|
|
1667
|
+
/**
|
|
1668
|
+
* Emitted when the Download as CSV action is triggered on an answer
|
|
1669
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1670
|
+
* @example
|
|
1671
|
+
*```js
|
|
1672
|
+
* //emit when action starts
|
|
1673
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1674
|
+
* console.log('download CSV', payload)}, {start: true })
|
|
1675
|
+
* //emit when action ends
|
|
1676
|
+
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1677
|
+
* console.log('download CSV', payload)})
|
|
1678
|
+
*```
|
|
1679
|
+
*/
|
|
1680
|
+
DownloadAsCsv = "downloadAsCsv",
|
|
1681
|
+
/**
|
|
1682
|
+
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1683
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1684
|
+
* @example
|
|
1685
|
+
*```js
|
|
1686
|
+
* //emit when action starts
|
|
1687
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1688
|
+
* console.log('download Xlsx', payload)}, { start: true })
|
|
1689
|
+
* //emit when action ends
|
|
1690
|
+
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1691
|
+
* console.log('download Xlsx', payload)})
|
|
1692
|
+
*```
|
|
1693
|
+
*/
|
|
1694
|
+
DownloadAsXlsx = "downloadAsXlsx",
|
|
1695
|
+
/**
|
|
1696
|
+
* Emitted when an Answer is deleted in the app
|
|
1697
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1698
|
+
* @example
|
|
1699
|
+
*```js
|
|
1700
|
+
* //emit when action starts
|
|
1701
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1702
|
+
* console.log('delete answer', payload)}, {start: true })
|
|
1703
|
+
* //trigger when action is completed
|
|
1704
|
+
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1705
|
+
* console.log('delete answer', payload)})
|
|
1706
|
+
*```
|
|
1707
|
+
*/
|
|
1708
|
+
AnswerDelete = "answerDelete",
|
|
1709
|
+
/**
|
|
1710
|
+
* Emitted when an answer is pinned to a Liveboard
|
|
1711
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1712
|
+
* @example
|
|
1713
|
+
*```js
|
|
1714
|
+
* //emit when action starts
|
|
1715
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1716
|
+
* console.log('pin', payload)
|
|
1717
|
+
* }, {
|
|
1718
|
+
* start: true
|
|
1719
|
+
* })
|
|
1720
|
+
* //emit when action ends
|
|
1721
|
+
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1722
|
+
* console.log('pin', payload)
|
|
1723
|
+
* })
|
|
1724
|
+
*```
|
|
1725
|
+
*/
|
|
1726
|
+
Pin = "pin",
|
|
1727
|
+
/**
|
|
1728
|
+
* Emitted when SpotIQ analysis is triggered
|
|
1729
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1730
|
+
* @example
|
|
1731
|
+
*```js
|
|
1732
|
+
* //emit when action starts
|
|
1733
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1734
|
+
* console.log('SpotIQAnalyze', payload)
|
|
1735
|
+
* }, {
|
|
1736
|
+
* start: true
|
|
1737
|
+
* })
|
|
1738
|
+
* //emit when action ends
|
|
1739
|
+
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1740
|
+
* console.log('SpotIQ analyze', payload)
|
|
1741
|
+
* })
|
|
1742
|
+
*```
|
|
1743
|
+
*/
|
|
1744
|
+
SpotIQAnalyze = "spotIQAnalyze",
|
|
1745
|
+
/**
|
|
1746
|
+
* Emitted when a user shares an object with another user or group
|
|
1747
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1748
|
+
* @example
|
|
1749
|
+
*```js
|
|
1750
|
+
* //emit when action starts
|
|
1751
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1752
|
+
* console.log('Share', payload)
|
|
1753
|
+
* }, {
|
|
1754
|
+
* start: true
|
|
1755
|
+
* })
|
|
1756
|
+
* //emit when action ends
|
|
1757
|
+
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1758
|
+
* console.log('Share', payload)
|
|
1759
|
+
* })
|
|
1760
|
+
*```
|
|
1761
|
+
*/
|
|
1762
|
+
Share = "share",
|
|
1763
|
+
/**
|
|
1764
|
+
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
1765
|
+
* data on a chart or table.
|
|
1766
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1767
|
+
* @example
|
|
1768
|
+
*```js
|
|
1769
|
+
* appEmbed.on(EmbedEvent.DrillInclude, payload => {
|
|
1770
|
+
* console.log('Drill include', payload);
|
|
1771
|
+
* })
|
|
1772
|
+
*```
|
|
1773
|
+
*/
|
|
1774
|
+
DrillInclude = "context-menu-item-include",
|
|
1775
|
+
/**
|
|
1776
|
+
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
1777
|
+
* data on a chart or table
|
|
1778
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1779
|
+
* @example
|
|
1780
|
+
*```js
|
|
1781
|
+
* appEmbed.on(EmbedEvent.DrillExclude, payload => {
|
|
1782
|
+
* console.log('Drill exclude', payload);
|
|
1783
|
+
* })
|
|
1784
|
+
*```
|
|
1785
|
+
*/
|
|
1786
|
+
DrillExclude = "context-menu-item-exclude",
|
|
1787
|
+
/**
|
|
1788
|
+
* Emitted when a column value is copied in the embedded app.
|
|
1789
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1790
|
+
* @example
|
|
1791
|
+
*```js
|
|
1792
|
+
* seachEmbed.on(EmbedEvent.CopyToClipboard, payload => {
|
|
1793
|
+
* console.log('copy to clipboard', payload);
|
|
1794
|
+
* })
|
|
1795
|
+
*```
|
|
1796
|
+
*/
|
|
1797
|
+
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
1798
|
+
/**
|
|
1799
|
+
* Emitted when a user clicks the **Update TML** action on
|
|
1800
|
+
* embedded Liveboard.
|
|
1801
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1802
|
+
* @example
|
|
1803
|
+
*```js
|
|
1804
|
+
* liveboardEmbed.on(EmbedEvent.UpdateTML)
|
|
1805
|
+
* })
|
|
1806
|
+
*```
|
|
1807
|
+
*/
|
|
1808
|
+
UpdateTML = "updateTSL",
|
|
1809
|
+
/**
|
|
1810
|
+
* Emitted when a user clicks the **Edit TML** action
|
|
1811
|
+
* on an embedded Liveboard.
|
|
1812
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1813
|
+
* @example
|
|
1814
|
+
*```js
|
|
1815
|
+
* appEmbed.on(EmbedEvent.EditTML, payload => {
|
|
1816
|
+
* console.log('Edit TML', payload);
|
|
1817
|
+
* })
|
|
1818
|
+
*```
|
|
1819
|
+
*/
|
|
1820
|
+
EditTML = "editTSL",
|
|
1821
|
+
/**
|
|
1822
|
+
* Emitted when the **Export TML** action is triggered on an
|
|
1823
|
+
* an embedded object in the app
|
|
1824
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1825
|
+
* @example
|
|
1826
|
+
*```js
|
|
1827
|
+
* //emit when action starts
|
|
1828
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1829
|
+
* console.log('Export TML', payload)}, { start: true })
|
|
1830
|
+
* //emit when action ends
|
|
1831
|
+
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1832
|
+
* console.log('Export TML', payload)})
|
|
1833
|
+
*```
|
|
1834
|
+
*/
|
|
1835
|
+
ExportTML = "exportTSL",
|
|
1836
|
+
/**
|
|
1837
|
+
* Emitted when an Answer is saved as a View.
|
|
1838
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1839
|
+
* @example
|
|
1840
|
+
*```js
|
|
1841
|
+
* appEmbed.on(EmbedEvent.SaveAsView, payload => {
|
|
1842
|
+
* console.log('View', payload);
|
|
1843
|
+
* })
|
|
1844
|
+
*```
|
|
1845
|
+
*/
|
|
1846
|
+
SaveAsView = "saveAsView",
|
|
1847
|
+
/**
|
|
1848
|
+
* Emitted when the user creates a copy of an Answer
|
|
1849
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1850
|
+
* @example
|
|
1851
|
+
*```js
|
|
1852
|
+
* //emit when action starts
|
|
1853
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1854
|
+
* console.log('Copy and edit', payload)}, {start: true })
|
|
1855
|
+
* //emit when action ends
|
|
1856
|
+
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1857
|
+
* console.log('Copy and edit', payload)})
|
|
1858
|
+
*```
|
|
1859
|
+
*/
|
|
1860
|
+
CopyAEdit = "copyAEdit",
|
|
1861
|
+
/**
|
|
1862
|
+
* Emitted when a user clicks Show underlying data on an Answer
|
|
1863
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1864
|
+
* @example
|
|
1865
|
+
*```js
|
|
1866
|
+
* liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => {
|
|
1867
|
+
* console.log('show data', payload);
|
|
1868
|
+
* })
|
|
1869
|
+
*```
|
|
1870
|
+
*/
|
|
1871
|
+
ShowUnderlyingData = "showUnderlyingData",
|
|
1872
|
+
/**
|
|
1873
|
+
* Emitted when an answer is switched to a chart or table view.
|
|
1874
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1875
|
+
* @example
|
|
1876
|
+
*```js
|
|
1877
|
+
* searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1878
|
+
* console.log('switch view', payload);
|
|
1879
|
+
* })
|
|
1880
|
+
*```
|
|
1881
|
+
*/
|
|
1882
|
+
AnswerChartSwitcher = "answerChartSwitcher",
|
|
1883
|
+
/**
|
|
1884
|
+
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
1885
|
+
* @hidden
|
|
1886
|
+
*/
|
|
1887
|
+
APP_INIT = "appInit",
|
|
1888
|
+
/**
|
|
1889
|
+
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1890
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1891
|
+
* @example
|
|
1892
|
+
*```js
|
|
1893
|
+
* liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
|
|
1894
|
+
* console.log('Liveboard details', payload);
|
|
1895
|
+
* })
|
|
1896
|
+
*```
|
|
1897
|
+
*/
|
|
1898
|
+
LiveboardInfo = "pinboardInfo",
|
|
1899
|
+
/**
|
|
1900
|
+
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1901
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1902
|
+
* @example
|
|
1903
|
+
*```js
|
|
1904
|
+
* liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => {
|
|
1905
|
+
* console.log('favorites', payload);
|
|
1906
|
+
* })
|
|
1907
|
+
*```
|
|
1908
|
+
*/
|
|
1909
|
+
AddToFavorites = "addToFavorites",
|
|
1910
|
+
/**
|
|
1911
|
+
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1912
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1913
|
+
* @example
|
|
1914
|
+
*```js
|
|
1915
|
+
* liveboardEmbed.on(EmbedEvent.Schedule, payload => {
|
|
1916
|
+
* console.log(`Liveboard schedule', payload);
|
|
1917
|
+
* })
|
|
1918
|
+
*```
|
|
1919
|
+
*/
|
|
1920
|
+
Schedule = "subscription",
|
|
1921
|
+
/**
|
|
1922
|
+
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1923
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1924
|
+
* @example
|
|
1925
|
+
*```js
|
|
1926
|
+
* liveboardEmbed.on(EmbedEvent.Edit, payload => {
|
|
1927
|
+
* console.log(`Liveboard edit', payload);
|
|
1928
|
+
* })
|
|
1929
|
+
*```
|
|
1930
|
+
*/
|
|
1931
|
+
Edit = "edit",
|
|
1932
|
+
/**
|
|
1933
|
+
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1934
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1935
|
+
* @example
|
|
1936
|
+
*```js
|
|
1937
|
+
* liveboardEmbed.on(EmbedEvent.MakeACopy, payload => {
|
|
1938
|
+
* console.log(`Copy', payload);
|
|
1939
|
+
* })
|
|
1940
|
+
*```
|
|
1941
|
+
*/
|
|
1942
|
+
MakeACopy = "makeACopy",
|
|
1943
|
+
/**
|
|
1944
|
+
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1945
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1946
|
+
* @example
|
|
1947
|
+
*```js
|
|
1948
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1949
|
+
*```
|
|
1950
|
+
* @example
|
|
1951
|
+
*```js
|
|
1952
|
+
* liveboardEmbed.on(EmbedEvent.Present, {
|
|
1953
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1954
|
+
* })
|
|
1955
|
+
*```
|
|
1956
|
+
*/
|
|
1957
|
+
Present = "present",
|
|
1958
|
+
/**
|
|
1959
|
+
* Emitted when a user clicks **Delete** on a visualization
|
|
1960
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1961
|
+
* @example
|
|
1962
|
+
*```js
|
|
1963
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1964
|
+
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1965
|
+
*```
|
|
1966
|
+
*/
|
|
1967
|
+
Delete = "delete",
|
|
1968
|
+
/**
|
|
1969
|
+
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1970
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1971
|
+
* @example
|
|
1972
|
+
*```js
|
|
1973
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1974
|
+
*```
|
|
1975
|
+
*/
|
|
1976
|
+
SchedulesList = "schedule-list",
|
|
1977
|
+
/**
|
|
1978
|
+
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1979
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1980
|
+
* @example
|
|
1981
|
+
*```js
|
|
1982
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1983
|
+
*```
|
|
1984
|
+
*/
|
|
1985
|
+
Cancel = "cancel",
|
|
1986
|
+
/**
|
|
1987
|
+
* Emitted when a user clicks **Explore** on a visualization
|
|
1988
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1989
|
+
* @example
|
|
1990
|
+
*```js
|
|
1991
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1992
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1993
|
+
*```
|
|
1994
|
+
*/
|
|
1995
|
+
Explore = "explore",
|
|
1996
|
+
/**
|
|
1997
|
+
* Emitted when a user clicks **Copy link** action on a visualization
|
|
1998
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1999
|
+
* @example
|
|
2000
|
+
*```js
|
|
2001
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
2002
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2003
|
+
*```
|
|
2004
|
+
*/
|
|
2005
|
+
CopyLink = "embedDocument",
|
|
2006
|
+
/**
|
|
2007
|
+
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
2008
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2009
|
+
* @example
|
|
2010
|
+
*```js
|
|
2011
|
+
* liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
|
|
2012
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2013
|
+
*```
|
|
2014
|
+
*/
|
|
2015
|
+
CrossFilterChanged = "cross-filter-changed",
|
|
2016
|
+
/**
|
|
2017
|
+
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2018
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2019
|
+
* @example
|
|
2020
|
+
*```js
|
|
2021
|
+
* LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
|
|
2022
|
+
* console.log('VizPointClick', payload)
|
|
2023
|
+
* })
|
|
2024
|
+
*```
|
|
2025
|
+
*/
|
|
2026
|
+
VizPointRightClick = "vizPointRightClick",
|
|
2027
|
+
/**
|
|
2028
|
+
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2029
|
+
* @hidden
|
|
2030
|
+
*/
|
|
2031
|
+
InsertIntoSlide = "insertInToSlide",
|
|
2032
|
+
/**
|
|
2033
|
+
* Emitted when a user changes any filter on a Liveboard.
|
|
2034
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
2035
|
+
* filter details.
|
|
2036
|
+
* @example
|
|
2037
|
+
*
|
|
2038
|
+
*```js
|
|
2039
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
2040
|
+
* console.log('payload', payload);
|
|
2041
|
+
* })
|
|
2042
|
+
*
|
|
2043
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
2044
|
+
*/
|
|
2045
|
+
FilterChanged = "filterChanged",
|
|
2046
|
+
/**
|
|
2047
|
+
* Emitted when a user clicks the **Go** button on the Search page
|
|
2048
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2049
|
+
*/
|
|
2050
|
+
SageEmbedQuery = "sageEmbedQuery",
|
|
2051
|
+
/**
|
|
2052
|
+
* Emitted when a user selects a data source.
|
|
2053
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2054
|
+
*/
|
|
2055
|
+
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2056
|
+
/**
|
|
2057
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2058
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2059
|
+
*/
|
|
2060
|
+
UpdateConnection = "updateConnection",
|
|
2061
|
+
/**
|
|
2062
|
+
* Emitted when a user updates a connection on the **Data** page
|
|
2063
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2064
|
+
*/
|
|
2065
|
+
CreateConnection = "createConnection",
|
|
2066
|
+
/**
|
|
2067
|
+
* Emitted when name, status (private or public) or filter values of a
|
|
2068
|
+
* Personalised view is updated.
|
|
2069
|
+
* @returns viewName: string
|
|
2070
|
+
* @returns viewId: string
|
|
2071
|
+
* @returns liveboardId: string
|
|
2072
|
+
* @returns isPublic: boolean
|
|
2073
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2074
|
+
*/
|
|
2075
|
+
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2076
|
+
/**
|
|
2077
|
+
* Emitted when a Personalised view is saved.
|
|
2078
|
+
* @returns viewName: string
|
|
2079
|
+
* @returns viewId: string
|
|
2080
|
+
* @returns liveboardId: string
|
|
2081
|
+
* @returns isPublic: boolean
|
|
2082
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2083
|
+
*/
|
|
2084
|
+
SavePersonalisedView = "savePersonalisedView",
|
|
2085
|
+
/**
|
|
2086
|
+
* Emitted when a Liveboard is reset.
|
|
2087
|
+
* @returns viewName: string
|
|
2088
|
+
* @returns viewId: string
|
|
2089
|
+
* @returns liveboardId: string
|
|
2090
|
+
* @returns isPublic: boolean
|
|
2091
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2092
|
+
*/
|
|
2093
|
+
ResetLiveboard = "resetLiveboard",
|
|
2094
|
+
/**
|
|
2095
|
+
* Emitted when a PersonalisedView is deleted.
|
|
2096
|
+
* @returns views: string[]
|
|
2097
|
+
* @returns liveboardId: string
|
|
2098
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2099
|
+
*/
|
|
2100
|
+
DeletePersonalisedView = "deletePersonalisedView",
|
|
2101
|
+
/**
|
|
2102
|
+
* Emitted when a user creates a new worksheet
|
|
2103
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2104
|
+
*/
|
|
2105
|
+
CreateWorksheet = "createWorksheet",
|
|
2106
|
+
/**
|
|
2107
|
+
* Emitted when Ask Sage is initialized.
|
|
2108
|
+
* @returns viewName: string
|
|
2109
|
+
* @returns viewId: string
|
|
2110
|
+
* @returns liveboardId: string
|
|
2111
|
+
* @returns isPublic: boolean
|
|
2112
|
+
* @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
2113
|
+
*/
|
|
2114
|
+
AskSageInit = "AskSageInit",
|
|
2115
|
+
/**
|
|
2116
|
+
* Emitted when a LB/viz is renamed
|
|
2117
|
+
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
2118
|
+
*/
|
|
2119
|
+
Rename = "rename",
|
|
2120
|
+
/**
|
|
2121
|
+
* Emitted if the user wants to intercept the search execution
|
|
2122
|
+
* and implement logic to decide whether to run the search or not
|
|
2123
|
+
*
|
|
2124
|
+
* Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
|
|
2125
|
+
* for this embed event to get emitted.
|
|
2126
|
+
* @param: payload
|
|
2127
|
+
* @param: responder
|
|
2128
|
+
* Contains elements that lets developers define whether ThoughtSpot
|
|
2129
|
+
* will run the search or not, and if not, which error message to provide.
|
|
2130
|
+
*
|
|
2131
|
+
* execute: When execute returns true, the search will be run.
|
|
2132
|
+
* When execute returns false, the search will not be executed.
|
|
2133
|
+
*
|
|
2134
|
+
* error: Developers can customize the user facing message when execute is
|
|
2135
|
+
* set to false using the error parameter in responder
|
|
2136
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
|
|
2137
|
+
* @example
|
|
2138
|
+
*```js
|
|
2139
|
+
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
2140
|
+
* (payload, responder) => {
|
|
2141
|
+
* responder({
|
|
2142
|
+
* data: {
|
|
2143
|
+
* execute:false,
|
|
2144
|
+
* error: {
|
|
2145
|
+
* //Provide a custom error message to explain to your end user
|
|
2146
|
+
* //why their search did not run
|
|
2147
|
+
* errorText: "This search query cannot be run.
|
|
2148
|
+
* Please contact your administrator for more details."
|
|
2149
|
+
* }
|
|
2150
|
+
* }})
|
|
2151
|
+
* })
|
|
2152
|
+
* ```
|
|
2153
|
+
*
|
|
2154
|
+
*```js
|
|
2155
|
+
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
2156
|
+
* (payload, responder) => {
|
|
2157
|
+
* const query = payload.data.data.answer.search_query
|
|
2158
|
+
* responder({
|
|
2159
|
+
* data: {
|
|
2160
|
+
* // returns true as long as the query does not include
|
|
2161
|
+
* // both the 'sales' AND the 'county' column
|
|
2162
|
+
* execute: !(query.includes("sales")&&query.includes("county")),
|
|
2163
|
+
* error: {
|
|
2164
|
+
* //Provide a custom error message to explain to your end user
|
|
2165
|
+
* // why their search did not run, and which searches are accepted by your custom logic.
|
|
2166
|
+
* errorText: "You can't use this query :" + query + ".
|
|
2167
|
+
* The 'sales' measures can never be used at the 'county' level.
|
|
2168
|
+
* Please try another measure, or remove 'county' from your search."
|
|
2169
|
+
* }
|
|
2170
|
+
* }})
|
|
2171
|
+
* })
|
|
2172
|
+
*```
|
|
2173
|
+
*/
|
|
2174
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
2175
|
+
/**
|
|
2176
|
+
* Emitted when parameter changes in an answer
|
|
2177
|
+
* or liveboard
|
|
2178
|
+
*
|
|
2179
|
+
* ```js
|
|
2180
|
+
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
2181
|
+
* console.log('payload', payload);
|
|
2182
|
+
* })
|
|
2183
|
+
*```
|
|
2184
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
|
|
2185
|
+
*/
|
|
2186
|
+
ParameterChanged = "parameterChanged"
|
|
2187
|
+
}
|
|
2188
|
+
/**
|
|
2189
|
+
* Event types that can be triggered by the host application
|
|
2190
|
+
* to the embedded ThoughtSpot app.
|
|
2191
|
+
*
|
|
2192
|
+
* To trigger an event use the corresponding
|
|
2193
|
+
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
2194
|
+
* SearchEmbed.trigger} method.
|
|
2195
|
+
* @example
|
|
2196
|
+
* ```js
|
|
2197
|
+
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
2198
|
+
* // Or
|
|
2199
|
+
* // const { HostEvent } = window.tsembed;
|
|
2200
|
+
*
|
|
2201
|
+
* // create the liveboard embed.
|
|
2202
|
+
*
|
|
2203
|
+
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
2204
|
+
* { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
|
|
2205
|
+
* ]);
|
|
2206
|
+
* ```
|
|
2207
|
+
* @example
|
|
2208
|
+
* If using React components to embed, use the format shown in this example:
|
|
2209
|
+
*
|
|
2210
|
+
* ```js
|
|
2211
|
+
* const selectVizs = () => {
|
|
2212
|
+
* embedRef.current.trigger(HostEvent.SetVisibleVizs, [
|
|
2213
|
+
* "715e4613-c891-4884-be44-aa8d13701c06",
|
|
2214
|
+
* "3f84d633-e325-44b2-be25-c6650e5a49cf"
|
|
2215
|
+
* ]);
|
|
2216
|
+
* };
|
|
2217
|
+
* ```
|
|
2218
|
+
*
|
|
2219
|
+
*
|
|
2220
|
+
* You can also attach an Embed event to a Host event to trigger
|
|
2221
|
+
* a specific action as shown in this example:
|
|
2222
|
+
* @example
|
|
2223
|
+
* ```js
|
|
2224
|
+
* const EmbeddedComponent = () => {
|
|
2225
|
+
* const embedRef = useRef(null); // import { useRef } from react
|
|
2226
|
+
* const onLiveboardRendered = () => {
|
|
2227
|
+
* embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
|
|
2228
|
+
* };
|
|
2229
|
+
*
|
|
2230
|
+
* return (
|
|
2231
|
+
* <LiveboardEmbed
|
|
2232
|
+
* ref={embedRef}
|
|
2233
|
+
* liveboardId="<liveboard-guid>"
|
|
2234
|
+
* onLiveboardRendered={onLiveboardRendered}
|
|
2235
|
+
* />
|
|
2236
|
+
* );
|
|
2237
|
+
* }
|
|
2238
|
+
* ```
|
|
2239
|
+
* @group Events
|
|
2240
|
+
*/
|
|
2241
|
+
export declare enum HostEvent {
|
|
2242
|
+
/**
|
|
2243
|
+
* Triggers a search operation with the search tokens specified in
|
|
2244
|
+
* the search query string.
|
|
2245
|
+
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2246
|
+
* Includes the following properties:
|
|
2247
|
+
* @param - `searchQuery` - query string with search tokens
|
|
2248
|
+
* @param - `dataSources` - Data source GUID to Search on
|
|
2249
|
+
* - Although an array, only a single source
|
|
2250
|
+
* is supported.
|
|
2251
|
+
* @param - `execute` - executes search and updates the existing query
|
|
2252
|
+
* @example
|
|
2253
|
+
* ```js
|
|
2254
|
+
* searchembed.trigger(HostEvent.Search, {
|
|
2255
|
+
searchQuery: "[sales] by [item type]",
|
|
2256
|
+
dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
|
|
2257
|
+
execute: true
|
|
2258
|
+
});
|
|
2259
|
+
* ```
|
|
2260
|
+
*/
|
|
2261
|
+
Search = "search",
|
|
2262
|
+
/**
|
|
2263
|
+
* Triggers a drill on certain points of the specified column
|
|
2264
|
+
* Includes the following properties:
|
|
2265
|
+
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2266
|
+
* to drill to. For example, { selectedPoints: []}
|
|
2267
|
+
* @param - columnGuid - Optional. GUID of the column to drill
|
|
2268
|
+
* by. If not provided it will auto drill by the configured
|
|
2269
|
+
* column.
|
|
2270
|
+
* @param - autoDrillDown - Optional. If true, the drill down will be
|
|
2271
|
+
* done automatically on the most popular column.
|
|
2272
|
+
* @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
|
|
2273
|
+
* in case of a liveboard.
|
|
2274
|
+
* @example
|
|
2275
|
+
* ```js
|
|
2276
|
+
* searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2277
|
+
* console.log(payload);
|
|
2278
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
2279
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
2280
|
+
* console.log('>>> called', clickedPoint);
|
|
2281
|
+
* searchEmbed.trigger(HostEvent.DrillDown, {
|
|
2282
|
+
* points: {
|
|
2283
|
+
* clickedPoint,
|
|
2284
|
+
* selectedPoints: selectedPoint
|
|
2285
|
+
* },
|
|
2286
|
+
* autoDrillDown: true,
|
|
2287
|
+
* });
|
|
2288
|
+
* })
|
|
2289
|
+
* ```
|
|
2290
|
+
* @example
|
|
2291
|
+
* ```js
|
|
2292
|
+
* // Works with TS 9.8.0 and above
|
|
2293
|
+
*
|
|
2294
|
+
* liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
|
|
2295
|
+
* console.log(payload);
|
|
2296
|
+
* const clickedPoint = payload.data.clickedPoint;
|
|
2297
|
+
* const selectedPoint = payload.data.selectedPoints;
|
|
2298
|
+
* console.log('>>> called', clickedPoint);
|
|
2299
|
+
* liveboardEmbed.trigger(HostEvent.DrillDown, {
|
|
2300
|
+
* points: {
|
|
2301
|
+
* clickedPoint,
|
|
2302
|
+
* selectedPoints: selectedPoint
|
|
2303
|
+
* },
|
|
2304
|
+
* columnGuid: "<guid of the column to drill>",
|
|
2305
|
+
* vizId: payload.data.vizId
|
|
2306
|
+
* });
|
|
2307
|
+
* })
|
|
2308
|
+
* ```
|
|
2309
|
+
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2310
|
+
*/
|
|
2311
|
+
DrillDown = "triggerDrillDown",
|
|
2312
|
+
/**
|
|
2313
|
+
* Apply filters
|
|
2314
|
+
* @hidden
|
|
2315
|
+
*/
|
|
2316
|
+
Filter = "filter",
|
|
2317
|
+
/**
|
|
2318
|
+
* Reload the answer or visualization
|
|
2319
|
+
* @hidden
|
|
2320
|
+
*/
|
|
2321
|
+
Reload = "reload",
|
|
2322
|
+
/**
|
|
2323
|
+
* Get current iframe src
|
|
2324
|
+
* @example
|
|
2325
|
+
* ```js
|
|
2326
|
+
* const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
|
|
2327
|
+
* ```
|
|
2328
|
+
* @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
|
|
2329
|
+
*/
|
|
2330
|
+
GetIframeUrl = "GetIframeUrl",
|
|
2331
|
+
/**
|
|
2332
|
+
* Display specific visualizations on a Liveboard.
|
|
2333
|
+
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2334
|
+
* in this parameter will be hidden.
|
|
2335
|
+
* @example
|
|
2336
|
+
* ```js
|
|
2337
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
|
|
2338
|
+
* '730496d6-6903-4601-937e-2c691821af3c',
|
|
2339
|
+
* 'd547ec54-2a37-4516-a222-2b06719af726'])
|
|
2340
|
+
* ```
|
|
2341
|
+
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2342
|
+
*/
|
|
2343
|
+
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2344
|
+
/**
|
|
2345
|
+
* Set a Liveboard tab as an active tab.
|
|
2346
|
+
* @param - tabId - string of id of Tab to show
|
|
2347
|
+
* @example
|
|
2348
|
+
* ```js
|
|
2349
|
+
* liveboardEmbed.trigger(HostEvent.SetActiveTab,{
|
|
2350
|
+
* tabId:'730496d6-6903-4601-937e-2c691821af3c'
|
|
2351
|
+
* })
|
|
2352
|
+
* ```
|
|
2353
|
+
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
|
|
2354
|
+
*/
|
|
2355
|
+
SetActiveTab = "SetActiveTab",
|
|
2356
|
+
/**
|
|
2357
|
+
* Update runtime filters applied on a Saved Answer or Liveboard. The
|
|
2358
|
+
* runtime filters passed here are appended to the existing runtime
|
|
2359
|
+
* filters.
|
|
2360
|
+
* Pass an array of runtime filters with the following attributes:
|
|
2361
|
+
*
|
|
2362
|
+
* `columnName`
|
|
2363
|
+
* _String_. The name of the column to filter on.
|
|
2364
|
+
*
|
|
2365
|
+
* `operator`
|
|
2366
|
+
* Runtime filter operator to apply. For information,
|
|
2367
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
2368
|
+
*
|
|
2369
|
+
* `values`
|
|
2370
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2371
|
+
* operators such as BW and IN accept multiple operands.
|
|
2372
|
+
*
|
|
2373
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2374
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2375
|
+
* embedding (SageEmbed).
|
|
2376
|
+
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2377
|
+
* @example
|
|
2378
|
+
* ```js
|
|
2379
|
+
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
2380
|
+
* {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
|
|
2381
|
+
* {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
|
|
2382
|
+
* ])
|
|
2383
|
+
* ```
|
|
2384
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2385
|
+
* @important
|
|
2386
|
+
*/
|
|
2387
|
+
UpdateRuntimeFilters = "UpdateRuntimeFilters",
|
|
2388
|
+
/**
|
|
2389
|
+
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2390
|
+
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2391
|
+
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
2392
|
+
* be a number; for example, `1`, `-1`.
|
|
2393
|
+
* @example
|
|
2394
|
+
* ```js
|
|
2395
|
+
* appEmbed.navigateToPage(-1)
|
|
2396
|
+
* ```
|
|
2397
|
+
* @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw
|
|
2398
|
+
*/
|
|
2399
|
+
Navigate = "Navigate",
|
|
2400
|
+
/**
|
|
2401
|
+
* Open the filter panel for a particular column.
|
|
2402
|
+
* Works with Search and Liveboard embed.
|
|
2403
|
+
* @param - { columnId: string,
|
|
2404
|
+
* name: string,
|
|
2405
|
+
* type: INT64/CHAR/DATE,
|
|
2406
|
+
* dataType: ATTRIBUTE/MEASURE }
|
|
2407
|
+
* @example
|
|
2408
|
+
* ```js
|
|
2409
|
+
* searchEmbed.trigger(HostEvent.OpenFilter,
|
|
2410
|
+
* { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
|
|
2411
|
+
* LiveboardEmbed.trigger(HostEvent.OpenFilter,
|
|
2412
|
+
* { columnId: '<column-GUID>'})
|
|
2413
|
+
* ```
|
|
2414
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2415
|
+
*/
|
|
2416
|
+
OpenFilter = "openFilter",
|
|
2417
|
+
/**
|
|
2418
|
+
* Add columns to the current search query.
|
|
2419
|
+
* @param - { columnIds: string[] }
|
|
2420
|
+
* @example
|
|
2421
|
+
* ```js
|
|
2422
|
+
* searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
|
|
2423
|
+
* ```
|
|
2424
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2425
|
+
*/
|
|
2426
|
+
AddColumns = "addColumns",
|
|
2427
|
+
/**
|
|
2428
|
+
* Remove a column from the current search query.
|
|
2429
|
+
* @param - { columnId: string }
|
|
2430
|
+
* @example
|
|
2431
|
+
* ```js
|
|
2432
|
+
* searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
|
|
2433
|
+
* ```
|
|
2434
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2435
|
+
*/
|
|
2436
|
+
RemoveColumn = "removeColumn",
|
|
2437
|
+
/**
|
|
2438
|
+
* Get the transient state of a Liveboard as encoded content.
|
|
2439
|
+
* This includes unsaved and ad hoc changes such as
|
|
2440
|
+
* Liveboard filters, runtime filters applied on visualizations on a
|
|
2441
|
+
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
2442
|
+
* sorting, toggling of legends, and data drill down.
|
|
2443
|
+
* @example
|
|
2444
|
+
* ```js
|
|
2445
|
+
* liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
|
|
2446
|
+
* data=>console.log(data))
|
|
2447
|
+
* ```
|
|
2448
|
+
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
2449
|
+
*/
|
|
2450
|
+
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2451
|
+
/**
|
|
2452
|
+
* Trigger the **Pin** action on an embedded object
|
|
2453
|
+
* @param - Liveboard embed takes the `vizId` as a
|
|
2454
|
+
* key. Can be left undefined when embedding Search, full app, or
|
|
2455
|
+
* a visualization.
|
|
2456
|
+
* @example
|
|
2457
|
+
* ```js
|
|
2458
|
+
* appEmbed.trigger(HostEvent.Pin)
|
|
2459
|
+
* ```
|
|
2460
|
+
* ```js
|
|
2461
|
+
* searchEmbed.trigger(HostEvent.Pin)
|
|
2462
|
+
* ```
|
|
2463
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2464
|
+
*/
|
|
2465
|
+
Pin = "pin",
|
|
2466
|
+
/**
|
|
2467
|
+
* Trigger the **Show Liveboard details** action
|
|
2468
|
+
* on an embedded Liveboard.
|
|
2469
|
+
* @example
|
|
2470
|
+
*```js
|
|
2471
|
+
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
2472
|
+
*```
|
|
2473
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2474
|
+
*/
|
|
2475
|
+
LiveboardInfo = "pinboardInfo",
|
|
2476
|
+
/**
|
|
2477
|
+
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2478
|
+
* @example
|
|
2479
|
+
* ```js
|
|
2480
|
+
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
2481
|
+
* ```
|
|
2482
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2483
|
+
*/
|
|
2484
|
+
Schedule = "subscription",
|
|
2485
|
+
/**
|
|
2486
|
+
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2487
|
+
* @example
|
|
2488
|
+
* ```js
|
|
2489
|
+
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
2490
|
+
* ```
|
|
2491
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2492
|
+
*/
|
|
2493
|
+
SchedulesList = "schedule-list",
|
|
2494
|
+
/**
|
|
2495
|
+
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
2496
|
+
* Answer.
|
|
2497
|
+
* @example
|
|
2498
|
+
* ```js
|
|
2499
|
+
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
2500
|
+
* ```
|
|
2501
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2502
|
+
*/
|
|
2503
|
+
ExportTML = "exportTSL",
|
|
2504
|
+
/**
|
|
2505
|
+
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
2506
|
+
* saved Answers in the full application embedding.
|
|
2507
|
+
* @example
|
|
2508
|
+
* ```js
|
|
2509
|
+
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
2510
|
+
* ```
|
|
2511
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2512
|
+
*/
|
|
2513
|
+
EditTML = "editTSL",
|
|
2514
|
+
/**
|
|
2515
|
+
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
2516
|
+
* @example
|
|
2517
|
+
* ```js
|
|
2518
|
+
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
2519
|
+
* ```
|
|
2520
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2521
|
+
*/
|
|
2522
|
+
UpdateTML = "updateTSL",
|
|
2523
|
+
/**
|
|
2524
|
+
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
2525
|
+
* visualization or Answer.
|
|
2526
|
+
*
|
|
2527
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
2528
|
+
* visualizations and Answers if the data is in tabular format.
|
|
2529
|
+
* @example
|
|
2530
|
+
* ```js
|
|
2531
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
2532
|
+
* ```
|
|
2533
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2534
|
+
*/
|
|
2535
|
+
DownloadAsPdf = "downloadAsPdf",
|
|
2536
|
+
/**
|
|
2537
|
+
* Trigger the **Make a copy** action on a Liveboard,
|
|
2538
|
+
* visualization, or Answer page.
|
|
2539
|
+
* @example
|
|
2540
|
+
* ```js
|
|
2541
|
+
* liveboardEmbed.trigger(HostEvent.MakeACopy)
|
|
2542
|
+
* ```
|
|
2543
|
+
* @example
|
|
2544
|
+
* ```js
|
|
2545
|
+
* liveboardEmbed.trigger(HostEvent.MakeACopy, {
|
|
2546
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2547
|
+
* ```
|
|
2548
|
+
* @example
|
|
2549
|
+
* ```js
|
|
2550
|
+
* vizEmbed.trigger(HostEvent.MakeACopy)
|
|
2551
|
+
* ```
|
|
2552
|
+
* @example
|
|
2553
|
+
* ```js
|
|
2554
|
+
* searchEmbed.trigger(HostEvent.MakeACopy)
|
|
2555
|
+
* ```
|
|
2556
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2557
|
+
*/
|
|
2558
|
+
MakeACopy = "makeACopy",
|
|
2559
|
+
/**
|
|
2560
|
+
* Trigger the **Delete** action for a Liveboard.
|
|
2561
|
+
* @example
|
|
2562
|
+
* ```js
|
|
2563
|
+
* appEmbed.trigger(HostEvent.Remove)
|
|
2564
|
+
* ```
|
|
2565
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2566
|
+
*/
|
|
2567
|
+
Remove = "delete",
|
|
2568
|
+
/**
|
|
2569
|
+
* Trigger the **Explore** action on a visualization.
|
|
2570
|
+
* @param - an object with `vizId` as a key
|
|
2571
|
+
* @example
|
|
2572
|
+
* ```js
|
|
2573
|
+
* liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2574
|
+
* ```
|
|
2575
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2576
|
+
*/
|
|
2577
|
+
Explore = "explore",
|
|
2578
|
+
/**
|
|
2579
|
+
* Trigger the **Create alert** action on a KPI chart
|
|
2580
|
+
* in a Liveboard or saved Answer.
|
|
2581
|
+
* @param - an object with `vizId` as a key
|
|
2582
|
+
* @example
|
|
2583
|
+
* ```js
|
|
2584
|
+
* liveboardEmbed.trigger(HostEvent.CreateMonitor {
|
|
2585
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2586
|
+
* })
|
|
2587
|
+
* ```
|
|
2588
|
+
* @example
|
|
2589
|
+
* ```js
|
|
2590
|
+
* searchEmbed.trigger(HostEvent.CreateMonitor)
|
|
2591
|
+
* ```
|
|
2592
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2593
|
+
*/
|
|
2594
|
+
CreateMonitor = "createMonitor",
|
|
2595
|
+
/**
|
|
2596
|
+
* Trigger the **Manage alerts** action on a KPI chart
|
|
2597
|
+
* in a visualization or saved Answer.
|
|
2598
|
+
* @param - an object with `vizId` as a key
|
|
2599
|
+
* @example
|
|
2600
|
+
* ```js
|
|
2601
|
+
* liveboardEmbed.trigger(HostEvent.ManageMonitor, {
|
|
2602
|
+
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
2603
|
+
* })
|
|
2604
|
+
* ```
|
|
2605
|
+
* @example
|
|
2606
|
+
* ```js
|
|
2607
|
+
* searchEmbed.trigger(HostEvent.ManageMonitor)
|
|
2608
|
+
* ```
|
|
2609
|
+
* @example
|
|
2610
|
+
* ```js
|
|
2611
|
+
* vizEmbed.trigger(HostEvent.ManageMonitor)
|
|
2612
|
+
* ```
|
|
2613
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2614
|
+
*/
|
|
2615
|
+
ManageMonitor = "manageMonitor",
|
|
2616
|
+
/**
|
|
2617
|
+
* Trigger the **Edit** action on a Liveboard or a visualization
|
|
2618
|
+
* on a Liveboard.
|
|
2619
|
+
*
|
|
2620
|
+
* This event is not supported in visualization embed and search embed.
|
|
2621
|
+
* @param - object - To trigger the action for a specific visualization
|
|
2622
|
+
* in Liveboard embed, pass in `vizId` as a key.
|
|
2623
|
+
* @example
|
|
2624
|
+
* ```js
|
|
2625
|
+
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
2626
|
+
* ```
|
|
2627
|
+
* ```js
|
|
2628
|
+
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
2629
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2630
|
+
* ```
|
|
2631
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2632
|
+
*/
|
|
2633
|
+
Edit = "edit",
|
|
2634
|
+
/**
|
|
2635
|
+
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
2636
|
+
* @param - object - to trigger the action for a
|
|
2637
|
+
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
2638
|
+
* @example
|
|
2639
|
+
* ```js
|
|
2640
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink)
|
|
2641
|
+
* ```
|
|
2642
|
+
* ```js
|
|
2643
|
+
* liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2644
|
+
* ```
|
|
2645
|
+
* ```js
|
|
2646
|
+
* vizEmbed.trigger((HostEvent.CopyLink)
|
|
2647
|
+
* ```
|
|
2648
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2649
|
+
*/
|
|
2650
|
+
CopyLink = "embedDocument",
|
|
2651
|
+
/**
|
|
2652
|
+
* Trigger the **Present** action on a Liveboard or visualization
|
|
2653
|
+
* @param - object - to trigger the action for a specific visualization
|
|
2654
|
+
* in Liveboard embed, pass in `vizId` as a key
|
|
2655
|
+
* @example
|
|
2656
|
+
* ```js
|
|
2657
|
+
* liveboardEmbed.trigger(HostEvent.Present)
|
|
2658
|
+
* ```
|
|
2659
|
+
* ```js
|
|
2660
|
+
* liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2661
|
+
* ```
|
|
2662
|
+
* ```js
|
|
2663
|
+
* vizEmbed.trigger((HostEvent.Present)
|
|
2664
|
+
* ```
|
|
2665
|
+
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2666
|
+
*/
|
|
2667
|
+
Present = "present",
|
|
2668
|
+
/**
|
|
2669
|
+
* Get TML for the current search.
|
|
2670
|
+
* @example
|
|
2671
|
+
* ```js
|
|
2672
|
+
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
2673
|
+
* console.log(
|
|
2674
|
+
* tml.answer.search_query // TML representation of the search query
|
|
2675
|
+
* );
|
|
2676
|
+
* })
|
|
2677
|
+
* ```
|
|
2678
|
+
* @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
2679
|
+
* @important
|
|
2680
|
+
*/
|
|
2681
|
+
GetTML = "getTML",
|
|
2682
|
+
/**
|
|
2683
|
+
* Trigger the **Show underlying data** action on visualization or search
|
|
2684
|
+
* @param - an object with vizId as a key
|
|
2685
|
+
* @example
|
|
2686
|
+
* ```js
|
|
2687
|
+
* liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId:
|
|
2688
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2689
|
+
* ```
|
|
2690
|
+
* ```js
|
|
2691
|
+
* vizEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
2692
|
+
* ```
|
|
2693
|
+
* ```js
|
|
2694
|
+
* searchEmbed.trigger(HostEvent.ShowUnderlyingData)
|
|
2695
|
+
* ```
|
|
2696
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2697
|
+
*/
|
|
2698
|
+
ShowUnderlyingData = "showUnderlyingData",
|
|
2699
|
+
/**
|
|
2700
|
+
* Trigger the **Delete** action for a visualization
|
|
2701
|
+
* in an embedded Liveboard, or a chart or table
|
|
2702
|
+
* generated from Search.
|
|
2703
|
+
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
2704
|
+
* Can be left empty if embedding Search or visualization.
|
|
2705
|
+
* @example
|
|
2706
|
+
* ```js
|
|
2707
|
+
* liveboardEmbed.trigger(HostEvent.Delete, {vizId:
|
|
2708
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2709
|
+
* ```
|
|
2710
|
+
* ```js
|
|
2711
|
+
* searchEmbed.trigger(HostEvent.Delete)
|
|
2712
|
+
* ```
|
|
2713
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2714
|
+
*/
|
|
2715
|
+
Delete = "onDeleteAnswer",
|
|
2716
|
+
/**
|
|
2717
|
+
* Trigger the **SpotIQ analyze** action on visualization
|
|
2718
|
+
* or search.
|
|
2719
|
+
* @param - Liveboard embed takes `vizId` as a
|
|
2720
|
+
* key. Can be left undefined when embedding Search or
|
|
2721
|
+
* visualization.
|
|
2722
|
+
* @example
|
|
2723
|
+
* ```js
|
|
2724
|
+
* liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId:
|
|
2725
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2726
|
+
* ```
|
|
2727
|
+
* ```js
|
|
2728
|
+
* vizEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
2729
|
+
* ```
|
|
2730
|
+
* ```js
|
|
2731
|
+
* searchEmbed.trigger(HostEvent.SpotIQAnalyze)
|
|
2732
|
+
* ```
|
|
2733
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2734
|
+
*/
|
|
2735
|
+
SpotIQAnalyze = "spotIQAnalyze",
|
|
2736
|
+
/**
|
|
2737
|
+
* Trigger the **Download** action on charts in
|
|
2738
|
+
* the embedded view.
|
|
2739
|
+
* @example
|
|
2740
|
+
* ```js
|
|
2741
|
+
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
2742
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2743
|
+
* ```
|
|
2744
|
+
* ```js
|
|
2745
|
+
* embed.trigger(HostEvent.Download)
|
|
2746
|
+
* ```
|
|
2747
|
+
* @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
|
|
2748
|
+
* Use {@link DownloadAsPng}
|
|
2749
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2750
|
+
*/
|
|
2751
|
+
Download = "downloadAsPng",
|
|
2752
|
+
/**
|
|
2753
|
+
* Trigger the **Download** > **PNG** action on
|
|
2754
|
+
* charts in the embedded view.
|
|
2755
|
+
* @example
|
|
2756
|
+
* ```js
|
|
2757
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
2758
|
+
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
2759
|
+
*
|
|
2760
|
+
* vizEmbed.trigger(HostEvent.DownloadAsPng)
|
|
2761
|
+
*
|
|
2762
|
+
* searchEmbed.trigger(HostEvent.DownloadAsPng)
|
|
2763
|
+
* ```
|
|
2764
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
|
|
2765
|
+
*/
|
|
2766
|
+
DownloadAsPng = "downloadAsPng",
|
|
2767
|
+
/**
|
|
2768
|
+
* Trigger the **Download** > **CSV** action on tables in
|
|
2769
|
+
* the embedded view.
|
|
2770
|
+
* @example
|
|
2771
|
+
* ```js
|
|
2772
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
2773
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2774
|
+
* ```
|
|
2775
|
+
* ```js
|
|
2776
|
+
* vizEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
2777
|
+
* ```
|
|
2778
|
+
* ```js
|
|
2779
|
+
* searchEmbed.trigger(HostEvent.DownloadAsCsv)
|
|
2780
|
+
* ```
|
|
2781
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2782
|
+
*/
|
|
2783
|
+
DownloadAsCsv = "downloadAsCSV",
|
|
2784
|
+
/**
|
|
2785
|
+
* Trigger the **Download** > **XLSX** action on tables
|
|
2786
|
+
* in the embedded view.
|
|
2787
|
+
* @example
|
|
2788
|
+
* ```js
|
|
2789
|
+
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
2790
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2791
|
+
* ```
|
|
2792
|
+
* ```js
|
|
2793
|
+
* vizEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
2794
|
+
* ```
|
|
2795
|
+
* ```js
|
|
2796
|
+
* searchEmbed.trigger(HostEvent.DownloadAsXlsx)
|
|
2797
|
+
* ```
|
|
2798
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2799
|
+
*/
|
|
2800
|
+
DownloadAsXlsx = "downloadAsXLSX",
|
|
2801
|
+
/**
|
|
2802
|
+
* Trigger the **Share** action on an embedded
|
|
2803
|
+
* Liveboard or Answer.
|
|
2804
|
+
* @example
|
|
2805
|
+
* ```js
|
|
2806
|
+
* liveboardEmbed.trigger(HostEvent.Share)
|
|
2807
|
+
* ```
|
|
2808
|
+
* ```js
|
|
2809
|
+
* searchEmbed.trigger(HostEvent.Share)
|
|
2810
|
+
* ```
|
|
2811
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2812
|
+
*/
|
|
2813
|
+
Share = "share",
|
|
2814
|
+
/**
|
|
2815
|
+
* Trigger the **Save** action on a Liveboard or Answer.
|
|
2816
|
+
* Saves the changes.
|
|
2817
|
+
* @example
|
|
2818
|
+
* ```js
|
|
2819
|
+
* liveboardEmbed.trigger(HostEvent.Save)
|
|
2820
|
+
* ```
|
|
2821
|
+
* ```js
|
|
2822
|
+
* searchEmbed.trigger(HostEvent.Save)
|
|
2823
|
+
* ```
|
|
2824
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2825
|
+
*/
|
|
2826
|
+
Save = "save",
|
|
2827
|
+
/**
|
|
2828
|
+
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2829
|
+
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2830
|
+
* @param - an object with `vizId` as a key
|
|
2831
|
+
* @example
|
|
2832
|
+
* ```js
|
|
2833
|
+
* liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId:
|
|
2834
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2835
|
+
* ```
|
|
2836
|
+
* ```js
|
|
2837
|
+
* vizEmbed.trigger(HostEvent.SyncToSheets)
|
|
2838
|
+
* ```
|
|
2839
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2840
|
+
*/
|
|
2841
|
+
SyncToSheets = "sync-to-sheets",
|
|
2842
|
+
/**
|
|
2843
|
+
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2844
|
+
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2845
|
+
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2846
|
+
* @param - an object with vizId as a key
|
|
2847
|
+
* @example
|
|
2848
|
+
* ```js
|
|
2849
|
+
* liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId:
|
|
2850
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2851
|
+
* ```
|
|
2852
|
+
* ```js
|
|
2853
|
+
* vizEmbed.trigger(HostEvent.SyncToOtherApps)
|
|
2854
|
+
* ```
|
|
2855
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2856
|
+
*/
|
|
2857
|
+
SyncToOtherApps = "sync-to-other-apps",
|
|
2858
|
+
/**
|
|
2859
|
+
* Trigger the **Manage pipelines** action on an embedded
|
|
2860
|
+
* visualization or Answer.
|
|
2861
|
+
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2862
|
+
* @param - an object with `vizId` as a key
|
|
2863
|
+
* @example
|
|
2864
|
+
* ```js
|
|
2865
|
+
* liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId:
|
|
2866
|
+
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2867
|
+
* ```
|
|
2868
|
+
* ```js
|
|
2869
|
+
* vizEmbed.trigger(HostEvent.ManagePipelines)
|
|
2870
|
+
* ```
|
|
2871
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2872
|
+
*/
|
|
2873
|
+
ManagePipelines = "manage-pipeline",
|
|
2874
|
+
/**
|
|
2875
|
+
* Reset search operation on the Search or Answer page.
|
|
2876
|
+
* @example
|
|
2877
|
+
* ```js
|
|
2878
|
+
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
2879
|
+
* ```
|
|
2880
|
+
* ```js
|
|
2881
|
+
* appEmbed.trigger(HostEvent.ResetSearch)
|
|
2882
|
+
* ```
|
|
2883
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
|
|
2884
|
+
*/
|
|
2885
|
+
ResetSearch = "resetSearch",
|
|
2886
|
+
/**
|
|
2887
|
+
* Get details of filters applied on the Liveboard.
|
|
2888
|
+
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
2889
|
+
* @example
|
|
2890
|
+
* ```js
|
|
2891
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
2892
|
+
* console.log('data', data);
|
|
2893
|
+
* ```
|
|
2894
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2895
|
+
*/
|
|
2896
|
+
GetFilters = "getFilters",
|
|
2897
|
+
/**
|
|
2898
|
+
* Update one or several filters applied on a Liveboard.
|
|
2899
|
+
* @param - `filter`: a single filter object containing column name,
|
|
2900
|
+
* filter operator, and values.
|
|
2901
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
2902
|
+
* and values for each.
|
|
2903
|
+
*
|
|
2904
|
+
* Each filter object must include the following attributes:
|
|
2905
|
+
*
|
|
2906
|
+
* `column` - Name of the column to filter on.
|
|
2907
|
+
*
|
|
2908
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
2909
|
+
* For information about the supported filter operators,
|
|
2910
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
2911
|
+
*
|
|
2912
|
+
* `values` - An array of one or several values. The value definition on the
|
|
2913
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
2914
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
2915
|
+
* @example
|
|
2916
|
+
* ```js
|
|
2917
|
+
*
|
|
2918
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2919
|
+
* filter: {
|
|
2920
|
+
* column: "item type",
|
|
2921
|
+
* oper: "IN",
|
|
2922
|
+
* values: ["bags","shirts"]
|
|
2923
|
+
* }
|
|
2924
|
+
* });
|
|
2925
|
+
* ```
|
|
2926
|
+
* @example
|
|
2927
|
+
* ```js
|
|
2928
|
+
*
|
|
2929
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2930
|
+
* filter: {
|
|
2931
|
+
* column: "date",
|
|
2932
|
+
* oper: "EQ",
|
|
2933
|
+
* values: ["JULY","2023"],
|
|
2934
|
+
* type: "MONTH_YEAR"
|
|
2935
|
+
* }
|
|
2936
|
+
* });
|
|
2937
|
+
* ```
|
|
2938
|
+
* @example
|
|
2939
|
+
*
|
|
2940
|
+
* ```js
|
|
2941
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2942
|
+
* filters: [{
|
|
2943
|
+
* column: "Item Type",
|
|
2944
|
+
* oper: 'IN',
|
|
2945
|
+
* values: ["bags","shirts"]
|
|
2946
|
+
* },
|
|
2947
|
+
* {
|
|
2948
|
+
* column: "Region",
|
|
2949
|
+
* oper: 'IN',
|
|
2950
|
+
* values: ["West","Midwest"]
|
|
2951
|
+
* },
|
|
2952
|
+
* {
|
|
2953
|
+
* column: "Date",
|
|
2954
|
+
* oper: 'EQ',
|
|
2955
|
+
* values: ["2023-07-31"],
|
|
2956
|
+
* types: "EXACT_DATE"
|
|
2957
|
+
* }]
|
|
2958
|
+
* });
|
|
2959
|
+
* ```
|
|
2960
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2961
|
+
*/
|
|
2962
|
+
UpdateFilters = "updateFilters",
|
|
2963
|
+
/**
|
|
2964
|
+
* Get tab details for the current Liveboard.
|
|
2965
|
+
* @example
|
|
2966
|
+
* ```js
|
|
2967
|
+
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
2968
|
+
* console.log(
|
|
2969
|
+
* tabDetails // TabDetails of current LB
|
|
2970
|
+
* );
|
|
2971
|
+
* })
|
|
2972
|
+
* ```
|
|
2973
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
|
|
2974
|
+
*/
|
|
2975
|
+
GetTabs = "getTabs",
|
|
2976
|
+
/**
|
|
2977
|
+
* Set the visible tabs on a Liveboard.
|
|
2978
|
+
* @param - an array of ids of tabs to show, the IDs not passed
|
|
2979
|
+
* will be hidden.
|
|
2980
|
+
* @example
|
|
2981
|
+
* ```js
|
|
2982
|
+
* liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
|
|
2983
|
+
* '430496d6-6903-4601-937e-2c691821af3c',
|
|
2984
|
+
* 'f547ec54-2a37-4516-a222-2b06719af726'])
|
|
2985
|
+
* ```
|
|
2986
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2987
|
+
*/
|
|
2988
|
+
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2989
|
+
/**
|
|
2990
|
+
* Set the hidden tabs on a Liveboard.
|
|
2991
|
+
* @param - an array of the IDs of the tabs to hide.
|
|
2992
|
+
* The IDs not passed will be shown.
|
|
2993
|
+
* @example
|
|
2994
|
+
* ```js
|
|
2995
|
+
* liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
|
|
2996
|
+
* '630496d6-6903-4601-937e-2c691821af3c',
|
|
2997
|
+
* 'i547ec54-2a37-4516-a222-2b06719af726'])
|
|
2998
|
+
* ```
|
|
2999
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
3000
|
+
*/
|
|
3001
|
+
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
3002
|
+
/**
|
|
3003
|
+
* Updates the search query string for Natural Language Search operations.
|
|
3004
|
+
* @param - `queryString`: Text string in Natural Language format
|
|
3005
|
+
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
3006
|
+
* @example
|
|
3007
|
+
* ```js
|
|
3008
|
+
* sageEmbed.trigger(HostEvent.UpdateSageQuery, {
|
|
3009
|
+
* queryString: 'revenue per year',
|
|
3010
|
+
* executeSearch: true,
|
|
3011
|
+
* })
|
|
3012
|
+
* ```
|
|
3013
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3014
|
+
*/
|
|
3015
|
+
UpdateSageQuery = "updateSageQuery",
|
|
3016
|
+
/**
|
|
3017
|
+
* Get the answer session for a Search or
|
|
3018
|
+
* Liveboard visualization.
|
|
3019
|
+
* @example
|
|
3020
|
+
* ```js
|
|
3021
|
+
* const {session} = await embed.trigger(
|
|
3022
|
+
* HostEvent.GetAnswerSession, {
|
|
3023
|
+
* vizId: '123', // For Liveboard Visualization.
|
|
3024
|
+
* })
|
|
3025
|
+
* ```
|
|
3026
|
+
* @example
|
|
3027
|
+
* ```js
|
|
3028
|
+
* const {session} = await embed.trigger( HostEvent.GetAnswerSession )
|
|
3029
|
+
* ```
|
|
3030
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
3031
|
+
*/
|
|
3032
|
+
GetAnswerSession = "getAnswerSession",
|
|
3033
|
+
/**
|
|
3034
|
+
* Trigger Ask Sage for viz
|
|
3035
|
+
* @example
|
|
3036
|
+
* ```js
|
|
3037
|
+
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
3038
|
+
* {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
|
|
3039
|
+
* ```
|
|
3040
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
3041
|
+
*/
|
|
3042
|
+
AskSage = "AskSage",
|
|
3043
|
+
/**
|
|
3044
|
+
* Trigger UpdateCrossFilter for Liveboard
|
|
3045
|
+
* @example
|
|
3046
|
+
* ```js
|
|
3047
|
+
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
3048
|
+
* vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
|
|
3049
|
+
* conditions: [
|
|
3050
|
+
* { columnName: 'Category', values: ['mfgr#12','mfgr#14'] },
|
|
3051
|
+
* { columnName: 'color', values: ['mint','hot'] },
|
|
3052
|
+
* ],
|
|
3053
|
+
* });
|
|
3054
|
+
* ```
|
|
3055
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
|
|
3056
|
+
*/
|
|
3057
|
+
UpdateCrossFilter = "UpdateCrossFilter",
|
|
3058
|
+
/**
|
|
3059
|
+
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
3060
|
+
* @example
|
|
3061
|
+
* ```js
|
|
3062
|
+
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
3063
|
+
* ```
|
|
3064
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
3065
|
+
*/
|
|
3066
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
3067
|
+
/**
|
|
3068
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
3069
|
+
* @example
|
|
3070
|
+
* ```js
|
|
3071
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
3072
|
+
* name: "Color",
|
|
3073
|
+
* value: "almond"
|
|
3074
|
+
* }])
|
|
3075
|
+
*
|
|
3076
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
3077
|
+
*/
|
|
3078
|
+
UpdateParameters = "UpdateParameters",
|
|
3079
|
+
/**
|
|
3080
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
3081
|
+
* ```js
|
|
3082
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
|
|
3083
|
+
* console.log('parameters', parameter);
|
|
3084
|
+
* });
|
|
3085
|
+
*```
|
|
3086
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
3087
|
+
*/
|
|
3088
|
+
GetParameters = "GetParameters"
|
|
3089
|
+
}
|
|
3090
|
+
/**
|
|
3091
|
+
* The different visual modes that the data sources panel within
|
|
3092
|
+
* search could appear in, such as hidden, collapsed, or expanded.
|
|
3093
|
+
*/
|
|
3094
|
+
export declare enum DataSourceVisualMode {
|
|
3095
|
+
/**
|
|
3096
|
+
* The data source panel is hidden.
|
|
3097
|
+
*/
|
|
3098
|
+
Hidden = "hide",
|
|
3099
|
+
/**
|
|
3100
|
+
* The data source panel is collapsed, but the user can manually expand it.
|
|
3101
|
+
*/
|
|
3102
|
+
Collapsed = "collapse",
|
|
3103
|
+
/**
|
|
3104
|
+
* The data source panel is expanded, but the user can manually collapse it.
|
|
3105
|
+
*/
|
|
3106
|
+
Expanded = "expand"
|
|
3107
|
+
}
|
|
3108
|
+
/**
|
|
3109
|
+
* The query params passed down to the embedded ThoughtSpot app
|
|
3110
|
+
* containing configuration and/or visual information.
|
|
3111
|
+
*/
|
|
3112
|
+
export declare enum Param {
|
|
3113
|
+
EmbedApp = "embedApp",
|
|
3114
|
+
DataSources = "dataSources",
|
|
3115
|
+
DataSourceMode = "dataSourceMode",
|
|
3116
|
+
DisableActions = "disableAction",
|
|
3117
|
+
DisableActionReason = "disableHint",
|
|
3118
|
+
ForceTable = "forceTable",
|
|
3119
|
+
preventLiveboardFilterRemoval = "preventPinboardFilterRemoval",
|
|
3120
|
+
SearchQuery = "searchQuery",
|
|
3121
|
+
HideActions = "hideAction",
|
|
3122
|
+
HideObjects = "hideObjects",
|
|
3123
|
+
HostAppUrl = "hostAppUrl",
|
|
3124
|
+
EnableVizTransformations = "enableVizTransform",
|
|
3125
|
+
EnableSearchAssist = "enableSearchAssist",
|
|
3126
|
+
HideResult = "hideResult",
|
|
3127
|
+
UseLastSelectedDataSource = "useLastSelectedSources",
|
|
3128
|
+
Tag = "tag",
|
|
3129
|
+
searchTokenString = "searchTokenString",
|
|
3130
|
+
executeSearch = "executeSearch",
|
|
3131
|
+
fullHeight = "isFullHeightPinboard",
|
|
3132
|
+
livedBoardEmbed = "isLiveboardEmbed",
|
|
3133
|
+
searchEmbed = "isSearchEmbed",
|
|
3134
|
+
vizEmbed = "isVizEmbed",
|
|
3135
|
+
Version = "sdkVersion",
|
|
3136
|
+
ViewPortHeight = "viewPortHeight",
|
|
3137
|
+
ViewPortWidth = "viewPortWidth",
|
|
3138
|
+
VisibleActions = "visibleAction",
|
|
3139
|
+
DisableLoginRedirect = "disableLoginRedirect",
|
|
3140
|
+
visibleVizs = "pinboardVisibleVizs",
|
|
3141
|
+
LiveboardV2Enabled = "isPinboardV2Enabled",
|
|
3142
|
+
DataPanelV2Enabled = "enableDataPanelV2",
|
|
3143
|
+
ShowAlerts = "showAlerts",
|
|
3144
|
+
Locale = "locale",
|
|
3145
|
+
CustomStyle = "customStyle",
|
|
3146
|
+
ForceSAMLAutoRedirect = "forceSAMLAutoRedirect",
|
|
3147
|
+
AuthType = "authType",
|
|
3148
|
+
IconSpriteUrl = "iconSprite",
|
|
3149
|
+
cookieless = "cookieless",
|
|
3150
|
+
ContextMenuTrigger = "isContextMenuEnabledOnLeftClick",
|
|
3151
|
+
LinkOverride = "linkOverride",
|
|
3152
|
+
blockNonEmbedFullAppAccess = "blockNonEmbedFullAppAccess",
|
|
3153
|
+
ShowInsertToSlide = "insertInToSlide",
|
|
3154
|
+
PrimaryNavHidden = "primaryNavHidden",
|
|
3155
|
+
HideProfleAndHelp = "profileAndHelpInNavBarHidden",
|
|
3156
|
+
HideApplicationSwitcher = "applicationSwitcherHidden",
|
|
3157
|
+
HideOrgSwitcher = "orgSwitcherHidden",
|
|
3158
|
+
IsSageEmbed = "isSageEmbed",
|
|
3159
|
+
HideWorksheetSelector = "hideWorksheetSelector",
|
|
3160
|
+
DisableWorksheetChange = "disableWorksheetChange",
|
|
3161
|
+
HideEurekaResults = "hideEurekaResults",
|
|
3162
|
+
HideEurekaSuggestions = "hideEurekaSuggestions",
|
|
3163
|
+
HideAutocompleteSuggestions = "hideAutocompleteSuggestions",
|
|
3164
|
+
HideLiveboardHeader = "hideLiveboardHeader",
|
|
3165
|
+
ShowLiveboardDescription = "showLiveboardDescription",
|
|
3166
|
+
ShowLiveboardTitle = "showLiveboardTitle",
|
|
3167
|
+
HiddenTabs = "hideTabs",
|
|
3168
|
+
VisibleTabs = "visibleTabs",
|
|
3169
|
+
HideTabPanel = "hideTabPanel",
|
|
3170
|
+
HideSampleQuestions = "hideSampleQuestions",
|
|
3171
|
+
WorksheetId = "worksheet",
|
|
3172
|
+
Query = "query",
|
|
3173
|
+
HideHomepageLeftNav = "hideHomepageLeftNav",
|
|
3174
|
+
ModularHomeExperienceEnabled = "modularHomeExperience",
|
|
3175
|
+
PendoTrackingKey = "additionalPendoKey",
|
|
3176
|
+
LiveboardHeaderSticky = "isLiveboardHeaderSticky",
|
|
3177
|
+
IsProductTour = "isProductTour",
|
|
3178
|
+
HideSearchBarTitle = "hideSearchBarTitle",
|
|
3179
|
+
HideSageAnswerHeader = "hideSageAnswerHeader",
|
|
3180
|
+
HideSearchBar = "hideSearchBar",
|
|
3181
|
+
ClientLogLevel = "clientLogLevel",
|
|
3182
|
+
OverrideNativeConsole = "overrideConsoleLogs",
|
|
3183
|
+
enableAskSage = "enableAskSage",
|
|
3184
|
+
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
3185
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
3186
|
+
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
3187
|
+
DateFormatLocale = "dateFormatLocale",
|
|
3188
|
+
NumberFormatLocale = "numberFormatLocale",
|
|
3189
|
+
CurrencyFormat = "currencyFormat",
|
|
3190
|
+
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
3191
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
3192
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
|
|
3193
|
+
FocusSearchBarOnRender = "focusSearchBarOnRender",
|
|
3194
|
+
DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
|
|
3195
|
+
HomePageSearchBarMode = "homePageSearchBarMode",
|
|
3196
|
+
ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
|
|
3197
|
+
ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
|
|
3198
|
+
LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
|
|
3199
|
+
SpotterEnabled = "isSpotterExperienceEnabled"
|
|
3200
|
+
}
|
|
3201
|
+
/**
|
|
3202
|
+
* ThoughtSpot application pages include actions and menu commands
|
|
3203
|
+
* for various user-initiated operations. These actions are represented
|
|
3204
|
+
* as enumeration members in the SDK. To show, hide, or disable
|
|
3205
|
+
* specific actions in the embedded view, define the Action
|
|
3206
|
+
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3207
|
+
* or `hiddenActions` array.
|
|
3208
|
+
* @example
|
|
3209
|
+
* ```js
|
|
3210
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
3211
|
+
* ... // other options
|
|
3212
|
+
* visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
|
|
3213
|
+
* disabledActions: [Action.Download],
|
|
3214
|
+
* //hiddenActions: [], // Set either this or visibleActions
|
|
3215
|
+
* })
|
|
3216
|
+
* ```
|
|
3217
|
+
* @example
|
|
3218
|
+
* ```js
|
|
3219
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
3220
|
+
* ... // other options
|
|
3221
|
+
* //visibleActions: [],
|
|
3222
|
+
* disabledActions: [Action.Download],
|
|
3223
|
+
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
3224
|
+
* })
|
|
3225
|
+
* ```
|
|
3226
|
+
*/
|
|
3227
|
+
export declare enum Action {
|
|
3228
|
+
/**
|
|
3229
|
+
* The **Save** action on an Answer or Liveboard.
|
|
3230
|
+
* Allows users to save the changes.
|
|
3231
|
+
* @example
|
|
3232
|
+
* ```js
|
|
3233
|
+
* disabledActions: [Action.Save]
|
|
3234
|
+
* ```
|
|
3235
|
+
*/
|
|
3236
|
+
Save = "save",
|
|
3237
|
+
/**
|
|
3238
|
+
* @hidden
|
|
3239
|
+
*/
|
|
3240
|
+
Update = "update",
|
|
3241
|
+
/**
|
|
3242
|
+
* @hidden
|
|
3243
|
+
*/
|
|
3244
|
+
SaveUntitled = "saveUntitled",
|
|
3245
|
+
/**
|
|
3246
|
+
* The **Save as View** action on the Answer
|
|
3247
|
+
* page. Saves an Answer as a View object in the full
|
|
3248
|
+
* application embedding mode.
|
|
3249
|
+
* @example
|
|
3250
|
+
* ```js
|
|
3251
|
+
* disabledActions: [Action.SaveAsView]
|
|
3252
|
+
* ```
|
|
3253
|
+
*/
|
|
3254
|
+
SaveAsView = "saveAsView",
|
|
3255
|
+
/**
|
|
3256
|
+
* The **Make a copy** action on a Liveboard or Answer
|
|
3257
|
+
* page. Creates a copy of the Liveboard.
|
|
3258
|
+
* In LiveboardEmbed, the **Make a copy** action is not available for
|
|
3259
|
+
* visualizations in the embedded Liveboard view.
|
|
3260
|
+
* In AppEmbed, the **Make a copy** action is available on both
|
|
3261
|
+
* Liveboards and visualizations.
|
|
3262
|
+
* @example
|
|
3263
|
+
* ```js
|
|
3264
|
+
* disabledActions: [Action.MakeACopy]
|
|
3265
|
+
* ```
|
|
3266
|
+
*/
|
|
3267
|
+
MakeACopy = "makeACopy",
|
|
3268
|
+
/**
|
|
3269
|
+
* The **Copy and Edit** action on a Liveboard.
|
|
3270
|
+
* This action is now replaced with `Action.MakeACopy`.
|
|
3271
|
+
* @example
|
|
3272
|
+
* ```js
|
|
3273
|
+
* disabledActions: [Action.EditACopy]
|
|
3274
|
+
* ```
|
|
3275
|
+
*/
|
|
3276
|
+
EditACopy = "editACopy",
|
|
3277
|
+
/**
|
|
3278
|
+
* The **Copy link** menu action on a Liveboard visualization.
|
|
3279
|
+
* Copies the visualization URL
|
|
3280
|
+
* @example
|
|
3281
|
+
* ```js
|
|
3282
|
+
* disabledActions: [Action.CopyLink]
|
|
3283
|
+
* ```
|
|
3284
|
+
*/
|
|
3285
|
+
CopyLink = "embedDocument",
|
|
3286
|
+
/**
|
|
3287
|
+
* @hidden
|
|
3288
|
+
*/
|
|
3289
|
+
ResetLayout = "resetLayout",
|
|
3290
|
+
/**
|
|
3291
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3292
|
+
* Allows scheduling a Liveboard notification.
|
|
3293
|
+
* @example
|
|
3294
|
+
* ```js
|
|
3295
|
+
* disabledActions: [Action.Schedule]
|
|
3296
|
+
* ```
|
|
3297
|
+
*/
|
|
3298
|
+
Schedule = "subscription",
|
|
3299
|
+
/**
|
|
3300
|
+
* The **Manage schedules** menu action on a Liveboard.
|
|
3301
|
+
* Allows users to manage scheduled Liveboard jobs.
|
|
3302
|
+
* @example
|
|
3303
|
+
* ```js
|
|
3304
|
+
* disabledActions: [Action.SchedulesList]
|
|
3305
|
+
* ```
|
|
3306
|
+
*/
|
|
3307
|
+
SchedulesList = "schedule-list",
|
|
3308
|
+
/**
|
|
3309
|
+
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3310
|
+
* Allows users to share an object with other users and groups.
|
|
3311
|
+
* @example
|
|
3312
|
+
* ```js
|
|
3313
|
+
* disabledActions: [Action.Share]
|
|
3314
|
+
* ```
|
|
3315
|
+
*/
|
|
3316
|
+
Share = "share",
|
|
3317
|
+
/**
|
|
3318
|
+
* The **Add filter** action on a Liveboard and Search page.
|
|
3319
|
+
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3320
|
+
* @example
|
|
3321
|
+
* ```js
|
|
3322
|
+
* disabledActions: [Action.AddFilter]
|
|
3323
|
+
* ```
|
|
3324
|
+
*/
|
|
3325
|
+
AddFilter = "addFilter",
|
|
3326
|
+
/**
|
|
3327
|
+
* The **Add Data Panel Objects** action on the data panel v2.
|
|
3328
|
+
* Allows to show action menu to add different objects (like
|
|
3329
|
+
* formulas, parameters) in data panel v2.
|
|
3330
|
+
* @example
|
|
3331
|
+
* ```js
|
|
3332
|
+
* disabledActions: [Action.AddDataPanelObjects]
|
|
3333
|
+
* ```
|
|
3334
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
3335
|
+
*/
|
|
3336
|
+
AddDataPanelObjects = "addDataPanelObjects",
|
|
3337
|
+
/**
|
|
3338
|
+
* Filter configuration options on a Liveboard and Search page.
|
|
3339
|
+
* Allows configuring filter options when adding filters to a
|
|
3340
|
+
* Liveboard or Answer.
|
|
3341
|
+
* @example
|
|
3342
|
+
* ```js
|
|
3343
|
+
* disabledActions: [Action.ConfigureFilter]
|
|
3344
|
+
* ```
|
|
3345
|
+
*/
|
|
3346
|
+
ConfigureFilter = "configureFilter",
|
|
3347
|
+
CollapseDataSources = "collapseDataSources",
|
|
3348
|
+
CollapseDataPanel = "collapseDataPanel",
|
|
3349
|
+
/**
|
|
3350
|
+
* The **Choose sources** button on Search page.
|
|
3351
|
+
* Allows selecting data sources for search queries.
|
|
3352
|
+
* @example
|
|
3353
|
+
* ```js
|
|
3354
|
+
* disabledActions: [Action.ChooseDataSources]
|
|
3355
|
+
* ```
|
|
3356
|
+
*/
|
|
3357
|
+
ChooseDataSources = "chooseDataSources",
|
|
3358
|
+
/**
|
|
3359
|
+
* The **Create formula** action on a Search or Answer page.
|
|
3360
|
+
* Allows adding formulas to an Answer.
|
|
3361
|
+
* @example
|
|
3362
|
+
* ```js
|
|
3363
|
+
* disabledActions: [Action.AddFormula]
|
|
3364
|
+
* ```
|
|
3365
|
+
*/
|
|
3366
|
+
AddFormula = "addFormula",
|
|
3367
|
+
/**
|
|
3368
|
+
* The **Add parameter** action on a Liveboard or Answer.
|
|
3369
|
+
* Allows adding Parameters to a Liveboard or Answer.
|
|
3370
|
+
* @example
|
|
3371
|
+
* ```js
|
|
3372
|
+
* disabledActions: [Action.AddParameter]
|
|
3373
|
+
* ```
|
|
3374
|
+
*/
|
|
3375
|
+
AddParameter = "addParameter",
|
|
3376
|
+
/**
|
|
3377
|
+
* The **Add Column Set** action on a Answer.
|
|
3378
|
+
* Allows adding column sets to a Answer.
|
|
3379
|
+
* @example
|
|
3380
|
+
* ```js
|
|
3381
|
+
* disabledActions: [Action.AddColumnSet]
|
|
3382
|
+
* ```
|
|
3383
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
3384
|
+
*/
|
|
3385
|
+
AddColumnSet = "addSimpleCohort",
|
|
3386
|
+
/**
|
|
3387
|
+
* The **Add Query Set** action on a Answer.
|
|
3388
|
+
* Allows adding query sets to a Answer.
|
|
3389
|
+
* @example
|
|
3390
|
+
* ```js
|
|
3391
|
+
* disabledActions: [Action.AddQuerySet]
|
|
3392
|
+
* ```
|
|
3393
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
3394
|
+
*/
|
|
3395
|
+
AddQuerySet = "addAdvancedCohort",
|
|
3396
|
+
/**
|
|
3397
|
+
* @hidden
|
|
3398
|
+
*/
|
|
3399
|
+
SearchOnTop = "searchOnTop",
|
|
3400
|
+
/**
|
|
3401
|
+
* The **SpotIQ analyze** menu action on a visualization or
|
|
3402
|
+
* Answer page.
|
|
3403
|
+
* @example
|
|
3404
|
+
* ```js
|
|
3405
|
+
* disabledActions: [Action.SpotIQAnalyze]
|
|
3406
|
+
* ```
|
|
3407
|
+
*/
|
|
3408
|
+
SpotIQAnalyze = "spotIQAnalyze",
|
|
3409
|
+
/**
|
|
3410
|
+
* @hidden
|
|
3411
|
+
*/
|
|
3412
|
+
ExplainInsight = "explainInsight",
|
|
3413
|
+
/**
|
|
3414
|
+
* @hidden
|
|
3415
|
+
*/
|
|
3416
|
+
SpotIQFollow = "spotIQFollow",
|
|
3417
|
+
ShareViz = "shareViz",
|
|
3418
|
+
/**
|
|
3419
|
+
* @hidden
|
|
3420
|
+
*/
|
|
3421
|
+
ReplaySearch = "replaySearch",
|
|
3422
|
+
/**
|
|
3423
|
+
* The **Show underlying data** menu action on a visualization or
|
|
3424
|
+
* Answer page.
|
|
3425
|
+
* @example
|
|
3426
|
+
* ```js
|
|
3427
|
+
* disabledActions: [Action.ShowUnderlyingData]
|
|
3428
|
+
* ```
|
|
3429
|
+
*/
|
|
3430
|
+
ShowUnderlyingData = "showUnderlyingData",
|
|
3431
|
+
/**
|
|
3432
|
+
* The **Download** menu action on Liveboard visualizations
|
|
3433
|
+
* and Answers.
|
|
3434
|
+
* Allows downloading a visualization or Answer.
|
|
3435
|
+
* @example
|
|
3436
|
+
* ```js
|
|
3437
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3438
|
+
* ```
|
|
3439
|
+
*/
|
|
3440
|
+
Download = "download",
|
|
3441
|
+
/**
|
|
3442
|
+
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3443
|
+
* or Answer page.
|
|
3444
|
+
* Downloads a visualization or Answer as a PNG file.
|
|
3445
|
+
* @example
|
|
3446
|
+
* ```js
|
|
3447
|
+
* disabledActions: [Action.DownloadAsPng]
|
|
3448
|
+
* ```
|
|
3449
|
+
*/
|
|
3450
|
+
DownloadAsPng = "downloadAsPng",
|
|
3451
|
+
/**
|
|
3452
|
+
*
|
|
3453
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
3454
|
+
*visualization, or Answer as a PDF file.
|
|
3455
|
+
*
|
|
3456
|
+
*
|
|
3457
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
3458
|
+
*visualizations and Answers if the data is in tabular format.
|
|
3459
|
+
* @example
|
|
3460
|
+
* ```js
|
|
3461
|
+
* disabledActions: [Action.DownloadAsPdf]
|
|
3462
|
+
* ```
|
|
3463
|
+
*/
|
|
3464
|
+
DownloadAsPdf = "downloadAsPdf",
|
|
3465
|
+
/**
|
|
3466
|
+
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3467
|
+
* or Answer page.
|
|
3468
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3469
|
+
* @example
|
|
3470
|
+
* ```js
|
|
3471
|
+
* disabledActions: [Action.DownloadAsCsv]
|
|
3472
|
+
* ```
|
|
3473
|
+
*/
|
|
3474
|
+
DownloadAsCsv = "downloadAsCSV",
|
|
3475
|
+
/**
|
|
3476
|
+
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3477
|
+
* or Answer page.
|
|
3478
|
+
* Downloads a visualization or Answer in the XLSX format.
|
|
3479
|
+
* @example
|
|
3480
|
+
* ```js
|
|
3481
|
+
* disabledActions: [Action.DownloadAsXlsx]
|
|
3482
|
+
* ```
|
|
3483
|
+
*/
|
|
3484
|
+
DownloadAsXlsx = "downloadAsXLSX",
|
|
3485
|
+
/**
|
|
3486
|
+
* @hidden
|
|
3487
|
+
*/
|
|
3488
|
+
DownloadTrace = "downloadTrace",
|
|
3489
|
+
/**
|
|
3490
|
+
* The **Export TML** menu action on Liveboard, Answers
|
|
3491
|
+
* Worksheets and Data Connections page.
|
|
3492
|
+
* Exports an object as a TML file.
|
|
3493
|
+
* @example
|
|
3494
|
+
* ```js
|
|
3495
|
+
* disabledActions: [Action.ExportTML]
|
|
3496
|
+
* ```
|
|
3497
|
+
*/
|
|
3498
|
+
ExportTML = "exportTSL",
|
|
3499
|
+
/**
|
|
3500
|
+
* The **Import TML** menu action for Liveboards and Answers.
|
|
3501
|
+
* Imports TML representation of ThoughtSpot objects.
|
|
3502
|
+
* @example
|
|
3503
|
+
* ```js
|
|
3504
|
+
* disabledActions: [Action.ImportTML]
|
|
3505
|
+
* ```
|
|
3506
|
+
*/
|
|
3507
|
+
ImportTML = "importTSL",
|
|
3508
|
+
/**
|
|
3509
|
+
* The **Update TML** menu action for Liveboards and Answers.
|
|
3510
|
+
* Update TML representation of ThoughtSpot objects.
|
|
3511
|
+
* @example
|
|
3512
|
+
* ```js
|
|
3513
|
+
* disabledActions: [Action.UpdateTML]
|
|
3514
|
+
* ```
|
|
3515
|
+
*/
|
|
3516
|
+
UpdateTML = "updateTSL",
|
|
3517
|
+
/**
|
|
3518
|
+
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3519
|
+
* Opens the TML editor.
|
|
3520
|
+
* @example
|
|
3521
|
+
* ```js
|
|
3522
|
+
* disabledActions: [Action.EditTML]
|
|
3523
|
+
* ```
|
|
3524
|
+
*/
|
|
3525
|
+
EditTML = "editTSL",
|
|
3526
|
+
/**
|
|
3527
|
+
* The **Present** menu action for Liveboards and Answers.
|
|
3528
|
+
* Allows presenting a Liveboard or visualization in
|
|
3529
|
+
* slideshow mode.
|
|
3530
|
+
* @example
|
|
3531
|
+
* ```js
|
|
3532
|
+
* disabledActions: [Action.Present]
|
|
3533
|
+
* ```
|
|
3534
|
+
*/
|
|
3535
|
+
Present = "present",
|
|
3536
|
+
/**
|
|
3537
|
+
* The tile resize options in the visualization menu.
|
|
3538
|
+
* Allows switching between different preset layouts.
|
|
3539
|
+
* @example
|
|
3540
|
+
* ```js
|
|
3541
|
+
* disabledActions: [Action.ToggleSize]
|
|
3542
|
+
* ```
|
|
3543
|
+
*/
|
|
3544
|
+
ToggleSize = "toggleSize",
|
|
3545
|
+
/**
|
|
3546
|
+
* The *Edit* action on the Liveboard page and in the
|
|
3547
|
+
* visualization menu.
|
|
3548
|
+
* Opens a Liveboard or visualization in edit mode.
|
|
3549
|
+
* @example
|
|
3550
|
+
* ```js
|
|
3551
|
+
* disabledActions: [Action.Edit]
|
|
3552
|
+
* ```
|
|
3553
|
+
*/
|
|
3554
|
+
Edit = "edit",
|
|
3555
|
+
/**
|
|
3556
|
+
* The text edit option for Liveboard and visualization titles.
|
|
3557
|
+
* @example
|
|
3558
|
+
* ```js
|
|
3559
|
+
* disabledActions: [Action.EditTitle]
|
|
3560
|
+
* ```
|
|
3561
|
+
*/
|
|
3562
|
+
EditTitle = "editTitle",
|
|
3563
|
+
/**
|
|
3564
|
+
* The **Delete** menu action on Liveboards and visualizations.
|
|
3565
|
+
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3566
|
+
* @example
|
|
3567
|
+
* ```js
|
|
3568
|
+
* disabledActions: [Action.Remove]
|
|
3569
|
+
* ```
|
|
3570
|
+
*/
|
|
3571
|
+
Remove = "delete",
|
|
3572
|
+
/**
|
|
3573
|
+
* @hidden
|
|
3574
|
+
*/
|
|
3575
|
+
Ungroup = "ungroup",
|
|
3576
|
+
/**
|
|
3577
|
+
* @hidden
|
|
3578
|
+
*/
|
|
3579
|
+
Describe = "describe",
|
|
3580
|
+
/**
|
|
3581
|
+
* @hidden
|
|
3582
|
+
*/
|
|
3583
|
+
Relate = "relate",
|
|
3584
|
+
/**
|
|
3585
|
+
* @hidden
|
|
3586
|
+
*/
|
|
3587
|
+
CustomizeHeadlines = "customizeHeadlines",
|
|
3588
|
+
/**
|
|
3589
|
+
* @hidden
|
|
3590
|
+
*/
|
|
3591
|
+
PinboardInfo = "pinboardInfo",
|
|
3592
|
+
/**
|
|
3593
|
+
* The **Show Liveboard details** menu action on a Liveboard.
|
|
3594
|
+
* Displays details such as the name, description, and
|
|
3595
|
+
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3596
|
+
* and update.
|
|
3597
|
+
* @example
|
|
3598
|
+
* ```js
|
|
3599
|
+
* disabledActions: [Action.LiveboardInfo]
|
|
3600
|
+
* ```
|
|
3601
|
+
*/
|
|
3602
|
+
LiveboardInfo = "pinboardInfo",
|
|
3603
|
+
/**
|
|
3604
|
+
* @hidden
|
|
3605
|
+
*/
|
|
3606
|
+
SendAnswerFeedback = "sendFeedback",
|
|
3607
|
+
/**
|
|
3608
|
+
* @hidden
|
|
3609
|
+
*/
|
|
3610
|
+
DownloadEmbraceQueries = "downloadEmbraceQueries",
|
|
3611
|
+
/**
|
|
3612
|
+
* The **Pin** menu action on an Answer or
|
|
3613
|
+
* Search results page.
|
|
3614
|
+
* @example
|
|
3615
|
+
* ```js
|
|
3616
|
+
* disabledActions: [Action.Pin]
|
|
3617
|
+
* ```
|
|
3618
|
+
*/
|
|
3619
|
+
Pin = "pin",
|
|
3620
|
+
/**
|
|
3621
|
+
* @hidden
|
|
3622
|
+
*/
|
|
3623
|
+
AnalysisInfo = "analysisInfo",
|
|
3624
|
+
/**
|
|
3625
|
+
* The **Schedule** menu action on a Liveboard.
|
|
3626
|
+
* @example
|
|
3627
|
+
* ```js
|
|
3628
|
+
* disabledActions: [Action.Subscription]
|
|
3629
|
+
* ```
|
|
3630
|
+
*/
|
|
3631
|
+
Subscription = "subscription",
|
|
3632
|
+
/**
|
|
3633
|
+
* The **Explore** action on Liveboard visualizations
|
|
3634
|
+
* @example
|
|
3635
|
+
* ```js
|
|
3636
|
+
* disabledActions: [Action.Explore]
|
|
3637
|
+
* ```
|
|
3638
|
+
*/
|
|
3639
|
+
Explore = "explore",
|
|
3640
|
+
/**
|
|
3641
|
+
* The action to include data points on a drilled-down Answer
|
|
3642
|
+
* or visualization
|
|
3643
|
+
* @example
|
|
3644
|
+
* ```js
|
|
3645
|
+
* disabledActions: [Action.DrillInclude]
|
|
3646
|
+
* ```
|
|
3647
|
+
*/
|
|
3648
|
+
DrillInclude = "context-menu-item-include",
|
|
3649
|
+
/**
|
|
3650
|
+
* The action to exclude data points on a drilled-down Answer
|
|
3651
|
+
* or visualization
|
|
3652
|
+
* @example
|
|
3653
|
+
* ```js
|
|
3654
|
+
* disabledActions: [Action.DrillInclude]
|
|
3655
|
+
* ```
|
|
3656
|
+
*/
|
|
3657
|
+
DrillExclude = "context-menu-item-exclude",
|
|
3658
|
+
/**
|
|
3659
|
+
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3660
|
+
* or Liveboard.
|
|
3661
|
+
* Copies the selected data point.
|
|
3662
|
+
* @example
|
|
3663
|
+
* ```js
|
|
3664
|
+
* disabledActions: [Action.CopyToClipboard]
|
|
3665
|
+
* ```
|
|
3666
|
+
*/
|
|
3667
|
+
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3668
|
+
CopyAndEdit = "context-menu-item-copy-and-edit",
|
|
3669
|
+
/**
|
|
3670
|
+
* @hidden
|
|
3671
|
+
*/
|
|
3672
|
+
DrillEdit = "context-menu-item-edit",
|
|
3673
|
+
EditMeasure = "context-menu-item-edit-measure",
|
|
3674
|
+
Separator = "context-menu-item-separator",
|
|
3675
|
+
/**
|
|
3676
|
+
* The **Drill down** menu action on Answers and Liveboard
|
|
3677
|
+
* visualizations.
|
|
3678
|
+
* Allows drilling down to a specific data point on a chart or table.
|
|
3679
|
+
* @example
|
|
3680
|
+
* ```js
|
|
3681
|
+
* disabledActions: [Action.DrillDown]
|
|
3682
|
+
* ```
|
|
3683
|
+
*/
|
|
3684
|
+
DrillDown = "DRILL",
|
|
3685
|
+
/**
|
|
3686
|
+
* The request access action on Liveboards.
|
|
3687
|
+
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3688
|
+
* @example
|
|
3689
|
+
* ```js
|
|
3690
|
+
* disabledActions: [Action.RequestAccess]
|
|
3691
|
+
* ```
|
|
3692
|
+
*/
|
|
3693
|
+
RequestAccess = "requestAccess",
|
|
3694
|
+
/**
|
|
3695
|
+
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3696
|
+
* of the Answer page
|
|
3697
|
+
* @example
|
|
3698
|
+
* ```js
|
|
3699
|
+
* disabledActions: [Action.QueryDetailsButtons]
|
|
3700
|
+
* ```
|
|
3701
|
+
*/
|
|
3702
|
+
QueryDetailsButtons = "queryDetailsButtons",
|
|
3703
|
+
/**
|
|
3704
|
+
* The **Delete** action for Answers in the full application
|
|
3705
|
+
* embedding mode.
|
|
3706
|
+
* @example
|
|
3707
|
+
* ```js
|
|
3708
|
+
* disabledActions: [Action.AnswerDelete]
|
|
3709
|
+
* ```
|
|
3710
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3711
|
+
*/
|
|
3712
|
+
AnswerDelete = "onDeleteAnswer",
|
|
3713
|
+
/**
|
|
3714
|
+
* The Chart switcher icon on Answer and visualization pages.
|
|
3715
|
+
* @example
|
|
3716
|
+
* ```js
|
|
3717
|
+
* disabledActions: [Action.AnswerChartSwitcher]
|
|
3718
|
+
* ```
|
|
3719
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3720
|
+
*/
|
|
3721
|
+
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3722
|
+
/**
|
|
3723
|
+
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3724
|
+
* @example
|
|
3725
|
+
* ```js
|
|
3726
|
+
* disabledActions: [Action.AddToFavorites]
|
|
3727
|
+
* ```
|
|
3728
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3729
|
+
*/
|
|
3730
|
+
AddToFavorites = "addToFavorites",
|
|
3731
|
+
/**
|
|
3732
|
+
* The edit icon on Liveboards (Classic experience).
|
|
3733
|
+
* @example
|
|
3734
|
+
* ```js
|
|
3735
|
+
* disabledActions: [Action.EditDetails]
|
|
3736
|
+
* ```
|
|
3737
|
+
* @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3738
|
+
*/
|
|
3739
|
+
EditDetails = "editDetails",
|
|
3740
|
+
/**
|
|
3741
|
+
* The Create alert action on KPI charts.
|
|
3742
|
+
* @example
|
|
3743
|
+
* ```js
|
|
3744
|
+
* disabledActions: [Action.CreateMonitor]
|
|
3745
|
+
* ```
|
|
3746
|
+
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3747
|
+
*/
|
|
3748
|
+
CreateMonitor = "createMonitor",
|
|
3749
|
+
/**
|
|
3750
|
+
* @deprecated
|
|
3751
|
+
* Reports errors
|
|
3752
|
+
* @example
|
|
3753
|
+
* ```js
|
|
3754
|
+
* disabledActions: [Action.ReportError]
|
|
3755
|
+
* ```
|
|
3756
|
+
* @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3757
|
+
*/
|
|
3758
|
+
ReportError = "reportError",
|
|
3759
|
+
/**
|
|
3760
|
+
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3761
|
+
* Allows sending data to a Google Sheet.
|
|
3762
|
+
* @example
|
|
3763
|
+
* ```js
|
|
3764
|
+
* disabledActions: [Action.SyncToSheets]
|
|
3765
|
+
* ```
|
|
3766
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3767
|
+
*/
|
|
3768
|
+
SyncToSheets = "sync-to-sheets",
|
|
3769
|
+
/**
|
|
3770
|
+
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3771
|
+
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3772
|
+
* Microsoft Teams, and so on.
|
|
3773
|
+
* @example
|
|
3774
|
+
* ```js
|
|
3775
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
3776
|
+
* ```
|
|
3777
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3778
|
+
*/
|
|
3779
|
+
SyncToOtherApps = "sync-to-other-apps",
|
|
3780
|
+
/**
|
|
3781
|
+
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3782
|
+
* Allows users to manage data sync pipelines to third-party apps.
|
|
3783
|
+
* @example
|
|
3784
|
+
* ```js
|
|
3785
|
+
* disabledActions: [Action.SyncToOtherApps]
|
|
3786
|
+
* ```
|
|
3787
|
+
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
3788
|
+
*/
|
|
3789
|
+
ManagePipelines = "manage-pipeline",
|
|
3790
|
+
/**
|
|
3791
|
+
* The **Filter** action on Liveboard visualizations.
|
|
3792
|
+
* Allows users to apply cross-filters on a Liveboard.
|
|
3793
|
+
* @example
|
|
3794
|
+
* ```js
|
|
3795
|
+
* disabledActions: [Action.CrossFilter]
|
|
3796
|
+
* ```
|
|
3797
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3798
|
+
*/
|
|
3799
|
+
CrossFilter = "context-menu-item-cross-filter",
|
|
3800
|
+
/**
|
|
3801
|
+
* The **Sync to Slack** action on Liveboard visualizations.
|
|
3802
|
+
* Allows sending data to third-party apps Slack
|
|
3803
|
+
* @example
|
|
3804
|
+
* ```js
|
|
3805
|
+
* disabledActions: [Action.SyncToSlack]
|
|
3806
|
+
* ```
|
|
3807
|
+
* @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
|
|
3808
|
+
*/
|
|
3809
|
+
SyncToSlack = "syncToSlack",
|
|
3810
|
+
/**
|
|
3811
|
+
* The **Sync to Teams** action on Liveboard visualizations.
|
|
3812
|
+
* Allows sending data to third-party apps Team
|
|
3813
|
+
* @example
|
|
3814
|
+
* ```js
|
|
3815
|
+
* disabledActions: [Action.SyncToTeams]
|
|
3816
|
+
* ```
|
|
3817
|
+
* @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
|
|
3818
|
+
*/
|
|
3819
|
+
SyncToTeams = "syncToTeams",
|
|
3820
|
+
/**
|
|
3821
|
+
* The **Remove** action that appears when cross filters are applied
|
|
3822
|
+
* on a Liveboard.
|
|
3823
|
+
* Removes filters applied o a visualization.
|
|
3824
|
+
* @example
|
|
3825
|
+
* ```js
|
|
3826
|
+
* disabledActions: [Action.RemoveCrossFilter]
|
|
3827
|
+
* ```
|
|
3828
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3829
|
+
*/
|
|
3830
|
+
RemoveCrossFilter = "context-menu-item-remove-cross-filter",
|
|
3831
|
+
/**
|
|
3832
|
+
* The **Aggregate** option in the chart axis or the
|
|
3833
|
+
* table column customization menu.
|
|
3834
|
+
* Provides aggregation options to analyze the data on a chart or table.
|
|
3835
|
+
* @example
|
|
3836
|
+
* ```js
|
|
3837
|
+
* disabledActions: [Action.AxisMenuAggregate]
|
|
3838
|
+
* ```
|
|
3839
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3840
|
+
*/
|
|
3841
|
+
AxisMenuAggregate = "axisMenuAggregate",
|
|
3842
|
+
/**
|
|
3843
|
+
* The **Time bucket** option in the chart axis or table column
|
|
3844
|
+
* customization menu.
|
|
3845
|
+
* Allows defining time metric for date comparison.
|
|
3846
|
+
* @example
|
|
3847
|
+
* ```js
|
|
3848
|
+
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
3849
|
+
* ```
|
|
3850
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3851
|
+
*/
|
|
3852
|
+
AxisMenuTimeBucket = "axisMenuTimeBucket",
|
|
3853
|
+
/**
|
|
3854
|
+
* The **Filter** action in the chart axis or table column
|
|
3855
|
+
* customization menu.
|
|
3856
|
+
* @example
|
|
3857
|
+
* ```js
|
|
3858
|
+
* disabledActions: [Action.AxisMenuFilter]
|
|
3859
|
+
* ```
|
|
3860
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3861
|
+
*/
|
|
3862
|
+
AxisMenuFilter = "axisMenuFilter",
|
|
3863
|
+
/**
|
|
3864
|
+
* The **Conditional formatting** action on chart or table.
|
|
3865
|
+
* Allows adding rules for conditional formatting of data
|
|
3866
|
+
* points on a chart or table.
|
|
3867
|
+
* @example
|
|
3868
|
+
* ```js
|
|
3869
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
3870
|
+
* ```
|
|
3871
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3872
|
+
*/
|
|
3873
|
+
AxisMenuConditionalFormat = "axisMenuConditionalFormat",
|
|
3874
|
+
/**
|
|
3875
|
+
* The **Sort** menu action on a table or chart axis
|
|
3876
|
+
* Sorts data in ascending or descending order.
|
|
3877
|
+
* Allows adding, editing, or removing filters.
|
|
3878
|
+
* @example
|
|
3879
|
+
* ```js
|
|
3880
|
+
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
3881
|
+
* ```
|
|
3882
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3883
|
+
*/
|
|
3884
|
+
AxisMenuSort = "axisMenuSort",
|
|
3885
|
+
/**
|
|
3886
|
+
* The **Group** option in the chart axis or table column
|
|
3887
|
+
* customization menu.
|
|
3888
|
+
* Allows grouping data points if the axes use the same
|
|
3889
|
+
* unit of measurement and a similar scale.
|
|
3890
|
+
* @example
|
|
3891
|
+
* ```js
|
|
3892
|
+
* disabledActions: [Action.AxisMenuGroup]
|
|
3893
|
+
* ```
|
|
3894
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3895
|
+
*/
|
|
3896
|
+
AxisMenuGroup = "axisMenuGroup",
|
|
3897
|
+
/**
|
|
3898
|
+
* The **Position** option in the axis customization menu.
|
|
3899
|
+
* Allows changing the position of the axis to the
|
|
3900
|
+
* left or right side of the chart.
|
|
3901
|
+
* @example
|
|
3902
|
+
* ```js
|
|
3903
|
+
* disabledActions: [Action.AxisMenuPosition]
|
|
3904
|
+
* ```
|
|
3905
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3906
|
+
*/
|
|
3907
|
+
AxisMenuPosition = "axisMenuPosition",
|
|
3908
|
+
/**
|
|
3909
|
+
* The **Rename** option in the chart axis or table column customization menu.
|
|
3910
|
+
* Renames the axis label on a chart or the column header on a table.
|
|
3911
|
+
* @example
|
|
3912
|
+
* ```js
|
|
3913
|
+
* disabledActions: [Action.AxisMenuRename]
|
|
3914
|
+
* ```
|
|
3915
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3916
|
+
*/
|
|
3917
|
+
AxisMenuRename = "axisMenuRename",
|
|
3918
|
+
/**
|
|
3919
|
+
* The **Edit** action in the axis customization menu.
|
|
3920
|
+
* Allows editing the axis name, position, minimum and maximum values,
|
|
3921
|
+
* and format of a column.
|
|
3922
|
+
* @example
|
|
3923
|
+
* ```js
|
|
3924
|
+
* disabledActions: [Action.AxisMenuEdit]
|
|
3925
|
+
* ```
|
|
3926
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3927
|
+
*/
|
|
3928
|
+
AxisMenuEdit = "axisMenuEdit",
|
|
3929
|
+
/**
|
|
3930
|
+
* The **Number format** action to customize the format of
|
|
3931
|
+
* the data labels on a chart or table.
|
|
3932
|
+
* @example
|
|
3933
|
+
* ```js
|
|
3934
|
+
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
3935
|
+
* ```
|
|
3936
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3937
|
+
*/
|
|
3938
|
+
AxisMenuNumberFormat = "axisMenuNumberFormat",
|
|
3939
|
+
/**
|
|
3940
|
+
* The **Text wrapping** action on a table.
|
|
3941
|
+
* Wraps or clips column text on a table.
|
|
3942
|
+
* @example
|
|
3943
|
+
* ```js
|
|
3944
|
+
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
3945
|
+
* ```
|
|
3946
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3947
|
+
*/
|
|
3948
|
+
AxisMenuTextWrapping = "axisMenuTextWrapping",
|
|
3949
|
+
/**
|
|
3950
|
+
* The **Remove** action in the chart axis or table column
|
|
3951
|
+
* customization menu.
|
|
3952
|
+
* Removes the data labels from a chart or the column of a
|
|
3953
|
+
* table visualization.
|
|
3954
|
+
* @example
|
|
3955
|
+
* ```js
|
|
3956
|
+
* disabledActions: [Action.AxisMenuRemove]
|
|
3957
|
+
* ```
|
|
3958
|
+
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
3959
|
+
*/
|
|
3960
|
+
AxisMenuRemove = "axisMenuRemove",
|
|
3961
|
+
/**
|
|
3962
|
+
* @hidden
|
|
3963
|
+
*/
|
|
3964
|
+
InsertInToSlide = "insertInToSlide",
|
|
3965
|
+
/**
|
|
3966
|
+
* The **Rename** menu action on Liveboards and visualizations.
|
|
3967
|
+
* Allows renaming a Liveboard or visualization.
|
|
3968
|
+
* @example
|
|
3969
|
+
* ```js
|
|
3970
|
+
* disabledActions: [Action.RenameModalTitleDescription]
|
|
3971
|
+
* ```
|
|
3972
|
+
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3973
|
+
*/
|
|
3974
|
+
RenameModalTitleDescription = "renameModalTitleDescription",
|
|
3975
|
+
/**
|
|
3976
|
+
*
|
|
3977
|
+
* @example
|
|
3978
|
+
* ```js
|
|
3979
|
+
* disabledActions: [Action.RequestVerification]
|
|
3980
|
+
* ```
|
|
3981
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3982
|
+
*/
|
|
3983
|
+
RequestVerification = "requestVerification",
|
|
3984
|
+
/**
|
|
3985
|
+
*
|
|
3986
|
+
*Allows users to mark a Liveboard as verified.
|
|
3987
|
+
* @example
|
|
3988
|
+
* ```js
|
|
3989
|
+
* disabledActions: [Action.MarkAsVerified]
|
|
3990
|
+
* ```
|
|
3991
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
3992
|
+
*/
|
|
3993
|
+
MarkAsVerified = "markAsVerified",
|
|
3994
|
+
/**
|
|
3995
|
+
* The **Add Tab** action on a Liveboard.
|
|
3996
|
+
* Allows adding a new tab to a Liveboard view.
|
|
3997
|
+
* @example
|
|
3998
|
+
* ```js
|
|
3999
|
+
* disabledActions: [Action.AddTab]
|
|
4000
|
+
* ```
|
|
4001
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4002
|
+
*/
|
|
4003
|
+
AddTab = "addTab",
|
|
4004
|
+
/**
|
|
4005
|
+
*
|
|
4006
|
+
*Initiates contextual change analysis on KPI charts.
|
|
4007
|
+
* @example
|
|
4008
|
+
* ```js
|
|
4009
|
+
* disabledActions: [Action.EnableContextualChangeAnalysis]
|
|
4010
|
+
* ```
|
|
4011
|
+
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
4012
|
+
*/
|
|
4013
|
+
EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
|
|
4014
|
+
/**
|
|
4015
|
+
*
|
|
4016
|
+
* @example
|
|
4017
|
+
* ```js
|
|
4018
|
+
* disabledActions: [Action.ShowSageQuery]
|
|
4019
|
+
* ```
|
|
4020
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4021
|
+
*/
|
|
4022
|
+
ShowSageQuery = "showSageQuery",
|
|
4023
|
+
/**
|
|
4024
|
+
*
|
|
4025
|
+
* @example
|
|
4026
|
+
* ```js
|
|
4027
|
+
* disabledActions: [Action.EditSageAnswer]
|
|
4028
|
+
* ```
|
|
4029
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4030
|
+
*/
|
|
4031
|
+
EditSageAnswer = "editSageAnswer",
|
|
4032
|
+
/**
|
|
4033
|
+
*
|
|
4034
|
+
*This action allows users to send feedback on AI-generated Answers.
|
|
4035
|
+
* @example
|
|
4036
|
+
* ```js
|
|
4037
|
+
* disabledActions: [Action.SageAnswerFeedback]
|
|
4038
|
+
* ```
|
|
4039
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4040
|
+
*/
|
|
4041
|
+
SageAnswerFeedback = "sageAnswerFeedback",
|
|
4042
|
+
/**
|
|
4043
|
+
*
|
|
4044
|
+
* @example
|
|
4045
|
+
* ```js
|
|
4046
|
+
* disabledActions: [Action.ModifySageAnswer]
|
|
4047
|
+
* ```
|
|
4048
|
+
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4049
|
+
*/
|
|
4050
|
+
ModifySageAnswer = "modifySageAnswer",
|
|
4051
|
+
/**
|
|
4052
|
+
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
4053
|
+
* Allows moving a visualization to a different tab.
|
|
4054
|
+
* @example
|
|
4055
|
+
* ```js
|
|
4056
|
+
* disabledActions: [Action.MoveToTab]
|
|
4057
|
+
* ```
|
|
4058
|
+
*/
|
|
4059
|
+
MoveToTab = "onContainerMove",
|
|
4060
|
+
/**
|
|
4061
|
+
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
4062
|
+
* @example
|
|
4063
|
+
* ```js
|
|
4064
|
+
* disabledActions: [Action.ManageMonitor]
|
|
4065
|
+
* ```
|
|
4066
|
+
*/
|
|
4067
|
+
ManageMonitor = "manageMonitor",
|
|
4068
|
+
/**
|
|
4069
|
+
* Action ID for Liveboard Personalised Views dropdown
|
|
4070
|
+
* @example
|
|
4071
|
+
* ```js
|
|
4072
|
+
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4073
|
+
* ```
|
|
4074
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4075
|
+
*/
|
|
4076
|
+
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
4077
|
+
/**
|
|
4078
|
+
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
4079
|
+
* @example
|
|
4080
|
+
* ```js
|
|
4081
|
+
* disabledActions: [Action.LiveboardUsers]
|
|
4082
|
+
* ```
|
|
4083
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4084
|
+
*/
|
|
4085
|
+
LiveboardUsers = "liveboardUsers",
|
|
4086
|
+
/**
|
|
4087
|
+
* Action ID for the Parent TML action
|
|
4088
|
+
* The parent action **TML** must be included to access TML-related options
|
|
4089
|
+
* within the cascading menu (specific to the answer page)
|
|
4090
|
+
* @example
|
|
4091
|
+
* ```js
|
|
4092
|
+
* // to include specific TML actions
|
|
4093
|
+
* visibleActions: [Action.TML, Action.ExportTML, Action.EditTML]
|
|
4094
|
+
*
|
|
4095
|
+
* ```
|
|
4096
|
+
* @example
|
|
4097
|
+
* ```js
|
|
4098
|
+
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4099
|
+
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4100
|
+
* ```
|
|
4101
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
4102
|
+
*/
|
|
4103
|
+
TML = "tml",
|
|
4104
|
+
/**
|
|
4105
|
+
* Action Id for CreateLiveboard for liveboard list page & Pin Modal
|
|
4106
|
+
* @example
|
|
4107
|
+
* ```js
|
|
4108
|
+
* hiddenAction: [Action.CreateLiveboard]
|
|
4109
|
+
* disabledActions: [Action.CreateLiveboard]
|
|
4110
|
+
* ```
|
|
4111
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
|
|
4112
|
+
*/
|
|
4113
|
+
CreateLiveboard = "createLiveboard",
|
|
4114
|
+
/**
|
|
4115
|
+
* Action ID for to hide Verified Liveboard Banner
|
|
4116
|
+
* @example
|
|
4117
|
+
* ```js
|
|
4118
|
+
* hiddenAction: [Action.VerifiedLiveboard]
|
|
4119
|
+
* ```
|
|
4120
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
|
|
4121
|
+
*/
|
|
4122
|
+
VerifiedLiveboard = "verifiedLiveboard",
|
|
4123
|
+
/**
|
|
4124
|
+
* Action ID for ask sage button
|
|
4125
|
+
* @example
|
|
4126
|
+
* ```js
|
|
4127
|
+
* hiddenAction: [Action.AskAi]
|
|
4128
|
+
* ```
|
|
4129
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
4130
|
+
*/
|
|
4131
|
+
AskAi = "AskAi",
|
|
4132
|
+
/**
|
|
4133
|
+
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
4134
|
+
* @example
|
|
4135
|
+
* ```js
|
|
4136
|
+
* disabledActions: [Action.AddToWatchlist]
|
|
4137
|
+
* ```
|
|
4138
|
+
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
4139
|
+
*/
|
|
4140
|
+
AddToWatchlist = "addToWatchlist",
|
|
4141
|
+
/**
|
|
4142
|
+
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
4143
|
+
* @example
|
|
4144
|
+
* ```js
|
|
4145
|
+
* disabledActions: [Action.RemoveFromWatchlist]
|
|
4146
|
+
* ```
|
|
4147
|
+
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
4148
|
+
*/
|
|
4149
|
+
RemoveFromWatchlist = "removeFromWatchlist",
|
|
4150
|
+
/**
|
|
4151
|
+
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
4152
|
+
* @example
|
|
4153
|
+
* ```js
|
|
4154
|
+
* disabledActions: [Action.OrganiseFavourites]
|
|
4155
|
+
* ```
|
|
4156
|
+
* @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
4157
|
+
*/
|
|
4158
|
+
OrganiseFavourites = "organiseFavourites",
|
|
4159
|
+
/**
|
|
4160
|
+
* Action ID for AI Highlights button
|
|
4161
|
+
* @example
|
|
4162
|
+
* ```js
|
|
4163
|
+
* hiddenAction: [Action.AIHighlights]
|
|
4164
|
+
* ```
|
|
4165
|
+
* @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
|
|
4166
|
+
*/
|
|
4167
|
+
AIHighlights = "AIHighlights",
|
|
4168
|
+
/**
|
|
4169
|
+
* Action ID for edit schedule action on schedule on homepage
|
|
4170
|
+
* @example
|
|
4171
|
+
* ```js
|
|
4172
|
+
* disabledActions: [Action.EditScheduleHomepage]
|
|
4173
|
+
* ```
|
|
4174
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4175
|
+
*/
|
|
4176
|
+
EditScheduleHomepage = "editScheduleHomepage",
|
|
4177
|
+
/**
|
|
4178
|
+
* Action ID for pause schedule action on schedule on homepage
|
|
4179
|
+
* @example
|
|
4180
|
+
* ```js
|
|
4181
|
+
* disabledActions: [Action.PauseScheduleHomepage]
|
|
4182
|
+
* ```
|
|
4183
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4184
|
+
*/
|
|
4185
|
+
PauseScheduleHomepage = "pauseScheduleHomepage",
|
|
4186
|
+
/**
|
|
4187
|
+
* Action ID for view schedule run action on schedule on homepage
|
|
4188
|
+
* @example
|
|
4189
|
+
* ```js
|
|
4190
|
+
* disabledActions: [Action.ViewScheduleRunHomepage]
|
|
4191
|
+
* ```
|
|
4192
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4193
|
+
*/
|
|
4194
|
+
ViewScheduleRunHomepage = "viewScheduleRunHomepage",
|
|
4195
|
+
/**
|
|
4196
|
+
* Action ID for unsubscribe schedule action on schedule on homepage
|
|
4197
|
+
* @example
|
|
4198
|
+
* ```js
|
|
4199
|
+
* disabledActions: [Action.UnsubscribeScheduleHomepage]
|
|
4200
|
+
* ```
|
|
4201
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4202
|
+
*/
|
|
4203
|
+
UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
|
|
4204
|
+
/**
|
|
4205
|
+
* The **Manage Tags** action on Homepage Favourite Module.
|
|
4206
|
+
* @example
|
|
4207
|
+
* ```js
|
|
4208
|
+
* disabledActions: [Action.ManageTags]
|
|
4209
|
+
* ```
|
|
4210
|
+
* @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4211
|
+
*/
|
|
4212
|
+
ManageTags = "manageTags",
|
|
4213
|
+
/**
|
|
4214
|
+
* Action ID for delete schedule action on schedule on homepage
|
|
4215
|
+
* @example
|
|
4216
|
+
* ```js
|
|
4217
|
+
* disabledActions: [Action.DeleteScheduleHomepage]
|
|
4218
|
+
* ```
|
|
4219
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4220
|
+
*/
|
|
4221
|
+
DeleteScheduleHomepage = "deleteScheduleHomepage",
|
|
4222
|
+
/**
|
|
4223
|
+
* The **Analyze CTA** action on KPI chart.
|
|
4224
|
+
* @example
|
|
4225
|
+
* ```js
|
|
4226
|
+
* disabledActions: [Action.KPIAnalysisCTA]
|
|
4227
|
+
* ```
|
|
4228
|
+
* @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
|
|
4229
|
+
*/
|
|
4230
|
+
KPIAnalysisCTA = "kpiAnalysisCTA"
|
|
4231
|
+
}
|
|
4232
|
+
export interface AnswerServiceType {
|
|
4233
|
+
getAnswer?: (offset: number, batchSize: number) => any;
|
|
4234
|
+
}
|
|
4235
|
+
export declare enum PrefetchFeatures {
|
|
4236
|
+
FullApp = "FullApp",
|
|
4237
|
+
SearchEmbed = "SearchEmbed",
|
|
4238
|
+
LiveboardEmbed = "LiveboardEmbed",
|
|
4239
|
+
VizEmbed = "VizEmbed"
|
|
4240
|
+
}
|
|
4241
|
+
/**
|
|
4242
|
+
* Enum for options to change context trigger
|
|
4243
|
+
*/
|
|
4244
|
+
export declare enum ContextMenuTriggerOptions {
|
|
4245
|
+
LEFT_CLICK = "left-click",
|
|
4246
|
+
RIGHT_CLICK = "right-click"
|
|
4247
|
+
}
|
|
4248
|
+
export interface ColumnValue {
|
|
4249
|
+
column: {
|
|
4250
|
+
id: string;
|
|
4251
|
+
name: string;
|
|
4252
|
+
dataType: string;
|
|
4253
|
+
[key: string]: any;
|
|
4254
|
+
};
|
|
4255
|
+
value: string | number | boolean | {
|
|
4256
|
+
v: {
|
|
4257
|
+
s: number;
|
|
4258
|
+
e: number;
|
|
4259
|
+
};
|
|
4260
|
+
};
|
|
4261
|
+
}
|
|
4262
|
+
export interface VizPoint {
|
|
4263
|
+
selectedAttributes: ColumnValue[];
|
|
4264
|
+
selectedMeasures: ColumnValue[];
|
|
4265
|
+
}
|
|
4266
|
+
/**
|
|
4267
|
+
* @group Events
|
|
4268
|
+
*/
|
|
4269
|
+
export interface CustomActionPayload {
|
|
4270
|
+
contextMenuPoints?: {
|
|
4271
|
+
clickedPoint: VizPoint;
|
|
4272
|
+
selectedPoints: VizPoint[];
|
|
4273
|
+
};
|
|
4274
|
+
embedAnswerData: {
|
|
4275
|
+
name: string;
|
|
4276
|
+
id: string;
|
|
4277
|
+
sources: {
|
|
4278
|
+
header: {
|
|
4279
|
+
guid: string;
|
|
4280
|
+
};
|
|
4281
|
+
};
|
|
4282
|
+
columns: any[];
|
|
4283
|
+
data: any[];
|
|
4284
|
+
[key: string]: any;
|
|
4285
|
+
};
|
|
4286
|
+
session: SessionInterface;
|
|
4287
|
+
vizId?: string;
|
|
4288
|
+
}
|
|
4289
|
+
export declare enum LogLevel {
|
|
4290
|
+
/**
|
|
4291
|
+
* No logs will be logged in the console.
|
|
4292
|
+
* @example
|
|
4293
|
+
* ```js
|
|
4294
|
+
* init({
|
|
4295
|
+
* ... // other options,
|
|
4296
|
+
* logLevel: LogLevel.SILENT,
|
|
4297
|
+
* })
|
|
4298
|
+
* ```
|
|
4299
|
+
* @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
|
|
4300
|
+
*/
|
|
4301
|
+
SILENT = "SILENT",
|
|
4302
|
+
/**
|
|
4303
|
+
* Only ERROR logs will be logged in the console.
|
|
4304
|
+
* @example
|
|
4305
|
+
* ```js
|
|
4306
|
+
* init({
|
|
4307
|
+
* ... // other options,
|
|
4308
|
+
* logLevel: LogLevel.ERROR,
|
|
4309
|
+
* })
|
|
4310
|
+
* ```
|
|
4311
|
+
* @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
|
|
4312
|
+
*/
|
|
4313
|
+
ERROR = "ERROR",
|
|
4314
|
+
/**
|
|
4315
|
+
* Only WARN and ERROR logs will be logged in the console.
|
|
4316
|
+
* @example
|
|
4317
|
+
* ```js
|
|
4318
|
+
* init({
|
|
4319
|
+
* ... // other options,
|
|
4320
|
+
* logLevel: LogLevel.WARN,
|
|
4321
|
+
* })
|
|
4322
|
+
* ```
|
|
4323
|
+
* @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
|
|
4324
|
+
*/
|
|
4325
|
+
WARN = "WARN",
|
|
4326
|
+
/**
|
|
4327
|
+
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
4328
|
+
* @example
|
|
4329
|
+
* ```js
|
|
4330
|
+
* init({
|
|
4331
|
+
* ... // other options,
|
|
4332
|
+
* logLevel: LogLevel.INFO,
|
|
4333
|
+
* })
|
|
4334
|
+
* ```
|
|
4335
|
+
* @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
|
|
4336
|
+
*/
|
|
4337
|
+
INFO = "INFO",
|
|
4338
|
+
/**
|
|
4339
|
+
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
4340
|
+
* @example
|
|
4341
|
+
* ```js
|
|
4342
|
+
* init({
|
|
4343
|
+
* ... // other options,
|
|
4344
|
+
* logLevel: LogLevel.DEBUG,
|
|
4345
|
+
* })
|
|
4346
|
+
* ```
|
|
4347
|
+
* @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
|
|
4348
|
+
*/
|
|
4349
|
+
DEBUG = "DEBUG",
|
|
4350
|
+
/**
|
|
4351
|
+
* All logs will be logged in the console.
|
|
4352
|
+
* @example
|
|
4353
|
+
* ```js
|
|
4354
|
+
* init({
|
|
4355
|
+
* ... // other options,
|
|
4356
|
+
* logLevel: LogLevel.TRACE,
|
|
4357
|
+
* })
|
|
4358
|
+
* ```
|
|
4359
|
+
* @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
|
|
4360
|
+
*/
|
|
4361
|
+
TRACE = "TRACE"
|
|
4362
|
+
}
|
|
4363
|
+
//# sourceMappingURL=types.d.ts.map
|