@thoughtspot/visual-embed-sdk 1.29.1-alpha.1 → 1.29.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/cjs/package.json +2 -1
- package/cjs/src/auth.d.ts +16 -28
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +56 -53
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/auth.spec.d.ts +0 -12
- package/cjs/src/auth.spec.d.ts.map +1 -1
- package/cjs/src/auth.spec.js +67 -89
- package/cjs/src/auth.spec.js.map +1 -1
- package/cjs/src/authToken.d.ts +2 -3
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +12 -13
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/authToken.spec.d.ts +2 -0
- package/cjs/src/authToken.spec.d.ts.map +1 -0
- package/cjs/src/authToken.spec.js +29 -0
- package/cjs/src/authToken.spec.js.map +1 -0
- package/cjs/src/config.d.ts +0 -1
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +0 -2
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/embed/app.d.ts +73 -43
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +45 -12
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +23 -4
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +1 -7
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +9 -17
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +3 -2
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embed.spec.js +0 -3
- package/cjs/src/embed/embed.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +0 -2
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +0 -2
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/events.spec.js +0 -3
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +14 -28
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +8 -8
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +79 -6
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/pinboard.spec.js +0 -3
- package/cjs/src/embed/pinboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +5 -21
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +2 -23
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/sage.spec.js +20 -34
- package/cjs/src/embed/sage.spec.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +0 -11
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +0 -2
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +60 -29
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +43 -9
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +34 -1
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed-trigger.spec.js +0 -3
- package/cjs/src/embed/ts-embed-trigger.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +1 -31
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +34 -44
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +83 -16
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.js +1 -1
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/index.d.ts +1 -3
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +1 -3
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +1 -3
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +0 -2
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/mixpanel-service.spec.js +0 -7
- package/cjs/src/mixpanel-service.spec.js.map +1 -1
- package/cjs/src/react/index.d.ts +2 -13
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +2 -13
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +15 -9
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/test/test-utils.d.ts +0 -2
- package/cjs/src/test/test-utils.d.ts.map +1 -1
- package/cjs/src/test/test-utils.js +0 -2
- package/cjs/src/test/test-utils.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +0 -1
- package/cjs/src/tokenizedFetch.d.ts.map +1 -1
- package/cjs/src/tokenizedFetch.js +0 -1
- package/cjs/src/tokenizedFetch.js.map +1 -1
- package/cjs/src/types.d.ts +276 -369
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +226 -299
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +0 -2
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +0 -2
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/authService/authService.spec.js +5 -18
- package/cjs/src/utils/authService/authService.spec.js.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts +2 -15
- package/cjs/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/cjs/src/utils/authService/tokenizedAuthService.js +9 -39
- package/cjs/src/utils/authService/tokenizedAuthService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +3 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +75 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +37 -12
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +70 -14
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +78 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/logger.d.ts.map +1 -1
- package/cjs/src/utils/logger.js +3 -5
- package/cjs/src/utils/logger.js.map +1 -1
- package/cjs/src/utils/processData.js +3 -3
- package/cjs/src/utils/processData.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +3 -4
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +0 -1
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +0 -2
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +2 -10
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +19 -13
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +16 -28
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/auth.spec.d.ts +0 -12
- package/dist/src/auth.spec.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +2 -3
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/authToken.spec.d.ts +2 -0
- package/dist/src/authToken.spec.d.ts.map +1 -0
- package/dist/src/config.d.ts +0 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +73 -43
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +1 -7
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +0 -2
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +14 -28
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +5 -21
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +0 -11
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +60 -29
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +1 -31
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +1 -3
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +1 -3
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +2 -13
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +0 -2
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/tokenizedFetch.d.ts +0 -1
- package/dist/src/tokenizedFetch.d.ts.map +1 -1
- package/dist/src/types.d.ts +276 -369
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +0 -2
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/authService/tokenizedAuthService.d.ts +2 -15
- package/dist/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +3 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +37 -12
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/logger.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +0 -1
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +2 -10
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +6935 -7012
- package/dist/tsembed-react.js +6928 -7002
- package/dist/tsembed.es.js +1961 -2240
- package/dist/tsembed.js +15248 -15519
- package/dist/visual-embed-sdk-react-full.d.ts +480 -648
- package/dist/visual-embed-sdk-react.d.ts +480 -648
- package/dist/visual-embed-sdk.d.ts +479 -636
- package/lib/package.json +2 -1
- package/lib/src/auth.d.ts +16 -28
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +53 -52
- package/lib/src/auth.js.map +1 -1
- package/lib/src/auth.spec.d.ts +0 -12
- package/lib/src/auth.spec.d.ts.map +1 -1
- package/lib/src/auth.spec.js +66 -88
- package/lib/src/auth.spec.js.map +1 -1
- package/lib/src/authToken.d.ts +2 -3
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +12 -13
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/authToken.spec.d.ts +2 -0
- package/lib/src/authToken.spec.d.ts.map +1 -0
- package/lib/src/authToken.spec.js +26 -0
- package/lib/src/authToken.spec.js.map +1 -0
- package/lib/src/config.d.ts +0 -1
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +0 -2
- package/lib/src/config.js.map +1 -1
- package/lib/src/embed/app.d.ts +73 -43
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +44 -11
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +24 -5
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -7
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +8 -16
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +4 -3
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embed.spec.js +0 -2
- package/lib/src/embed/embed.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +0 -2
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +0 -2
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/events.spec.js +0 -2
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +14 -28
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +9 -9
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +79 -6
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/pinboard.spec.js +0 -2
- package/lib/src/embed/pinboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts +5 -21
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +2 -23
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/sage.spec.js +20 -33
- package/lib/src/embed/sage.spec.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +0 -11
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +0 -2
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +60 -29
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +43 -9
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +35 -2
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed-trigger.spec.js +0 -2
- package/lib/src/embed/ts-embed-trigger.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +1 -31
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +37 -47
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +83 -16
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.js +1 -1
- package/lib/src/errors.js.map +1 -1
- package/lib/src/index.d.ts +1 -3
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -3
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +1 -3
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +0 -2
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/mixpanel-service.spec.js +0 -7
- package/lib/src/mixpanel-service.spec.js.map +1 -1
- package/lib/src/react/index.d.ts +2 -13
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +2 -12
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +16 -10
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +0 -2
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +0 -2
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +0 -1
- package/lib/src/tokenizedFetch.d.ts.map +1 -1
- package/lib/src/tokenizedFetch.js +0 -1
- package/lib/src/tokenizedFetch.js.map +1 -1
- package/lib/src/types.d.ts +276 -369
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +226 -299
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +0 -2
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +0 -2
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +6 -19
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.d.ts +2 -15
- package/lib/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
- package/lib/src/utils/authService/tokenizedAuthService.js +8 -37
- package/lib/src/utils/authService/tokenizedAuthService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +3 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +74 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +37 -12
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +71 -15
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +80 -2
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/logger.d.ts.map +1 -1
- package/lib/src/utils/logger.js +2 -3
- package/lib/src/utils/logger.js.map +1 -1
- package/lib/src/utils/processData.js +4 -4
- package/lib/src/utils/processData.js.map +1 -1
- package/lib/src/utils/processData.spec.js +3 -4
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +0 -1
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +0 -2
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +2 -10
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +17 -12
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +486 -647
- package/package.json +2 -1
- package/src/auth.spec.ts +72 -92
- package/src/auth.ts +62 -57
- package/src/authToken.spec.ts +31 -0
- package/src/authToken.ts +12 -12
- package/src/config.ts +0 -2
- package/src/embed/app.spec.ts +39 -5
- package/src/embed/app.ts +108 -50
- package/src/embed/base.spec.ts +5 -4
- package/src/embed/base.ts +30 -36
- package/src/embed/embed.spec.ts +0 -2
- package/src/embed/embedConfig.ts +0 -2
- package/src/embed/events.spec.ts +0 -2
- package/src/embed/liveboard.spec.ts +104 -11
- package/src/embed/liveboard.ts +25 -38
- package/src/embed/pinboard.spec.ts +0 -2
- package/src/embed/sage.spec.ts +20 -38
- package/src/embed/sage.ts +5 -38
- package/src/embed/search-bar.tsx +0 -11
- package/src/embed/search.spec.ts +48 -2
- package/src/embed/search.ts +94 -38
- package/src/embed/ts-embed-trigger.spec.ts +0 -3
- package/src/embed/ts-embed.spec.ts +109 -32
- package/src/embed/ts-embed.ts +68 -79
- package/src/errors.ts +1 -1
- package/src/index.ts +1 -3
- package/src/mixpanel-service.spec.ts +3 -12
- package/src/mixpanel-service.ts +1 -4
- package/src/react/index.spec.tsx +48 -67
- package/src/react/index.tsx +1 -13
- package/src/test/test-utils.ts +0 -2
- package/src/tokenizedFetch.ts +0 -1
- package/src/types.ts +276 -368
- package/src/utils/authService/authService.spec.ts +9 -22
- package/src/utils/authService/authService.ts +0 -2
- package/src/utils/authService/tokenizedAuthService.ts +8 -38
- package/src/utils/graphql/answerService/answer-queries.ts +77 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +88 -2
- package/src/utils/graphql/answerService/answerService.ts +87 -16
- package/src/utils/logger.ts +2 -3
- package/src/utils/processData.spec.ts +3 -4
- package/src/utils/processData.ts +4 -4
- package/src/utils/processTrigger.ts +0 -2
- package/src/utils.ts +21 -13
- package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts +0 -2
- package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts.map +0 -1
- package/cjs/src/utils/authService/tokenizedAuthService.spec.js +0 -32
- package/cjs/src/utils/authService/tokenizedAuthService.spec.js.map +0 -1
- package/cjs/src/utils/sessionInfoService.d.ts +0 -66
- package/cjs/src/utils/sessionInfoService.d.ts.map +0 -1
- package/cjs/src/utils/sessionInfoService.js +0 -92
- package/cjs/src/utils/sessionInfoService.js.map +0 -1
- package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts +0 -2
- package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts.map +0 -1
- package/dist/src/utils/sessionInfoService.d.ts +0 -66
- package/dist/src/utils/sessionInfoService.d.ts.map +0 -1
- package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts +0 -2
- package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts.map +0 -1
- package/lib/src/utils/authService/tokenizedAuthService.spec.js +0 -29
- package/lib/src/utils/authService/tokenizedAuthService.spec.js.map +0 -1
- package/lib/src/utils/sessionInfoService.d.ts +0 -66
- package/lib/src/utils/sessionInfoService.d.ts.map +0 -1
- package/lib/src/utils/sessionInfoService.js +0 -85
- package/lib/src/utils/sessionInfoService.js.map +0 -1
- package/src/utils/authService/tokenizedAuthService.spec.ts +0 -36
- package/src/utils/sessionInfoService.ts +0 -101
|
@@ -9,7 +9,6 @@ import EventEmitter from 'eventemitter3';
|
|
|
9
9
|
*
|
|
10
10
|
* ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
|
|
11
11
|
* in other web applications.
|
|
12
|
-
*
|
|
13
12
|
* @summary ThoughtSpot Visual Embed SDK
|
|
14
13
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
15
14
|
*/
|
|
@@ -20,7 +19,6 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
20
19
|
*
|
|
21
20
|
* Full application embedding
|
|
22
21
|
* https://developers.thoughtspot.com/docs/?pageid=full-embed
|
|
23
|
-
*
|
|
24
22
|
* @summary Full app embed
|
|
25
23
|
* @module
|
|
26
24
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
@@ -58,9 +56,26 @@ export enum Page {
|
|
|
58
56
|
*/
|
|
59
57
|
SpotIQ = "insights"
|
|
60
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
* Define the initial state os column custom group accordions
|
|
61
|
+
* in data panel v2.
|
|
62
|
+
*/
|
|
63
|
+
export enum DataPanelCustomColumnGroupsAccordionState {
|
|
64
|
+
/**
|
|
65
|
+
* Expand all the accordion initially in data panel v2.
|
|
66
|
+
*/
|
|
67
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
68
|
+
/**
|
|
69
|
+
* Collapse all the accordions initially in data panel v2.
|
|
70
|
+
*/
|
|
71
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
72
|
+
/**
|
|
73
|
+
* Expand the first accordion and collapse the rest.
|
|
74
|
+
*/
|
|
75
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
76
|
+
}
|
|
61
77
|
/**
|
|
62
78
|
* The view configuration for full app embedding.
|
|
63
|
-
*
|
|
64
79
|
* @group Embed components
|
|
65
80
|
*/
|
|
66
81
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
@@ -68,10 +83,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
68
83
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
69
84
|
* is displayed. By default, the navigation bar is hidden.
|
|
70
85
|
* This flag also controls the homepage left navigation bar.
|
|
71
|
-
*
|
|
72
86
|
* @default true
|
|
73
87
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
74
|
-
*
|
|
75
88
|
* @example
|
|
76
89
|
* ```js
|
|
77
90
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -87,13 +100,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
87
100
|
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
88
101
|
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
89
102
|
*
|
|
103
|
+
*
|
|
90
104
|
* **Note**: This option does not apply to the classic homepage.
|
|
91
105
|
* To access the updated modular homepage, set
|
|
92
106
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
93
|
-
*
|
|
94
107
|
* @default false
|
|
95
108
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
96
|
-
*
|
|
97
109
|
* @example
|
|
98
110
|
* ```js
|
|
99
111
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -108,7 +120,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
108
120
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
109
121
|
* @default false
|
|
110
122
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
111
|
-
*
|
|
112
123
|
* @example
|
|
113
124
|
* ```js
|
|
114
125
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -122,13 +133,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
122
133
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
123
134
|
* By default, the application switcher is shown.
|
|
124
135
|
*
|
|
136
|
+
*
|
|
125
137
|
* **Note**: This option does not apply to the classic homepage.
|
|
126
138
|
* To access the updated modular homepage, set
|
|
127
139
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
128
|
-
*
|
|
129
140
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
130
141
|
* @default false
|
|
131
|
-
*
|
|
132
142
|
* @example
|
|
133
143
|
* ```js
|
|
134
144
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -142,13 +152,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
142
152
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
143
153
|
* By default, the Org switcher button is shown.
|
|
144
154
|
*
|
|
155
|
+
*
|
|
145
156
|
* **Note**: This option does not apply to the classic homepage.
|
|
146
157
|
* To access the updated modular homepage, set
|
|
147
158
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
148
|
-
*
|
|
149
159
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
150
160
|
* @default true
|
|
151
|
-
*
|
|
152
161
|
* @example
|
|
153
162
|
* ```js
|
|
154
163
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -166,9 +175,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
166
175
|
*
|
|
167
176
|
* For eg, if you want the component to open to a specific Liveboard
|
|
168
177
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
169
|
-
*
|
|
170
178
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
171
|
-
*
|
|
172
179
|
* @example
|
|
173
180
|
* ```js
|
|
174
181
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -184,9 +191,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
184
191
|
*
|
|
185
192
|
* Use this to open to particular page in the app. To open to a specific
|
|
186
193
|
* path within the app, use the `path` attribute which is more flexible.
|
|
187
|
-
*
|
|
188
194
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
189
|
-
*
|
|
190
195
|
* @example
|
|
191
196
|
* ```js
|
|
192
197
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -200,7 +205,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
200
205
|
* This puts a filter tag on the application. All metadata lists in the
|
|
201
206
|
* application, such as Liveboards and answers, would be filtered by this
|
|
202
207
|
* tag.
|
|
203
|
-
*
|
|
204
208
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
205
209
|
* @example
|
|
206
210
|
* ```js
|
|
@@ -213,9 +217,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
213
217
|
tag?: string;
|
|
214
218
|
/**
|
|
215
219
|
* The array of GUIDs to be hidden
|
|
216
|
-
*
|
|
217
220
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
218
|
-
*
|
|
219
221
|
* @example
|
|
220
222
|
* ```js
|
|
221
223
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -231,7 +233,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
231
233
|
/**
|
|
232
234
|
* Render liveboards using the new v2 rendering mode
|
|
233
235
|
* This is a transient flag which is primarily meant for internal use
|
|
234
|
-
*
|
|
235
236
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
236
237
|
* @hidden
|
|
237
238
|
*/
|
|
@@ -239,9 +240,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
239
240
|
/**
|
|
240
241
|
* If set to true, the Search Assist feature is enabled.
|
|
241
242
|
* @default true
|
|
242
|
-
*
|
|
243
243
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
244
|
-
*
|
|
245
244
|
* @example
|
|
246
245
|
* ```js
|
|
247
246
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -254,9 +253,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
254
253
|
/**
|
|
255
254
|
* If set to true, the embedded object container dynamically resizes
|
|
256
255
|
* according to the height of the pages which support fullHeight mode.
|
|
257
|
-
*
|
|
258
256
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
259
|
-
*
|
|
260
257
|
* @example
|
|
261
258
|
* ```js
|
|
262
259
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -268,7 +265,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
268
265
|
fullHeight?: boolean;
|
|
269
266
|
/**
|
|
270
267
|
* Flag to control Data panel experience
|
|
271
|
-
*
|
|
272
268
|
* @default false
|
|
273
269
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
274
270
|
* @hidden
|
|
@@ -276,10 +272,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
276
272
|
dataPanelV2?: boolean;
|
|
277
273
|
/**
|
|
278
274
|
* Show or hide Liveboard header
|
|
279
|
-
*
|
|
280
275
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
281
276
|
* @default false
|
|
282
|
-
*
|
|
283
277
|
* @example
|
|
284
278
|
* ```js
|
|
285
279
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -291,10 +285,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
291
285
|
hideLiveboardHeader?: boolean;
|
|
292
286
|
/**
|
|
293
287
|
* Show or hide Liveboard title
|
|
294
|
-
*
|
|
295
288
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
296
289
|
* @default false
|
|
297
|
-
*
|
|
298
290
|
* @example
|
|
299
291
|
* ```js
|
|
300
292
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -306,10 +298,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
306
298
|
showLiveboardTitle?: boolean;
|
|
307
299
|
/**
|
|
308
300
|
* Show or hide Liveboard description
|
|
309
|
-
*
|
|
310
301
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
311
302
|
* @default false
|
|
312
|
-
*
|
|
313
303
|
* @example
|
|
314
304
|
* ```js
|
|
315
305
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -321,10 +311,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
321
311
|
showLiveboardDescription?: boolean;
|
|
322
312
|
/**
|
|
323
313
|
* Flag to control new Modular Home experience.
|
|
324
|
-
*
|
|
325
314
|
* @default false
|
|
326
315
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
327
|
-
*
|
|
328
316
|
* @example
|
|
329
317
|
* ```js
|
|
330
318
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -336,7 +324,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
336
324
|
modularHomeExperience?: boolean;
|
|
337
325
|
/**
|
|
338
326
|
* Boolean to control if Liveboard header is sticky or not.
|
|
339
|
-
*
|
|
340
327
|
* @example
|
|
341
328
|
* ```js
|
|
342
329
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -349,22 +336,70 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
349
336
|
isLiveboardHeaderSticky?: boolean;
|
|
350
337
|
/**
|
|
351
338
|
* enable or disable ask sage
|
|
352
|
-
*
|
|
353
339
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
354
340
|
* @default false
|
|
355
341
|
*/
|
|
356
342
|
enableAskSage?: boolean;
|
|
357
343
|
/**
|
|
358
344
|
* To set the initial state of the search bar in case of saved-answers.
|
|
359
|
-
*
|
|
360
345
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
361
346
|
* @default false
|
|
362
347
|
*/
|
|
363
348
|
collapseSearchBarInitially?: boolean;
|
|
349
|
+
/**
|
|
350
|
+
* To enable custom column groups in data panel v2.
|
|
351
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
352
|
+
* @default false
|
|
353
|
+
* @example
|
|
354
|
+
* ```js
|
|
355
|
+
* const embed = new AppEmbed('#embed', {
|
|
356
|
+
* ... // other app view config
|
|
357
|
+
* enableCustomColumnGroups: true,
|
|
358
|
+
* });
|
|
359
|
+
* ```
|
|
360
|
+
*/
|
|
361
|
+
enableCustomColumnGroups?: boolean;
|
|
362
|
+
/**
|
|
363
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
364
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
365
|
+
* List of different enum values:-
|
|
366
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
367
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
368
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
369
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
370
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
371
|
+
* @example
|
|
372
|
+
* ```js
|
|
373
|
+
* const embed = new AppEmbed('#embed', {
|
|
374
|
+
* ... // other app view config
|
|
375
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
376
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
377
|
+
* });
|
|
378
|
+
* ```
|
|
379
|
+
*/
|
|
380
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
381
|
+
/**
|
|
382
|
+
* This flag is used to enable the 2 column layout in liveboard
|
|
383
|
+
* @type {boolean}
|
|
384
|
+
* @default false
|
|
385
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
386
|
+
* @example
|
|
387
|
+
* ```js
|
|
388
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
389
|
+
* ... // other options
|
|
390
|
+
* enable2ColumnLayout: true,
|
|
391
|
+
* })
|
|
392
|
+
* ```
|
|
393
|
+
*/
|
|
394
|
+
enable2ColumnLayout?: boolean;
|
|
395
|
+
/**
|
|
396
|
+
* Flag to use OnBeforeSearchExecute embed event
|
|
397
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
398
|
+
*/
|
|
399
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
364
400
|
}
|
|
365
401
|
/**
|
|
366
402
|
* Embeds full ThoughtSpot experience in a host application.
|
|
367
|
-
*
|
|
368
403
|
* @group Embed components
|
|
369
404
|
*/
|
|
370
405
|
export class AppEmbed extends V1Embed {
|
|
@@ -377,14 +412,12 @@ export class AppEmbed extends V1Embed {
|
|
|
377
412
|
protected getEmbedParams(): string;
|
|
378
413
|
/**
|
|
379
414
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
380
|
-
*
|
|
381
415
|
* @param pageId The ID of the page to be embedded.
|
|
382
416
|
*/
|
|
383
417
|
getIFrameSrc(): string;
|
|
384
418
|
/**
|
|
385
419
|
* Set the iframe height as per the computed height received
|
|
386
420
|
* from the ThoughtSpot app.
|
|
387
|
-
*
|
|
388
421
|
* @param data The event payload
|
|
389
422
|
*/
|
|
390
423
|
protected updateIFrameHeight: (data: MessagePayload) => void;
|
|
@@ -392,7 +425,6 @@ export class AppEmbed extends V1Embed {
|
|
|
392
425
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
393
426
|
* This is used for embedding answers, pinboards, visualizations and full application
|
|
394
427
|
* only.
|
|
395
|
-
*
|
|
396
428
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
397
429
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
398
430
|
* When used with `noReload` (default: true) this can also be a number
|
|
@@ -403,7 +435,6 @@ export class AppEmbed extends V1Embed {
|
|
|
403
435
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
404
436
|
/**
|
|
405
437
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
406
|
-
*
|
|
407
438
|
* @param renderOptions An object containing the page ID
|
|
408
439
|
* to be embedded.
|
|
409
440
|
*/
|
|
@@ -435,7 +466,6 @@ export const handleAuth: () => Promise<boolean>;
|
|
|
435
466
|
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
436
467
|
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
437
468
|
* to your app.
|
|
438
|
-
*
|
|
439
469
|
* @param url The URL provided for prefetch
|
|
440
470
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
441
471
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -447,7 +477,6 @@ export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) =>
|
|
|
447
477
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
448
478
|
* component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
|
|
449
479
|
* to actually embed. That is handled internally.
|
|
450
|
-
*
|
|
451
480
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
452
481
|
* authentication mechanism and so on.
|
|
453
482
|
* @example
|
|
@@ -474,7 +503,6 @@ export function disableAutoLogin(): void;
|
|
|
474
503
|
*
|
|
475
504
|
* You can call the `init` method again to re login, if autoLogin is set to
|
|
476
505
|
* true in this second call it will be honored.
|
|
477
|
-
*
|
|
478
506
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
479
507
|
* @returns Promise which resolves when logout completes.
|
|
480
508
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
@@ -484,13 +512,11 @@ export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
|
|
|
484
512
|
/**
|
|
485
513
|
* Renders functions in a queue, resolves to next function only after the callback next
|
|
486
514
|
* is called
|
|
487
|
-
*
|
|
488
515
|
* @param fn The function being registered
|
|
489
516
|
*/
|
|
490
517
|
export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
491
518
|
/**
|
|
492
519
|
* Imports TML representation of the metadata objects into ThoughtSpot.
|
|
493
|
-
*
|
|
494
520
|
* @param data
|
|
495
521
|
* @example
|
|
496
522
|
* ```js
|
|
@@ -515,7 +541,6 @@ export const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
515
541
|
/**
|
|
516
542
|
* Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
|
|
517
543
|
* format.
|
|
518
|
-
*
|
|
519
544
|
* @param data
|
|
520
545
|
* @example
|
|
521
546
|
* ```js
|
|
@@ -554,13 +579,11 @@ export function reset(): void;
|
|
|
554
579
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
555
580
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
556
581
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
557
|
-
*
|
|
558
582
|
* @summary Liveboard & visualization embed
|
|
559
583
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
560
584
|
*/
|
|
561
585
|
/**
|
|
562
586
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
563
|
-
*
|
|
564
587
|
* @group Embed components
|
|
565
588
|
*/
|
|
566
589
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -573,9 +596,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
573
596
|
* visualizations to display on the screen.
|
|
574
597
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
575
598
|
* incrementally as users scroll the page to view the charts and tables.
|
|
576
|
-
*
|
|
577
599
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
578
|
-
*
|
|
579
600
|
* @example
|
|
580
601
|
* ```js
|
|
581
602
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -589,7 +610,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
589
610
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
590
611
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
591
612
|
* other screens navigable from a Liveboard.
|
|
592
|
-
*
|
|
593
613
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
594
614
|
* @default 500
|
|
595
615
|
* @example
|
|
@@ -604,7 +624,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
604
624
|
defaultHeight?: number;
|
|
605
625
|
/**
|
|
606
626
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
607
|
-
*
|
|
608
627
|
* @example
|
|
609
628
|
* ```js
|
|
610
629
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -612,14 +631,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
612
631
|
* enableVizTransformations:true,
|
|
613
632
|
* })
|
|
614
633
|
* ```
|
|
615
|
-
*
|
|
616
634
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
617
635
|
*/
|
|
618
636
|
enableVizTransformations?: boolean;
|
|
619
637
|
/**
|
|
620
638
|
* The Liveboard to display in the embedded view.
|
|
621
639
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
622
|
-
*
|
|
623
640
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
624
641
|
* @example
|
|
625
642
|
* ```js
|
|
@@ -631,15 +648,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
631
648
|
liveboardId?: string;
|
|
632
649
|
/**
|
|
633
650
|
* To support backward compatibility
|
|
634
|
-
*
|
|
635
651
|
* @hidden
|
|
636
652
|
*/
|
|
637
653
|
pinboardId?: string;
|
|
638
654
|
/**
|
|
639
655
|
* The visualization within the Liveboard to display.
|
|
640
|
-
*
|
|
641
656
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
642
|
-
*
|
|
643
657
|
* @example
|
|
644
658
|
* ```js
|
|
645
659
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -652,7 +666,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
652
666
|
/**
|
|
653
667
|
* If set to true, all filter chips from a
|
|
654
668
|
* Liveboard page will be read-only (no X buttons)
|
|
655
|
-
*
|
|
656
669
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
657
670
|
* @example
|
|
658
671
|
* ```js
|
|
@@ -667,9 +680,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
667
680
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
668
681
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
669
682
|
* event.
|
|
670
|
-
*
|
|
671
683
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
672
|
-
*
|
|
673
684
|
* @example
|
|
674
685
|
* ```js
|
|
675
686
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -683,14 +694,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
683
694
|
visibleVizs?: string[];
|
|
684
695
|
/**
|
|
685
696
|
* To support backward compatibility
|
|
686
|
-
*
|
|
687
697
|
* @hidden
|
|
688
698
|
*/
|
|
689
699
|
preventPinboardFilterRemoval?: boolean;
|
|
690
700
|
/**
|
|
691
701
|
* Render embedded Liveboards and visualizations in the
|
|
692
702
|
* new Liveboard experience mode.
|
|
693
|
-
*
|
|
694
703
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
695
704
|
* @example
|
|
696
705
|
* ```js
|
|
@@ -704,7 +713,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
704
713
|
/**
|
|
705
714
|
* Set a Liveboard tab as an active tab.
|
|
706
715
|
* Specify the tab ID.
|
|
707
|
-
*
|
|
708
716
|
* @example
|
|
709
717
|
* ```js
|
|
710
718
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -717,9 +725,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
717
725
|
activeTabId?: string;
|
|
718
726
|
/**
|
|
719
727
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
720
|
-
*
|
|
721
728
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
722
|
-
*
|
|
723
729
|
* @example
|
|
724
730
|
* ```js
|
|
725
731
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -731,7 +737,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
731
737
|
hideTabPanel?: boolean;
|
|
732
738
|
/**
|
|
733
739
|
* Show or hide the Liveboard header.
|
|
734
|
-
*
|
|
735
740
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
736
741
|
* @default false
|
|
737
742
|
* @example
|
|
@@ -747,7 +752,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
747
752
|
* Show or hide the Liveboard title.
|
|
748
753
|
* @default false
|
|
749
754
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
750
|
-
*
|
|
751
755
|
* @example
|
|
752
756
|
* ```js
|
|
753
757
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -761,7 +765,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
761
765
|
* Show or hide the Liveboard description.
|
|
762
766
|
* @default false
|
|
763
767
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
764
|
-
*
|
|
765
768
|
* @example
|
|
766
769
|
* ```js
|
|
767
770
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -775,7 +778,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
775
778
|
* Control the position and visibility of
|
|
776
779
|
* the Liveboard header as the users scroll down the
|
|
777
780
|
* embedded Liveboard page.
|
|
778
|
-
*
|
|
779
781
|
* @example
|
|
780
782
|
* ```js
|
|
781
783
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -788,7 +790,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
788
790
|
isLiveboardHeaderSticky?: boolean;
|
|
789
791
|
/**
|
|
790
792
|
* enable or disable ask sage
|
|
791
|
-
*
|
|
792
793
|
* @default false
|
|
793
794
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
794
795
|
* @example
|
|
@@ -800,12 +801,25 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
800
801
|
* ```
|
|
801
802
|
*/
|
|
802
803
|
enableAskSage?: boolean;
|
|
804
|
+
/**
|
|
805
|
+
* This flag is used to enable the 2 column layout in liveboard
|
|
806
|
+
* @type {boolean}
|
|
807
|
+
* @default false
|
|
808
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
809
|
+
* @example
|
|
810
|
+
* ```js
|
|
811
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
812
|
+
* ... // other options
|
|
813
|
+
* enable2ColumnLayout: true,
|
|
814
|
+
* })
|
|
815
|
+
* ```
|
|
816
|
+
*/
|
|
817
|
+
enable2ColumnLayout?: boolean;
|
|
803
818
|
}
|
|
804
819
|
/**
|
|
805
820
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
806
821
|
* waits for the authentication to complete, so you need not wait for
|
|
807
822
|
* `AuthStatus.SUCCESS`.
|
|
808
|
-
*
|
|
809
823
|
* @example
|
|
810
824
|
* ```js
|
|
811
825
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -829,14 +843,12 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
829
843
|
protected handleRenderForPrerender(): void;
|
|
830
844
|
/**
|
|
831
845
|
* Triggers an event to the embedded app
|
|
832
|
-
*
|
|
833
846
|
* @param messageType The event type
|
|
834
847
|
* @param data The payload to send with the message
|
|
835
848
|
*/
|
|
836
849
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
837
850
|
/**
|
|
838
851
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
839
|
-
*
|
|
840
852
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
841
853
|
* visualization ID and the runtime filters.
|
|
842
854
|
*/
|
|
@@ -853,7 +865,6 @@ export class PinboardEmbed extends LiveboardEmbed {
|
|
|
853
865
|
* Copyright (c) 2022
|
|
854
866
|
*
|
|
855
867
|
* Embed ThoughtSpot search or a saved answer
|
|
856
|
-
*
|
|
857
868
|
* @summary Search embed
|
|
858
869
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
859
870
|
*/
|
|
@@ -874,18 +885,33 @@ export interface SearchOptions {
|
|
|
874
885
|
*/
|
|
875
886
|
executeSearch?: boolean;
|
|
876
887
|
}
|
|
888
|
+
/**
|
|
889
|
+
* Define the initial state os column custom group accordions
|
|
890
|
+
* in data panel v2.
|
|
891
|
+
*/
|
|
892
|
+
export enum DataPanelCustomColumnGroupsAccordionState {
|
|
893
|
+
/**
|
|
894
|
+
* Expand all the accordion initially in data panel v2.
|
|
895
|
+
*/
|
|
896
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
897
|
+
/**
|
|
898
|
+
* Collapse all the accordions initially in data panel v2.
|
|
899
|
+
*/
|
|
900
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
901
|
+
/**
|
|
902
|
+
* Expand the first accordion and collapse the rest.
|
|
903
|
+
*/
|
|
904
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
905
|
+
}
|
|
877
906
|
/**
|
|
878
907
|
* The configuration attributes for the embedded search view.
|
|
879
|
-
*
|
|
880
908
|
* @group Embed components
|
|
881
909
|
*/
|
|
882
910
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
883
911
|
/**
|
|
884
912
|
* If set to true, the data sources panel is collapsed on load,
|
|
885
913
|
* but can be expanded manually.
|
|
886
|
-
*
|
|
887
914
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
888
|
-
*
|
|
889
915
|
* @example
|
|
890
916
|
* ```js
|
|
891
917
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -897,9 +923,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
897
923
|
collapseDataSources?: boolean;
|
|
898
924
|
/**
|
|
899
925
|
* Show or hide the data sources panel.
|
|
900
|
-
*
|
|
901
926
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
902
|
-
*
|
|
903
927
|
* @example
|
|
904
928
|
* ```js
|
|
905
929
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -913,9 +937,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
913
937
|
* Show or hide the charts and tables in search answers.
|
|
914
938
|
* This attribute can be used to create a custom visualization
|
|
915
939
|
* using raw answer data.
|
|
916
|
-
*
|
|
917
940
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
918
|
-
*
|
|
919
941
|
* @example
|
|
920
942
|
* ```js
|
|
921
943
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -925,11 +947,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
925
947
|
* ```
|
|
926
948
|
*/
|
|
927
949
|
hideResults?: boolean;
|
|
950
|
+
/**
|
|
951
|
+
* If set to true, expands all the data sources panel.
|
|
952
|
+
*/
|
|
953
|
+
expandAllDataSource?: boolean;
|
|
928
954
|
/**
|
|
929
955
|
* If set to true, the Search Assist feature is enabled.
|
|
930
|
-
*
|
|
931
956
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
932
|
-
*
|
|
933
957
|
* @example
|
|
934
958
|
* ```js
|
|
935
959
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -942,9 +966,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
942
966
|
/**
|
|
943
967
|
* If set to true, the tabular view is set as the default
|
|
944
968
|
* format for presenting search data.
|
|
945
|
-
*
|
|
946
969
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
947
|
-
*
|
|
948
970
|
* @example
|
|
949
971
|
* ```js
|
|
950
972
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -956,9 +978,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
956
978
|
/**
|
|
957
979
|
* The array of data source GUIDs to set on load.
|
|
958
980
|
* Only a single data source is supported currently.
|
|
959
|
-
*
|
|
960
981
|
* @deprecated Use `dataSource` instead.
|
|
961
|
-
*
|
|
962
982
|
* @example
|
|
963
983
|
* ```js
|
|
964
984
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -970,9 +990,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
970
990
|
dataSources?: string[];
|
|
971
991
|
/**
|
|
972
992
|
* The array of data source GUIDs to set on load.
|
|
973
|
-
*
|
|
974
993
|
* @version: SDK: 1.19.0
|
|
975
|
-
*
|
|
976
994
|
* @example
|
|
977
995
|
* ```js
|
|
978
996
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -984,7 +1002,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
984
1002
|
dataSource?: string;
|
|
985
1003
|
/**
|
|
986
1004
|
* The initial search query to load the answer with.
|
|
987
|
-
*
|
|
988
1005
|
* @deprecated
|
|
989
1006
|
*
|
|
990
1007
|
* Use {@link searchOptions} instead.
|
|
@@ -1000,7 +1017,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1000
1017
|
* If it is executed, the focus is placed on the results.
|
|
1001
1018
|
* If it’s not executed, the focus is placed at the end of
|
|
1002
1019
|
* the token string in the search bar.
|
|
1003
|
-
*
|
|
1004
1020
|
* @example
|
|
1005
1021
|
* ```js
|
|
1006
1022
|
* searchOptions: {
|
|
@@ -1012,9 +1028,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1012
1028
|
searchOptions?: SearchOptions;
|
|
1013
1029
|
/**
|
|
1014
1030
|
* The GUID of a saved answer to load initially.
|
|
1015
|
-
*
|
|
1016
1031
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1017
|
-
*
|
|
1018
1032
|
* @example
|
|
1019
1033
|
* ```js
|
|
1020
1034
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1027,9 +1041,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1027
1041
|
/**
|
|
1028
1042
|
* If set to true, the search page will render without the Search Bar
|
|
1029
1043
|
* The chart/table should still be visible.
|
|
1030
|
-
*
|
|
1031
1044
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1032
|
-
*
|
|
1033
1045
|
* @example
|
|
1034
1046
|
* ```js
|
|
1035
1047
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1041,10 +1053,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1041
1053
|
hideSearchBar?: boolean;
|
|
1042
1054
|
/**
|
|
1043
1055
|
* Flag to control Data panel experience
|
|
1044
|
-
*
|
|
1045
1056
|
* @default false
|
|
1046
1057
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1047
|
-
*
|
|
1048
1058
|
* @example
|
|
1049
1059
|
* ```js
|
|
1050
1060
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1056,22 +1066,56 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1056
1066
|
dataPanelV2?: boolean;
|
|
1057
1067
|
/**
|
|
1058
1068
|
* Flag to set if last selected dataSource should be used
|
|
1059
|
-
*
|
|
1060
1069
|
* @version: SDK: 1.24.0
|
|
1061
1070
|
*/
|
|
1062
1071
|
useLastSelectedSources?: boolean;
|
|
1063
1072
|
/**
|
|
1064
1073
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1065
|
-
*
|
|
1066
1074
|
* @default false
|
|
1067
1075
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1068
1076
|
*/
|
|
1069
1077
|
collapseSearchBarInitially?: boolean;
|
|
1078
|
+
/**
|
|
1079
|
+
* To enable custom column groups in data panel v2
|
|
1080
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1081
|
+
* @default false
|
|
1082
|
+
* @example
|
|
1083
|
+
* ```js
|
|
1084
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
1085
|
+
* ... // other options
|
|
1086
|
+
* enableCustomColumnGroups: true,
|
|
1087
|
+
* });
|
|
1088
|
+
* ```
|
|
1089
|
+
*/
|
|
1090
|
+
enableCustomColumnGroups?: boolean;
|
|
1091
|
+
/**
|
|
1092
|
+
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1093
|
+
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
1094
|
+
*/
|
|
1095
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1096
|
+
/**
|
|
1097
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
1098
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
1099
|
+
* List of different enum values:-
|
|
1100
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1101
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1102
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1103
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1104
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1105
|
+
* @example
|
|
1106
|
+
* ```js
|
|
1107
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
1108
|
+
* ... // other options
|
|
1109
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
1110
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
1111
|
+
* });
|
|
1112
|
+
* ```
|
|
1113
|
+
*/
|
|
1114
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1070
1115
|
}
|
|
1071
1116
|
export const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
1072
1117
|
/**
|
|
1073
1118
|
* Embed ThoughtSpot search
|
|
1074
|
-
*
|
|
1075
1119
|
* @group Embed components
|
|
1076
1120
|
*/
|
|
1077
1121
|
export class SearchEmbed extends TsEmbed {
|
|
@@ -1084,7 +1128,6 @@ export class SearchEmbed extends TsEmbed {
|
|
|
1084
1128
|
/**
|
|
1085
1129
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
1086
1130
|
* loaded in the iframe
|
|
1087
|
-
*
|
|
1088
1131
|
* @param answerId The GUID of a saved answer
|
|
1089
1132
|
* @param dataSources A list of data source GUIDs
|
|
1090
1133
|
*/
|
|
@@ -1102,11 +1145,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1102
1145
|
/**
|
|
1103
1146
|
* The array of data source GUIDs to set on load.
|
|
1104
1147
|
* Only a single data source is supported currently.
|
|
1105
|
-
*
|
|
1106
1148
|
* @deprecated Use `dataSource` instead
|
|
1107
|
-
*
|
|
1108
1149
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
1109
|
-
*
|
|
1110
1150
|
* @example
|
|
1111
1151
|
* ```js
|
|
1112
1152
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1118,9 +1158,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1118
1158
|
dataSources?: string[];
|
|
1119
1159
|
/**
|
|
1120
1160
|
* Pass the ID of the source to be selected.
|
|
1121
|
-
*
|
|
1122
1161
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
1123
|
-
*
|
|
1124
1162
|
* @example
|
|
1125
1163
|
* ```js
|
|
1126
1164
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1132,9 +1170,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1132
1170
|
dataSource?: string;
|
|
1133
1171
|
/**
|
|
1134
1172
|
* Boolean to define if the last selected data source should be used
|
|
1135
|
-
*
|
|
1136
1173
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
1137
|
-
*
|
|
1138
1174
|
* @example
|
|
1139
1175
|
* ```js
|
|
1140
1176
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1154,9 +1190,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1154
1190
|
* If it is executed, the focus is placed on the results.
|
|
1155
1191
|
* If it’s not executed, the focus is placed at the end of
|
|
1156
1192
|
* the token string in the search bar.
|
|
1157
|
-
*
|
|
1158
1193
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
1159
|
-
*
|
|
1160
1194
|
* @example
|
|
1161
1195
|
* ```js
|
|
1162
1196
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1172,7 +1206,6 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1172
1206
|
}
|
|
1173
1207
|
/**
|
|
1174
1208
|
* Embed ThoughtSpot search bar
|
|
1175
|
-
*
|
|
1176
1209
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
1177
1210
|
* @group Embed components
|
|
1178
1211
|
*/
|
|
@@ -1193,10 +1226,15 @@ export let loggedInStatus: boolean;
|
|
|
1193
1226
|
export let samlAuthWindow: Window;
|
|
1194
1227
|
export let samlCompletionPromise: Promise<void>;
|
|
1195
1228
|
export const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
|
|
1229
|
+
interface sessionInfoInterface {
|
|
1230
|
+
userGUID: any;
|
|
1231
|
+
isPublicUser: any;
|
|
1232
|
+
mixpanelToken: any;
|
|
1233
|
+
[key: string]: any;
|
|
1234
|
+
}
|
|
1196
1235
|
/**
|
|
1197
1236
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
1198
1237
|
* of {@link AuthStatus.FAILURE}.
|
|
1199
|
-
*
|
|
1200
1238
|
* @group Authentication / Init
|
|
1201
1239
|
*/
|
|
1202
1240
|
export enum AuthFailureType {
|
|
@@ -1207,7 +1245,6 @@ export enum AuthFailureType {
|
|
|
1207
1245
|
}
|
|
1208
1246
|
/**
|
|
1209
1247
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
1210
|
-
*
|
|
1211
1248
|
* @group Authentication / Init
|
|
1212
1249
|
*/
|
|
1213
1250
|
export enum AuthStatus {
|
|
@@ -1231,27 +1268,23 @@ export enum AuthStatus {
|
|
|
1231
1268
|
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
1232
1269
|
* popup is waiting to be triggered either programmatically
|
|
1233
1270
|
* or by the trigger button.
|
|
1234
|
-
*
|
|
1235
1271
|
* @version SDK: 1.19.0
|
|
1236
1272
|
*/
|
|
1237
1273
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
1238
1274
|
}
|
|
1239
1275
|
/**
|
|
1240
1276
|
* Event emitter returned from {@link init}.
|
|
1241
|
-
*
|
|
1242
1277
|
* @group Authentication / Init
|
|
1243
1278
|
*/
|
|
1244
1279
|
export interface AuthEventEmitter {
|
|
1245
1280
|
/**
|
|
1246
1281
|
* Register a listener on Auth failure.
|
|
1247
|
-
*
|
|
1248
1282
|
* @param event
|
|
1249
1283
|
* @param listener
|
|
1250
1284
|
*/
|
|
1251
1285
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
1252
1286
|
/**
|
|
1253
1287
|
* Register a listener on Auth SDK success.
|
|
1254
|
-
*
|
|
1255
1288
|
* @param event
|
|
1256
1289
|
* @param listener
|
|
1257
1290
|
*/
|
|
@@ -1262,13 +1295,11 @@ export interface AuthEventEmitter {
|
|
|
1262
1295
|
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
1263
1296
|
/**
|
|
1264
1297
|
* Trigger an event on the emitter returned from init.
|
|
1265
|
-
*
|
|
1266
1298
|
* @param {@link AuthEvent}
|
|
1267
1299
|
*/
|
|
1268
1300
|
emit(event: AuthEvent, ...args: any[]): boolean;
|
|
1269
1301
|
/**
|
|
1270
1302
|
* Remove listener from the emitter returned from init.
|
|
1271
|
-
*
|
|
1272
1303
|
* @param event
|
|
1273
1304
|
* @param listener
|
|
1274
1305
|
* @param context
|
|
@@ -1277,14 +1308,12 @@ export interface AuthEventEmitter {
|
|
|
1277
1308
|
off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
|
|
1278
1309
|
/**
|
|
1279
1310
|
* Remove all the event listeners
|
|
1280
|
-
*
|
|
1281
1311
|
* @param event
|
|
1282
1312
|
*/
|
|
1283
1313
|
removeAllListeners(event: AuthStatus): this;
|
|
1284
1314
|
}
|
|
1285
1315
|
/**
|
|
1286
1316
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
1287
|
-
*
|
|
1288
1317
|
* @group Authentication / Init
|
|
1289
1318
|
*/
|
|
1290
1319
|
export enum AuthEvent {
|
|
@@ -1310,7 +1339,7 @@ export function notifyAuthSDKSuccess(): void;
|
|
|
1310
1339
|
/**
|
|
1311
1340
|
*
|
|
1312
1341
|
*/
|
|
1313
|
-
export function notifyAuthSuccess():
|
|
1342
|
+
export function notifyAuthSuccess(): void;
|
|
1314
1343
|
/**
|
|
1315
1344
|
*
|
|
1316
1345
|
* @param failureType
|
|
@@ -1320,32 +1349,25 @@ export function notifyAuthFailure(failureType: AuthFailureType): void;
|
|
|
1320
1349
|
*
|
|
1321
1350
|
*/
|
|
1322
1351
|
export function notifyLogout(): void;
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
* This should be called after the cookie is set for cookie auth or
|
|
1326
|
-
* after the token is set for cookieless.
|
|
1327
|
-
*
|
|
1328
|
-
* @return {Promise<void>}
|
|
1329
|
-
* @example
|
|
1330
|
-
* ```js
|
|
1331
|
-
* await postLoginService();
|
|
1332
|
-
* ```
|
|
1333
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1334
|
-
*/
|
|
1335
|
-
export function postLoginService(): Promise<void>;
|
|
1352
|
+
export const initSession: (sessionDetails: sessionInfoInterface) => void;
|
|
1353
|
+
export const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
|
|
1336
1354
|
/**
|
|
1337
1355
|
* Return releaseVersion if available
|
|
1338
1356
|
*/
|
|
1339
1357
|
export function getReleaseVersion(): string;
|
|
1358
|
+
/**
|
|
1359
|
+
* Return a promise that resolves with the session information when
|
|
1360
|
+
* authentication is successful. And info is available.
|
|
1361
|
+
* @group Global methods
|
|
1362
|
+
*/
|
|
1363
|
+
export function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
1340
1364
|
/**
|
|
1341
1365
|
* Perform token based authentication
|
|
1342
|
-
*
|
|
1343
1366
|
* @param embedConfig The embed configuration
|
|
1344
1367
|
*/
|
|
1345
1368
|
export const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1346
1369
|
/**
|
|
1347
1370
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
1348
|
-
*
|
|
1349
1371
|
* @param embedConfig The embed configuration
|
|
1350
1372
|
*/
|
|
1351
1373
|
export const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1355,7 +1377,6 @@ export const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolea
|
|
|
1355
1377
|
*
|
|
1356
1378
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1357
1379
|
* strongly advised not to use this authentication method in production.
|
|
1358
|
-
*
|
|
1359
1380
|
* @param embedConfig The embed configuration
|
|
1360
1381
|
*/
|
|
1361
1382
|
export const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1364,7 +1385,6 @@ export const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
1364
1385
|
export const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1365
1386
|
/**
|
|
1366
1387
|
* Perform authentication on the ThoughtSpot cluster
|
|
1367
|
-
*
|
|
1368
1388
|
* @param embedConfig The embed configuration
|
|
1369
1389
|
*/
|
|
1370
1390
|
export const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1372,92 +1392,24 @@ export const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
1372
1392
|
* Check if we are authenticated to the ThoughtSpot cluster
|
|
1373
1393
|
*/
|
|
1374
1394
|
export const isAuthenticated: () => boolean;
|
|
1375
|
-
|
|
1376
|
-
export type SessionInfo = {
|
|
1377
|
-
releaseVersion: string;
|
|
1378
|
-
userGUID: string;
|
|
1379
|
-
currentOrgId: number;
|
|
1380
|
-
privileges: string[];
|
|
1381
|
-
mixpanelToken: string;
|
|
1382
|
-
isPublicUser: boolean;
|
|
1383
|
-
clusterId: string;
|
|
1384
|
-
clusterName: string;
|
|
1385
|
-
[key: string]: any;
|
|
1386
|
-
};
|
|
1387
|
-
/**
|
|
1388
|
-
* Returns the session info object and caches it for future use.
|
|
1389
|
-
* Once fetched the session info object is cached and returned from the cache on
|
|
1390
|
-
* subsequent calls.
|
|
1391
|
-
*
|
|
1392
|
-
* @example ```js
|
|
1393
|
-
* const sessionInfo = await getSessionInfo();
|
|
1394
|
-
* console.log(sessionInfo);
|
|
1395
|
-
* ```
|
|
1396
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1397
|
-
* @returns {Promise<SessionInfo>} The session info object.
|
|
1398
|
-
*/
|
|
1399
|
-
export function getSessionInfo(): Promise<SessionInfo>;
|
|
1400
|
-
/**
|
|
1401
|
-
* Returns the cached session info object. If the client is not authenticated the
|
|
1402
|
-
* function will return null.
|
|
1403
|
-
*
|
|
1404
|
-
* @example ```js
|
|
1405
|
-
* const sessionInfo = getCachedSessionInfo();
|
|
1406
|
-
* if (sessionInfo) {
|
|
1407
|
-
* console.log(sessionInfo);
|
|
1408
|
-
* } else {
|
|
1409
|
-
* console.log('Not authenticated');
|
|
1410
|
-
* }
|
|
1411
|
-
* ```
|
|
1412
|
-
* @returns {SessionInfo | null} The session info object.
|
|
1413
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1414
|
-
*/
|
|
1415
|
-
export function getCachedSessionInfo(): SessionInfo | null;
|
|
1416
|
-
/**
|
|
1417
|
-
* Processes the session info response and returns the session info object.
|
|
1418
|
-
*
|
|
1419
|
-
* @param sessionInfoResp {any} Response from the session info API.
|
|
1420
|
-
* @returns {SessionInfo} The session info object.
|
|
1421
|
-
* @example ```js
|
|
1422
|
-
* const sessionInfoResp = await fetch(sessionInfoPath);
|
|
1423
|
-
* const sessionInfo = getSessionDetails(sessionInfoResp);
|
|
1424
|
-
* console.log(sessionInfo);
|
|
1425
|
-
* ```
|
|
1426
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1427
|
-
*/
|
|
1428
|
-
export const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
|
|
1429
|
-
/**
|
|
1430
|
-
* Resets the cached session info object and forces a new fetch on the next call.
|
|
1431
|
-
*
|
|
1432
|
-
* @example ```js
|
|
1433
|
-
* resetCachedSessionInfo();
|
|
1434
|
-
* const sessionInfo = await getSessionInfo();
|
|
1435
|
-
* console.log(sessionInfo);
|
|
1436
|
-
* ```
|
|
1437
|
-
* @version SDK: 1.28.3 | ThoughtSpot ts7.april.cl, 7.2.1
|
|
1438
|
-
* @returns {void}
|
|
1439
|
-
*/
|
|
1440
|
-
export function resetCachedSessionInfo(): void;
|
|
1395
|
+
export {};
|
|
1441
1396
|
|
|
1442
1397
|
/**
|
|
1443
1398
|
* Copyright (c) 2023
|
|
1444
1399
|
*
|
|
1445
1400
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
1446
|
-
*
|
|
1447
1401
|
* @summary Type definitions for Embed SDK
|
|
1448
1402
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1449
1403
|
*/
|
|
1450
1404
|
/**
|
|
1451
1405
|
* The authentication mechanism for allowing access to the
|
|
1452
1406
|
* the embedded app
|
|
1453
|
-
*
|
|
1454
1407
|
* @group Authentication / Init
|
|
1455
1408
|
*/
|
|
1456
1409
|
export enum AuthType {
|
|
1457
1410
|
/**
|
|
1458
1411
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
1459
1412
|
* `Passthrough`.
|
|
1460
|
-
*
|
|
1461
1413
|
* @example
|
|
1462
1414
|
* ```js
|
|
1463
1415
|
* init({
|
|
@@ -1475,7 +1427,6 @@ export enum AuthType {
|
|
|
1475
1427
|
* To use this:
|
|
1476
1428
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1477
1429
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1478
|
-
*
|
|
1479
1430
|
* @example
|
|
1480
1431
|
* ```js
|
|
1481
1432
|
* init({
|
|
@@ -1488,14 +1439,12 @@ export enum AuthType {
|
|
|
1488
1439
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1489
1440
|
/**
|
|
1490
1441
|
* SSO using SAML
|
|
1491
|
-
*
|
|
1492
1442
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1493
1443
|
* @hidden
|
|
1494
1444
|
*/
|
|
1495
1445
|
SSO = "SSO_SAML",
|
|
1496
1446
|
/**
|
|
1497
1447
|
* SSO using SAML
|
|
1498
|
-
*
|
|
1499
1448
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1500
1449
|
* @hidden
|
|
1501
1450
|
*/
|
|
@@ -1507,7 +1456,6 @@ export enum AuthType {
|
|
|
1507
1456
|
*
|
|
1508
1457
|
* This redirects the host application to the SAML IdP. The host application
|
|
1509
1458
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1510
|
-
*
|
|
1511
1459
|
* @example
|
|
1512
1460
|
* ```js
|
|
1513
1461
|
* init({
|
|
@@ -1548,7 +1496,6 @@ export enum AuthType {
|
|
|
1548
1496
|
SAMLRedirect = "SSO_SAML",
|
|
1549
1497
|
/**
|
|
1550
1498
|
* SSO using OIDC
|
|
1551
|
-
*
|
|
1552
1499
|
* @hidden
|
|
1553
1500
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
1554
1501
|
*/
|
|
@@ -1561,7 +1508,6 @@ export enum AuthType {
|
|
|
1561
1508
|
OIDCRedirect = "SSO_OIDC",
|
|
1562
1509
|
/**
|
|
1563
1510
|
* Trusted authentication server
|
|
1564
|
-
*
|
|
1565
1511
|
* @hidden
|
|
1566
1512
|
* @deprecated Use {@link TrustedAuth} instead
|
|
1567
1513
|
*/
|
|
@@ -1570,7 +1516,6 @@ export enum AuthType {
|
|
|
1570
1516
|
* Trusted authentication server. Use your own authentication server
|
|
1571
1517
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1572
1518
|
* from ThoughtSpot.
|
|
1573
|
-
*
|
|
1574
1519
|
* @example
|
|
1575
1520
|
* ```js
|
|
1576
1521
|
* init({
|
|
@@ -1582,6 +1527,7 @@ export enum AuthType {
|
|
|
1582
1527
|
* .then((data) => data.token);
|
|
1583
1528
|
* }
|
|
1584
1529
|
* });
|
|
1530
|
+
* });
|
|
1585
1531
|
* ```
|
|
1586
1532
|
*/
|
|
1587
1533
|
TrustedAuthToken = "AuthServer",
|
|
@@ -1591,7 +1537,6 @@ export enum AuthType {
|
|
|
1591
1537
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1592
1538
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1593
1539
|
* implemented by some browsers.
|
|
1594
|
-
*
|
|
1595
1540
|
* @example
|
|
1596
1541
|
* ```js
|
|
1597
1542
|
* init({
|
|
@@ -1664,7 +1609,6 @@ export interface customCssInterface {
|
|
|
1664
1609
|
/**
|
|
1665
1610
|
* Can be used to define a custom font face
|
|
1666
1611
|
* like:
|
|
1667
|
-
*
|
|
1668
1612
|
* @example
|
|
1669
1613
|
* ```js
|
|
1670
1614
|
* rules_UNSTABLE?: {
|
|
@@ -1704,7 +1648,6 @@ export interface CustomStyles {
|
|
|
1704
1648
|
* Thoughtspot components.
|
|
1705
1649
|
* You can customize styles, text strings, and icons.
|
|
1706
1650
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
1707
|
-
*
|
|
1708
1651
|
* @example
|
|
1709
1652
|
* ```js
|
|
1710
1653
|
* init({
|
|
@@ -1747,7 +1690,6 @@ export interface CustomisationsInterface {
|
|
|
1747
1690
|
* It includes the ThoughtSpot hostname or IP address,
|
|
1748
1691
|
* the type of authentication, and the authentication endpoint
|
|
1749
1692
|
* if a trusted authentication server is used.
|
|
1750
|
-
*
|
|
1751
1693
|
* @group Authentication / Init
|
|
1752
1694
|
*/
|
|
1753
1695
|
export interface EmbedConfig {
|
|
@@ -1795,7 +1737,6 @@ export interface EmbedConfig {
|
|
|
1795
1737
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1796
1738
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1797
1739
|
* place.
|
|
1798
|
-
*
|
|
1799
1740
|
* @default false
|
|
1800
1741
|
* @deprecated
|
|
1801
1742
|
*/
|
|
@@ -1806,7 +1747,6 @@ export interface EmbedConfig {
|
|
|
1806
1747
|
*
|
|
1807
1748
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1808
1749
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1809
|
-
*
|
|
1810
1750
|
* @default false
|
|
1811
1751
|
* @version SDK: 1.18.0
|
|
1812
1752
|
*/
|
|
@@ -1817,7 +1757,6 @@ export interface EmbedConfig {
|
|
|
1817
1757
|
* terminated.
|
|
1818
1758
|
*
|
|
1819
1759
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1820
|
-
*
|
|
1821
1760
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1822
1761
|
*/
|
|
1823
1762
|
redirectPath?: string;
|
|
@@ -1827,7 +1766,6 @@ export interface EmbedConfig {
|
|
|
1827
1766
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1828
1767
|
* should be encoded in base64. This provides additional security to
|
|
1829
1768
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1830
|
-
*
|
|
1831
1769
|
* @default false
|
|
1832
1770
|
*/
|
|
1833
1771
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -1837,7 +1775,6 @@ export interface EmbedConfig {
|
|
|
1837
1775
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
1838
1776
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1839
1777
|
* in this case.
|
|
1840
|
-
*
|
|
1841
1778
|
* @default false
|
|
1842
1779
|
*/
|
|
1843
1780
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -1845,14 +1782,12 @@ export interface EmbedConfig {
|
|
|
1845
1782
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
1846
1783
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
1847
1784
|
* persists even in the case of a non-logged-in user.
|
|
1848
|
-
*
|
|
1849
1785
|
* @default false
|
|
1850
1786
|
*/
|
|
1851
1787
|
ignoreNoCookieAccess?: boolean;
|
|
1852
1788
|
/**
|
|
1853
1789
|
* Re-login a user with the previous login options
|
|
1854
1790
|
* when a user session expires.
|
|
1855
|
-
*
|
|
1856
1791
|
* @default false
|
|
1857
1792
|
*/
|
|
1858
1793
|
autoLogin?: boolean;
|
|
@@ -1861,20 +1796,17 @@ export interface EmbedConfig {
|
|
|
1861
1796
|
* This flag is typically used alongside the combination of authentication modes such
|
|
1862
1797
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
1863
1798
|
* EmbedConfig.autoLogin}
|
|
1864
|
-
*
|
|
1865
1799
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1866
1800
|
* @default false
|
|
1867
1801
|
*/
|
|
1868
1802
|
disableLoginRedirect?: boolean;
|
|
1869
1803
|
/**
|
|
1870
1804
|
* This message is displayed in the embedded view when a user login fails.
|
|
1871
|
-
*
|
|
1872
1805
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1873
1806
|
*/
|
|
1874
1807
|
loginFailedMessage?: string;
|
|
1875
1808
|
/**
|
|
1876
1809
|
* Calls the prefetch method internally when set to `true`
|
|
1877
|
-
*
|
|
1878
1810
|
* @default false
|
|
1879
1811
|
*/
|
|
1880
1812
|
callPrefetch?: boolean;
|
|
@@ -1882,7 +1814,6 @@ export interface EmbedConfig {
|
|
|
1882
1814
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1883
1815
|
* to start after the previous embed's render is complete. This helps improve
|
|
1884
1816
|
* performance by decreasing the load on the browser.
|
|
1885
|
-
*
|
|
1886
1817
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1887
1818
|
* @default false
|
|
1888
1819
|
*/
|
|
@@ -1890,7 +1821,6 @@ export interface EmbedConfig {
|
|
|
1890
1821
|
/**
|
|
1891
1822
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
1892
1823
|
* You would also need to set `style-src` in the CSP settings.
|
|
1893
|
-
*
|
|
1894
1824
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1895
1825
|
* @default ''
|
|
1896
1826
|
*/
|
|
@@ -1902,13 +1832,11 @@ export interface EmbedConfig {
|
|
|
1902
1832
|
*
|
|
1903
1833
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1904
1834
|
* involves an extra network call.
|
|
1905
|
-
*
|
|
1906
1835
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1907
1836
|
*/
|
|
1908
1837
|
detectCookieAccessSlow?: boolean;
|
|
1909
1838
|
/**
|
|
1910
1839
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1911
|
-
*
|
|
1912
1840
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
1913
1841
|
*/
|
|
1914
1842
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -1919,7 +1847,6 @@ export interface EmbedConfig {
|
|
|
1919
1847
|
suppressSageEmbedBetaWarning?: boolean;
|
|
1920
1848
|
/**
|
|
1921
1849
|
* Custom style params for embed Config.
|
|
1922
|
-
*
|
|
1923
1850
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1924
1851
|
*/
|
|
1925
1852
|
customizations?: CustomisationsInterface;
|
|
@@ -1927,7 +1854,6 @@ export interface EmbedConfig {
|
|
|
1927
1854
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1928
1855
|
* button that the user can click to trigger the flow.
|
|
1929
1856
|
* This attribute sets a containing element for that button.
|
|
1930
|
-
*
|
|
1931
1857
|
* @example
|
|
1932
1858
|
* ```js
|
|
1933
1859
|
* init({
|
|
@@ -1949,7 +1875,6 @@ export interface EmbedConfig {
|
|
|
1949
1875
|
/**
|
|
1950
1876
|
* Text to show in the button which triggers the popup auth flow.
|
|
1951
1877
|
* Default: `Authorize`.
|
|
1952
|
-
*
|
|
1953
1878
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1954
1879
|
*/
|
|
1955
1880
|
authTriggerText?: string;
|
|
@@ -1957,14 +1882,12 @@ export interface EmbedConfig {
|
|
|
1957
1882
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
1958
1883
|
* access to the embedded application users
|
|
1959
1884
|
* outside of the iframe.
|
|
1960
|
-
*
|
|
1961
1885
|
* @default true
|
|
1962
1886
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1963
1887
|
*/
|
|
1964
1888
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1965
1889
|
/**
|
|
1966
1890
|
* Host config in case embedded app is inside TS app itself
|
|
1967
|
-
*
|
|
1968
1891
|
* @hidden
|
|
1969
1892
|
*/
|
|
1970
1893
|
hostConfig?: {
|
|
@@ -1974,20 +1897,18 @@ export interface EmbedConfig {
|
|
|
1974
1897
|
};
|
|
1975
1898
|
/**
|
|
1976
1899
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
1977
|
-
* is added as an additional key to the embed, as per this
|
|
1900
|
+
* 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].
|
|
1978
1901
|
*
|
|
1979
1902
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
1980
1903
|
*/
|
|
1981
1904
|
pendoTrackingKey?: string;
|
|
1982
1905
|
/**
|
|
1983
1906
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
1984
|
-
*
|
|
1985
1907
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
1986
1908
|
*/
|
|
1987
1909
|
suppressErrorAlerts?: boolean;
|
|
1988
1910
|
/**
|
|
1989
1911
|
* Log level for the SDK.
|
|
1990
|
-
*
|
|
1991
1912
|
* @default LogLevel.ERROR
|
|
1992
1913
|
* @example
|
|
1993
1914
|
* ```js
|
|
@@ -2001,16 +1922,43 @@ export interface EmbedConfig {
|
|
|
2001
1922
|
logLevel?: LogLevel;
|
|
2002
1923
|
/**
|
|
2003
1924
|
* Disables the Mixpanel tracking from the SDK.
|
|
2004
|
-
*
|
|
2005
1925
|
* @version SDK: 1.27.9
|
|
2006
1926
|
*/
|
|
2007
1927
|
disableSDKTracking?: boolean;
|
|
1928
|
+
/**
|
|
1929
|
+
* Overrides default/user preffered locale for date formatting
|
|
1930
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
1931
|
+
*/
|
|
1932
|
+
dateFormatLocale?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* Overrides default/user preffered locale for number formatting
|
|
1935
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
1936
|
+
*/
|
|
1937
|
+
numberFormatLocale?: string;
|
|
1938
|
+
/**
|
|
1939
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
1940
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
1941
|
+
*/
|
|
1942
|
+
currencyFormat?: string;
|
|
1943
|
+
/**
|
|
1944
|
+
* This flag is used to disable the token verification in the SDK.
|
|
1945
|
+
* Enabling this flag will also disable the caching of the token.
|
|
1946
|
+
* @hidden
|
|
1947
|
+
* @example
|
|
1948
|
+
* ```js
|
|
1949
|
+
* init({
|
|
1950
|
+
* ...embedConfig,
|
|
1951
|
+
* disableTokenVerification : true
|
|
1952
|
+
* })
|
|
1953
|
+
* ```
|
|
1954
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
1955
|
+
*/
|
|
1956
|
+
disableTokenVerification?: boolean;
|
|
2008
1957
|
}
|
|
2009
1958
|
export interface LayoutConfig {
|
|
2010
1959
|
}
|
|
2011
1960
|
/**
|
|
2012
1961
|
* Embedded iframe configuration
|
|
2013
|
-
*
|
|
2014
1962
|
* @group Embed components
|
|
2015
1963
|
*/
|
|
2016
1964
|
export interface FrameParams {
|
|
@@ -2045,9 +1993,7 @@ export interface ViewConfig {
|
|
|
2045
1993
|
/**
|
|
2046
1994
|
* The width and height dimensions to render an embedded
|
|
2047
1995
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2048
|
-
*
|
|
2049
1996
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2050
|
-
*
|
|
2051
1997
|
* @example
|
|
2052
1998
|
* ```js
|
|
2053
1999
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2073,7 +2019,6 @@ export interface ViewConfig {
|
|
|
2073
2019
|
* (...), and the contextual menu. These actions will be disabled
|
|
2074
2020
|
* for the user.
|
|
2075
2021
|
* Use this to disable actions.
|
|
2076
|
-
*
|
|
2077
2022
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2078
2023
|
* @example
|
|
2079
2024
|
* ```js
|
|
@@ -2101,9 +2046,7 @@ export interface ViewConfig {
|
|
|
2101
2046
|
* The list of actions to hide from the embedded.
|
|
2102
2047
|
* This actions will be hidden from the user.
|
|
2103
2048
|
* Use this to hide an action.
|
|
2104
|
-
*
|
|
2105
2049
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2106
|
-
*
|
|
2107
2050
|
* @example
|
|
2108
2051
|
* ```js
|
|
2109
2052
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2121,10 +2064,8 @@ export interface ViewConfig {
|
|
|
2121
2064
|
* Use this to hide all actions except the ones you want to show.
|
|
2122
2065
|
*
|
|
2123
2066
|
* Use either this or hiddenActions.
|
|
2124
|
-
*
|
|
2125
2067
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2126
2068
|
* @important
|
|
2127
|
-
*
|
|
2128
2069
|
* @example
|
|
2129
2070
|
* ```js
|
|
2130
2071
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2136,9 +2077,7 @@ export interface ViewConfig {
|
|
|
2136
2077
|
visibleActions?: Action[];
|
|
2137
2078
|
/**
|
|
2138
2079
|
* Show alert messages and toast messages in the embedded view.
|
|
2139
|
-
*
|
|
2140
2080
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2141
|
-
*
|
|
2142
2081
|
* @example
|
|
2143
2082
|
* ```js
|
|
2144
2083
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2151,9 +2090,7 @@ export interface ViewConfig {
|
|
|
2151
2090
|
/**
|
|
2152
2091
|
* The list of runtime filters to apply to a search answer,
|
|
2153
2092
|
* visualization, or Liveboard.
|
|
2154
|
-
*
|
|
2155
2093
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2156
|
-
*
|
|
2157
2094
|
* @example
|
|
2158
2095
|
* ```js
|
|
2159
2096
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2172,9 +2109,7 @@ export interface ViewConfig {
|
|
|
2172
2109
|
/**
|
|
2173
2110
|
* The list of parameter override to apply to a search answer,
|
|
2174
2111
|
* visualization, or Liveboard.
|
|
2175
|
-
*
|
|
2176
2112
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2177
|
-
*
|
|
2178
2113
|
* @example
|
|
2179
2114
|
* ```js
|
|
2180
2115
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2191,7 +2126,6 @@ export interface ViewConfig {
|
|
|
2191
2126
|
runtimeParameters?: RuntimeParameter[];
|
|
2192
2127
|
/**
|
|
2193
2128
|
* The locale/language to use for the embedded view.
|
|
2194
|
-
*
|
|
2195
2129
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2196
2130
|
* @example
|
|
2197
2131
|
* ```js
|
|
@@ -2227,7 +2161,6 @@ export interface ViewConfig {
|
|
|
2227
2161
|
/**
|
|
2228
2162
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
2229
2163
|
* You would also need to set `style-src` in the CSP settings.
|
|
2230
|
-
*
|
|
2231
2164
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
2232
2165
|
* @default ''
|
|
2233
2166
|
*/
|
|
@@ -2235,9 +2168,7 @@ export interface ViewConfig {
|
|
|
2235
2168
|
/**
|
|
2236
2169
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2237
2170
|
* child inside it.
|
|
2238
|
-
*
|
|
2239
2171
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2240
|
-
*
|
|
2241
2172
|
* @example
|
|
2242
2173
|
* ```js
|
|
2243
2174
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2249,7 +2180,6 @@ export interface ViewConfig {
|
|
|
2249
2180
|
insertAsSibling?: boolean;
|
|
2250
2181
|
/**
|
|
2251
2182
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2252
|
-
*
|
|
2253
2183
|
* @example
|
|
2254
2184
|
* ```js
|
|
2255
2185
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2262,7 +2192,6 @@ export interface ViewConfig {
|
|
|
2262
2192
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2263
2193
|
/**
|
|
2264
2194
|
* Flag to override openNew tab context menu link
|
|
2265
|
-
*
|
|
2266
2195
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2267
2196
|
* @example
|
|
2268
2197
|
* ```js
|
|
@@ -2275,7 +2204,6 @@ export interface ViewConfig {
|
|
|
2275
2204
|
linkOverride?: boolean;
|
|
2276
2205
|
/**
|
|
2277
2206
|
* flag to enable insert into slides action
|
|
2278
|
-
*
|
|
2279
2207
|
* @hidden
|
|
2280
2208
|
* @private
|
|
2281
2209
|
*/
|
|
@@ -2283,7 +2211,6 @@ export interface ViewConfig {
|
|
|
2283
2211
|
/**
|
|
2284
2212
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2285
2213
|
* if available and matches the configuration.
|
|
2286
|
-
*
|
|
2287
2214
|
* @version SDK: 1.22.0
|
|
2288
2215
|
* @hidden
|
|
2289
2216
|
*
|
|
@@ -2297,7 +2224,6 @@ export interface ViewConfig {
|
|
|
2297
2224
|
*
|
|
2298
2225
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2299
2226
|
* embedded view.
|
|
2300
|
-
*
|
|
2301
2227
|
* @default false
|
|
2302
2228
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2303
2229
|
*/
|
|
@@ -2306,7 +2232,6 @@ export interface ViewConfig {
|
|
|
2306
2232
|
* The list of tab IDs to hide from the embedded.
|
|
2307
2233
|
* This Tabs will be hidden from their respective LBs.
|
|
2308
2234
|
* Use this to hide an tabID.
|
|
2309
|
-
*
|
|
2310
2235
|
* @example
|
|
2311
2236
|
* ```js
|
|
2312
2237
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2323,10 +2248,11 @@ export interface ViewConfig {
|
|
|
2323
2248
|
* Hide the home page modules
|
|
2324
2249
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
2325
2250
|
*
|
|
2251
|
+
*
|
|
2252
|
+
*
|
|
2326
2253
|
* **Note**: This option does not apply to the classic homepage.
|
|
2327
2254
|
* To access the updated modular homepage, set
|
|
2328
2255
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2329
|
-
*
|
|
2330
2256
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2331
2257
|
* @example
|
|
2332
2258
|
* ```js
|
|
@@ -2335,19 +2261,17 @@ export interface ViewConfig {
|
|
|
2335
2261
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2336
2262
|
* })
|
|
2337
2263
|
* ```
|
|
2338
|
-
*
|
|
2339
2264
|
*/
|
|
2340
2265
|
hiddenHomepageModules?: HomepageModule[];
|
|
2341
2266
|
/**
|
|
2342
2267
|
* reordering the home page modules
|
|
2343
2268
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
2344
2269
|
*
|
|
2270
|
+
*
|
|
2345
2271
|
* **Note**: This option does not apply to the classic homepage.
|
|
2346
2272
|
* To access the updated modular homepage, set
|
|
2347
2273
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2348
|
-
*
|
|
2349
2274
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
2350
|
-
*
|
|
2351
2275
|
* @example
|
|
2352
2276
|
* ```js
|
|
2353
2277
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2362,9 +2286,7 @@ export interface ViewConfig {
|
|
|
2362
2286
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2363
2287
|
*
|
|
2364
2288
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2365
|
-
*
|
|
2366
2289
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2367
|
-
*
|
|
2368
2290
|
* @example
|
|
2369
2291
|
* ```js
|
|
2370
2292
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2381,8 +2303,7 @@ export interface ViewConfig {
|
|
|
2381
2303
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2382
2304
|
* There are 8 eight home navigation list items.
|
|
2383
2305
|
* To hide these items, specify the string in the array.
|
|
2384
|
-
*
|
|
2385
|
-
* * @example
|
|
2306
|
+
* @example
|
|
2386
2307
|
* ```js
|
|
2387
2308
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2388
2309
|
* ... // other options
|
|
@@ -2390,10 +2311,11 @@ export interface ViewConfig {
|
|
|
2390
2311
|
* })
|
|
2391
2312
|
* ```
|
|
2392
2313
|
*
|
|
2314
|
+
*
|
|
2315
|
+
*
|
|
2393
2316
|
* **Note**: This option does not apply to the classic homepage.
|
|
2394
2317
|
* To access the updated modular homepage, set
|
|
2395
2318
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2396
|
-
*
|
|
2397
2319
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2398
2320
|
*/
|
|
2399
2321
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2401,7 +2323,6 @@ export interface ViewConfig {
|
|
|
2401
2323
|
* PreRender id to be used for PreRendering the embed.
|
|
2402
2324
|
* Use PreRender to render the embed in the background and then
|
|
2403
2325
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2404
|
-
*
|
|
2405
2326
|
* @example
|
|
2406
2327
|
* ```js
|
|
2407
2328
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2418,11 +2339,9 @@ export interface ViewConfig {
|
|
|
2418
2339
|
* of its embedding element and adjust its own size accordingly.
|
|
2419
2340
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2420
2341
|
* its dimensions based on changes to the size of the embedding element.
|
|
2421
|
-
*
|
|
2422
2342
|
* @type {boolean}
|
|
2423
2343
|
* @default false
|
|
2424
2344
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2425
|
-
*
|
|
2426
2345
|
* @example
|
|
2427
2346
|
* ```js
|
|
2428
2347
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2437,14 +2356,22 @@ export interface ViewConfig {
|
|
|
2437
2356
|
doNotTrackPreRenderSize?: boolean;
|
|
2438
2357
|
/**
|
|
2439
2358
|
* For internal tracking of the embed component type.
|
|
2440
|
-
*
|
|
2441
2359
|
* @hidden
|
|
2442
2360
|
*/
|
|
2443
2361
|
embedComponentType?: string;
|
|
2362
|
+
/**
|
|
2363
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
2364
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
2365
|
+
*
|
|
2366
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2367
|
+
* embedded view.
|
|
2368
|
+
* @default false
|
|
2369
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2370
|
+
*/
|
|
2371
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
2444
2372
|
}
|
|
2445
2373
|
/**
|
|
2446
2374
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
2447
|
-
*
|
|
2448
2375
|
* @group Events
|
|
2449
2376
|
*/
|
|
2450
2377
|
export type MessagePayload = {
|
|
@@ -2455,7 +2382,6 @@ export type MessagePayload = {
|
|
|
2455
2382
|
/**
|
|
2456
2383
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2457
2384
|
* option
|
|
2458
|
-
*
|
|
2459
2385
|
* @group Events
|
|
2460
2386
|
*/
|
|
2461
2387
|
export type MessageOptions = {
|
|
@@ -2467,7 +2393,6 @@ export type MessageOptions = {
|
|
|
2467
2393
|
};
|
|
2468
2394
|
/**
|
|
2469
2395
|
* MessageCallback: Embed event message callback
|
|
2470
|
-
*
|
|
2471
2396
|
* @group Events
|
|
2472
2397
|
*/
|
|
2473
2398
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -2557,7 +2482,6 @@ export enum RuntimeFilterOp {
|
|
|
2557
2482
|
* **Note**: This option does not apply to the classic homepage.
|
|
2558
2483
|
* To access the updated modular homepage, set
|
|
2559
2484
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2560
|
-
*
|
|
2561
2485
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2562
2486
|
*/
|
|
2563
2487
|
export enum HomepageModule {
|
|
@@ -2604,7 +2528,7 @@ export interface RuntimeFilter {
|
|
|
2604
2528
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
2605
2529
|
* operands.
|
|
2606
2530
|
*/
|
|
2607
|
-
values: (number | boolean | string)[];
|
|
2531
|
+
values: (number | boolean | string | bigint)[];
|
|
2608
2532
|
}
|
|
2609
2533
|
/**
|
|
2610
2534
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -2625,7 +2549,6 @@ export interface RuntimeParameter {
|
|
|
2625
2549
|
*
|
|
2626
2550
|
* To add an event listener use the corresponding
|
|
2627
2551
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
2628
|
-
*
|
|
2629
2552
|
* @example
|
|
2630
2553
|
* ```js
|
|
2631
2554
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2643,7 +2566,6 @@ export interface RuntimeParameter {
|
|
|
2643
2566
|
export enum EmbedEvent {
|
|
2644
2567
|
/**
|
|
2645
2568
|
* Rendering has initialized.
|
|
2646
|
-
*
|
|
2647
2569
|
* @example
|
|
2648
2570
|
*```js
|
|
2649
2571
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -2657,7 +2579,7 @@ export enum EmbedEvent {
|
|
|
2657
2579
|
Init = "init",
|
|
2658
2580
|
/**
|
|
2659
2581
|
* Authentication has either succeeded or failed.
|
|
2660
|
-
*
|
|
2582
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2661
2583
|
* @example
|
|
2662
2584
|
*```js
|
|
2663
2585
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -2669,8 +2591,8 @@ export enum EmbedEvent {
|
|
|
2669
2591
|
AuthInit = "authInit",
|
|
2670
2592
|
/**
|
|
2671
2593
|
* The embed object container has loaded.
|
|
2672
|
-
*
|
|
2673
2594
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2595
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2674
2596
|
* @example
|
|
2675
2597
|
*```js
|
|
2676
2598
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -2683,8 +2605,8 @@ export enum EmbedEvent {
|
|
|
2683
2605
|
Load = "load",
|
|
2684
2606
|
/**
|
|
2685
2607
|
* Data pertaining to answer or Liveboard is received
|
|
2686
|
-
*
|
|
2687
2608
|
* @return data - The answer or Liveboard data
|
|
2609
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2688
2610
|
* @example
|
|
2689
2611
|
*```js
|
|
2690
2612
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -2696,13 +2618,12 @@ export enum EmbedEvent {
|
|
|
2696
2618
|
Data = "data",
|
|
2697
2619
|
/**
|
|
2698
2620
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2699
|
-
*
|
|
2700
2621
|
* @hidden
|
|
2701
2622
|
*/
|
|
2702
2623
|
FiltersChanged = "filtersChanged",
|
|
2703
2624
|
/**
|
|
2704
2625
|
* Search query has been updated by the user.
|
|
2705
|
-
*
|
|
2626
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2706
2627
|
* @example
|
|
2707
2628
|
*```js
|
|
2708
2629
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -2711,13 +2632,13 @@ export enum EmbedEvent {
|
|
|
2711
2632
|
QueryChanged = "queryChanged",
|
|
2712
2633
|
/**
|
|
2713
2634
|
* A drill-down operation has been performed.
|
|
2714
|
-
*
|
|
2635
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2715
2636
|
* @returns additionalFilters - Any additional filters applied
|
|
2716
2637
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2717
2638
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2718
2639
|
* @example
|
|
2719
2640
|
*```js
|
|
2720
|
-
* searchEmbed.
|
|
2641
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2721
2642
|
* points: {
|
|
2722
2643
|
* clickedPoint,
|
|
2723
2644
|
* selectedPoints: selectedPoint
|
|
@@ -2748,8 +2669,8 @@ export enum EmbedEvent {
|
|
|
2748
2669
|
Drilldown = "drillDown",
|
|
2749
2670
|
/**
|
|
2750
2671
|
* One or more data sources have been selected.
|
|
2751
|
-
*
|
|
2752
2672
|
* @returns dataSourceIds - the list of data sources
|
|
2673
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2753
2674
|
* @example
|
|
2754
2675
|
* ```js
|
|
2755
2676
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -2760,7 +2681,6 @@ export enum EmbedEvent {
|
|
|
2760
2681
|
DataSourceSelected = "dataSourceSelected",
|
|
2761
2682
|
/**
|
|
2762
2683
|
* One or more data columns have been selected.
|
|
2763
|
-
*
|
|
2764
2684
|
* @returns columnIds - the list of columns
|
|
2765
2685
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2766
2686
|
* @example
|
|
@@ -2773,10 +2693,10 @@ export enum EmbedEvent {
|
|
|
2773
2693
|
AddRemoveColumns = "addRemoveColumns",
|
|
2774
2694
|
/**
|
|
2775
2695
|
* A custom action has been triggered.
|
|
2776
|
-
*
|
|
2777
2696
|
* @returns actionId - ID of the custom action
|
|
2778
2697
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
2779
2698
|
* Answer or Liveboard data
|
|
2699
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2780
2700
|
* @example
|
|
2781
2701
|
* ```js
|
|
2782
2702
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -2790,7 +2710,6 @@ export enum EmbedEvent {
|
|
|
2790
2710
|
CustomAction = "customAction",
|
|
2791
2711
|
/**
|
|
2792
2712
|
* Listen to double click actions on a visualization.
|
|
2793
|
-
*
|
|
2794
2713
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
2795
2714
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2796
2715
|
* @example
|
|
@@ -2803,7 +2722,6 @@ export enum EmbedEvent {
|
|
|
2803
2722
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
2804
2723
|
/**
|
|
2805
2724
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
2806
|
-
*
|
|
2807
2725
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
2808
2726
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2809
2727
|
* @important
|
|
@@ -2824,21 +2742,22 @@ export enum EmbedEvent {
|
|
|
2824
2742
|
/**
|
|
2825
2743
|
* An error has occurred. This event is fired for the following error types:
|
|
2826
2744
|
*
|
|
2827
|
-
*
|
|
2745
|
+
* `API`: API call failure error.
|
|
2828
2746
|
*
|
|
2829
|
-
*
|
|
2747
|
+
* `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
|
|
2748
|
+
* mode.
|
|
2830
2749
|
*
|
|
2831
|
-
*
|
|
2750
|
+
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
2832
2751
|
*
|
|
2833
|
-
*
|
|
2752
|
+
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
2834
2753
|
*
|
|
2835
|
-
*
|
|
2754
|
+
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
2836
2755
|
*
|
|
2837
|
-
*
|
|
2838
|
-
*
|
|
2839
|
-
* For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
|
|
2756
|
+
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
2840
2757
|
*
|
|
2758
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
2841
2759
|
* @returns error - An error object or message
|
|
2760
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2842
2761
|
* @example
|
|
2843
2762
|
* ```js
|
|
2844
2763
|
* // API error
|
|
@@ -2862,8 +2781,8 @@ export enum EmbedEvent {
|
|
|
2862
2781
|
Error = "Error",
|
|
2863
2782
|
/**
|
|
2864
2783
|
* The embedded object has sent an alert.
|
|
2865
|
-
*
|
|
2866
2784
|
* @returns alert - An alert object
|
|
2785
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2867
2786
|
* @example
|
|
2868
2787
|
* ```js
|
|
2869
2788
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -2872,7 +2791,7 @@ export enum EmbedEvent {
|
|
|
2872
2791
|
Alert = "alert",
|
|
2873
2792
|
/**
|
|
2874
2793
|
* The ThoughtSpot auth session has expired.
|
|
2875
|
-
*
|
|
2794
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2876
2795
|
* @example
|
|
2877
2796
|
*```js
|
|
2878
2797
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -2885,26 +2804,22 @@ export enum EmbedEvent {
|
|
|
2885
2804
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2886
2805
|
/**
|
|
2887
2806
|
* ThoughtSpot failed to validate the auth session.
|
|
2888
|
-
*
|
|
2889
2807
|
* @hidden
|
|
2890
2808
|
*/
|
|
2891
2809
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
2892
2810
|
/**
|
|
2893
2811
|
* ThoughtSpot failed to validate the auth session.
|
|
2894
|
-
*
|
|
2895
2812
|
* @hidden
|
|
2896
2813
|
*/
|
|
2897
2814
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
2898
2815
|
/**
|
|
2899
2816
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
2900
|
-
*
|
|
2901
2817
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
2902
2818
|
* @hidden
|
|
2903
2819
|
*/
|
|
2904
2820
|
EmbedHeight = "EMBED_HEIGHT",
|
|
2905
2821
|
/**
|
|
2906
2822
|
* The center of visible iframe viewport is calculated.
|
|
2907
|
-
*
|
|
2908
2823
|
* @returns data - The center of the visible Iframe viewport.
|
|
2909
2824
|
* @hidden
|
|
2910
2825
|
*/
|
|
@@ -2912,7 +2827,6 @@ export enum EmbedEvent {
|
|
|
2912
2827
|
/**
|
|
2913
2828
|
* Emitted when the **Get Data** action is initiated.
|
|
2914
2829
|
* Applicable to `SearchBarEmbed` only.
|
|
2915
|
-
*
|
|
2916
2830
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2917
2831
|
* @example
|
|
2918
2832
|
*```js
|
|
@@ -2925,7 +2839,7 @@ export enum EmbedEvent {
|
|
|
2925
2839
|
GetDataClick = "getDataClick",
|
|
2926
2840
|
/**
|
|
2927
2841
|
* Detects the route change.
|
|
2928
|
-
*
|
|
2842
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
2929
2843
|
* @example
|
|
2930
2844
|
*```js
|
|
2931
2845
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -2935,15 +2849,13 @@ export enum EmbedEvent {
|
|
|
2935
2849
|
RouteChange = "ROUTE_CHANGE",
|
|
2936
2850
|
/**
|
|
2937
2851
|
* The v1 event type for Data
|
|
2938
|
-
*
|
|
2939
2852
|
* @hidden
|
|
2940
2853
|
*/
|
|
2941
2854
|
V1Data = "exportVizDataToParent",
|
|
2942
2855
|
/**
|
|
2943
2856
|
* Emitted when the embed does not have cookie access. This happens
|
|
2944
2857
|
* when Safari and other Web browsers block third-party cookies
|
|
2945
|
-
* are blocked by default.
|
|
2946
|
-
*
|
|
2858
|
+
* are blocked by default.
|
|
2947
2859
|
* @example
|
|
2948
2860
|
*```js
|
|
2949
2861
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -2953,14 +2865,12 @@ export enum EmbedEvent {
|
|
|
2953
2865
|
NoCookieAccess = "noCookieAccess",
|
|
2954
2866
|
/**
|
|
2955
2867
|
* Emitted when SAML is complete
|
|
2956
|
-
*
|
|
2957
2868
|
* @private
|
|
2958
2869
|
* @hidden
|
|
2959
2870
|
*/
|
|
2960
2871
|
SAMLComplete = "samlComplete",
|
|
2961
2872
|
/**
|
|
2962
2873
|
* Emitted when any modal is opened in the app
|
|
2963
|
-
*
|
|
2964
2874
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2965
2875
|
* @example
|
|
2966
2876
|
*```js
|
|
@@ -2972,7 +2882,6 @@ export enum EmbedEvent {
|
|
|
2972
2882
|
DialogOpen = "dialog-open",
|
|
2973
2883
|
/**
|
|
2974
2884
|
* Emitted when any modal is closed in the app
|
|
2975
|
-
*
|
|
2976
2885
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2977
2886
|
* @example
|
|
2978
2887
|
*```js
|
|
@@ -2985,8 +2894,7 @@ export enum EmbedEvent {
|
|
|
2985
2894
|
/**
|
|
2986
2895
|
* Emitted when the Liveboard shell loads.
|
|
2987
2896
|
* You can use this event as a hook to trigger
|
|
2988
|
-
*
|
|
2989
|
-
*
|
|
2897
|
+
* actions on the rendered Liveboard.
|
|
2990
2898
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2991
2899
|
* @example
|
|
2992
2900
|
*```js
|
|
@@ -3006,9 +2914,7 @@ export enum EmbedEvent {
|
|
|
3006
2914
|
*/
|
|
3007
2915
|
LiveboardRendered = "PinboardRendered",
|
|
3008
2916
|
/**
|
|
3009
|
-
*
|
|
3010
|
-
* is triggered on all events.
|
|
3011
|
-
*
|
|
2917
|
+
* Emits all events.
|
|
3012
2918
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3013
2919
|
* @example
|
|
3014
2920
|
*```js
|
|
@@ -3020,17 +2926,16 @@ export enum EmbedEvent {
|
|
|
3020
2926
|
ALL = "*",
|
|
3021
2927
|
/**
|
|
3022
2928
|
* Emitted when an Answer is saved in the app
|
|
3023
|
-
*
|
|
3024
2929
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3025
2930
|
* @example
|
|
3026
2931
|
*```js
|
|
3027
|
-
* //
|
|
2932
|
+
* //Emit when action starts
|
|
3028
2933
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3029
2934
|
* console.log('Save', payload)
|
|
3030
2935
|
* }, {
|
|
3031
2936
|
* start: true
|
|
3032
2937
|
* })
|
|
3033
|
-
* //
|
|
2938
|
+
* //emit when action ends
|
|
3034
2939
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3035
2940
|
* console.log('Save', payload)
|
|
3036
2941
|
* })
|
|
@@ -3040,15 +2945,14 @@ export enum EmbedEvent {
|
|
|
3040
2945
|
/**
|
|
3041
2946
|
* Emitted when the download action is triggered on an answer
|
|
3042
2947
|
*
|
|
3043
|
-
* **Note**:
|
|
2948
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
3044
2949
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3045
2950
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3046
2951
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
3047
|
-
*
|
|
3048
2952
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3049
2953
|
* @example
|
|
3050
2954
|
*```js
|
|
3051
|
-
* liveboardEmbed.
|
|
2955
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3052
2956
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3053
2957
|
* })
|
|
3054
2958
|
*```
|
|
@@ -3056,14 +2960,13 @@ export enum EmbedEvent {
|
|
|
3056
2960
|
Download = "download",
|
|
3057
2961
|
/**
|
|
3058
2962
|
* Emitted when the download action is triggered on an answer
|
|
3059
|
-
*
|
|
3060
2963
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3061
2964
|
* @example
|
|
3062
2965
|
*```js
|
|
3063
|
-
* //
|
|
2966
|
+
* //emit when action starts
|
|
3064
2967
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3065
2968
|
* console.log('download PNG', payload)}, {start: true })
|
|
3066
|
-
* //
|
|
2969
|
+
* //emit when action ends
|
|
3067
2970
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3068
2971
|
* console.log('download PNG', payload)})
|
|
3069
2972
|
*```
|
|
@@ -3071,14 +2974,13 @@ export enum EmbedEvent {
|
|
|
3071
2974
|
DownloadAsPng = "downloadAsPng",
|
|
3072
2975
|
/**
|
|
3073
2976
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
3074
|
-
*
|
|
3075
2977
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3076
2978
|
* @example
|
|
3077
2979
|
*```js
|
|
3078
|
-
* //
|
|
2980
|
+
* //emit when action starts
|
|
3079
2981
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3080
2982
|
* console.log('download PDF', payload)}, {start: true })
|
|
3081
|
-
* //
|
|
2983
|
+
* //emit when action ends
|
|
3082
2984
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3083
2985
|
* console.log('download PDF', payload)})
|
|
3084
2986
|
*```
|
|
@@ -3086,14 +2988,13 @@ export enum EmbedEvent {
|
|
|
3086
2988
|
DownloadAsPdf = "downloadAsPdf",
|
|
3087
2989
|
/**
|
|
3088
2990
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
3089
|
-
*
|
|
3090
2991
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3091
2992
|
* @example
|
|
3092
2993
|
*```js
|
|
3093
|
-
* //
|
|
2994
|
+
* //emit when action starts
|
|
3094
2995
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3095
2996
|
* console.log('download CSV', payload)}, {start: true })
|
|
3096
|
-
* //
|
|
2997
|
+
* //emit when action ends
|
|
3097
2998
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3098
2999
|
* console.log('download CSV', payload)})
|
|
3099
3000
|
*```
|
|
@@ -3101,14 +3002,13 @@ export enum EmbedEvent {
|
|
|
3101
3002
|
DownloadAsCsv = "downloadAsCsv",
|
|
3102
3003
|
/**
|
|
3103
3004
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
3104
|
-
*
|
|
3105
3005
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3106
3006
|
* @example
|
|
3107
3007
|
*```js
|
|
3108
|
-
* //
|
|
3008
|
+
* //emit when action starts
|
|
3109
3009
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3110
3010
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3111
|
-
* //
|
|
3011
|
+
* //emit when action ends
|
|
3112
3012
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3113
3013
|
* console.log('download Xlsx', payload)})
|
|
3114
3014
|
*```
|
|
@@ -3116,14 +3016,13 @@ export enum EmbedEvent {
|
|
|
3116
3016
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3117
3017
|
/**
|
|
3118
3018
|
* Emitted when an Answer is deleted in the app
|
|
3119
|
-
*
|
|
3120
3019
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3121
3020
|
* @example
|
|
3122
3021
|
*```js
|
|
3123
|
-
* //
|
|
3022
|
+
* //emit when action starts
|
|
3124
3023
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3125
3024
|
* console.log('delete answer', payload)}, {start: true })
|
|
3126
|
-
* //
|
|
3025
|
+
* //emit when action is completed
|
|
3127
3026
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3128
3027
|
* console.log('delete answer', payload)})
|
|
3129
3028
|
*```
|
|
@@ -3131,17 +3030,16 @@ export enum EmbedEvent {
|
|
|
3131
3030
|
AnswerDelete = "answerDelete",
|
|
3132
3031
|
/**
|
|
3133
3032
|
* Emitted when an answer is pinned to a Liveboard
|
|
3134
|
-
*
|
|
3135
3033
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3136
3034
|
* @example
|
|
3137
3035
|
*```js
|
|
3138
|
-
* //
|
|
3036
|
+
* //emit when action starts
|
|
3139
3037
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3140
3038
|
* console.log('pin', payload)
|
|
3141
3039
|
* }, {
|
|
3142
3040
|
* start: true
|
|
3143
3041
|
* })
|
|
3144
|
-
* //
|
|
3042
|
+
* //emit when action ends
|
|
3145
3043
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3146
3044
|
* console.log('pin', payload)
|
|
3147
3045
|
* })
|
|
@@ -3150,17 +3048,16 @@ export enum EmbedEvent {
|
|
|
3150
3048
|
Pin = "pin",
|
|
3151
3049
|
/**
|
|
3152
3050
|
* Emitted when SpotIQ analysis is triggered
|
|
3153
|
-
*
|
|
3154
3051
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3155
3052
|
* @example
|
|
3156
3053
|
*```js
|
|
3157
|
-
* //
|
|
3054
|
+
* //emit when action starts
|
|
3158
3055
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3159
3056
|
* console.log('SpotIQAnalyze', payload)
|
|
3160
3057
|
* }, {
|
|
3161
3058
|
* start: true
|
|
3162
3059
|
* })
|
|
3163
|
-
* //
|
|
3060
|
+
* //emit when action ends
|
|
3164
3061
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3165
3062
|
* console.log('SpotIQ analyze', payload)
|
|
3166
3063
|
* })
|
|
@@ -3169,17 +3066,16 @@ export enum EmbedEvent {
|
|
|
3169
3066
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3170
3067
|
/**
|
|
3171
3068
|
* Emitted when a user shares an object with another user or group
|
|
3172
|
-
*
|
|
3173
3069
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3174
3070
|
* @example
|
|
3175
3071
|
*```js
|
|
3176
|
-
* //
|
|
3072
|
+
* //emit when action starts
|
|
3177
3073
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3178
3074
|
* console.log('Share', payload)
|
|
3179
3075
|
* }, {
|
|
3180
3076
|
* start: true
|
|
3181
3077
|
* })
|
|
3182
|
-
* //
|
|
3078
|
+
* //emit when action ends
|
|
3183
3079
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3184
3080
|
* console.log('Share', payload)
|
|
3185
3081
|
* })
|
|
@@ -3189,7 +3085,6 @@ export enum EmbedEvent {
|
|
|
3189
3085
|
/**
|
|
3190
3086
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
3191
3087
|
* data on a chart or table.
|
|
3192
|
-
*
|
|
3193
3088
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3194
3089
|
* @example
|
|
3195
3090
|
*```js
|
|
@@ -3202,7 +3097,6 @@ export enum EmbedEvent {
|
|
|
3202
3097
|
/**
|
|
3203
3098
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
3204
3099
|
* data on a chart or table
|
|
3205
|
-
*
|
|
3206
3100
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3207
3101
|
* @example
|
|
3208
3102
|
*```js
|
|
@@ -3214,7 +3108,6 @@ export enum EmbedEvent {
|
|
|
3214
3108
|
DrillExclude = "context-menu-item-exclude",
|
|
3215
3109
|
/**
|
|
3216
3110
|
* Emitted when a column value is copied in the embedded app.
|
|
3217
|
-
*
|
|
3218
3111
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3219
3112
|
* @example
|
|
3220
3113
|
*```js
|
|
@@ -3225,7 +3118,8 @@ export enum EmbedEvent {
|
|
|
3225
3118
|
*/
|
|
3226
3119
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3227
3120
|
/**
|
|
3228
|
-
* Emitted when a user clicks the **Update TML** action
|
|
3121
|
+
* Emitted when a user clicks the **Update TML** action on
|
|
3122
|
+
* embedded Liveboard.
|
|
3229
3123
|
*
|
|
3230
3124
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3231
3125
|
* @example
|
|
@@ -3237,6 +3131,7 @@ export enum EmbedEvent {
|
|
|
3237
3131
|
UpdateTML = "updateTSL",
|
|
3238
3132
|
/**
|
|
3239
3133
|
* Emitted when a user clicks the **Edit TML** action
|
|
3134
|
+
* on an embedded Liveboard.
|
|
3240
3135
|
*
|
|
3241
3136
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3242
3137
|
* @example
|
|
@@ -3250,14 +3145,13 @@ export enum EmbedEvent {
|
|
|
3250
3145
|
/**
|
|
3251
3146
|
* Emitted when the **Export TML** action is triggered on an
|
|
3252
3147
|
* an embedded object in the app
|
|
3253
|
-
*
|
|
3254
3148
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3255
3149
|
* @example
|
|
3256
3150
|
*```js
|
|
3257
|
-
* //
|
|
3151
|
+
* //emit when action starts
|
|
3258
3152
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3259
3153
|
* console.log('Export TML', payload)}, { start: true })
|
|
3260
|
-
* //
|
|
3154
|
+
* //emit when action ends
|
|
3261
3155
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3262
3156
|
* console.log('Export TML', payload)})
|
|
3263
3157
|
*```
|
|
@@ -3265,7 +3159,6 @@ export enum EmbedEvent {
|
|
|
3265
3159
|
ExportTML = "exportTSL",
|
|
3266
3160
|
/**
|
|
3267
3161
|
* Emitted when an Answer is saved as a View.
|
|
3268
|
-
*
|
|
3269
3162
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3270
3163
|
* @example
|
|
3271
3164
|
*```js
|
|
@@ -3277,14 +3170,13 @@ export enum EmbedEvent {
|
|
|
3277
3170
|
SaveAsView = "saveAsView",
|
|
3278
3171
|
/**
|
|
3279
3172
|
* Emitted when the user creates a copy of an Answer
|
|
3280
|
-
*
|
|
3281
3173
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3282
3174
|
* @example
|
|
3283
3175
|
*```js
|
|
3284
|
-
* //
|
|
3176
|
+
* //emit when action starts
|
|
3285
3177
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3286
3178
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3287
|
-
* //
|
|
3179
|
+
* //emit when action ends
|
|
3288
3180
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3289
3181
|
* console.log('Copy and edit', payload)})
|
|
3290
3182
|
*```
|
|
@@ -3292,7 +3184,6 @@ export enum EmbedEvent {
|
|
|
3292
3184
|
CopyAEdit = "copyAEdit",
|
|
3293
3185
|
/**
|
|
3294
3186
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
3295
|
-
*
|
|
3296
3187
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3297
3188
|
* @example
|
|
3298
3189
|
*```js
|
|
@@ -3304,7 +3195,6 @@ export enum EmbedEvent {
|
|
|
3304
3195
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3305
3196
|
/**
|
|
3306
3197
|
* Emitted when an answer is switched to a chart or table view.
|
|
3307
|
-
*
|
|
3308
3198
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3309
3199
|
* @example
|
|
3310
3200
|
*```js
|
|
@@ -3316,13 +3206,11 @@ export enum EmbedEvent {
|
|
|
3316
3206
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3317
3207
|
/**
|
|
3318
3208
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
3319
|
-
*
|
|
3320
3209
|
* @hidden
|
|
3321
3210
|
*/
|
|
3322
3211
|
APP_INIT = "appInit",
|
|
3323
3212
|
/**
|
|
3324
3213
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3325
|
-
*
|
|
3326
3214
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3327
3215
|
* @example
|
|
3328
3216
|
*```js
|
|
@@ -3334,7 +3222,6 @@ export enum EmbedEvent {
|
|
|
3334
3222
|
LiveboardInfo = "pinboardInfo",
|
|
3335
3223
|
/**
|
|
3336
3224
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3337
|
-
*
|
|
3338
3225
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3339
3226
|
* @example
|
|
3340
3227
|
*```js
|
|
@@ -3346,7 +3233,6 @@ export enum EmbedEvent {
|
|
|
3346
3233
|
AddToFavorites = "addToFavorites",
|
|
3347
3234
|
/**
|
|
3348
3235
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3349
|
-
*
|
|
3350
3236
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3351
3237
|
* @example
|
|
3352
3238
|
*```js
|
|
@@ -3358,7 +3244,6 @@ export enum EmbedEvent {
|
|
|
3358
3244
|
Schedule = "subscription",
|
|
3359
3245
|
/**
|
|
3360
3246
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3361
|
-
*
|
|
3362
3247
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3363
3248
|
* @example
|
|
3364
3249
|
*```js
|
|
@@ -3370,7 +3255,6 @@ export enum EmbedEvent {
|
|
|
3370
3255
|
Edit = "edit",
|
|
3371
3256
|
/**
|
|
3372
3257
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3373
|
-
*
|
|
3374
3258
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3375
3259
|
* @example
|
|
3376
3260
|
*```js
|
|
@@ -3382,11 +3266,10 @@ export enum EmbedEvent {
|
|
|
3382
3266
|
MakeACopy = "makeACopy",
|
|
3383
3267
|
/**
|
|
3384
3268
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3385
|
-
*
|
|
3386
3269
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3387
3270
|
* @example
|
|
3388
3271
|
*```js
|
|
3389
|
-
* liveboardEmbed.
|
|
3272
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3390
3273
|
*```
|
|
3391
3274
|
* @example
|
|
3392
3275
|
*```js
|
|
@@ -3398,71 +3281,64 @@ export enum EmbedEvent {
|
|
|
3398
3281
|
Present = "present",
|
|
3399
3282
|
/**
|
|
3400
3283
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3401
|
-
*
|
|
3402
3284
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3403
3285
|
* @example
|
|
3404
3286
|
*```js
|
|
3405
|
-
* liveboardEmbed.
|
|
3287
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3406
3288
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3407
3289
|
*```
|
|
3408
3290
|
*/
|
|
3409
3291
|
Delete = "delete",
|
|
3410
3292
|
/**
|
|
3411
3293
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3412
|
-
*
|
|
3413
3294
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3414
3295
|
* @example
|
|
3415
3296
|
*```js
|
|
3416
|
-
* liveboardEmbed.
|
|
3297
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3417
3298
|
*```
|
|
3418
3299
|
*/
|
|
3419
3300
|
SchedulesList = "schedule-list",
|
|
3420
3301
|
/**
|
|
3421
3302
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3422
|
-
*
|
|
3423
3303
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3424
3304
|
* @example
|
|
3425
3305
|
*```js
|
|
3426
|
-
* liveboardEmbed.
|
|
3306
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3427
3307
|
*```
|
|
3428
3308
|
*/
|
|
3429
3309
|
Cancel = "cancel",
|
|
3430
3310
|
/**
|
|
3431
3311
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3432
|
-
*
|
|
3433
3312
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3434
3313
|
* @example
|
|
3435
3314
|
*```js
|
|
3436
|
-
* liveboardEmbed.
|
|
3315
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3437
3316
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3438
3317
|
*```
|
|
3439
3318
|
*/
|
|
3440
3319
|
Explore = "explore",
|
|
3441
3320
|
/**
|
|
3442
3321
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3443
|
-
*
|
|
3444
3322
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3445
3323
|
* @example
|
|
3446
3324
|
*```js
|
|
3447
|
-
* liveboardEmbed.
|
|
3325
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3448
3326
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3449
3327
|
*```
|
|
3450
3328
|
*/
|
|
3451
3329
|
CopyLink = "embedDocument",
|
|
3452
3330
|
/**
|
|
3453
3331
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3454
|
-
*
|
|
3455
3332
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3456
3333
|
* @example
|
|
3457
3334
|
*```js
|
|
3458
|
-
* liveboardEmbed.
|
|
3335
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3459
3336
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3460
3337
|
*```
|
|
3461
3338
|
*/
|
|
3462
3339
|
CrossFilterChanged = "cross-filter-changed",
|
|
3463
3340
|
/**
|
|
3464
3341
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3465
|
-
*
|
|
3466
3342
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3467
3343
|
* @example
|
|
3468
3344
|
*```js
|
|
@@ -3474,44 +3350,53 @@ export enum EmbedEvent {
|
|
|
3474
3350
|
VizPointRightClick = "vizPointRightClick",
|
|
3475
3351
|
/**
|
|
3476
3352
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
3477
|
-
*
|
|
3478
3353
|
* @hidden
|
|
3479
3354
|
*/
|
|
3480
3355
|
InsertIntoSlide = "insertInToSlide",
|
|
3481
3356
|
/**
|
|
3482
|
-
* @hidden
|
|
3483
3357
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3358
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
3359
|
+
* filter details.
|
|
3360
|
+
* @example
|
|
3361
|
+
*
|
|
3362
|
+
*```js
|
|
3363
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3364
|
+
* console.log('payload', payload);
|
|
3365
|
+
* })
|
|
3366
|
+
*
|
|
3484
3367
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3368
|
+
* @example
|
|
3369
|
+
*
|
|
3370
|
+
*```js
|
|
3371
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3372
|
+
* console.log('payload', payload);
|
|
3373
|
+
* })
|
|
3374
|
+
*```
|
|
3485
3375
|
*/
|
|
3486
3376
|
FilterChanged = "filterChanged",
|
|
3487
3377
|
/**
|
|
3488
3378
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
3489
|
-
*
|
|
3490
3379
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3491
3380
|
*/
|
|
3492
3381
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3493
3382
|
/**
|
|
3494
3383
|
* Emitted when a user selects a data source.
|
|
3495
|
-
*
|
|
3496
3384
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3497
3385
|
*/
|
|
3498
3386
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3499
3387
|
/**
|
|
3500
3388
|
* Emitted when a user updates a connection on the **Data** page
|
|
3501
|
-
*
|
|
3502
3389
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3503
3390
|
*/
|
|
3504
3391
|
UpdateConnection = "updateConnection",
|
|
3505
3392
|
/**
|
|
3506
3393
|
* Emitted when a user updates a connection on the **Data** page
|
|
3507
|
-
*
|
|
3508
3394
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3509
3395
|
*/
|
|
3510
3396
|
CreateConnection = "createConnection",
|
|
3511
3397
|
/**
|
|
3512
3398
|
* Emitted when name, status (private or public) or filter values of a
|
|
3513
3399
|
* Personalised view is updated.
|
|
3514
|
-
*
|
|
3515
3400
|
* @returns viewName: string
|
|
3516
3401
|
* @returns viewId: string
|
|
3517
3402
|
* @returns liveboardId: string
|
|
@@ -3521,7 +3406,6 @@ export enum EmbedEvent {
|
|
|
3521
3406
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3522
3407
|
/**
|
|
3523
3408
|
* Emitted when a Personalised view is saved.
|
|
3524
|
-
*
|
|
3525
3409
|
* @returns viewName: string
|
|
3526
3410
|
* @returns viewId: string
|
|
3527
3411
|
* @returns liveboardId: string
|
|
@@ -3531,7 +3415,6 @@ export enum EmbedEvent {
|
|
|
3531
3415
|
SavePersonalisedView = "savePersonalisedView",
|
|
3532
3416
|
/**
|
|
3533
3417
|
* Emitted when a Liveboard is reset.
|
|
3534
|
-
*
|
|
3535
3418
|
* @returns viewName: string
|
|
3536
3419
|
* @returns viewId: string
|
|
3537
3420
|
* @returns liveboardId: string
|
|
@@ -3541,7 +3424,6 @@ export enum EmbedEvent {
|
|
|
3541
3424
|
ResetLiveboard = "resetLiveboard",
|
|
3542
3425
|
/**
|
|
3543
3426
|
* Emitted when a PersonalisedView is deleted.
|
|
3544
|
-
*
|
|
3545
3427
|
* @returns views: string[]
|
|
3546
3428
|
* @returns liveboardId: string
|
|
3547
3429
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -3549,13 +3431,11 @@ export enum EmbedEvent {
|
|
|
3549
3431
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3550
3432
|
/**
|
|
3551
3433
|
* Emitted when a user creates a new worksheet
|
|
3552
|
-
*
|
|
3553
3434
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3554
3435
|
*/
|
|
3555
3436
|
CreateWorksheet = "createWorksheet",
|
|
3556
3437
|
/**
|
|
3557
3438
|
* Emitted when Ask Sage is initialized.
|
|
3558
|
-
*
|
|
3559
3439
|
* @returns viewName: string
|
|
3560
3440
|
* @returns viewId: string
|
|
3561
3441
|
* @returns liveboardId: string
|
|
@@ -3565,10 +3445,32 @@ export enum EmbedEvent {
|
|
|
3565
3445
|
AskSageInit = "AskSageInit",
|
|
3566
3446
|
/**
|
|
3567
3447
|
* Emitted when a LB/viz is renamed
|
|
3568
|
-
*
|
|
3569
3448
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3570
3449
|
*/
|
|
3571
|
-
Rename = "rename"
|
|
3450
|
+
Rename = "rename",
|
|
3451
|
+
/**
|
|
3452
|
+
* Emitted when user wants to intercept the search execution
|
|
3453
|
+
*
|
|
3454
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
3455
|
+
* event
|
|
3456
|
+
*
|
|
3457
|
+
*```js
|
|
3458
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
3459
|
+
* responder({
|
|
3460
|
+
* data: {
|
|
3461
|
+
* execute: true,
|
|
3462
|
+
* error: {errorText: "My own customised error"}
|
|
3463
|
+
* }})
|
|
3464
|
+
* })
|
|
3465
|
+
*```
|
|
3466
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3467
|
+
*/
|
|
3468
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
3469
|
+
/**
|
|
3470
|
+
* Emitted when runtime parameters changes
|
|
3471
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3472
|
+
*/
|
|
3473
|
+
ParameterChanged = "ParameterChanged"
|
|
3572
3474
|
}
|
|
3573
3475
|
/**
|
|
3574
3476
|
* Event types that can be triggered by the host application
|
|
@@ -3577,7 +3479,6 @@ export enum EmbedEvent {
|
|
|
3577
3479
|
* To trigger an event use the corresponding
|
|
3578
3480
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
3579
3481
|
* SearchEmbed.trigger} method.
|
|
3580
|
-
*
|
|
3581
3482
|
* @example
|
|
3582
3483
|
* ```js
|
|
3583
3484
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3598,7 +3499,6 @@ export enum HostEvent {
|
|
|
3598
3499
|
* the search query string.
|
|
3599
3500
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3600
3501
|
* Includes the following properties:
|
|
3601
|
-
*
|
|
3602
3502
|
* @param - `searchQuery` - query string with search tokens
|
|
3603
3503
|
* @param - `dataSources` - Data source GUID to Search on
|
|
3604
3504
|
* - Although an array, only a single source
|
|
@@ -3617,7 +3517,6 @@ export enum HostEvent {
|
|
|
3617
3517
|
/**
|
|
3618
3518
|
* Triggers a drill on certain points of the specified column
|
|
3619
3519
|
* Includes the following properties:
|
|
3620
|
-
*
|
|
3621
3520
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
3622
3521
|
* to drill to. For example, { selectedPoints: []}
|
|
3623
3522
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -3667,19 +3566,16 @@ export enum HostEvent {
|
|
|
3667
3566
|
DrillDown = "triggerDrillDown",
|
|
3668
3567
|
/**
|
|
3669
3568
|
* Apply filters
|
|
3670
|
-
*
|
|
3671
3569
|
* @hidden
|
|
3672
3570
|
*/
|
|
3673
3571
|
Filter = "filter",
|
|
3674
3572
|
/**
|
|
3675
3573
|
* Reload the answer or visualization
|
|
3676
|
-
*
|
|
3677
3574
|
* @hidden
|
|
3678
3575
|
*/
|
|
3679
3576
|
Reload = "reload",
|
|
3680
3577
|
/**
|
|
3681
3578
|
* Display specific visualizations on a Liveboard.
|
|
3682
|
-
*
|
|
3683
3579
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
3684
3580
|
* in this parameter will be hidden.
|
|
3685
3581
|
* @example
|
|
@@ -3693,7 +3589,6 @@ export enum HostEvent {
|
|
|
3693
3589
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
3694
3590
|
/**
|
|
3695
3591
|
* Set a Liveboard tab as an active tab.
|
|
3696
|
-
*
|
|
3697
3592
|
* @param - tabId - string of id of Tab to show
|
|
3698
3593
|
* @example
|
|
3699
3594
|
* ```js
|
|
@@ -3709,18 +3604,21 @@ export enum HostEvent {
|
|
|
3709
3604
|
* runtime filters passed here are appended to the existing runtime
|
|
3710
3605
|
* filters.
|
|
3711
3606
|
* Pass an array of runtime filters with the following attributes:
|
|
3607
|
+
*
|
|
3712
3608
|
* `columnName`
|
|
3713
3609
|
* _String_. The name of the column to filter on.
|
|
3610
|
+
*
|
|
3714
3611
|
* `operator`
|
|
3715
3612
|
* Runtime filter operator to apply. For information,
|
|
3716
|
-
* see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
|
|
3613
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
3614
|
+
*
|
|
3717
3615
|
* `values`
|
|
3718
|
-
*
|
|
3719
|
-
*
|
|
3720
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3721
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3722
|
-
* embedding (SageEmbed).
|
|
3616
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
3617
|
+
* operators such as BW and IN accept multiple operands.
|
|
3723
3618
|
*
|
|
3619
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3620
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3621
|
+
* embedding (SageEmbed).
|
|
3724
3622
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
3725
3623
|
* @example
|
|
3726
3624
|
* ```js
|
|
@@ -3736,7 +3634,6 @@ export enum HostEvent {
|
|
|
3736
3634
|
/**
|
|
3737
3635
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
3738
3636
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
3739
|
-
*
|
|
3740
3637
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
3741
3638
|
* be a number; for example, `1`, `-1`.
|
|
3742
3639
|
* @example
|
|
@@ -3749,7 +3646,6 @@ export enum HostEvent {
|
|
|
3749
3646
|
/**
|
|
3750
3647
|
* Open the filter panel for a particular column.
|
|
3751
3648
|
* Works with Search and Liveboard embed.
|
|
3752
|
-
*
|
|
3753
3649
|
* @param - { columnId: string,
|
|
3754
3650
|
* name: string,
|
|
3755
3651
|
* type: INT64/CHAR/DATE,
|
|
@@ -3766,7 +3662,6 @@ export enum HostEvent {
|
|
|
3766
3662
|
OpenFilter = "openFilter",
|
|
3767
3663
|
/**
|
|
3768
3664
|
* Add columns to the current search query.
|
|
3769
|
-
*
|
|
3770
3665
|
* @param - { columnIds: string[] }
|
|
3771
3666
|
* @example
|
|
3772
3667
|
* ```js
|
|
@@ -3777,7 +3672,6 @@ export enum HostEvent {
|
|
|
3777
3672
|
AddColumns = "addColumns",
|
|
3778
3673
|
/**
|
|
3779
3674
|
* Remove a column from the current search query.
|
|
3780
|
-
*
|
|
3781
3675
|
* @param - { columnId: string }
|
|
3782
3676
|
* @example
|
|
3783
3677
|
* ```js
|
|
@@ -3792,10 +3686,9 @@ export enum HostEvent {
|
|
|
3792
3686
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
3793
3687
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
3794
3688
|
* sorting, toggling of legends, and data drill down.
|
|
3795
|
-
*
|
|
3796
3689
|
* @example
|
|
3797
3690
|
* ```js
|
|
3798
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
3691
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
3799
3692
|
* data=>console.log(data))
|
|
3800
3693
|
* ```
|
|
3801
3694
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -3803,7 +3696,6 @@ export enum HostEvent {
|
|
|
3803
3696
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
3804
3697
|
/**
|
|
3805
3698
|
* Trigger the **Pin** action on an embedded object
|
|
3806
|
-
*
|
|
3807
3699
|
* @param - Liveboard embed takes the `vizId` as a
|
|
3808
3700
|
* key. Can be left undefined when embedding Search, full app, or
|
|
3809
3701
|
* a visualization.
|
|
@@ -3820,7 +3712,6 @@ export enum HostEvent {
|
|
|
3820
3712
|
/**
|
|
3821
3713
|
* Trigger the **Show Liveboard details** action
|
|
3822
3714
|
* on an embedded Liveboard.
|
|
3823
|
-
*
|
|
3824
3715
|
* @example
|
|
3825
3716
|
*```js
|
|
3826
3717
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -3830,7 +3721,6 @@ export enum HostEvent {
|
|
|
3830
3721
|
LiveboardInfo = "pinboardInfo",
|
|
3831
3722
|
/**
|
|
3832
3723
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
3833
|
-
*
|
|
3834
3724
|
* @example
|
|
3835
3725
|
* ```js
|
|
3836
3726
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -3840,7 +3730,6 @@ export enum HostEvent {
|
|
|
3840
3730
|
Schedule = "subscription",
|
|
3841
3731
|
/**
|
|
3842
3732
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
3843
|
-
*
|
|
3844
3733
|
* @example
|
|
3845
3734
|
* ```js
|
|
3846
3735
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -3849,17 +3738,21 @@ export enum HostEvent {
|
|
|
3849
3738
|
*/
|
|
3850
3739
|
SchedulesList = "schedule-list",
|
|
3851
3740
|
/**
|
|
3852
|
-
* Trigger the **Export TML** action on an embedded Liveboard
|
|
3741
|
+
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
3742
|
+
* Answer.
|
|
3853
3743
|
*
|
|
3854
3744
|
* @example
|
|
3855
3745
|
* ```js
|
|
3856
3746
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
3857
3747
|
* ```
|
|
3748
|
+
*
|
|
3858
3749
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3859
3750
|
*/
|
|
3860
3751
|
ExportTML = "exportTSL",
|
|
3861
3752
|
/**
|
|
3862
|
-
* Trigger the **Edit TML** action on an embedded Liveboard
|
|
3753
|
+
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
3754
|
+
* saved Answers in the full application embedding.
|
|
3755
|
+
*
|
|
3863
3756
|
*
|
|
3864
3757
|
* @example
|
|
3865
3758
|
* ```js
|
|
@@ -3870,7 +3763,6 @@ export enum HostEvent {
|
|
|
3870
3763
|
EditTML = "editTSL",
|
|
3871
3764
|
/**
|
|
3872
3765
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
3873
|
-
*
|
|
3874
3766
|
* @example
|
|
3875
3767
|
* ```js
|
|
3876
3768
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -3879,7 +3771,11 @@ export enum HostEvent {
|
|
|
3879
3771
|
*/
|
|
3880
3772
|
UpdateTML = "updateTSL",
|
|
3881
3773
|
/**
|
|
3882
|
-
* Trigger the **Download PDF** action on an embedded Liveboard
|
|
3774
|
+
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
3775
|
+
* visualization or Answer.
|
|
3776
|
+
*
|
|
3777
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
3778
|
+
* visualizations and Answers if the data is in tabular format.
|
|
3883
3779
|
*
|
|
3884
3780
|
* @example
|
|
3885
3781
|
* ```js
|
|
@@ -3891,7 +3787,6 @@ export enum HostEvent {
|
|
|
3891
3787
|
/**
|
|
3892
3788
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
3893
3789
|
* visualization page.
|
|
3894
|
-
*
|
|
3895
3790
|
* @example
|
|
3896
3791
|
* ```js
|
|
3897
3792
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -3907,7 +3802,6 @@ export enum HostEvent {
|
|
|
3907
3802
|
MakeACopy = "makeACopy",
|
|
3908
3803
|
/**
|
|
3909
3804
|
* Trigger the **Delete** action for a Liveboard.
|
|
3910
|
-
*
|
|
3911
3805
|
* @example
|
|
3912
3806
|
* ```js
|
|
3913
3807
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -3917,7 +3811,6 @@ export enum HostEvent {
|
|
|
3917
3811
|
Remove = "delete",
|
|
3918
3812
|
/**
|
|
3919
3813
|
* Trigger the **Explore** action on a visualization.
|
|
3920
|
-
*
|
|
3921
3814
|
* @param - an object with `vizId` as a key
|
|
3922
3815
|
* @example
|
|
3923
3816
|
* ```js
|
|
@@ -3928,7 +3821,6 @@ export enum HostEvent {
|
|
|
3928
3821
|
Explore = "explore",
|
|
3929
3822
|
/**
|
|
3930
3823
|
* Trigger the **Create alert** action on a visualization
|
|
3931
|
-
*
|
|
3932
3824
|
* @param - an object with `vizId` as a key
|
|
3933
3825
|
* @example
|
|
3934
3826
|
* ```js
|
|
@@ -3941,7 +3833,6 @@ export enum HostEvent {
|
|
|
3941
3833
|
CreateMonitor = "createMonitor",
|
|
3942
3834
|
/**
|
|
3943
3835
|
* Trigger the **Manage alerts** action on a visualization
|
|
3944
|
-
*
|
|
3945
3836
|
* @param - an object with `vizId` as a key
|
|
3946
3837
|
* @example
|
|
3947
3838
|
* ```js
|
|
@@ -3953,29 +3844,28 @@ export enum HostEvent {
|
|
|
3953
3844
|
*/
|
|
3954
3845
|
ManageMonitor = "manageMonitor",
|
|
3955
3846
|
/**
|
|
3956
|
-
* Trigger the **Edit** action on a Liveboard or visualization
|
|
3847
|
+
* Trigger the **Edit** action on a Liveboard or a visualization
|
|
3848
|
+
* on a Liveboard.
|
|
3849
|
+
*
|
|
3850
|
+
* This event is not supported in visualization embed and search embed.
|
|
3957
3851
|
*
|
|
3958
3852
|
* @param - object - To trigger the action for a specific visualization
|
|
3959
3853
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
3960
|
-
*
|
|
3961
|
-
* a visualization.
|
|
3854
|
+
*
|
|
3962
3855
|
* @example
|
|
3963
3856
|
* ```js
|
|
3964
3857
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
3965
3858
|
* ```
|
|
3859
|
+
* @example
|
|
3966
3860
|
* ```js
|
|
3967
3861
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
3968
3862
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3969
3863
|
* ```
|
|
3970
|
-
* ```js
|
|
3971
|
-
* vizEmbed.trigger((HostEvent.Edit)
|
|
3972
|
-
* ```
|
|
3973
3864
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3974
3865
|
*/
|
|
3975
3866
|
Edit = "edit",
|
|
3976
3867
|
/**
|
|
3977
3868
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
3978
|
-
*
|
|
3979
3869
|
* @param - object - to trigger the action for a
|
|
3980
3870
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
3981
3871
|
* @example
|
|
@@ -3993,7 +3883,6 @@ export enum HostEvent {
|
|
|
3993
3883
|
CopyLink = "embedDocument",
|
|
3994
3884
|
/**
|
|
3995
3885
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
3996
|
-
*
|
|
3997
3886
|
* @param - object - to trigger the action for a specific visualization
|
|
3998
3887
|
* in Liveboard embed, pass in `vizId` as a key
|
|
3999
3888
|
* @example
|
|
@@ -4011,12 +3900,11 @@ export enum HostEvent {
|
|
|
4011
3900
|
Present = "present",
|
|
4012
3901
|
/**
|
|
4013
3902
|
* Get TML for the current search.
|
|
4014
|
-
*
|
|
4015
3903
|
* @example
|
|
4016
3904
|
* ```js
|
|
4017
3905
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
4018
3906
|
* console.log(
|
|
4019
|
-
* tml.search_query // TML representation of the search query
|
|
3907
|
+
* tml.answer.search_query // TML representation of the search query
|
|
4020
3908
|
* );
|
|
4021
3909
|
* })
|
|
4022
3910
|
* ```
|
|
@@ -4026,7 +3914,6 @@ export enum HostEvent {
|
|
|
4026
3914
|
GetTML = "getTML",
|
|
4027
3915
|
/**
|
|
4028
3916
|
* Trigger the **Show underlying data** action on visualization or search
|
|
4029
|
-
*
|
|
4030
3917
|
* @param - an object with vizId as a key
|
|
4031
3918
|
* @example
|
|
4032
3919
|
* ```js
|
|
@@ -4046,7 +3933,6 @@ export enum HostEvent {
|
|
|
4046
3933
|
* Trigger the **Delete** action for a visualization
|
|
4047
3934
|
* in an embedded Liveboard, or a chart or table
|
|
4048
3935
|
* generated from Search.
|
|
4049
|
-
*
|
|
4050
3936
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
4051
3937
|
* Can be left empty if embedding Search or visualization.
|
|
4052
3938
|
* @example
|
|
@@ -4063,7 +3949,6 @@ export enum HostEvent {
|
|
|
4063
3949
|
/**
|
|
4064
3950
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
4065
3951
|
* or search.
|
|
4066
|
-
*
|
|
4067
3952
|
* @param - Liveboard embed takes `vizId` as a
|
|
4068
3953
|
* key. Can be left undefined when embedding Search or
|
|
4069
3954
|
* visualization.
|
|
@@ -4084,7 +3969,6 @@ export enum HostEvent {
|
|
|
4084
3969
|
/**
|
|
4085
3970
|
* Trigger the **Download** action on charts in
|
|
4086
3971
|
* the embedded view.
|
|
4087
|
-
*
|
|
4088
3972
|
* @example
|
|
4089
3973
|
* ```js
|
|
4090
3974
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -4101,7 +3985,6 @@ export enum HostEvent {
|
|
|
4101
3985
|
/**
|
|
4102
3986
|
* Trigger the **Download** > **PNG** action on
|
|
4103
3987
|
* charts in the embedded view.
|
|
4104
|
-
*
|
|
4105
3988
|
* @example
|
|
4106
3989
|
* ```js
|
|
4107
3990
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -4117,7 +4000,6 @@ export enum HostEvent {
|
|
|
4117
4000
|
/**
|
|
4118
4001
|
* Trigger the **Download** > **CSV** action on tables in
|
|
4119
4002
|
* the embedded view.
|
|
4120
|
-
*
|
|
4121
4003
|
* @example
|
|
4122
4004
|
* ```js
|
|
4123
4005
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -4135,7 +4017,6 @@ export enum HostEvent {
|
|
|
4135
4017
|
/**
|
|
4136
4018
|
* Trigger the **Download** > **XLSX** action on tables
|
|
4137
4019
|
* in the embedded view.
|
|
4138
|
-
*
|
|
4139
4020
|
* @example
|
|
4140
4021
|
* ```js
|
|
4141
4022
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -4153,7 +4034,6 @@ export enum HostEvent {
|
|
|
4153
4034
|
/**
|
|
4154
4035
|
* Trigger the **Share** action on an embedded
|
|
4155
4036
|
* Liveboard or Answer.
|
|
4156
|
-
*
|
|
4157
4037
|
* @example
|
|
4158
4038
|
* ```js
|
|
4159
4039
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -4167,7 +4047,6 @@ export enum HostEvent {
|
|
|
4167
4047
|
/**
|
|
4168
4048
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
4169
4049
|
* Saves the changes.
|
|
4170
|
-
*
|
|
4171
4050
|
* @example
|
|
4172
4051
|
* ```js
|
|
4173
4052
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -4181,7 +4060,6 @@ export enum HostEvent {
|
|
|
4181
4060
|
/**
|
|
4182
4061
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
4183
4062
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
4184
|
-
*
|
|
4185
4063
|
* @param - an object with `vizId` as a key
|
|
4186
4064
|
* @example
|
|
4187
4065
|
* ```js
|
|
@@ -4198,7 +4076,6 @@ export enum HostEvent {
|
|
|
4198
4076
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
4199
4077
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
4200
4078
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
4201
|
-
*
|
|
4202
4079
|
* @param - an object with vizId as a key
|
|
4203
4080
|
* @example
|
|
4204
4081
|
* ```js
|
|
@@ -4215,7 +4092,6 @@ export enum HostEvent {
|
|
|
4215
4092
|
* Trigger the **Manage pipelines** action on an embedded
|
|
4216
4093
|
* visualization or Answer.
|
|
4217
4094
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
4218
|
-
*
|
|
4219
4095
|
* @param - an object with `vizId` as a key
|
|
4220
4096
|
* @example
|
|
4221
4097
|
* ```js
|
|
@@ -4230,7 +4106,6 @@ export enum HostEvent {
|
|
|
4230
4106
|
ManagePipelines = "manage-pipeline",
|
|
4231
4107
|
/**
|
|
4232
4108
|
* Reset search operation on the Search or Answer page.
|
|
4233
|
-
*
|
|
4234
4109
|
* @example
|
|
4235
4110
|
* ```js
|
|
4236
4111
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -4242,32 +4117,73 @@ export enum HostEvent {
|
|
|
4242
4117
|
*/
|
|
4243
4118
|
ResetSearch = "resetSearch",
|
|
4244
4119
|
/**
|
|
4245
|
-
*
|
|
4246
|
-
*
|
|
4120
|
+
* Get details of filters applied on the Liveboard.
|
|
4121
|
+
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
4247
4122
|
*
|
|
4248
4123
|
* @example
|
|
4249
|
-
*
|
|
4124
|
+
* ```js
|
|
4125
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
4126
|
+
* console.log('data', data);
|
|
4127
|
+
* ```
|
|
4250
4128
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4251
4129
|
*/
|
|
4252
4130
|
GetFilters = "getFilters",
|
|
4253
4131
|
/**
|
|
4132
|
+
* Update one or several filters applied on a Liveboard.
|
|
4133
|
+
* @param - `filter`: a single filter object containing column name,
|
|
4134
|
+
* filter operator, and values.
|
|
4135
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
4136
|
+
* and values for each.
|
|
4137
|
+
*
|
|
4138
|
+
* Each filter object must include the following attributes:
|
|
4139
|
+
*
|
|
4140
|
+
* `column` - Name of the column to filter on.
|
|
4254
4141
|
*
|
|
4255
|
-
*
|
|
4142
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
4143
|
+
* For information about the supported filter operators,
|
|
4144
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4145
|
+
*
|
|
4146
|
+
* `values` - An array of one or several values. The value definition on the
|
|
4147
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
4148
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
4149
|
+
*
|
|
4150
|
+
* @example
|
|
4151
|
+
* ```js
|
|
4256
4152
|
*
|
|
4257
|
-
*
|
|
4153
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4154
|
+
* filter: {
|
|
4155
|
+
* column: "item type",
|
|
4156
|
+
* oper: "IN",
|
|
4157
|
+
* values: ["bags","shirts"],
|
|
4158
|
+
* }
|
|
4159
|
+
* });
|
|
4160
|
+
* ```
|
|
4258
4161
|
* @example
|
|
4259
4162
|
*
|
|
4260
4163
|
* ```js
|
|
4261
4164
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4262
|
-
*
|
|
4263
|
-
*
|
|
4165
|
+
* filters: [{
|
|
4166
|
+
* column: "Item Type",
|
|
4167
|
+
* oper: 'IN',
|
|
4168
|
+
* values: ["bags","shirts"]
|
|
4169
|
+
* },
|
|
4170
|
+
* {
|
|
4171
|
+
* column: "Region",
|
|
4172
|
+
* oper: 'IN',
|
|
4173
|
+
* values: ["West","Midwest"]
|
|
4174
|
+
* },
|
|
4175
|
+
* {
|
|
4176
|
+
* column: "Date",
|
|
4177
|
+
* oper: 'EQ',
|
|
4178
|
+
* values: ["1656680400"]
|
|
4179
|
+
* }]
|
|
4180
|
+
* });
|
|
4264
4181
|
* ```
|
|
4265
4182
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4266
4183
|
*/
|
|
4267
4184
|
UpdateFilters = "updateFilters",
|
|
4268
4185
|
/**
|
|
4269
4186
|
* Get tab details for the current Liveboard.
|
|
4270
|
-
*
|
|
4271
4187
|
* @example
|
|
4272
4188
|
* ```js
|
|
4273
4189
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -4281,7 +4197,6 @@ export enum HostEvent {
|
|
|
4281
4197
|
GetTabs = "getTabs",
|
|
4282
4198
|
/**
|
|
4283
4199
|
* Set the visible tabs on a Liveboard.
|
|
4284
|
-
*
|
|
4285
4200
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
4286
4201
|
* will be hidden.
|
|
4287
4202
|
* @example
|
|
@@ -4295,7 +4210,6 @@ export enum HostEvent {
|
|
|
4295
4210
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4296
4211
|
/**
|
|
4297
4212
|
* Set the hidden tabs on a Liveboard.
|
|
4298
|
-
*
|
|
4299
4213
|
* @param - an array of the IDs of the tabs to hide.
|
|
4300
4214
|
* The IDs not passed will be shown.
|
|
4301
4215
|
* @example
|
|
@@ -4309,7 +4223,6 @@ export enum HostEvent {
|
|
|
4309
4223
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4310
4224
|
/**
|
|
4311
4225
|
* Updates the search query string for Natural Language Search operations.
|
|
4312
|
-
*
|
|
4313
4226
|
* @param - `queryString`: Text string in Natural Language format
|
|
4314
4227
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
4315
4228
|
* @example
|
|
@@ -4324,7 +4237,6 @@ export enum HostEvent {
|
|
|
4324
4237
|
UpdateSageQuery = "updateSageQuery",
|
|
4325
4238
|
/**
|
|
4326
4239
|
* Get the answer session for a Search / Visualization.
|
|
4327
|
-
*
|
|
4328
4240
|
* @example
|
|
4329
4241
|
* ```js
|
|
4330
4242
|
* const {session} = await embed.trigger(
|
|
@@ -4337,7 +4249,6 @@ export enum HostEvent {
|
|
|
4337
4249
|
GetAnswerSession = "getAnswerSession",
|
|
4338
4250
|
/**
|
|
4339
4251
|
* Trigger Ask Sage for viz
|
|
4340
|
-
*
|
|
4341
4252
|
* @example
|
|
4342
4253
|
* ```js
|
|
4343
4254
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -4348,7 +4259,6 @@ export enum HostEvent {
|
|
|
4348
4259
|
AskSage = "AskSage",
|
|
4349
4260
|
/**
|
|
4350
4261
|
* Trigger UpdateCrossFilter for Liveboard
|
|
4351
|
-
*
|
|
4352
4262
|
* @example
|
|
4353
4263
|
* ```js
|
|
4354
4264
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4364,14 +4274,42 @@ export enum HostEvent {
|
|
|
4364
4274
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4365
4275
|
/**
|
|
4366
4276
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
4367
|
-
*
|
|
4368
4277
|
* @example
|
|
4369
4278
|
* ```js
|
|
4370
4279
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
4371
4280
|
* ```
|
|
4372
4281
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4373
4282
|
*/
|
|
4374
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
4283
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4284
|
+
/**
|
|
4285
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4286
|
+
* @example
|
|
4287
|
+
* ```js
|
|
4288
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
4289
|
+
*
|
|
4290
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4291
|
+
*/
|
|
4292
|
+
CreateLiveboard = "CreateLiveboard",
|
|
4293
|
+
/**
|
|
4294
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
4295
|
+
* @example
|
|
4296
|
+
* ```js
|
|
4297
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
4298
|
+
* name: "Color",
|
|
4299
|
+
* value: "almond"
|
|
4300
|
+
* }])
|
|
4301
|
+
*
|
|
4302
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4303
|
+
*/
|
|
4304
|
+
UpdateParameters = "UpdateParameters",
|
|
4305
|
+
/**
|
|
4306
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
4307
|
+
* ```js
|
|
4308
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters);
|
|
4309
|
+
*
|
|
4310
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4311
|
+
*/
|
|
4312
|
+
GetParameters = "GetParameters"
|
|
4375
4313
|
}
|
|
4376
4314
|
/**
|
|
4377
4315
|
* The different visual modes that the data sources panel within
|
|
@@ -4468,7 +4406,15 @@ export enum Param {
|
|
|
4468
4406
|
ClientLogLevel = "clientLogLevel",
|
|
4469
4407
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
4470
4408
|
enableAskSage = "enableAskSage",
|
|
4471
|
-
CollapseSearchBarInitially = "collapseSearchBarInitially"
|
|
4409
|
+
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
4410
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
4411
|
+
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
4412
|
+
DateFormatLocale = "dateFormatLocale",
|
|
4413
|
+
NumberFormatLocale = "numberFormatLocale",
|
|
4414
|
+
CurrencyFormat = "currencyFormat",
|
|
4415
|
+
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4416
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
4417
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4472
4418
|
}
|
|
4473
4419
|
/**
|
|
4474
4420
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -4477,7 +4423,6 @@ export enum Param {
|
|
|
4477
4423
|
* specific actions in the embedded view, define the Action
|
|
4478
4424
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
4479
4425
|
* or `hiddenActions` array.
|
|
4480
|
-
*
|
|
4481
4426
|
* @example
|
|
4482
4427
|
* ```js
|
|
4483
4428
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -4501,10 +4446,9 @@ export enum Action {
|
|
|
4501
4446
|
/**
|
|
4502
4447
|
* The **Save** action on an Answer or Liveboard.
|
|
4503
4448
|
* Allows users to save the changes.
|
|
4504
|
-
*
|
|
4505
4449
|
* @example
|
|
4506
4450
|
* ```js
|
|
4507
|
-
* disabledActions: [Action.
|
|
4451
|
+
* disabledActions: [Action.Save]
|
|
4508
4452
|
* ```
|
|
4509
4453
|
*/
|
|
4510
4454
|
Save = "save",
|
|
@@ -4518,7 +4462,8 @@ export enum Action {
|
|
|
4518
4462
|
SaveUntitled = "saveUntitled",
|
|
4519
4463
|
/**
|
|
4520
4464
|
* The **Save as View** action on the Answer
|
|
4521
|
-
* page. Saves an Answer as a View object
|
|
4465
|
+
* page. Saves an Answer as a View object in the full
|
|
4466
|
+
* application embedding mode.
|
|
4522
4467
|
*
|
|
4523
4468
|
* @example
|
|
4524
4469
|
* ```js
|
|
@@ -4533,7 +4478,6 @@ export enum Action {
|
|
|
4533
4478
|
* visualizations in the embedded Liveboard view.
|
|
4534
4479
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
4535
4480
|
* Liveboards and visualizations.
|
|
4536
|
-
*
|
|
4537
4481
|
* @example
|
|
4538
4482
|
* ```js
|
|
4539
4483
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -4543,7 +4487,6 @@ export enum Action {
|
|
|
4543
4487
|
/**
|
|
4544
4488
|
* The **Copy and Edit** action on a Liveboard.
|
|
4545
4489
|
* This action is now replaced with `Action.MakeACopy`.
|
|
4546
|
-
*
|
|
4547
4490
|
* @example
|
|
4548
4491
|
* ```js
|
|
4549
4492
|
* disabledActions: [Action.EditACopy]
|
|
@@ -4553,7 +4496,6 @@ export enum Action {
|
|
|
4553
4496
|
/**
|
|
4554
4497
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
4555
4498
|
* Copies the visualization URL
|
|
4556
|
-
*
|
|
4557
4499
|
* @example
|
|
4558
4500
|
* ```js
|
|
4559
4501
|
* disabledActions: [Action.CopyLink]
|
|
@@ -4567,7 +4509,6 @@ export enum Action {
|
|
|
4567
4509
|
/**
|
|
4568
4510
|
* The **Schedule** menu action on a Liveboard.
|
|
4569
4511
|
* Allows scheduling a Liveboard notification.
|
|
4570
|
-
*
|
|
4571
4512
|
* @example
|
|
4572
4513
|
* ```js
|
|
4573
4514
|
* disabledActions: [Action.Schedule]
|
|
@@ -4577,7 +4518,6 @@ export enum Action {
|
|
|
4577
4518
|
/**
|
|
4578
4519
|
* The **Manage schedules** menu action on a Liveboard.
|
|
4579
4520
|
* Allows users to manage scheduled Liveboard jobs.
|
|
4580
|
-
*
|
|
4581
4521
|
* @example
|
|
4582
4522
|
* ```js
|
|
4583
4523
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -4587,7 +4527,6 @@ export enum Action {
|
|
|
4587
4527
|
/**
|
|
4588
4528
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
4589
4529
|
* Allows users to share an object with other users and groups.
|
|
4590
|
-
*
|
|
4591
4530
|
* @example
|
|
4592
4531
|
* ```js
|
|
4593
4532
|
* disabledActions: [Action.Share]
|
|
@@ -4597,7 +4536,6 @@ export enum Action {
|
|
|
4597
4536
|
/**
|
|
4598
4537
|
* The **Add filter** action on a Liveboard and Search page.
|
|
4599
4538
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
4600
|
-
*
|
|
4601
4539
|
* @example
|
|
4602
4540
|
* ```js
|
|
4603
4541
|
* disabledActions: [Action.AddFilter]
|
|
@@ -4608,7 +4546,6 @@ export enum Action {
|
|
|
4608
4546
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
4609
4547
|
* Allows to show action menu to add different objects (like
|
|
4610
4548
|
* formulas, parameters) in data panel v2.
|
|
4611
|
-
*
|
|
4612
4549
|
* @example
|
|
4613
4550
|
* ```js
|
|
4614
4551
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -4620,7 +4557,6 @@ export enum Action {
|
|
|
4620
4557
|
* Filter configuration options on a Liveboard and Search page.
|
|
4621
4558
|
* Allows configuring filter options when adding filters to a
|
|
4622
4559
|
* Liveboard or Answer.
|
|
4623
|
-
*
|
|
4624
4560
|
* @example
|
|
4625
4561
|
* ```js
|
|
4626
4562
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -4631,7 +4567,6 @@ export enum Action {
|
|
|
4631
4567
|
/**
|
|
4632
4568
|
* The **Choose sources** button on Search page.
|
|
4633
4569
|
* Allows selecting data sources for search queries.
|
|
4634
|
-
*
|
|
4635
4570
|
* @example
|
|
4636
4571
|
* ```js
|
|
4637
4572
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -4641,7 +4576,6 @@ export enum Action {
|
|
|
4641
4576
|
/**
|
|
4642
4577
|
* The **Create formula** action on a Search or Answer page.
|
|
4643
4578
|
* Allows adding formulas to an Answer.
|
|
4644
|
-
*
|
|
4645
4579
|
* @example
|
|
4646
4580
|
* ```js
|
|
4647
4581
|
* disabledActions: [Action.AddFormula]
|
|
@@ -4651,7 +4585,6 @@ export enum Action {
|
|
|
4651
4585
|
/**
|
|
4652
4586
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
4653
4587
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
4654
|
-
*
|
|
4655
4588
|
* @example
|
|
4656
4589
|
* ```js
|
|
4657
4590
|
* disabledActions: [Action.AddParameter]
|
|
@@ -4661,7 +4594,6 @@ export enum Action {
|
|
|
4661
4594
|
/**
|
|
4662
4595
|
* The **Add Column Set** action on a Answer.
|
|
4663
4596
|
* Allows adding column sets to a Answer.
|
|
4664
|
-
*
|
|
4665
4597
|
* @example
|
|
4666
4598
|
* ```js
|
|
4667
4599
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -4672,7 +4604,6 @@ export enum Action {
|
|
|
4672
4604
|
/**
|
|
4673
4605
|
* The **Add Query Set** action on a Answer.
|
|
4674
4606
|
* Allows adding query sets to a Answer.
|
|
4675
|
-
*
|
|
4676
4607
|
* @example
|
|
4677
4608
|
* ```js
|
|
4678
4609
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -4687,7 +4618,6 @@ export enum Action {
|
|
|
4687
4618
|
/**
|
|
4688
4619
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
4689
4620
|
* Answer page.
|
|
4690
|
-
*
|
|
4691
4621
|
* @example
|
|
4692
4622
|
* ```js
|
|
4693
4623
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -4710,7 +4640,6 @@ export enum Action {
|
|
|
4710
4640
|
/**
|
|
4711
4641
|
* The **Show underlying data** menu action on a visualization or
|
|
4712
4642
|
* Answer page.
|
|
4713
|
-
*
|
|
4714
4643
|
* @example
|
|
4715
4644
|
* ```js
|
|
4716
4645
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -4721,7 +4650,6 @@ export enum Action {
|
|
|
4721
4650
|
* The **Download** menu action on Liveboard visualizations
|
|
4722
4651
|
* and Answers.
|
|
4723
4652
|
* Allows downloading a visualization or Answer.
|
|
4724
|
-
*
|
|
4725
4653
|
* @example
|
|
4726
4654
|
* ```js
|
|
4727
4655
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -4732,7 +4660,6 @@ export enum Action {
|
|
|
4732
4660
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
4733
4661
|
* or Answer page.
|
|
4734
4662
|
* Downloads a visualization or Answer as a PNG file.
|
|
4735
|
-
*
|
|
4736
4663
|
* @example
|
|
4737
4664
|
* ```js
|
|
4738
4665
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -4740,9 +4667,16 @@ export enum Action {
|
|
|
4740
4667
|
*/
|
|
4741
4668
|
DownloadAsPng = "downloadAsPng",
|
|
4742
4669
|
/**
|
|
4743
|
-
* The **Download** > **PDF** menu action on a Liveboard.
|
|
4744
|
-
* Downloads a visualization or Answer as a PDF file.
|
|
4745
4670
|
*
|
|
4671
|
+
* The **Download PDF** action that downloads a Liveboard,
|
|
4672
|
+
* visualization, or Answer as a PDF file.
|
|
4673
|
+
*
|
|
4674
|
+
*
|
|
4675
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
4676
|
+
* visualizations and Answers if the data is in tabular format.
|
|
4677
|
+
*
|
|
4678
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
4679
|
+
*visualizations and Answers if the data is in tabular format.
|
|
4746
4680
|
* @example
|
|
4747
4681
|
* ```js
|
|
4748
4682
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -4753,7 +4687,6 @@ export enum Action {
|
|
|
4753
4687
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
4754
4688
|
* or Answer page.
|
|
4755
4689
|
* Downloads a visualization or Answer in the XLSX format.
|
|
4756
|
-
*
|
|
4757
4690
|
* @example
|
|
4758
4691
|
* ```js
|
|
4759
4692
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -4764,7 +4697,6 @@ export enum Action {
|
|
|
4764
4697
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
4765
4698
|
* or Answer page.
|
|
4766
4699
|
* Downloads a visualization or Answer in the XLSX format.
|
|
4767
|
-
*
|
|
4768
4700
|
* @example
|
|
4769
4701
|
* ```js
|
|
4770
4702
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -4779,7 +4711,6 @@ export enum Action {
|
|
|
4779
4711
|
* The **Export TML** menu action on Liveboard, Answers
|
|
4780
4712
|
* Worksheets and Data Connections page.
|
|
4781
4713
|
* Exports an object as a TML file.
|
|
4782
|
-
*
|
|
4783
4714
|
* @example
|
|
4784
4715
|
* ```js
|
|
4785
4716
|
* disabledActions: [Action.ExportTML]
|
|
@@ -4789,7 +4720,6 @@ export enum Action {
|
|
|
4789
4720
|
/**
|
|
4790
4721
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
4791
4722
|
* Imports TML representation of ThoughtSpot objects.
|
|
4792
|
-
*
|
|
4793
4723
|
* @example
|
|
4794
4724
|
* ```js
|
|
4795
4725
|
* disabledActions: [Action.ImportTML]
|
|
@@ -4799,7 +4729,6 @@ export enum Action {
|
|
|
4799
4729
|
/**
|
|
4800
4730
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
4801
4731
|
* Update TML representation of ThoughtSpot objects.
|
|
4802
|
-
*
|
|
4803
4732
|
* @example
|
|
4804
4733
|
* ```js
|
|
4805
4734
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -4809,7 +4738,6 @@ export enum Action {
|
|
|
4809
4738
|
/**
|
|
4810
4739
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
4811
4740
|
* Opens the TML editor.
|
|
4812
|
-
*
|
|
4813
4741
|
* @example
|
|
4814
4742
|
* ```js
|
|
4815
4743
|
* disabledActions: [Action.EditTML]
|
|
@@ -4820,7 +4748,6 @@ export enum Action {
|
|
|
4820
4748
|
* The **Present** menu action for Liveboards and Answers.
|
|
4821
4749
|
* Allows presenting a Liveboard or visualization in
|
|
4822
4750
|
* slideshow mode.
|
|
4823
|
-
*
|
|
4824
4751
|
* @example
|
|
4825
4752
|
* ```js
|
|
4826
4753
|
* disabledActions: [Action.Present]
|
|
@@ -4830,7 +4757,6 @@ export enum Action {
|
|
|
4830
4757
|
/**
|
|
4831
4758
|
* The tile resize options in the visualization menu.
|
|
4832
4759
|
* Allows switching between different preset layouts.
|
|
4833
|
-
*
|
|
4834
4760
|
* @example
|
|
4835
4761
|
* ```js
|
|
4836
4762
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -4841,7 +4767,6 @@ export enum Action {
|
|
|
4841
4767
|
* The *Edit* action on the Liveboard page and in the
|
|
4842
4768
|
* visualization menu.
|
|
4843
4769
|
* Opens a Liveboard or visualization in edit mode.
|
|
4844
|
-
*
|
|
4845
4770
|
* @example
|
|
4846
4771
|
* ```js
|
|
4847
4772
|
* disabledActions: [Action.Edit]
|
|
@@ -4850,7 +4775,6 @@ export enum Action {
|
|
|
4850
4775
|
Edit = "edit",
|
|
4851
4776
|
/**
|
|
4852
4777
|
* The text edit option for Liveboard and visualization titles.
|
|
4853
|
-
*
|
|
4854
4778
|
* @example
|
|
4855
4779
|
* ```js
|
|
4856
4780
|
* disabledActions: [Action.EditTitle]
|
|
@@ -4860,7 +4784,6 @@ export enum Action {
|
|
|
4860
4784
|
/**
|
|
4861
4785
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
4862
4786
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
4863
|
-
*
|
|
4864
4787
|
* @example
|
|
4865
4788
|
* ```js
|
|
4866
4789
|
* disabledActions: [Action.Remove]
|
|
@@ -4892,7 +4815,6 @@ export enum Action {
|
|
|
4892
4815
|
* Displays details such as the name, description, and
|
|
4893
4816
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
4894
4817
|
* and update.
|
|
4895
|
-
*
|
|
4896
4818
|
* @example
|
|
4897
4819
|
* ```js
|
|
4898
4820
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -4910,7 +4832,6 @@ export enum Action {
|
|
|
4910
4832
|
/**
|
|
4911
4833
|
* The **Pin** menu action on an Answer or
|
|
4912
4834
|
* Search results page.
|
|
4913
|
-
*
|
|
4914
4835
|
* @example
|
|
4915
4836
|
* ```js
|
|
4916
4837
|
* disabledActions: [Action.Pin]
|
|
@@ -4923,7 +4844,6 @@ export enum Action {
|
|
|
4923
4844
|
AnalysisInfo = "analysisInfo",
|
|
4924
4845
|
/**
|
|
4925
4846
|
* The **Schedule** menu action on a Liveboard.
|
|
4926
|
-
*
|
|
4927
4847
|
* @example
|
|
4928
4848
|
* ```js
|
|
4929
4849
|
* disabledActions: [Action.Subscription]
|
|
@@ -4932,7 +4852,6 @@ export enum Action {
|
|
|
4932
4852
|
Subscription = "subscription",
|
|
4933
4853
|
/**
|
|
4934
4854
|
* The **Explore** action on Liveboard visualizations
|
|
4935
|
-
*
|
|
4936
4855
|
* @example
|
|
4937
4856
|
* ```js
|
|
4938
4857
|
* disabledActions: [Action.Explore]
|
|
@@ -4942,7 +4861,6 @@ export enum Action {
|
|
|
4942
4861
|
/**
|
|
4943
4862
|
* The action to include data points on a drilled-down Answer
|
|
4944
4863
|
* or visualization
|
|
4945
|
-
*
|
|
4946
4864
|
* @example
|
|
4947
4865
|
* ```js
|
|
4948
4866
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -4952,7 +4870,6 @@ export enum Action {
|
|
|
4952
4870
|
/**
|
|
4953
4871
|
* The action to exclude data points on a drilled-down Answer
|
|
4954
4872
|
* or visualization
|
|
4955
|
-
*
|
|
4956
4873
|
* @example
|
|
4957
4874
|
* ```js
|
|
4958
4875
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -4963,7 +4880,6 @@ export enum Action {
|
|
|
4963
4880
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
4964
4881
|
* or Liveboard.
|
|
4965
4882
|
* Copies the selected data point.
|
|
4966
|
-
*
|
|
4967
4883
|
* @example
|
|
4968
4884
|
* ```js
|
|
4969
4885
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -4981,7 +4897,6 @@ export enum Action {
|
|
|
4981
4897
|
* The **Drill down** menu action on Answers and Liveboard
|
|
4982
4898
|
* visualizations.
|
|
4983
4899
|
* Allows drilling down to a specific data point on a chart or table.
|
|
4984
|
-
*
|
|
4985
4900
|
* @example
|
|
4986
4901
|
* ```js
|
|
4987
4902
|
* disabledActions: [Action.DrillDown]
|
|
@@ -4991,7 +4906,6 @@ export enum Action {
|
|
|
4991
4906
|
/**
|
|
4992
4907
|
* The request access action on Liveboards.
|
|
4993
4908
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
4994
|
-
*
|
|
4995
4909
|
* @example
|
|
4996
4910
|
* ```js
|
|
4997
4911
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -5001,7 +4915,6 @@ export enum Action {
|
|
|
5001
4915
|
/**
|
|
5002
4916
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
5003
4917
|
* of the Answer page
|
|
5004
|
-
*
|
|
5005
4918
|
* @example
|
|
5006
4919
|
* ```js
|
|
5007
4920
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5009,7 +4922,8 @@ export enum Action {
|
|
|
5009
4922
|
*/
|
|
5010
4923
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
5011
4924
|
/**
|
|
5012
|
-
* The **Delete** action for Answers
|
|
4925
|
+
* The **Delete** action for Answers in the full application
|
|
4926
|
+
* embedding mode.
|
|
5013
4927
|
*
|
|
5014
4928
|
* @example
|
|
5015
4929
|
* ```js
|
|
@@ -5020,7 +4934,6 @@ export enum Action {
|
|
|
5020
4934
|
AnswerDelete = "onDeleteAnswer",
|
|
5021
4935
|
/**
|
|
5022
4936
|
* The Chart switcher icon on Answer and visualization pages.
|
|
5023
|
-
*
|
|
5024
4937
|
* @example
|
|
5025
4938
|
* ```js
|
|
5026
4939
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5030,7 +4943,6 @@ export enum Action {
|
|
|
5030
4943
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5031
4944
|
/**
|
|
5032
4945
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
5033
|
-
*
|
|
5034
4946
|
* @example
|
|
5035
4947
|
* ```js
|
|
5036
4948
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5040,7 +4952,6 @@ export enum Action {
|
|
|
5040
4952
|
AddToFavorites = "addToFavorites",
|
|
5041
4953
|
/**
|
|
5042
4954
|
* The edit icon on Liveboards (Classic experience).
|
|
5043
|
-
*
|
|
5044
4955
|
* @example
|
|
5045
4956
|
* ```js
|
|
5046
4957
|
* disabledActions: [Action.EditDetails]
|
|
@@ -5050,7 +4961,6 @@ export enum Action {
|
|
|
5050
4961
|
EditDetails = "editDetails",
|
|
5051
4962
|
/**
|
|
5052
4963
|
* The Create alert action on KPI charts.
|
|
5053
|
-
*
|
|
5054
4964
|
* @example
|
|
5055
4965
|
* ```js
|
|
5056
4966
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -5069,7 +4979,6 @@ export enum Action {
|
|
|
5069
4979
|
/**
|
|
5070
4980
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
5071
4981
|
* Allows sending data to a Google Sheet.
|
|
5072
|
-
*
|
|
5073
4982
|
* @example
|
|
5074
4983
|
* ```js
|
|
5075
4984
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -5081,7 +4990,6 @@ export enum Action {
|
|
|
5081
4990
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
5082
4991
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
5083
4992
|
* Microsoft Teams, and so on.
|
|
5084
|
-
*
|
|
5085
4993
|
* @example
|
|
5086
4994
|
* ```js
|
|
5087
4995
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5092,7 +5000,6 @@ export enum Action {
|
|
|
5092
5000
|
/**
|
|
5093
5001
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
5094
5002
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5095
|
-
*
|
|
5096
5003
|
* @example
|
|
5097
5004
|
* ```js
|
|
5098
5005
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5103,7 +5010,6 @@ export enum Action {
|
|
|
5103
5010
|
/**
|
|
5104
5011
|
* The **Filter** action on Liveboard visualizations.
|
|
5105
5012
|
* Allows users to apply cross-filters on a Liveboard.
|
|
5106
|
-
*
|
|
5107
5013
|
* @example
|
|
5108
5014
|
* ```js
|
|
5109
5015
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -5114,7 +5020,6 @@ export enum Action {
|
|
|
5114
5020
|
/**
|
|
5115
5021
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5116
5022
|
* Allows sending data to third-party apps Slack
|
|
5117
|
-
*
|
|
5118
5023
|
* @example
|
|
5119
5024
|
* ```js
|
|
5120
5025
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -5125,7 +5030,6 @@ export enum Action {
|
|
|
5125
5030
|
/**
|
|
5126
5031
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5127
5032
|
* Allows sending data to third-party apps Team
|
|
5128
|
-
*
|
|
5129
5033
|
* @example
|
|
5130
5034
|
* ```js
|
|
5131
5035
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -5137,7 +5041,6 @@ export enum Action {
|
|
|
5137
5041
|
* The **Remove** action that appears when cross filters are applied
|
|
5138
5042
|
* on a Liveboard.
|
|
5139
5043
|
* Removes filters applied o a visualization.
|
|
5140
|
-
*
|
|
5141
5044
|
* @example
|
|
5142
5045
|
* ```js
|
|
5143
5046
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5149,7 +5052,6 @@ export enum Action {
|
|
|
5149
5052
|
* The **Aggregate** option in the chart axis or the
|
|
5150
5053
|
* table column customization menu.
|
|
5151
5054
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
5152
|
-
*
|
|
5153
5055
|
* @example
|
|
5154
5056
|
* ```js
|
|
5155
5057
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -5161,7 +5063,6 @@ export enum Action {
|
|
|
5161
5063
|
* The **Time bucket** option in the chart axis or table column
|
|
5162
5064
|
* customization menu.
|
|
5163
5065
|
* Allows defining time metric for date comparison.
|
|
5164
|
-
*
|
|
5165
5066
|
* @example
|
|
5166
5067
|
* ```js
|
|
5167
5068
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -5172,7 +5073,6 @@ export enum Action {
|
|
|
5172
5073
|
/**
|
|
5173
5074
|
* The **Filter** action in the chart axis or table column
|
|
5174
5075
|
* customization menu.
|
|
5175
|
-
*
|
|
5176
5076
|
* @example
|
|
5177
5077
|
* ```js
|
|
5178
5078
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -5184,7 +5084,6 @@ export enum Action {
|
|
|
5184
5084
|
* The **Conditional formatting** action on chart or table.
|
|
5185
5085
|
* Allows adding rules for conditional formatting of data
|
|
5186
5086
|
* points on a chart or table.
|
|
5187
|
-
*
|
|
5188
5087
|
* @example
|
|
5189
5088
|
* ```js
|
|
5190
5089
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5196,7 +5095,6 @@ export enum Action {
|
|
|
5196
5095
|
* The **Sort** menu action on a table or chart axis
|
|
5197
5096
|
* Sorts data in ascending or descending order.
|
|
5198
5097
|
* Allows adding, editing, or removing filters.
|
|
5199
|
-
*
|
|
5200
5098
|
* @example
|
|
5201
5099
|
* ```js
|
|
5202
5100
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5209,7 +5107,6 @@ export enum Action {
|
|
|
5209
5107
|
* customization menu.
|
|
5210
5108
|
* Allows grouping data points if the axes use the same
|
|
5211
5109
|
* unit of measurement and a similar scale.
|
|
5212
|
-
*
|
|
5213
5110
|
* @example
|
|
5214
5111
|
* ```js
|
|
5215
5112
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -5221,7 +5118,6 @@ export enum Action {
|
|
|
5221
5118
|
* The **Position** option in the axis customization menu.
|
|
5222
5119
|
* Allows changing the position of the axis to the
|
|
5223
5120
|
* left or right side of the chart.
|
|
5224
|
-
*
|
|
5225
5121
|
* @example
|
|
5226
5122
|
* ```js
|
|
5227
5123
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -5232,7 +5128,6 @@ export enum Action {
|
|
|
5232
5128
|
/**
|
|
5233
5129
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
5234
5130
|
* Renames the axis label on a chart or the column header on a table.
|
|
5235
|
-
*
|
|
5236
5131
|
* @example
|
|
5237
5132
|
* ```js
|
|
5238
5133
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -5244,7 +5139,6 @@ export enum Action {
|
|
|
5244
5139
|
* The **Edit** action in the axis customization menu.
|
|
5245
5140
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
5246
5141
|
* and format of a column.
|
|
5247
|
-
*
|
|
5248
5142
|
* @example
|
|
5249
5143
|
* ```js
|
|
5250
5144
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -5255,7 +5149,6 @@ export enum Action {
|
|
|
5255
5149
|
/**
|
|
5256
5150
|
* The **Number format** action to customize the format of
|
|
5257
5151
|
* the data labels on a chart or table.
|
|
5258
|
-
*
|
|
5259
5152
|
* @example
|
|
5260
5153
|
* ```js
|
|
5261
5154
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -5266,7 +5159,6 @@ export enum Action {
|
|
|
5266
5159
|
/**
|
|
5267
5160
|
* The **Text wrapping** action on a table.
|
|
5268
5161
|
* Wraps or clips column text on a table.
|
|
5269
|
-
*
|
|
5270
5162
|
* @example
|
|
5271
5163
|
* ```js
|
|
5272
5164
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -5279,7 +5171,6 @@ export enum Action {
|
|
|
5279
5171
|
* customization menu.
|
|
5280
5172
|
* Removes the data labels from a chart or the column of a
|
|
5281
5173
|
* table visualization.
|
|
5282
|
-
*
|
|
5283
5174
|
* @example
|
|
5284
5175
|
* ```js
|
|
5285
5176
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -5294,7 +5185,6 @@ export enum Action {
|
|
|
5294
5185
|
/**
|
|
5295
5186
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
5296
5187
|
* Allows renaming a Liveboard or visualization.
|
|
5297
|
-
*
|
|
5298
5188
|
* @example
|
|
5299
5189
|
* ```js
|
|
5300
5190
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -5338,7 +5228,6 @@ export enum Action {
|
|
|
5338
5228
|
/**
|
|
5339
5229
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
5340
5230
|
* Allows moving a visualization to a different tab.
|
|
5341
|
-
*
|
|
5342
5231
|
* @example
|
|
5343
5232
|
* ```js
|
|
5344
5233
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -5347,7 +5236,6 @@ export enum Action {
|
|
|
5347
5236
|
MoveToTab = "onContainerMove",
|
|
5348
5237
|
/**
|
|
5349
5238
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
5350
|
-
*
|
|
5351
5239
|
* @example
|
|
5352
5240
|
* ```js
|
|
5353
5241
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5356,7 +5244,6 @@ export enum Action {
|
|
|
5356
5244
|
ManageMonitor = "ManageMonitor",
|
|
5357
5245
|
/**
|
|
5358
5246
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5359
|
-
*
|
|
5360
5247
|
* @example
|
|
5361
5248
|
* ```js
|
|
5362
5249
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -5366,7 +5253,6 @@ export enum Action {
|
|
|
5366
5253
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5367
5254
|
/**
|
|
5368
5255
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
5369
|
-
*
|
|
5370
5256
|
* @example
|
|
5371
5257
|
* ```js
|
|
5372
5258
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -5378,7 +5264,6 @@ export enum Action {
|
|
|
5378
5264
|
* Action ID for the Parent TML action
|
|
5379
5265
|
* The parent action **TML** must be included to access TML-related options
|
|
5380
5266
|
* within the cascading menu (specific to the answer page)
|
|
5381
|
-
*
|
|
5382
5267
|
* @example
|
|
5383
5268
|
* ```js
|
|
5384
5269
|
* // to include specific TML actions
|
|
@@ -5390,13 +5275,11 @@ export enum Action {
|
|
|
5390
5275
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5391
5276
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5392
5277
|
* ```
|
|
5393
|
-
*
|
|
5394
|
-
* @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
|
|
5278
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5395
5279
|
*/
|
|
5396
5280
|
TML = "tml",
|
|
5397
5281
|
/**
|
|
5398
5282
|
* Action ID for to hide Verified Liveboard Banner
|
|
5399
|
-
*
|
|
5400
5283
|
* @example
|
|
5401
5284
|
* ```js
|
|
5402
5285
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -5406,7 +5289,6 @@ export enum Action {
|
|
|
5406
5289
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
5407
5290
|
/**
|
|
5408
5291
|
* Action ID for ask sage button
|
|
5409
|
-
*
|
|
5410
5292
|
* @example
|
|
5411
5293
|
* ```js
|
|
5412
5294
|
* hiddenAction: [Action.AskAi]
|
|
@@ -5416,7 +5298,6 @@ export enum Action {
|
|
|
5416
5298
|
AskAi = "AskAi",
|
|
5417
5299
|
/**
|
|
5418
5300
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
5419
|
-
*
|
|
5420
5301
|
* @example
|
|
5421
5302
|
* ```js
|
|
5422
5303
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -5426,7 +5307,6 @@ export enum Action {
|
|
|
5426
5307
|
AddToWatchlist = "addToWatchlist",
|
|
5427
5308
|
/**
|
|
5428
5309
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
5429
|
-
*
|
|
5430
5310
|
* @example
|
|
5431
5311
|
* ```js
|
|
5432
5312
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -5434,19 +5314,8 @@ export enum Action {
|
|
|
5434
5314
|
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
5435
5315
|
*/
|
|
5436
5316
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
5437
|
-
/**
|
|
5438
|
-
* The **Copy KPI Link** menu action on KPI watchlist.
|
|
5439
|
-
*
|
|
5440
|
-
* @example
|
|
5441
|
-
* ```js
|
|
5442
|
-
* disabledActions: [Action.CopyKpiLink]
|
|
5443
|
-
* ```
|
|
5444
|
-
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
5445
|
-
*/
|
|
5446
|
-
CopyKpiLink = "copyKpiLink",
|
|
5447
5317
|
/**
|
|
5448
5318
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
5449
|
-
*
|
|
5450
5319
|
* @example
|
|
5451
5320
|
* ```js
|
|
5452
5321
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -5456,7 +5325,6 @@ export enum Action {
|
|
|
5456
5325
|
OrganiseFavourites = "organiseFavourites",
|
|
5457
5326
|
/**
|
|
5458
5327
|
* Action ID for AI Highlights button
|
|
5459
|
-
*
|
|
5460
5328
|
* @example
|
|
5461
5329
|
* ```js
|
|
5462
5330
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -5525,7 +5393,6 @@ export interface CustomActionPayload {
|
|
|
5525
5393
|
export enum LogLevel {
|
|
5526
5394
|
/**
|
|
5527
5395
|
* No logs will be logged in the console.
|
|
5528
|
-
*
|
|
5529
5396
|
* @example
|
|
5530
5397
|
* ```js
|
|
5531
5398
|
* init({
|
|
@@ -5538,7 +5405,6 @@ export enum LogLevel {
|
|
|
5538
5405
|
SILENT = "SILENT",
|
|
5539
5406
|
/**
|
|
5540
5407
|
* Only ERROR logs will be logged in the console.
|
|
5541
|
-
*
|
|
5542
5408
|
* @example
|
|
5543
5409
|
* ```js
|
|
5544
5410
|
* init({
|
|
@@ -5551,7 +5417,6 @@ export enum LogLevel {
|
|
|
5551
5417
|
ERROR = "ERROR",
|
|
5552
5418
|
/**
|
|
5553
5419
|
* Only WARN and ERROR logs will be logged in the console.
|
|
5554
|
-
*
|
|
5555
5420
|
* @example
|
|
5556
5421
|
* ```js
|
|
5557
5422
|
* init({
|
|
@@ -5564,7 +5429,6 @@ export enum LogLevel {
|
|
|
5564
5429
|
WARN = "WARN",
|
|
5565
5430
|
/**
|
|
5566
5431
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
5567
|
-
*
|
|
5568
5432
|
* @example
|
|
5569
5433
|
* ```js
|
|
5570
5434
|
* init({
|
|
@@ -5577,7 +5441,6 @@ export enum LogLevel {
|
|
|
5577
5441
|
INFO = "INFO",
|
|
5578
5442
|
/**
|
|
5579
5443
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
5580
|
-
*
|
|
5581
5444
|
* @example
|
|
5582
5445
|
* ```js
|
|
5583
5446
|
* init({
|
|
@@ -5590,7 +5453,6 @@ export enum LogLevel {
|
|
|
5590
5453
|
DEBUG = "DEBUG",
|
|
5591
5454
|
/**
|
|
5592
5455
|
* All logs will be logged in the console.
|
|
5593
|
-
*
|
|
5594
5456
|
* @example
|
|
5595
5457
|
* ```js
|
|
5596
5458
|
* init({
|
|
@@ -5948,7 +5810,6 @@ export interface CustomCssVariables {
|
|
|
5948
5810
|
* Copyright (c) 2023
|
|
5949
5811
|
*
|
|
5950
5812
|
* Embed ThoughtSpot Sage
|
|
5951
|
-
*
|
|
5952
5813
|
* @summary TS Sage embed
|
|
5953
5814
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
5954
5815
|
*/
|
|
@@ -5971,7 +5832,6 @@ export interface SearchOptions {
|
|
|
5971
5832
|
/**
|
|
5972
5833
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
5973
5834
|
* GPT and LLM.
|
|
5974
|
-
*
|
|
5975
5835
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
5976
5836
|
* @group Embed components
|
|
5977
5837
|
*/
|
|
@@ -5980,7 +5840,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
5980
5840
|
* If set to true, a list of Liveboard and Answers related
|
|
5981
5841
|
* to the natural language search will be shown below the
|
|
5982
5842
|
* AI generated answer.
|
|
5983
|
-
*
|
|
5984
5843
|
* @deprecated Currently Liveboard and Answers related
|
|
5985
5844
|
* to the natural language search will not be shown for sage
|
|
5986
5845
|
* embed
|
|
@@ -5988,49 +5847,43 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
5988
5847
|
showObjectResults?: boolean;
|
|
5989
5848
|
/**
|
|
5990
5849
|
* flag used by the TS product tour page to show the blue search bar
|
|
5991
|
-
* even after the search is completed. This is different from
|
|
5992
|
-
* experience where it mimics closer to the non-embed case.
|
|
5850
|
+
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
5851
|
+
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
5993
5852
|
* The Sample questions container is collapsed when this value is set after
|
|
5994
5853
|
* does a search.
|
|
5995
|
-
*
|
|
5996
5854
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
5997
5855
|
* @hidden
|
|
5998
5856
|
*/
|
|
5999
5857
|
isProductTour?: boolean;
|
|
6000
5858
|
/**
|
|
6001
5859
|
* Show or hide the search bar title.
|
|
6002
|
-
*
|
|
6003
|
-
* @
|
|
5860
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
5861
|
+
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
6004
5862
|
*/
|
|
6005
5863
|
hideSearchBarTitle?: boolean;
|
|
6006
5864
|
/**
|
|
6007
5865
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
6008
5866
|
* at the top of the Answer page.
|
|
6009
|
-
*
|
|
6010
5867
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
6011
5868
|
*/
|
|
6012
5869
|
hideSageAnswerHeader?: boolean;
|
|
6013
5870
|
/**
|
|
6014
5871
|
* Disable the worksheet selection option.
|
|
6015
|
-
*
|
|
6016
5872
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6017
5873
|
*/
|
|
6018
5874
|
disableWorksheetChange?: boolean;
|
|
6019
5875
|
/**
|
|
6020
5876
|
* Hide the worksheet selection panel.
|
|
6021
|
-
*
|
|
6022
5877
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6023
5878
|
*/
|
|
6024
5879
|
hideWorksheetSelector?: boolean;
|
|
6025
5880
|
/**
|
|
6026
5881
|
* Show or hide autocomplete suggestions for the search query string.
|
|
6027
|
-
*
|
|
6028
5882
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6029
5883
|
*/
|
|
6030
5884
|
hideAutocompleteSuggestions?: boolean;
|
|
6031
5885
|
/**
|
|
6032
5886
|
* Show or hide autocomplete suggestions for the search query string.
|
|
6033
|
-
*
|
|
6034
5887
|
* @deprecated
|
|
6035
5888
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
6036
5889
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -6040,7 +5893,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6040
5893
|
* Show or hide sample questions.
|
|
6041
5894
|
* The sample questions are autogenerated based on the worksheet
|
|
6042
5895
|
* selected for the search operation.
|
|
6043
|
-
*
|
|
6044
5896
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6045
5897
|
*/
|
|
6046
5898
|
hideSampleQuestions?: boolean;
|
|
@@ -6058,7 +5910,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6058
5910
|
* If it is executed, the focus is placed on the results.
|
|
6059
5911
|
* If it’s not executed, the focus is placed at the end of
|
|
6060
5912
|
* the token string in the search bar.
|
|
6061
|
-
*
|
|
6062
5913
|
* @example
|
|
6063
5914
|
* ```js
|
|
6064
5915
|
* searchOptions: {
|
|
@@ -6070,10 +5921,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6070
5921
|
*/
|
|
6071
5922
|
searchOptions?: SearchOptions;
|
|
6072
5923
|
}
|
|
6073
|
-
export const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
6074
5924
|
/**
|
|
6075
5925
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
6076
|
-
*
|
|
6077
5926
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
6078
5927
|
* @group Embed components
|
|
6079
5928
|
*/
|
|
@@ -6087,20 +5936,17 @@ export class SageEmbed extends V1Embed {
|
|
|
6087
5936
|
/**
|
|
6088
5937
|
* Constructs a map of parameters to be passed on to the
|
|
6089
5938
|
* embedded Eureka or Sage search page.
|
|
6090
|
-
*
|
|
6091
5939
|
* @returns {string} query string
|
|
6092
5940
|
*/
|
|
6093
5941
|
protected getEmbedParams(): string;
|
|
6094
5942
|
/**
|
|
6095
5943
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
6096
5944
|
* loaded in the iframe
|
|
6097
|
-
*
|
|
6098
5945
|
* @returns {string} iframe url
|
|
6099
5946
|
*/
|
|
6100
5947
|
getIFrameSrc(): string;
|
|
6101
5948
|
/**
|
|
6102
5949
|
* Render the embedded ThoughtSpot Sage
|
|
6103
|
-
*
|
|
6104
5950
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
6105
5951
|
*/
|
|
6106
5952
|
render(): Promise<SageEmbed>;
|
|
@@ -6127,7 +5973,6 @@ export interface UnderlyingDataPoint {
|
|
|
6127
5973
|
* custom action payload. This service could be used to run
|
|
6128
5974
|
* graphql queries in the context of the answer on which the
|
|
6129
5975
|
* custom action was triggered.
|
|
6130
|
-
*
|
|
6131
5976
|
* @example
|
|
6132
5977
|
* ```js
|
|
6133
5978
|
* embed.on(EmbedEvent.CustomAction, e => {
|
|
@@ -6137,13 +5982,22 @@ export interface UnderlyingDataPoint {
|
|
|
6137
5982
|
* const data = await underlying.fetchData(0, 100);
|
|
6138
5983
|
* })
|
|
6139
5984
|
* ```
|
|
5985
|
+
* @example
|
|
5986
|
+
* ```js
|
|
5987
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
5988
|
+
* const service = await embed.getAnswerService();
|
|
5989
|
+
* await service.addColumns([
|
|
5990
|
+
* "<column guid>"
|
|
5991
|
+
* ]);
|
|
5992
|
+
* console.log(await service.fetchData());
|
|
5993
|
+
* });
|
|
5994
|
+
* ```
|
|
6140
5995
|
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
6141
5996
|
* @group Events
|
|
6142
5997
|
*/
|
|
6143
5998
|
export class AnswerService {
|
|
6144
5999
|
/**
|
|
6145
6000
|
* Should not need to be called directly.
|
|
6146
|
-
*
|
|
6147
6001
|
* @param session
|
|
6148
6002
|
* @param answer
|
|
6149
6003
|
* @param thoughtSpotHost
|
|
@@ -6157,21 +6011,42 @@ export class AnswerService {
|
|
|
6157
6011
|
getSourceDetail(): Promise<any>;
|
|
6158
6012
|
/**
|
|
6159
6013
|
* Remove columnIds and return updated answer session.
|
|
6160
|
-
*
|
|
6161
6014
|
* @param columnIds
|
|
6162
6015
|
* @returns
|
|
6163
6016
|
*/
|
|
6164
6017
|
removeColumns(columnIds: string[]): Promise<any>;
|
|
6165
6018
|
/**
|
|
6166
6019
|
* Add columnIds and return updated answer session.
|
|
6167
|
-
*
|
|
6168
6020
|
* @param columnIds
|
|
6169
6021
|
* @returns
|
|
6170
6022
|
*/
|
|
6171
6023
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6024
|
+
/**
|
|
6025
|
+
* Add columns by names and return updated answer session.
|
|
6026
|
+
* @param columnNames
|
|
6027
|
+
* @returns
|
|
6028
|
+
* @example
|
|
6029
|
+
* ```js
|
|
6030
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6031
|
+
* const service = await embed.getAnswerService();
|
|
6032
|
+
* await service.addColumnsByNames([
|
|
6033
|
+
* "col name 1",
|
|
6034
|
+
* "col name 2"
|
|
6035
|
+
* ]);
|
|
6036
|
+
* console.log(await service.fetchData());
|
|
6037
|
+
* });
|
|
6038
|
+
*/
|
|
6039
|
+
addColumnsByNames(columnNames: string[]): Promise<any>;
|
|
6040
|
+
/**
|
|
6041
|
+
* Add a filter to the answer.
|
|
6042
|
+
* @param columnName
|
|
6043
|
+
* @param operator
|
|
6044
|
+
* @param values
|
|
6045
|
+
* @returns
|
|
6046
|
+
*/
|
|
6047
|
+
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6172
6048
|
/**
|
|
6173
6049
|
* Fetch data from the answer.
|
|
6174
|
-
*
|
|
6175
6050
|
* @param offset
|
|
6176
6051
|
* @param size
|
|
6177
6052
|
* @returns
|
|
@@ -6183,7 +6058,6 @@ export class AnswerService {
|
|
|
6183
6058
|
/**
|
|
6184
6059
|
* Fetch the data for the answer as a CSV blob. This might be
|
|
6185
6060
|
* quicker for larger data.
|
|
6186
|
-
*
|
|
6187
6061
|
* @param userLocale
|
|
6188
6062
|
* @param includeInfo Include the CSV header in the output
|
|
6189
6063
|
* @returns Response
|
|
@@ -6192,7 +6066,6 @@ export class AnswerService {
|
|
|
6192
6066
|
/**
|
|
6193
6067
|
* Just get the internal URL for this answer's data
|
|
6194
6068
|
* as a CSV blob.
|
|
6195
|
-
*
|
|
6196
6069
|
* @param userLocale
|
|
6197
6070
|
* @param includeInfo
|
|
6198
6071
|
* @returns
|
|
@@ -6202,7 +6075,6 @@ export class AnswerService {
|
|
|
6202
6075
|
* Get underlying data given a point and the output column names.
|
|
6203
6076
|
* In case of a context menu action, the selectedPoints are
|
|
6204
6077
|
* automatically passed.
|
|
6205
|
-
*
|
|
6206
6078
|
* @param outputColumnNames
|
|
6207
6079
|
* @param selectedPoints
|
|
6208
6080
|
* @example
|
|
@@ -6219,7 +6091,6 @@ export class AnswerService {
|
|
|
6219
6091
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
6220
6092
|
/**
|
|
6221
6093
|
* Execute a custom graphql query in the context of the answer.
|
|
6222
|
-
*
|
|
6223
6094
|
* @param query graphql query
|
|
6224
6095
|
* @param variables graphql variables
|
|
6225
6096
|
* @returns
|
|
@@ -6227,15 +6098,14 @@ export class AnswerService {
|
|
|
6227
6098
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
6228
6099
|
/**
|
|
6229
6100
|
* Get the internal session details for the answer.
|
|
6230
|
-
*
|
|
6231
6101
|
* @returns
|
|
6232
6102
|
*/
|
|
6233
6103
|
getSession(): SessionInterface;
|
|
6104
|
+
getAnswer(): Promise<any>;
|
|
6234
6105
|
}
|
|
6235
6106
|
|
|
6236
6107
|
/**
|
|
6237
6108
|
* Gets the configuration embed was initialized with.
|
|
6238
|
-
*
|
|
6239
6109
|
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
6240
6110
|
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
6241
6111
|
* @group Global methods
|
|
@@ -6244,7 +6114,6 @@ export const getEmbedConfig: () => EmbedConfig;
|
|
|
6244
6114
|
/**
|
|
6245
6115
|
* Sets the configuration embed was initialized with.
|
|
6246
6116
|
* And returns the new configuration.
|
|
6247
|
-
*
|
|
6248
6117
|
* @param newConfig The configuration to set.
|
|
6249
6118
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
6250
6119
|
* @group Global methods
|
|
@@ -6267,7 +6136,6 @@ export const MIXPANEL_EVENT: {
|
|
|
6267
6136
|
};
|
|
6268
6137
|
/**
|
|
6269
6138
|
* Pushes the event with its Property key-value map to mixpanel.
|
|
6270
|
-
*
|
|
6271
6139
|
* @param eventId
|
|
6272
6140
|
* @param eventProps
|
|
6273
6141
|
*/
|
|
@@ -6276,7 +6144,7 @@ export function uploadMixpanelEvent(eventId: string, eventProps?: {}): void;
|
|
|
6276
6144
|
*
|
|
6277
6145
|
* @param sessionInfo
|
|
6278
6146
|
*/
|
|
6279
|
-
export function initMixpanel(sessionInfo:
|
|
6147
|
+
export function initMixpanel(sessionInfo: any): void;
|
|
6280
6148
|
/**
|
|
6281
6149
|
*
|
|
6282
6150
|
*/
|
|
@@ -6285,7 +6153,6 @@ export function testResetMixpanel(): void;
|
|
|
6285
6153
|
/**
|
|
6286
6154
|
* Fetch wrapper that adds the authentication token to the request.
|
|
6287
6155
|
* Use this to call the ThoughtSpot APIs when using the visual embed sdk.
|
|
6288
|
-
*
|
|
6289
6156
|
* @param input
|
|
6290
6157
|
* @param init
|
|
6291
6158
|
* @version SDK: 1.28.0
|
|
@@ -6293,15 +6160,14 @@ export function testResetMixpanel(): void;
|
|
|
6293
6160
|
*/
|
|
6294
6161
|
export const tokenizedFetch: typeof fetch;
|
|
6295
6162
|
|
|
6296
|
-
export
|
|
6163
|
+
export const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
|
|
6297
6164
|
/**
|
|
6298
6165
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
6299
|
-
*
|
|
6300
6166
|
* @example
|
|
6301
6167
|
* ```js
|
|
6302
6168
|
* resetCachedAuthToken();
|
|
6303
6169
|
* ```
|
|
6304
|
-
* @version SDK: 1.28.
|
|
6170
|
+
* @version SDK: 1.28.2 | ThoughtSpot: *
|
|
6305
6171
|
* @group Authentication / Init
|
|
6306
6172
|
*/
|
|
6307
6173
|
export const resetCachedAuthToken: () => void;
|
|
@@ -6310,7 +6176,6 @@ export const resetCachedAuthToken: () => void;
|
|
|
6310
6176
|
* Copyright (c) 2022
|
|
6311
6177
|
*
|
|
6312
6178
|
* Base classes
|
|
6313
|
-
*
|
|
6314
6179
|
* @summary Base classes
|
|
6315
6180
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
6316
6181
|
*/
|
|
@@ -6359,19 +6224,16 @@ export class TsEmbed {
|
|
|
6359
6224
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
6360
6225
|
/**
|
|
6361
6226
|
* Handles errors within the SDK
|
|
6362
|
-
*
|
|
6363
6227
|
* @param error The error message or object
|
|
6364
6228
|
*/
|
|
6365
6229
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
6366
6230
|
/**
|
|
6367
6231
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
6368
|
-
*
|
|
6369
6232
|
* @param query
|
|
6370
6233
|
*/
|
|
6371
6234
|
protected getEmbedBasePath(query: string): string;
|
|
6372
6235
|
/**
|
|
6373
6236
|
* Common query params set for all the embed modes.
|
|
6374
|
-
*
|
|
6375
6237
|
* @param queryParams
|
|
6376
6238
|
* @returns queryParams
|
|
6377
6239
|
*/
|
|
@@ -6379,7 +6241,6 @@ export class TsEmbed {
|
|
|
6379
6241
|
/**
|
|
6380
6242
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
6381
6243
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
6382
|
-
*
|
|
6383
6244
|
* @param queryString The query string to append to the URL.
|
|
6384
6245
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
6385
6246
|
* the full application.
|
|
@@ -6392,7 +6253,6 @@ export class TsEmbed {
|
|
|
6392
6253
|
/**
|
|
6393
6254
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
6394
6255
|
* event listeners.
|
|
6395
|
-
*
|
|
6396
6256
|
* @param url - The URL of the embedded ThoughtSpot app.
|
|
6397
6257
|
*/
|
|
6398
6258
|
protected renderIFrame(url: string): Promise<any>;
|
|
@@ -6406,13 +6266,11 @@ export class TsEmbed {
|
|
|
6406
6266
|
protected insertIntoDOM(child: string | Node): void;
|
|
6407
6267
|
/**
|
|
6408
6268
|
* Sets the height of the iframe
|
|
6409
|
-
*
|
|
6410
6269
|
* @param height The height in pixels
|
|
6411
6270
|
*/
|
|
6412
6271
|
protected setIFrameHeight(height: number | string): void;
|
|
6413
6272
|
/**
|
|
6414
6273
|
* Executes all registered event handlers for a particular event type
|
|
6415
|
-
*
|
|
6416
6274
|
* @param eventType The event type
|
|
6417
6275
|
* @param data The payload invoked with the event handler
|
|
6418
6276
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -6424,7 +6282,6 @@ export class TsEmbed {
|
|
|
6424
6282
|
protected getThoughtSpotHost(): string;
|
|
6425
6283
|
/**
|
|
6426
6284
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
6427
|
-
*
|
|
6428
6285
|
* @param eventType The v2 event type
|
|
6429
6286
|
* @returns The corresponding v1 event type if one exists
|
|
6430
6287
|
* or else the v2 event type itself
|
|
@@ -6434,7 +6291,6 @@ export class TsEmbed {
|
|
|
6434
6291
|
* Calculates the iframe center for the current visible viewPort
|
|
6435
6292
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
6436
6293
|
* in Host app. ViewPort height of the tab.
|
|
6437
|
-
*
|
|
6438
6294
|
* @returns iframe Center in visible viewport,
|
|
6439
6295
|
* Iframe height,
|
|
6440
6296
|
* View port height.
|
|
@@ -6449,7 +6305,6 @@ export class TsEmbed {
|
|
|
6449
6305
|
/**
|
|
6450
6306
|
* Registers an event listener to trigger an alert when the ThoughtSpot app
|
|
6451
6307
|
* sends an event of a particular message type to the host application.
|
|
6452
|
-
*
|
|
6453
6308
|
* @param messageType The message type
|
|
6454
6309
|
* @param callback A callback as a function
|
|
6455
6310
|
* @param options The message options
|
|
@@ -6473,7 +6328,6 @@ export class TsEmbed {
|
|
|
6473
6328
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
|
|
6474
6329
|
/**
|
|
6475
6330
|
* Removes an event listener for a particular event type.
|
|
6476
|
-
*
|
|
6477
6331
|
* @param messageType The message type
|
|
6478
6332
|
* @param callback The callback to remove
|
|
6479
6333
|
* @example
|
|
@@ -6486,7 +6340,6 @@ export class TsEmbed {
|
|
|
6486
6340
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
6487
6341
|
/**
|
|
6488
6342
|
* Triggers an event to the embedded app
|
|
6489
|
-
*
|
|
6490
6343
|
* @param messageType The event type
|
|
6491
6344
|
* @param data The payload to send with the message
|
|
6492
6345
|
*/
|
|
@@ -6495,7 +6348,6 @@ export class TsEmbed {
|
|
|
6495
6348
|
* Marks the ThoughtSpot object to have been rendered
|
|
6496
6349
|
* Needs to be overridden by subclasses to do the actual
|
|
6497
6350
|
* rendering of the iframe.
|
|
6498
|
-
*
|
|
6499
6351
|
* @param args
|
|
6500
6352
|
*/
|
|
6501
6353
|
render(): Promise<TsEmbed>;
|
|
@@ -6503,7 +6355,6 @@ export class TsEmbed {
|
|
|
6503
6355
|
protected handleRenderForPrerender(): void;
|
|
6504
6356
|
/**
|
|
6505
6357
|
* Creates the preRender shell
|
|
6506
|
-
*
|
|
6507
6358
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
6508
6359
|
*/
|
|
6509
6360
|
preRender(showPreRenderByDefault?: boolean): TsEmbed;
|
|
@@ -6511,13 +6362,11 @@ export class TsEmbed {
|
|
|
6511
6362
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
6512
6363
|
* host app URL.
|
|
6513
6364
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
6514
|
-
*
|
|
6515
6365
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
6516
6366
|
*/
|
|
6517
6367
|
getThoughtSpotPostUrlParams(): string;
|
|
6518
6368
|
/**
|
|
6519
6369
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
6520
|
-
*
|
|
6521
6370
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
6522
6371
|
*/
|
|
6523
6372
|
destroy(): void;
|
|
@@ -6526,7 +6375,6 @@ export class TsEmbed {
|
|
|
6526
6375
|
* Prerenders a generic instance of the TS component.
|
|
6527
6376
|
* This means without the path but with the flags already applied.
|
|
6528
6377
|
* This is useful for prerendering the component in the background.
|
|
6529
|
-
*
|
|
6530
6378
|
* @version SDK: 1.22.0
|
|
6531
6379
|
* @returns
|
|
6532
6380
|
*/
|
|
@@ -6544,7 +6392,6 @@ export class TsEmbed {
|
|
|
6544
6392
|
* element. This function adjusts the position, width, and height of the PreRender
|
|
6545
6393
|
* component
|
|
6546
6394
|
* to match the dimensions and position of the embedding element.
|
|
6547
|
-
*
|
|
6548
6395
|
* @throws {Error} Throws an error if the embedding element (passed as domSelector)
|
|
6549
6396
|
* is not defined or not found.
|
|
6550
6397
|
*/
|
|
@@ -6557,7 +6404,6 @@ export class TsEmbed {
|
|
|
6557
6404
|
/**
|
|
6558
6405
|
* Retrieves unique HTML element IDs for PreRender-related elements.
|
|
6559
6406
|
* These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
|
|
6560
|
-
*
|
|
6561
6407
|
* @returns {object} An object containing the IDs for the PreRender elements.
|
|
6562
6408
|
* @property {string} wrapper - The HTML element ID for the PreRender wrapper.
|
|
6563
6409
|
* @property {string} child - The HTML element ID for the PreRender child.
|
|
@@ -6569,7 +6415,6 @@ export class TsEmbed {
|
|
|
6569
6415
|
/**
|
|
6570
6416
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
6571
6417
|
* session.
|
|
6572
|
-
*
|
|
6573
6418
|
* @param vizId [Optional] to get for a specific viz in case of a liveboard.
|
|
6574
6419
|
* @version SDK: 1.25.0 / ThoughtSpot 9.10.0
|
|
6575
6420
|
*/
|
|
@@ -6579,7 +6424,6 @@ export class TsEmbed {
|
|
|
6579
6424
|
* Base class for embedding v1 experience
|
|
6580
6425
|
* Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
|
|
6581
6426
|
* which is currently under migration to v2
|
|
6582
|
-
*
|
|
6583
6427
|
* @inheritdoc
|
|
6584
6428
|
*/
|
|
6585
6429
|
export class V1Embed extends TsEmbed {
|
|
@@ -6587,7 +6431,6 @@ export class V1Embed extends TsEmbed {
|
|
|
6587
6431
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
6588
6432
|
/**
|
|
6589
6433
|
* Render the app in an iframe and set up event handlers
|
|
6590
|
-
*
|
|
6591
6434
|
* @param iframeSrc
|
|
6592
6435
|
*/
|
|
6593
6436
|
protected renderV1Embed(iframeSrc: string): Promise<any>;
|