@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
|
@@ -13,7 +13,6 @@ interface PreRenderProps {
|
|
|
13
13
|
* PreRender id to be used for PreRendering the embed.
|
|
14
14
|
* Use PreRender to render the embed in the background and then
|
|
15
15
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
16
|
-
*
|
|
17
16
|
* @example
|
|
18
17
|
* ```js
|
|
19
18
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -40,7 +39,6 @@ interface PreRenderProps {
|
|
|
40
39
|
}
|
|
41
40
|
/**
|
|
42
41
|
* React component for Search Embed.
|
|
43
|
-
*
|
|
44
42
|
* @example
|
|
45
43
|
* ```tsx
|
|
46
44
|
* function Search() {
|
|
@@ -57,7 +55,6 @@ interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
57
55
|
}
|
|
58
56
|
/**
|
|
59
57
|
* React component for Full app Embed.
|
|
60
|
-
*
|
|
61
58
|
* @example
|
|
62
59
|
* ```tsx
|
|
63
60
|
* function Search() {
|
|
@@ -77,7 +74,6 @@ export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttri
|
|
|
77
74
|
* default.
|
|
78
75
|
*
|
|
79
76
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
80
|
-
*
|
|
81
77
|
* @example
|
|
82
78
|
* ```tsx
|
|
83
79
|
* function LandingPageComponent() {
|
|
@@ -94,7 +90,6 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
|
|
|
94
90
|
}
|
|
95
91
|
/**
|
|
96
92
|
* React component for Liveboard embed.
|
|
97
|
-
*
|
|
98
93
|
* @example
|
|
99
94
|
* ```tsx
|
|
100
95
|
* function Liveboard() {
|
|
@@ -112,14 +107,13 @@ export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & Rea
|
|
|
112
107
|
/**
|
|
113
108
|
* React component for PreRendered Liveboard embed.
|
|
114
109
|
*
|
|
115
|
-
*
|
|
110
|
+
* PreRenderedLiveboardEmbed will preRender the liveboard and will be hidden by default.
|
|
116
111
|
*
|
|
117
112
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
118
113
|
*
|
|
119
114
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
120
115
|
* tries to preRender the LiveboardEmbed, so it is recommended to use pass the
|
|
121
116
|
* liveboardId to both the components.
|
|
122
|
-
*
|
|
123
117
|
* @example
|
|
124
118
|
* ```tsx
|
|
125
119
|
* function LandingPageComponent() {
|
|
@@ -137,7 +131,6 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
137
131
|
}
|
|
138
132
|
/**
|
|
139
133
|
* React component for Search bar embed.
|
|
140
|
-
*
|
|
141
134
|
* @example
|
|
142
135
|
* ```tsx
|
|
143
136
|
* function SearchBar() {
|
|
@@ -156,7 +149,6 @@ export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps
|
|
|
156
149
|
* default.
|
|
157
150
|
*
|
|
158
151
|
* SearchBarEmbed with preRenderId passed will call showPreRender on the embed.
|
|
159
|
-
*
|
|
160
152
|
* @example
|
|
161
153
|
* ```tsx
|
|
162
154
|
* function LandingPageComponent() {
|
|
@@ -173,7 +165,6 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
173
165
|
}
|
|
174
166
|
/**
|
|
175
167
|
* React component for LLM based search Sage embed.
|
|
176
|
-
*
|
|
177
168
|
* @example
|
|
178
169
|
* ```tsx
|
|
179
170
|
* function Sage() {
|
|
@@ -192,7 +183,6 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
|
|
|
192
183
|
* default.
|
|
193
184
|
*
|
|
194
185
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
195
|
-
*
|
|
196
186
|
* @example
|
|
197
187
|
* ```tsx
|
|
198
188
|
* function LandingPageComponent() {
|
|
@@ -208,7 +198,6 @@ export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProp
|
|
|
208
198
|
type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
|
|
209
199
|
/**
|
|
210
200
|
* Get a reference to the embed component to trigger events on the component.
|
|
211
|
-
*
|
|
212
201
|
* @example
|
|
213
202
|
* ```
|
|
214
203
|
* function Component() {
|
|
@@ -232,11 +221,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
232
221
|
/**
|
|
233
222
|
* The array of data source GUIDs to set on load.
|
|
234
223
|
* Only a single data source is supported currently.
|
|
235
|
-
*
|
|
236
224
|
* @deprecated Use `dataSource` instead
|
|
237
|
-
*
|
|
238
225
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
239
|
-
*
|
|
240
226
|
* @example
|
|
241
227
|
* ```js
|
|
242
228
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -248,9 +234,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
248
234
|
dataSources?: string[];
|
|
249
235
|
/**
|
|
250
236
|
* Pass the ID of the source to be selected.
|
|
251
|
-
*
|
|
252
237
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
253
|
-
*
|
|
254
238
|
* @example
|
|
255
239
|
* ```js
|
|
256
240
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -262,9 +246,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
262
246
|
dataSource?: string;
|
|
263
247
|
/**
|
|
264
248
|
* Boolean to define if the last selected data source should be used
|
|
265
|
-
*
|
|
266
249
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
267
|
-
*
|
|
268
250
|
* @example
|
|
269
251
|
* ```js
|
|
270
252
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -284,9 +266,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
284
266
|
* If it is executed, the focus is placed on the results.
|
|
285
267
|
* If it’s not executed, the focus is placed at the end of
|
|
286
268
|
* the token string in the search bar.
|
|
287
|
-
*
|
|
288
269
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
289
|
-
*
|
|
290
270
|
* @example
|
|
291
271
|
* ```js
|
|
292
272
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -302,7 +282,6 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
302
282
|
}
|
|
303
283
|
/**
|
|
304
284
|
* Embed ThoughtSpot search bar
|
|
305
|
-
*
|
|
306
285
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
307
286
|
* @group Embed components
|
|
308
287
|
*/
|
|
@@ -323,7 +302,6 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
323
302
|
* Copyright (c) 2023
|
|
324
303
|
*
|
|
325
304
|
* Embed ThoughtSpot Sage
|
|
326
|
-
*
|
|
327
305
|
* @summary TS Sage embed
|
|
328
306
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
329
307
|
*/
|
|
@@ -346,7 +324,6 @@ export interface SearchOptions {
|
|
|
346
324
|
/**
|
|
347
325
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
348
326
|
* GPT and LLM.
|
|
349
|
-
*
|
|
350
327
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
351
328
|
* @group Embed components
|
|
352
329
|
*/
|
|
@@ -355,7 +332,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
355
332
|
* If set to true, a list of Liveboard and Answers related
|
|
356
333
|
* to the natural language search will be shown below the
|
|
357
334
|
* AI generated answer.
|
|
358
|
-
*
|
|
359
335
|
* @deprecated Currently Liveboard and Answers related
|
|
360
336
|
* to the natural language search will not be shown for sage
|
|
361
337
|
* embed
|
|
@@ -363,49 +339,43 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
363
339
|
showObjectResults?: boolean;
|
|
364
340
|
/**
|
|
365
341
|
* flag used by the TS product tour page to show the blue search bar
|
|
366
|
-
* even after the search is completed. This is different from
|
|
367
|
-
* experience where it mimics closer to the non-embed case.
|
|
342
|
+
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
343
|
+
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
368
344
|
* The Sample questions container is collapsed when this value is set after
|
|
369
345
|
* does a search.
|
|
370
|
-
*
|
|
371
346
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
372
347
|
* @hidden
|
|
373
348
|
*/
|
|
374
349
|
isProductTour?: boolean;
|
|
375
350
|
/**
|
|
376
351
|
* Show or hide the search bar title.
|
|
377
|
-
*
|
|
378
|
-
* @
|
|
352
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
353
|
+
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
379
354
|
*/
|
|
380
355
|
hideSearchBarTitle?: boolean;
|
|
381
356
|
/**
|
|
382
357
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
383
358
|
* at the top of the Answer page.
|
|
384
|
-
*
|
|
385
359
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
386
360
|
*/
|
|
387
361
|
hideSageAnswerHeader?: boolean;
|
|
388
362
|
/**
|
|
389
363
|
* Disable the worksheet selection option.
|
|
390
|
-
*
|
|
391
364
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
392
365
|
*/
|
|
393
366
|
disableWorksheetChange?: boolean;
|
|
394
367
|
/**
|
|
395
368
|
* Hide the worksheet selection panel.
|
|
396
|
-
*
|
|
397
369
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
398
370
|
*/
|
|
399
371
|
hideWorksheetSelector?: boolean;
|
|
400
372
|
/**
|
|
401
373
|
* Show or hide autocomplete suggestions for the search query string.
|
|
402
|
-
*
|
|
403
374
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
404
375
|
*/
|
|
405
376
|
hideAutocompleteSuggestions?: boolean;
|
|
406
377
|
/**
|
|
407
378
|
* Show or hide autocomplete suggestions for the search query string.
|
|
408
|
-
*
|
|
409
379
|
* @deprecated
|
|
410
380
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
411
381
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -415,7 +385,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
415
385
|
* Show or hide sample questions.
|
|
416
386
|
* The sample questions are autogenerated based on the worksheet
|
|
417
387
|
* selected for the search operation.
|
|
418
|
-
*
|
|
419
388
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
420
389
|
*/
|
|
421
390
|
hideSampleQuestions?: boolean;
|
|
@@ -433,7 +402,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
433
402
|
* If it is executed, the focus is placed on the results.
|
|
434
403
|
* If it’s not executed, the focus is placed at the end of
|
|
435
404
|
* the token string in the search bar.
|
|
436
|
-
*
|
|
437
405
|
* @example
|
|
438
406
|
* ```js
|
|
439
407
|
* searchOptions: {
|
|
@@ -445,10 +413,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
445
413
|
*/
|
|
446
414
|
searchOptions?: SearchOptions;
|
|
447
415
|
}
|
|
448
|
-
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
449
416
|
/**
|
|
450
417
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
451
|
-
*
|
|
452
418
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
453
419
|
* @group Embed components
|
|
454
420
|
*/
|
|
@@ -462,20 +428,17 @@ export declare class SageEmbed extends V1Embed {
|
|
|
462
428
|
/**
|
|
463
429
|
* Constructs a map of parameters to be passed on to the
|
|
464
430
|
* embedded Eureka or Sage search page.
|
|
465
|
-
*
|
|
466
431
|
* @returns {string} query string
|
|
467
432
|
*/
|
|
468
433
|
protected getEmbedParams(): string;
|
|
469
434
|
/**
|
|
470
435
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
471
436
|
* loaded in the iframe
|
|
472
|
-
*
|
|
473
437
|
* @returns {string} iframe url
|
|
474
438
|
*/
|
|
475
439
|
getIFrameSrc(): string;
|
|
476
440
|
/**
|
|
477
441
|
* Render the embedded ThoughtSpot Sage
|
|
478
|
-
*
|
|
479
442
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
480
443
|
*/
|
|
481
444
|
render(): Promise<SageEmbed>;
|
|
@@ -485,7 +448,6 @@ export declare class SageEmbed extends V1Embed {
|
|
|
485
448
|
* Copyright (c) 2022
|
|
486
449
|
*
|
|
487
450
|
* Embed ThoughtSpot search or a saved answer
|
|
488
|
-
*
|
|
489
451
|
* @summary Search embed
|
|
490
452
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
491
453
|
*/
|
|
@@ -506,18 +468,33 @@ export interface SearchOptions {
|
|
|
506
468
|
*/
|
|
507
469
|
executeSearch?: boolean;
|
|
508
470
|
}
|
|
471
|
+
/**
|
|
472
|
+
* Define the initial state os column custom group accordions
|
|
473
|
+
* in data panel v2.
|
|
474
|
+
*/
|
|
475
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
476
|
+
/**
|
|
477
|
+
* Expand all the accordion initially in data panel v2.
|
|
478
|
+
*/
|
|
479
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
480
|
+
/**
|
|
481
|
+
* Collapse all the accordions initially in data panel v2.
|
|
482
|
+
*/
|
|
483
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
484
|
+
/**
|
|
485
|
+
* Expand the first accordion and collapse the rest.
|
|
486
|
+
*/
|
|
487
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
488
|
+
}
|
|
509
489
|
/**
|
|
510
490
|
* The configuration attributes for the embedded search view.
|
|
511
|
-
*
|
|
512
491
|
* @group Embed components
|
|
513
492
|
*/
|
|
514
493
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
515
494
|
/**
|
|
516
495
|
* If set to true, the data sources panel is collapsed on load,
|
|
517
496
|
* but can be expanded manually.
|
|
518
|
-
*
|
|
519
497
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
520
|
-
*
|
|
521
498
|
* @example
|
|
522
499
|
* ```js
|
|
523
500
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -529,9 +506,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
529
506
|
collapseDataSources?: boolean;
|
|
530
507
|
/**
|
|
531
508
|
* Show or hide the data sources panel.
|
|
532
|
-
*
|
|
533
509
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
534
|
-
*
|
|
535
510
|
* @example
|
|
536
511
|
* ```js
|
|
537
512
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -545,9 +520,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
545
520
|
* Show or hide the charts and tables in search answers.
|
|
546
521
|
* This attribute can be used to create a custom visualization
|
|
547
522
|
* using raw answer data.
|
|
548
|
-
*
|
|
549
523
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
550
|
-
*
|
|
551
524
|
* @example
|
|
552
525
|
* ```js
|
|
553
526
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -557,11 +530,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
557
530
|
* ```
|
|
558
531
|
*/
|
|
559
532
|
hideResults?: boolean;
|
|
533
|
+
/**
|
|
534
|
+
* If set to true, expands all the data sources panel.
|
|
535
|
+
*/
|
|
536
|
+
expandAllDataSource?: boolean;
|
|
560
537
|
/**
|
|
561
538
|
* If set to true, the Search Assist feature is enabled.
|
|
562
|
-
*
|
|
563
539
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
564
|
-
*
|
|
565
540
|
* @example
|
|
566
541
|
* ```js
|
|
567
542
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -574,9 +549,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
574
549
|
/**
|
|
575
550
|
* If set to true, the tabular view is set as the default
|
|
576
551
|
* format for presenting search data.
|
|
577
|
-
*
|
|
578
552
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
579
|
-
*
|
|
580
553
|
* @example
|
|
581
554
|
* ```js
|
|
582
555
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -588,9 +561,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
588
561
|
/**
|
|
589
562
|
* The array of data source GUIDs to set on load.
|
|
590
563
|
* Only a single data source is supported currently.
|
|
591
|
-
*
|
|
592
564
|
* @deprecated Use `dataSource` instead.
|
|
593
|
-
*
|
|
594
565
|
* @example
|
|
595
566
|
* ```js
|
|
596
567
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -602,9 +573,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
602
573
|
dataSources?: string[];
|
|
603
574
|
/**
|
|
604
575
|
* The array of data source GUIDs to set on load.
|
|
605
|
-
*
|
|
606
576
|
* @version: SDK: 1.19.0
|
|
607
|
-
*
|
|
608
577
|
* @example
|
|
609
578
|
* ```js
|
|
610
579
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -616,7 +585,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
616
585
|
dataSource?: string;
|
|
617
586
|
/**
|
|
618
587
|
* The initial search query to load the answer with.
|
|
619
|
-
*
|
|
620
588
|
* @deprecated
|
|
621
589
|
*
|
|
622
590
|
* Use {@link searchOptions} instead.
|
|
@@ -632,7 +600,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
632
600
|
* If it is executed, the focus is placed on the results.
|
|
633
601
|
* If it’s not executed, the focus is placed at the end of
|
|
634
602
|
* the token string in the search bar.
|
|
635
|
-
*
|
|
636
603
|
* @example
|
|
637
604
|
* ```js
|
|
638
605
|
* searchOptions: {
|
|
@@ -644,9 +611,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
644
611
|
searchOptions?: SearchOptions;
|
|
645
612
|
/**
|
|
646
613
|
* The GUID of a saved answer to load initially.
|
|
647
|
-
*
|
|
648
614
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
649
|
-
*
|
|
650
615
|
* @example
|
|
651
616
|
* ```js
|
|
652
617
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -659,9 +624,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
659
624
|
/**
|
|
660
625
|
* If set to true, the search page will render without the Search Bar
|
|
661
626
|
* The chart/table should still be visible.
|
|
662
|
-
*
|
|
663
627
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
664
|
-
*
|
|
665
628
|
* @example
|
|
666
629
|
* ```js
|
|
667
630
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -673,10 +636,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
673
636
|
hideSearchBar?: boolean;
|
|
674
637
|
/**
|
|
675
638
|
* Flag to control Data panel experience
|
|
676
|
-
*
|
|
677
639
|
* @default false
|
|
678
640
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
679
|
-
*
|
|
680
641
|
* @example
|
|
681
642
|
* ```js
|
|
682
643
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -688,22 +649,56 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
688
649
|
dataPanelV2?: boolean;
|
|
689
650
|
/**
|
|
690
651
|
* Flag to set if last selected dataSource should be used
|
|
691
|
-
*
|
|
692
652
|
* @version: SDK: 1.24.0
|
|
693
653
|
*/
|
|
694
654
|
useLastSelectedSources?: boolean;
|
|
695
655
|
/**
|
|
696
656
|
* To set the initial state of the search bar in case of saved-answers.
|
|
697
|
-
*
|
|
698
657
|
* @default false
|
|
699
658
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
700
659
|
*/
|
|
701
660
|
collapseSearchBarInitially?: boolean;
|
|
661
|
+
/**
|
|
662
|
+
* To enable custom column groups in data panel v2
|
|
663
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
664
|
+
* @default false
|
|
665
|
+
* @example
|
|
666
|
+
* ```js
|
|
667
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
668
|
+
* ... // other options
|
|
669
|
+
* enableCustomColumnGroups: true,
|
|
670
|
+
* });
|
|
671
|
+
* ```
|
|
672
|
+
*/
|
|
673
|
+
enableCustomColumnGroups?: boolean;
|
|
674
|
+
/**
|
|
675
|
+
* Flag to enable onBeforeSearchExecute Embed Event
|
|
676
|
+
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
677
|
+
*/
|
|
678
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
679
|
+
/**
|
|
680
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
681
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
682
|
+
* List of different enum values:-
|
|
683
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
684
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
685
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
686
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
687
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
688
|
+
* @example
|
|
689
|
+
* ```js
|
|
690
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
691
|
+
* ... // other options
|
|
692
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
693
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
694
|
+
* });
|
|
695
|
+
* ```
|
|
696
|
+
*/
|
|
697
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
702
698
|
}
|
|
703
699
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
704
700
|
/**
|
|
705
701
|
* Embed ThoughtSpot search
|
|
706
|
-
*
|
|
707
702
|
* @group Embed components
|
|
708
703
|
*/
|
|
709
704
|
export declare class SearchEmbed extends TsEmbed {
|
|
@@ -716,7 +711,6 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
716
711
|
/**
|
|
717
712
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
718
713
|
* loaded in the iframe
|
|
719
|
-
*
|
|
720
714
|
* @param answerId The GUID of a saved answer
|
|
721
715
|
* @param dataSources A list of data source GUIDs
|
|
722
716
|
*/
|
|
@@ -732,7 +726,6 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
732
726
|
*
|
|
733
727
|
* Full application embedding
|
|
734
728
|
* https://developers.thoughtspot.com/docs/?pageid=full-embed
|
|
735
|
-
*
|
|
736
729
|
* @summary Full app embed
|
|
737
730
|
* @module
|
|
738
731
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
@@ -770,9 +763,26 @@ export declare enum Page {
|
|
|
770
763
|
*/
|
|
771
764
|
SpotIQ = "insights"
|
|
772
765
|
}
|
|
766
|
+
/**
|
|
767
|
+
* Define the initial state os column custom group accordions
|
|
768
|
+
* in data panel v2.
|
|
769
|
+
*/
|
|
770
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
771
|
+
/**
|
|
772
|
+
* Expand all the accordion initially in data panel v2.
|
|
773
|
+
*/
|
|
774
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
775
|
+
/**
|
|
776
|
+
* Collapse all the accordions initially in data panel v2.
|
|
777
|
+
*/
|
|
778
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
779
|
+
/**
|
|
780
|
+
* Expand the first accordion and collapse the rest.
|
|
781
|
+
*/
|
|
782
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
783
|
+
}
|
|
773
784
|
/**
|
|
774
785
|
* The view configuration for full app embedding.
|
|
775
|
-
*
|
|
776
786
|
* @group Embed components
|
|
777
787
|
*/
|
|
778
788
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
@@ -780,10 +790,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
780
790
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
781
791
|
* is displayed. By default, the navigation bar is hidden.
|
|
782
792
|
* This flag also controls the homepage left navigation bar.
|
|
783
|
-
*
|
|
784
793
|
* @default true
|
|
785
794
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
786
|
-
*
|
|
787
795
|
* @example
|
|
788
796
|
* ```js
|
|
789
797
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -799,13 +807,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
799
807
|
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
800
808
|
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
801
809
|
*
|
|
810
|
+
*
|
|
802
811
|
* **Note**: This option does not apply to the classic homepage.
|
|
803
812
|
* To access the updated modular homepage, set
|
|
804
813
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
805
|
-
*
|
|
806
814
|
* @default false
|
|
807
815
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
808
|
-
*
|
|
809
816
|
* @example
|
|
810
817
|
* ```js
|
|
811
818
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -820,7 +827,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
820
827
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
821
828
|
* @default false
|
|
822
829
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
823
|
-
*
|
|
824
830
|
* @example
|
|
825
831
|
* ```js
|
|
826
832
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -834,13 +840,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
834
840
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
835
841
|
* By default, the application switcher is shown.
|
|
836
842
|
*
|
|
843
|
+
*
|
|
837
844
|
* **Note**: This option does not apply to the classic homepage.
|
|
838
845
|
* To access the updated modular homepage, set
|
|
839
846
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
840
|
-
*
|
|
841
847
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
842
848
|
* @default false
|
|
843
|
-
*
|
|
844
849
|
* @example
|
|
845
850
|
* ```js
|
|
846
851
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -854,13 +859,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
854
859
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
855
860
|
* By default, the Org switcher button is shown.
|
|
856
861
|
*
|
|
862
|
+
*
|
|
857
863
|
* **Note**: This option does not apply to the classic homepage.
|
|
858
864
|
* To access the updated modular homepage, set
|
|
859
865
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
860
|
-
*
|
|
861
866
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
862
867
|
* @default true
|
|
863
|
-
*
|
|
864
868
|
* @example
|
|
865
869
|
* ```js
|
|
866
870
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -878,9 +882,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
878
882
|
*
|
|
879
883
|
* For eg, if you want the component to open to a specific Liveboard
|
|
880
884
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
881
|
-
*
|
|
882
885
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
883
|
-
*
|
|
884
886
|
* @example
|
|
885
887
|
* ```js
|
|
886
888
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -896,9 +898,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
896
898
|
*
|
|
897
899
|
* Use this to open to particular page in the app. To open to a specific
|
|
898
900
|
* path within the app, use the `path` attribute which is more flexible.
|
|
899
|
-
*
|
|
900
901
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
901
|
-
*
|
|
902
902
|
* @example
|
|
903
903
|
* ```js
|
|
904
904
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -912,7 +912,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
912
912
|
* This puts a filter tag on the application. All metadata lists in the
|
|
913
913
|
* application, such as Liveboards and answers, would be filtered by this
|
|
914
914
|
* tag.
|
|
915
|
-
*
|
|
916
915
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
917
916
|
* @example
|
|
918
917
|
* ```js
|
|
@@ -925,9 +924,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
925
924
|
tag?: string;
|
|
926
925
|
/**
|
|
927
926
|
* The array of GUIDs to be hidden
|
|
928
|
-
*
|
|
929
927
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
930
|
-
*
|
|
931
928
|
* @example
|
|
932
929
|
* ```js
|
|
933
930
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -943,7 +940,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
943
940
|
/**
|
|
944
941
|
* Render liveboards using the new v2 rendering mode
|
|
945
942
|
* This is a transient flag which is primarily meant for internal use
|
|
946
|
-
*
|
|
947
943
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
948
944
|
* @hidden
|
|
949
945
|
*/
|
|
@@ -951,9 +947,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
951
947
|
/**
|
|
952
948
|
* If set to true, the Search Assist feature is enabled.
|
|
953
949
|
* @default true
|
|
954
|
-
*
|
|
955
950
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
956
|
-
*
|
|
957
951
|
* @example
|
|
958
952
|
* ```js
|
|
959
953
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -966,9 +960,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
966
960
|
/**
|
|
967
961
|
* If set to true, the embedded object container dynamically resizes
|
|
968
962
|
* according to the height of the pages which support fullHeight mode.
|
|
969
|
-
*
|
|
970
963
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
971
|
-
*
|
|
972
964
|
* @example
|
|
973
965
|
* ```js
|
|
974
966
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -980,7 +972,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
980
972
|
fullHeight?: boolean;
|
|
981
973
|
/**
|
|
982
974
|
* Flag to control Data panel experience
|
|
983
|
-
*
|
|
984
975
|
* @default false
|
|
985
976
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
986
977
|
* @hidden
|
|
@@ -988,10 +979,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
988
979
|
dataPanelV2?: boolean;
|
|
989
980
|
/**
|
|
990
981
|
* Show or hide Liveboard header
|
|
991
|
-
*
|
|
992
982
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
993
983
|
* @default false
|
|
994
|
-
*
|
|
995
984
|
* @example
|
|
996
985
|
* ```js
|
|
997
986
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1003,10 +992,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1003
992
|
hideLiveboardHeader?: boolean;
|
|
1004
993
|
/**
|
|
1005
994
|
* Show or hide Liveboard title
|
|
1006
|
-
*
|
|
1007
995
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1008
996
|
* @default false
|
|
1009
|
-
*
|
|
1010
997
|
* @example
|
|
1011
998
|
* ```js
|
|
1012
999
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1018,10 +1005,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1018
1005
|
showLiveboardTitle?: boolean;
|
|
1019
1006
|
/**
|
|
1020
1007
|
* Show or hide Liveboard description
|
|
1021
|
-
*
|
|
1022
1008
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1023
1009
|
* @default false
|
|
1024
|
-
*
|
|
1025
1010
|
* @example
|
|
1026
1011
|
* ```js
|
|
1027
1012
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1033,10 +1018,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1033
1018
|
showLiveboardDescription?: boolean;
|
|
1034
1019
|
/**
|
|
1035
1020
|
* Flag to control new Modular Home experience.
|
|
1036
|
-
*
|
|
1037
1021
|
* @default false
|
|
1038
1022
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1039
|
-
*
|
|
1040
1023
|
* @example
|
|
1041
1024
|
* ```js
|
|
1042
1025
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1048,7 +1031,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1048
1031
|
modularHomeExperience?: boolean;
|
|
1049
1032
|
/**
|
|
1050
1033
|
* Boolean to control if Liveboard header is sticky or not.
|
|
1051
|
-
*
|
|
1052
1034
|
* @example
|
|
1053
1035
|
* ```js
|
|
1054
1036
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1061,22 +1043,70 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1061
1043
|
isLiveboardHeaderSticky?: boolean;
|
|
1062
1044
|
/**
|
|
1063
1045
|
* enable or disable ask sage
|
|
1064
|
-
*
|
|
1065
1046
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1066
1047
|
* @default false
|
|
1067
1048
|
*/
|
|
1068
1049
|
enableAskSage?: boolean;
|
|
1069
1050
|
/**
|
|
1070
1051
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1071
|
-
*
|
|
1072
1052
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1073
1053
|
* @default false
|
|
1074
1054
|
*/
|
|
1075
1055
|
collapseSearchBarInitially?: boolean;
|
|
1056
|
+
/**
|
|
1057
|
+
* To enable custom column groups in data panel v2.
|
|
1058
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1059
|
+
* @default false
|
|
1060
|
+
* @example
|
|
1061
|
+
* ```js
|
|
1062
|
+
* const embed = new AppEmbed('#embed', {
|
|
1063
|
+
* ... // other app view config
|
|
1064
|
+
* enableCustomColumnGroups: true,
|
|
1065
|
+
* });
|
|
1066
|
+
* ```
|
|
1067
|
+
*/
|
|
1068
|
+
enableCustomColumnGroups?: boolean;
|
|
1069
|
+
/**
|
|
1070
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
1071
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
1072
|
+
* List of different enum values:-
|
|
1073
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1074
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1075
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1076
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1077
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1078
|
+
* @example
|
|
1079
|
+
* ```js
|
|
1080
|
+
* const embed = new AppEmbed('#embed', {
|
|
1081
|
+
* ... // other app view config
|
|
1082
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
1083
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
1084
|
+
* });
|
|
1085
|
+
* ```
|
|
1086
|
+
*/
|
|
1087
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1088
|
+
/**
|
|
1089
|
+
* This flag is used to enable the 2 column layout in liveboard
|
|
1090
|
+
* @type {boolean}
|
|
1091
|
+
* @default false
|
|
1092
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1093
|
+
* @example
|
|
1094
|
+
* ```js
|
|
1095
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1096
|
+
* ... // other options
|
|
1097
|
+
* enable2ColumnLayout: true,
|
|
1098
|
+
* })
|
|
1099
|
+
* ```
|
|
1100
|
+
*/
|
|
1101
|
+
enable2ColumnLayout?: boolean;
|
|
1102
|
+
/**
|
|
1103
|
+
* Flag to use OnBeforeSearchExecute embed event
|
|
1104
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
1105
|
+
*/
|
|
1106
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1076
1107
|
}
|
|
1077
1108
|
/**
|
|
1078
1109
|
* Embeds full ThoughtSpot experience in a host application.
|
|
1079
|
-
*
|
|
1080
1110
|
* @group Embed components
|
|
1081
1111
|
*/
|
|
1082
1112
|
export declare class AppEmbed extends V1Embed {
|
|
@@ -1089,14 +1119,12 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1089
1119
|
protected getEmbedParams(): string;
|
|
1090
1120
|
/**
|
|
1091
1121
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
1092
|
-
*
|
|
1093
1122
|
* @param pageId The ID of the page to be embedded.
|
|
1094
1123
|
*/
|
|
1095
1124
|
getIFrameSrc(): string;
|
|
1096
1125
|
/**
|
|
1097
1126
|
* Set the iframe height as per the computed height received
|
|
1098
1127
|
* from the ThoughtSpot app.
|
|
1099
|
-
*
|
|
1100
1128
|
* @param data The event payload
|
|
1101
1129
|
*/
|
|
1102
1130
|
protected updateIFrameHeight: (data: MessagePayload) => void;
|
|
@@ -1104,7 +1132,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1104
1132
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
1105
1133
|
* This is used for embedding answers, pinboards, visualizations and full application
|
|
1106
1134
|
* only.
|
|
1107
|
-
*
|
|
1108
1135
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
1109
1136
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
1110
1137
|
* When used with `noReload` (default: true) this can also be a number
|
|
@@ -1115,7 +1142,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1115
1142
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
1116
1143
|
/**
|
|
1117
1144
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
1118
|
-
*
|
|
1119
1145
|
* @param renderOptions An object containing the page ID
|
|
1120
1146
|
* to be embedded.
|
|
1121
1147
|
*/
|
|
@@ -1128,13 +1154,11 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1128
1154
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
1129
1155
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
1130
1156
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
1131
|
-
*
|
|
1132
1157
|
* @summary Liveboard & visualization embed
|
|
1133
1158
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1134
1159
|
*/
|
|
1135
1160
|
/**
|
|
1136
1161
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
1137
|
-
*
|
|
1138
1162
|
* @group Embed components
|
|
1139
1163
|
*/
|
|
1140
1164
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -1147,9 +1171,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1147
1171
|
* visualizations to display on the screen.
|
|
1148
1172
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
1149
1173
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1150
|
-
*
|
|
1151
1174
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1152
|
-
*
|
|
1153
1175
|
* @example
|
|
1154
1176
|
* ```js
|
|
1155
1177
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1163,7 +1185,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1163
1185
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
1164
1186
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
1165
1187
|
* other screens navigable from a Liveboard.
|
|
1166
|
-
*
|
|
1167
1188
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1168
1189
|
* @default 500
|
|
1169
1190
|
* @example
|
|
@@ -1178,7 +1199,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1178
1199
|
defaultHeight?: number;
|
|
1179
1200
|
/**
|
|
1180
1201
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
1181
|
-
*
|
|
1182
1202
|
* @example
|
|
1183
1203
|
* ```js
|
|
1184
1204
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1186,14 +1206,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1186
1206
|
* enableVizTransformations:true,
|
|
1187
1207
|
* })
|
|
1188
1208
|
* ```
|
|
1189
|
-
*
|
|
1190
1209
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1191
1210
|
*/
|
|
1192
1211
|
enableVizTransformations?: boolean;
|
|
1193
1212
|
/**
|
|
1194
1213
|
* The Liveboard to display in the embedded view.
|
|
1195
1214
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
1196
|
-
*
|
|
1197
1215
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
1198
1216
|
* @example
|
|
1199
1217
|
* ```js
|
|
@@ -1205,15 +1223,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1205
1223
|
liveboardId?: string;
|
|
1206
1224
|
/**
|
|
1207
1225
|
* To support backward compatibility
|
|
1208
|
-
*
|
|
1209
1226
|
* @hidden
|
|
1210
1227
|
*/
|
|
1211
1228
|
pinboardId?: string;
|
|
1212
1229
|
/**
|
|
1213
1230
|
* The visualization within the Liveboard to display.
|
|
1214
|
-
*
|
|
1215
1231
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1216
|
-
*
|
|
1217
1232
|
* @example
|
|
1218
1233
|
* ```js
|
|
1219
1234
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1226,7 +1241,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1226
1241
|
/**
|
|
1227
1242
|
* If set to true, all filter chips from a
|
|
1228
1243
|
* Liveboard page will be read-only (no X buttons)
|
|
1229
|
-
*
|
|
1230
1244
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
1231
1245
|
* @example
|
|
1232
1246
|
* ```js
|
|
@@ -1241,9 +1255,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1241
1255
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
1242
1256
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
1243
1257
|
* event.
|
|
1244
|
-
*
|
|
1245
1258
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1246
|
-
*
|
|
1247
1259
|
* @example
|
|
1248
1260
|
* ```js
|
|
1249
1261
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1257,14 +1269,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1257
1269
|
visibleVizs?: string[];
|
|
1258
1270
|
/**
|
|
1259
1271
|
* To support backward compatibility
|
|
1260
|
-
*
|
|
1261
1272
|
* @hidden
|
|
1262
1273
|
*/
|
|
1263
1274
|
preventPinboardFilterRemoval?: boolean;
|
|
1264
1275
|
/**
|
|
1265
1276
|
* Render embedded Liveboards and visualizations in the
|
|
1266
1277
|
* new Liveboard experience mode.
|
|
1267
|
-
*
|
|
1268
1278
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
1269
1279
|
* @example
|
|
1270
1280
|
* ```js
|
|
@@ -1278,7 +1288,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1278
1288
|
/**
|
|
1279
1289
|
* Set a Liveboard tab as an active tab.
|
|
1280
1290
|
* Specify the tab ID.
|
|
1281
|
-
*
|
|
1282
1291
|
* @example
|
|
1283
1292
|
* ```js
|
|
1284
1293
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1291,9 +1300,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1291
1300
|
activeTabId?: string;
|
|
1292
1301
|
/**
|
|
1293
1302
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1294
|
-
*
|
|
1295
1303
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1296
|
-
*
|
|
1297
1304
|
* @example
|
|
1298
1305
|
* ```js
|
|
1299
1306
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1305,7 +1312,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1305
1312
|
hideTabPanel?: boolean;
|
|
1306
1313
|
/**
|
|
1307
1314
|
* Show or hide the Liveboard header.
|
|
1308
|
-
*
|
|
1309
1315
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1310
1316
|
* @default false
|
|
1311
1317
|
* @example
|
|
@@ -1321,7 +1327,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1321
1327
|
* Show or hide the Liveboard title.
|
|
1322
1328
|
* @default false
|
|
1323
1329
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1324
|
-
*
|
|
1325
1330
|
* @example
|
|
1326
1331
|
* ```js
|
|
1327
1332
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1335,7 +1340,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1335
1340
|
* Show or hide the Liveboard description.
|
|
1336
1341
|
* @default false
|
|
1337
1342
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1338
|
-
*
|
|
1339
1343
|
* @example
|
|
1340
1344
|
* ```js
|
|
1341
1345
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1349,7 +1353,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1349
1353
|
* Control the position and visibility of
|
|
1350
1354
|
* the Liveboard header as the users scroll down the
|
|
1351
1355
|
* embedded Liveboard page.
|
|
1352
|
-
*
|
|
1353
1356
|
* @example
|
|
1354
1357
|
* ```js
|
|
1355
1358
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1362,7 +1365,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1362
1365
|
isLiveboardHeaderSticky?: boolean;
|
|
1363
1366
|
/**
|
|
1364
1367
|
* enable or disable ask sage
|
|
1365
|
-
*
|
|
1366
1368
|
* @default false
|
|
1367
1369
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1368
1370
|
* @example
|
|
@@ -1374,12 +1376,25 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1374
1376
|
* ```
|
|
1375
1377
|
*/
|
|
1376
1378
|
enableAskSage?: boolean;
|
|
1379
|
+
/**
|
|
1380
|
+
* This flag is used to enable the 2 column layout in liveboard
|
|
1381
|
+
* @type {boolean}
|
|
1382
|
+
* @default false
|
|
1383
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1384
|
+
* @example
|
|
1385
|
+
* ```js
|
|
1386
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1387
|
+
* ... // other options
|
|
1388
|
+
* enable2ColumnLayout: true,
|
|
1389
|
+
* })
|
|
1390
|
+
* ```
|
|
1391
|
+
*/
|
|
1392
|
+
enable2ColumnLayout?: boolean;
|
|
1377
1393
|
}
|
|
1378
1394
|
/**
|
|
1379
1395
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
1380
1396
|
* waits for the authentication to complete, so you need not wait for
|
|
1381
1397
|
* `AuthStatus.SUCCESS`.
|
|
1382
|
-
*
|
|
1383
1398
|
* @example
|
|
1384
1399
|
* ```js
|
|
1385
1400
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1403,14 +1418,12 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
1403
1418
|
protected handleRenderForPrerender(): void;
|
|
1404
1419
|
/**
|
|
1405
1420
|
* Triggers an event to the embedded app
|
|
1406
|
-
*
|
|
1407
1421
|
* @param messageType The event type
|
|
1408
1422
|
* @param data The payload to send with the message
|
|
1409
1423
|
*/
|
|
1410
1424
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
1411
1425
|
/**
|
|
1412
1426
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
1413
|
-
*
|
|
1414
1427
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
1415
1428
|
* visualization ID and the runtime filters.
|
|
1416
1429
|
*/
|
|
@@ -1446,7 +1459,6 @@ export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewCon
|
|
|
1446
1459
|
*
|
|
1447
1460
|
* ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
|
|
1448
1461
|
* in other web applications.
|
|
1449
|
-
*
|
|
1450
1462
|
* @summary ThoughtSpot Visual Embed SDK
|
|
1451
1463
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1452
1464
|
*/
|
|
@@ -1456,21 +1468,18 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
1456
1468
|
* Copyright (c) 2023
|
|
1457
1469
|
*
|
|
1458
1470
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
1459
|
-
*
|
|
1460
1471
|
* @summary Type definitions for Embed SDK
|
|
1461
1472
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1462
1473
|
*/
|
|
1463
1474
|
/**
|
|
1464
1475
|
* The authentication mechanism for allowing access to the
|
|
1465
1476
|
* the embedded app
|
|
1466
|
-
*
|
|
1467
1477
|
* @group Authentication / Init
|
|
1468
1478
|
*/
|
|
1469
1479
|
export declare enum AuthType {
|
|
1470
1480
|
/**
|
|
1471
1481
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
1472
1482
|
* `Passthrough`.
|
|
1473
|
-
*
|
|
1474
1483
|
* @example
|
|
1475
1484
|
* ```js
|
|
1476
1485
|
* init({
|
|
@@ -1488,7 +1497,6 @@ export declare enum AuthType {
|
|
|
1488
1497
|
* To use this:
|
|
1489
1498
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1490
1499
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1491
|
-
*
|
|
1492
1500
|
* @example
|
|
1493
1501
|
* ```js
|
|
1494
1502
|
* init({
|
|
@@ -1501,14 +1509,12 @@ export declare enum AuthType {
|
|
|
1501
1509
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1502
1510
|
/**
|
|
1503
1511
|
* SSO using SAML
|
|
1504
|
-
*
|
|
1505
1512
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1506
1513
|
* @hidden
|
|
1507
1514
|
*/
|
|
1508
1515
|
SSO = "SSO_SAML",
|
|
1509
1516
|
/**
|
|
1510
1517
|
* SSO using SAML
|
|
1511
|
-
*
|
|
1512
1518
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1513
1519
|
* @hidden
|
|
1514
1520
|
*/
|
|
@@ -1520,7 +1526,6 @@ export declare enum AuthType {
|
|
|
1520
1526
|
*
|
|
1521
1527
|
* This redirects the host application to the SAML IdP. The host application
|
|
1522
1528
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1523
|
-
*
|
|
1524
1529
|
* @example
|
|
1525
1530
|
* ```js
|
|
1526
1531
|
* init({
|
|
@@ -1561,7 +1566,6 @@ export declare enum AuthType {
|
|
|
1561
1566
|
SAMLRedirect = "SSO_SAML",
|
|
1562
1567
|
/**
|
|
1563
1568
|
* SSO using OIDC
|
|
1564
|
-
*
|
|
1565
1569
|
* @hidden
|
|
1566
1570
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
1567
1571
|
*/
|
|
@@ -1574,7 +1578,6 @@ export declare enum AuthType {
|
|
|
1574
1578
|
OIDCRedirect = "SSO_OIDC",
|
|
1575
1579
|
/**
|
|
1576
1580
|
* Trusted authentication server
|
|
1577
|
-
*
|
|
1578
1581
|
* @hidden
|
|
1579
1582
|
* @deprecated Use {@link TrustedAuth} instead
|
|
1580
1583
|
*/
|
|
@@ -1583,7 +1586,6 @@ export declare enum AuthType {
|
|
|
1583
1586
|
* Trusted authentication server. Use your own authentication server
|
|
1584
1587
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1585
1588
|
* from ThoughtSpot.
|
|
1586
|
-
*
|
|
1587
1589
|
* @example
|
|
1588
1590
|
* ```js
|
|
1589
1591
|
* init({
|
|
@@ -1595,6 +1597,7 @@ export declare enum AuthType {
|
|
|
1595
1597
|
* .then((data) => data.token);
|
|
1596
1598
|
* }
|
|
1597
1599
|
* });
|
|
1600
|
+
* });
|
|
1598
1601
|
* ```
|
|
1599
1602
|
*/
|
|
1600
1603
|
TrustedAuthToken = "AuthServer",
|
|
@@ -1604,7 +1607,6 @@ export declare enum AuthType {
|
|
|
1604
1607
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1605
1608
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1606
1609
|
* implemented by some browsers.
|
|
1607
|
-
*
|
|
1608
1610
|
* @example
|
|
1609
1611
|
* ```js
|
|
1610
1612
|
* init({
|
|
@@ -1677,7 +1679,6 @@ export interface customCssInterface {
|
|
|
1677
1679
|
/**
|
|
1678
1680
|
* Can be used to define a custom font face
|
|
1679
1681
|
* like:
|
|
1680
|
-
*
|
|
1681
1682
|
* @example
|
|
1682
1683
|
* ```js
|
|
1683
1684
|
* rules_UNSTABLE?: {
|
|
@@ -1717,7 +1718,6 @@ export interface CustomStyles {
|
|
|
1717
1718
|
* Thoughtspot components.
|
|
1718
1719
|
* You can customize styles, text strings, and icons.
|
|
1719
1720
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
1720
|
-
*
|
|
1721
1721
|
* @example
|
|
1722
1722
|
* ```js
|
|
1723
1723
|
* init({
|
|
@@ -1760,7 +1760,6 @@ export interface CustomisationsInterface {
|
|
|
1760
1760
|
* It includes the ThoughtSpot hostname or IP address,
|
|
1761
1761
|
* the type of authentication, and the authentication endpoint
|
|
1762
1762
|
* if a trusted authentication server is used.
|
|
1763
|
-
*
|
|
1764
1763
|
* @group Authentication / Init
|
|
1765
1764
|
*/
|
|
1766
1765
|
export interface EmbedConfig {
|
|
@@ -1808,7 +1807,6 @@ export interface EmbedConfig {
|
|
|
1808
1807
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1809
1808
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1810
1809
|
* place.
|
|
1811
|
-
*
|
|
1812
1810
|
* @default false
|
|
1813
1811
|
* @deprecated
|
|
1814
1812
|
*/
|
|
@@ -1819,7 +1817,6 @@ export interface EmbedConfig {
|
|
|
1819
1817
|
*
|
|
1820
1818
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1821
1819
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1822
|
-
*
|
|
1823
1820
|
* @default false
|
|
1824
1821
|
* @version SDK: 1.18.0
|
|
1825
1822
|
*/
|
|
@@ -1830,7 +1827,6 @@ export interface EmbedConfig {
|
|
|
1830
1827
|
* terminated.
|
|
1831
1828
|
*
|
|
1832
1829
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1833
|
-
*
|
|
1834
1830
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1835
1831
|
*/
|
|
1836
1832
|
redirectPath?: string;
|
|
@@ -1840,7 +1836,6 @@ export interface EmbedConfig {
|
|
|
1840
1836
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1841
1837
|
* should be encoded in base64. This provides additional security to
|
|
1842
1838
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1843
|
-
*
|
|
1844
1839
|
* @default false
|
|
1845
1840
|
*/
|
|
1846
1841
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -1850,7 +1845,6 @@ export interface EmbedConfig {
|
|
|
1850
1845
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
1851
1846
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1852
1847
|
* in this case.
|
|
1853
|
-
*
|
|
1854
1848
|
* @default false
|
|
1855
1849
|
*/
|
|
1856
1850
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -1858,14 +1852,12 @@ export interface EmbedConfig {
|
|
|
1858
1852
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
1859
1853
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
1860
1854
|
* persists even in the case of a non-logged-in user.
|
|
1861
|
-
*
|
|
1862
1855
|
* @default false
|
|
1863
1856
|
*/
|
|
1864
1857
|
ignoreNoCookieAccess?: boolean;
|
|
1865
1858
|
/**
|
|
1866
1859
|
* Re-login a user with the previous login options
|
|
1867
1860
|
* when a user session expires.
|
|
1868
|
-
*
|
|
1869
1861
|
* @default false
|
|
1870
1862
|
*/
|
|
1871
1863
|
autoLogin?: boolean;
|
|
@@ -1874,20 +1866,17 @@ export interface EmbedConfig {
|
|
|
1874
1866
|
* This flag is typically used alongside the combination of authentication modes such
|
|
1875
1867
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
1876
1868
|
* EmbedConfig.autoLogin}
|
|
1877
|
-
*
|
|
1878
1869
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1879
1870
|
* @default false
|
|
1880
1871
|
*/
|
|
1881
1872
|
disableLoginRedirect?: boolean;
|
|
1882
1873
|
/**
|
|
1883
1874
|
* This message is displayed in the embedded view when a user login fails.
|
|
1884
|
-
*
|
|
1885
1875
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1886
1876
|
*/
|
|
1887
1877
|
loginFailedMessage?: string;
|
|
1888
1878
|
/**
|
|
1889
1879
|
* Calls the prefetch method internally when set to `true`
|
|
1890
|
-
*
|
|
1891
1880
|
* @default false
|
|
1892
1881
|
*/
|
|
1893
1882
|
callPrefetch?: boolean;
|
|
@@ -1895,7 +1884,6 @@ export interface EmbedConfig {
|
|
|
1895
1884
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1896
1885
|
* to start after the previous embed's render is complete. This helps improve
|
|
1897
1886
|
* performance by decreasing the load on the browser.
|
|
1898
|
-
*
|
|
1899
1887
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1900
1888
|
* @default false
|
|
1901
1889
|
*/
|
|
@@ -1903,7 +1891,6 @@ export interface EmbedConfig {
|
|
|
1903
1891
|
/**
|
|
1904
1892
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
1905
1893
|
* You would also need to set `style-src` in the CSP settings.
|
|
1906
|
-
*
|
|
1907
1894
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1908
1895
|
* @default ''
|
|
1909
1896
|
*/
|
|
@@ -1915,13 +1902,11 @@ export interface EmbedConfig {
|
|
|
1915
1902
|
*
|
|
1916
1903
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1917
1904
|
* involves an extra network call.
|
|
1918
|
-
*
|
|
1919
1905
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1920
1906
|
*/
|
|
1921
1907
|
detectCookieAccessSlow?: boolean;
|
|
1922
1908
|
/**
|
|
1923
1909
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
1924
|
-
*
|
|
1925
1910
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
1926
1911
|
*/
|
|
1927
1912
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -1932,7 +1917,6 @@ export interface EmbedConfig {
|
|
|
1932
1917
|
suppressSageEmbedBetaWarning?: boolean;
|
|
1933
1918
|
/**
|
|
1934
1919
|
* Custom style params for embed Config.
|
|
1935
|
-
*
|
|
1936
1920
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1937
1921
|
*/
|
|
1938
1922
|
customizations?: CustomisationsInterface;
|
|
@@ -1940,7 +1924,6 @@ export interface EmbedConfig {
|
|
|
1940
1924
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
1941
1925
|
* button that the user can click to trigger the flow.
|
|
1942
1926
|
* This attribute sets a containing element for that button.
|
|
1943
|
-
*
|
|
1944
1927
|
* @example
|
|
1945
1928
|
* ```js
|
|
1946
1929
|
* init({
|
|
@@ -1962,7 +1945,6 @@ export interface EmbedConfig {
|
|
|
1962
1945
|
/**
|
|
1963
1946
|
* Text to show in the button which triggers the popup auth flow.
|
|
1964
1947
|
* Default: `Authorize`.
|
|
1965
|
-
*
|
|
1966
1948
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
1967
1949
|
*/
|
|
1968
1950
|
authTriggerText?: string;
|
|
@@ -1970,14 +1952,12 @@ export interface EmbedConfig {
|
|
|
1970
1952
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
1971
1953
|
* access to the embedded application users
|
|
1972
1954
|
* outside of the iframe.
|
|
1973
|
-
*
|
|
1974
1955
|
* @default true
|
|
1975
1956
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
1976
1957
|
*/
|
|
1977
1958
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1978
1959
|
/**
|
|
1979
1960
|
* Host config in case embedded app is inside TS app itself
|
|
1980
|
-
*
|
|
1981
1961
|
* @hidden
|
|
1982
1962
|
*/
|
|
1983
1963
|
hostConfig?: {
|
|
@@ -1987,20 +1967,18 @@ export interface EmbedConfig {
|
|
|
1987
1967
|
};
|
|
1988
1968
|
/**
|
|
1989
1969
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
1990
|
-
* is added as an additional key to the embed, as per this
|
|
1970
|
+
* 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].
|
|
1991
1971
|
*
|
|
1992
1972
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
1993
1973
|
*/
|
|
1994
1974
|
pendoTrackingKey?: string;
|
|
1995
1975
|
/**
|
|
1996
1976
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
1997
|
-
*
|
|
1998
1977
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
1999
1978
|
*/
|
|
2000
1979
|
suppressErrorAlerts?: boolean;
|
|
2001
1980
|
/**
|
|
2002
1981
|
* Log level for the SDK.
|
|
2003
|
-
*
|
|
2004
1982
|
* @default LogLevel.ERROR
|
|
2005
1983
|
* @example
|
|
2006
1984
|
* ```js
|
|
@@ -2014,16 +1992,43 @@ export interface EmbedConfig {
|
|
|
2014
1992
|
logLevel?: LogLevel;
|
|
2015
1993
|
/**
|
|
2016
1994
|
* Disables the Mixpanel tracking from the SDK.
|
|
2017
|
-
*
|
|
2018
1995
|
* @version SDK: 1.27.9
|
|
2019
1996
|
*/
|
|
2020
1997
|
disableSDKTracking?: boolean;
|
|
1998
|
+
/**
|
|
1999
|
+
* Overrides default/user preffered locale for date formatting
|
|
2000
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2001
|
+
*/
|
|
2002
|
+
dateFormatLocale?: string;
|
|
2003
|
+
/**
|
|
2004
|
+
* Overrides default/user preffered locale for number formatting
|
|
2005
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2006
|
+
*/
|
|
2007
|
+
numberFormatLocale?: string;
|
|
2008
|
+
/**
|
|
2009
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
2010
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2011
|
+
*/
|
|
2012
|
+
currencyFormat?: string;
|
|
2013
|
+
/**
|
|
2014
|
+
* This flag is used to disable the token verification in the SDK.
|
|
2015
|
+
* Enabling this flag will also disable the caching of the token.
|
|
2016
|
+
* @hidden
|
|
2017
|
+
* @example
|
|
2018
|
+
* ```js
|
|
2019
|
+
* init({
|
|
2020
|
+
* ...embedConfig,
|
|
2021
|
+
* disableTokenVerification : true
|
|
2022
|
+
* })
|
|
2023
|
+
* ```
|
|
2024
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
2025
|
+
*/
|
|
2026
|
+
disableTokenVerification?: boolean;
|
|
2021
2027
|
}
|
|
2022
2028
|
export interface LayoutConfig {
|
|
2023
2029
|
}
|
|
2024
2030
|
/**
|
|
2025
2031
|
* Embedded iframe configuration
|
|
2026
|
-
*
|
|
2027
2032
|
* @group Embed components
|
|
2028
2033
|
*/
|
|
2029
2034
|
export interface FrameParams {
|
|
@@ -2058,9 +2063,7 @@ export interface ViewConfig {
|
|
|
2058
2063
|
/**
|
|
2059
2064
|
* The width and height dimensions to render an embedded
|
|
2060
2065
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2061
|
-
*
|
|
2062
2066
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2063
|
-
*
|
|
2064
2067
|
* @example
|
|
2065
2068
|
* ```js
|
|
2066
2069
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2086,7 +2089,6 @@ export interface ViewConfig {
|
|
|
2086
2089
|
* (...), and the contextual menu. These actions will be disabled
|
|
2087
2090
|
* for the user.
|
|
2088
2091
|
* Use this to disable actions.
|
|
2089
|
-
*
|
|
2090
2092
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2091
2093
|
* @example
|
|
2092
2094
|
* ```js
|
|
@@ -2114,9 +2116,7 @@ export interface ViewConfig {
|
|
|
2114
2116
|
* The list of actions to hide from the embedded.
|
|
2115
2117
|
* This actions will be hidden from the user.
|
|
2116
2118
|
* Use this to hide an action.
|
|
2117
|
-
*
|
|
2118
2119
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2119
|
-
*
|
|
2120
2120
|
* @example
|
|
2121
2121
|
* ```js
|
|
2122
2122
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2134,10 +2134,8 @@ export interface ViewConfig {
|
|
|
2134
2134
|
* Use this to hide all actions except the ones you want to show.
|
|
2135
2135
|
*
|
|
2136
2136
|
* Use either this or hiddenActions.
|
|
2137
|
-
*
|
|
2138
2137
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2139
2138
|
* @important
|
|
2140
|
-
*
|
|
2141
2139
|
* @example
|
|
2142
2140
|
* ```js
|
|
2143
2141
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2149,9 +2147,7 @@ export interface ViewConfig {
|
|
|
2149
2147
|
visibleActions?: Action[];
|
|
2150
2148
|
/**
|
|
2151
2149
|
* Show alert messages and toast messages in the embedded view.
|
|
2152
|
-
*
|
|
2153
2150
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2154
|
-
*
|
|
2155
2151
|
* @example
|
|
2156
2152
|
* ```js
|
|
2157
2153
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2164,9 +2160,7 @@ export interface ViewConfig {
|
|
|
2164
2160
|
/**
|
|
2165
2161
|
* The list of runtime filters to apply to a search answer,
|
|
2166
2162
|
* visualization, or Liveboard.
|
|
2167
|
-
*
|
|
2168
2163
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2169
|
-
*
|
|
2170
2164
|
* @example
|
|
2171
2165
|
* ```js
|
|
2172
2166
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2185,9 +2179,7 @@ export interface ViewConfig {
|
|
|
2185
2179
|
/**
|
|
2186
2180
|
* The list of parameter override to apply to a search answer,
|
|
2187
2181
|
* visualization, or Liveboard.
|
|
2188
|
-
*
|
|
2189
2182
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2190
|
-
*
|
|
2191
2183
|
* @example
|
|
2192
2184
|
* ```js
|
|
2193
2185
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2204,7 +2196,6 @@ export interface ViewConfig {
|
|
|
2204
2196
|
runtimeParameters?: RuntimeParameter[];
|
|
2205
2197
|
/**
|
|
2206
2198
|
* The locale/language to use for the embedded view.
|
|
2207
|
-
*
|
|
2208
2199
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2209
2200
|
* @example
|
|
2210
2201
|
* ```js
|
|
@@ -2240,7 +2231,6 @@ export interface ViewConfig {
|
|
|
2240
2231
|
/**
|
|
2241
2232
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
2242
2233
|
* You would also need to set `style-src` in the CSP settings.
|
|
2243
|
-
*
|
|
2244
2234
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
2245
2235
|
* @default ''
|
|
2246
2236
|
*/
|
|
@@ -2248,9 +2238,7 @@ export interface ViewConfig {
|
|
|
2248
2238
|
/**
|
|
2249
2239
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2250
2240
|
* child inside it.
|
|
2251
|
-
*
|
|
2252
2241
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2253
|
-
*
|
|
2254
2242
|
* @example
|
|
2255
2243
|
* ```js
|
|
2256
2244
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2262,7 +2250,6 @@ export interface ViewConfig {
|
|
|
2262
2250
|
insertAsSibling?: boolean;
|
|
2263
2251
|
/**
|
|
2264
2252
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2265
|
-
*
|
|
2266
2253
|
* @example
|
|
2267
2254
|
* ```js
|
|
2268
2255
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2275,7 +2262,6 @@ export interface ViewConfig {
|
|
|
2275
2262
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2276
2263
|
/**
|
|
2277
2264
|
* Flag to override openNew tab context menu link
|
|
2278
|
-
*
|
|
2279
2265
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2280
2266
|
* @example
|
|
2281
2267
|
* ```js
|
|
@@ -2288,7 +2274,6 @@ export interface ViewConfig {
|
|
|
2288
2274
|
linkOverride?: boolean;
|
|
2289
2275
|
/**
|
|
2290
2276
|
* flag to enable insert into slides action
|
|
2291
|
-
*
|
|
2292
2277
|
* @hidden
|
|
2293
2278
|
* @private
|
|
2294
2279
|
*/
|
|
@@ -2296,7 +2281,6 @@ export interface ViewConfig {
|
|
|
2296
2281
|
/**
|
|
2297
2282
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2298
2283
|
* if available and matches the configuration.
|
|
2299
|
-
*
|
|
2300
2284
|
* @version SDK: 1.22.0
|
|
2301
2285
|
* @hidden
|
|
2302
2286
|
*
|
|
@@ -2310,7 +2294,6 @@ export interface ViewConfig {
|
|
|
2310
2294
|
*
|
|
2311
2295
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2312
2296
|
* embedded view.
|
|
2313
|
-
*
|
|
2314
2297
|
* @default false
|
|
2315
2298
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2316
2299
|
*/
|
|
@@ -2319,7 +2302,6 @@ export interface ViewConfig {
|
|
|
2319
2302
|
* The list of tab IDs to hide from the embedded.
|
|
2320
2303
|
* This Tabs will be hidden from their respective LBs.
|
|
2321
2304
|
* Use this to hide an tabID.
|
|
2322
|
-
*
|
|
2323
2305
|
* @example
|
|
2324
2306
|
* ```js
|
|
2325
2307
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2336,10 +2318,11 @@ export interface ViewConfig {
|
|
|
2336
2318
|
* Hide the home page modules
|
|
2337
2319
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
2338
2320
|
*
|
|
2321
|
+
*
|
|
2322
|
+
*
|
|
2339
2323
|
* **Note**: This option does not apply to the classic homepage.
|
|
2340
2324
|
* To access the updated modular homepage, set
|
|
2341
2325
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2342
|
-
*
|
|
2343
2326
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2344
2327
|
* @example
|
|
2345
2328
|
* ```js
|
|
@@ -2348,19 +2331,17 @@ export interface ViewConfig {
|
|
|
2348
2331
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2349
2332
|
* })
|
|
2350
2333
|
* ```
|
|
2351
|
-
*
|
|
2352
2334
|
*/
|
|
2353
2335
|
hiddenHomepageModules?: HomepageModule[];
|
|
2354
2336
|
/**
|
|
2355
2337
|
* reordering the home page modules
|
|
2356
2338
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
2357
2339
|
*
|
|
2340
|
+
*
|
|
2358
2341
|
* **Note**: This option does not apply to the classic homepage.
|
|
2359
2342
|
* To access the updated modular homepage, set
|
|
2360
2343
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2361
|
-
*
|
|
2362
2344
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
2363
|
-
*
|
|
2364
2345
|
* @example
|
|
2365
2346
|
* ```js
|
|
2366
2347
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2375,9 +2356,7 @@ export interface ViewConfig {
|
|
|
2375
2356
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2376
2357
|
*
|
|
2377
2358
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2378
|
-
*
|
|
2379
2359
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2380
|
-
*
|
|
2381
2360
|
* @example
|
|
2382
2361
|
* ```js
|
|
2383
2362
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2394,8 +2373,7 @@ export interface ViewConfig {
|
|
|
2394
2373
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2395
2374
|
* There are 8 eight home navigation list items.
|
|
2396
2375
|
* To hide these items, specify the string in the array.
|
|
2397
|
-
*
|
|
2398
|
-
* * @example
|
|
2376
|
+
* @example
|
|
2399
2377
|
* ```js
|
|
2400
2378
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2401
2379
|
* ... // other options
|
|
@@ -2403,10 +2381,11 @@ export interface ViewConfig {
|
|
|
2403
2381
|
* })
|
|
2404
2382
|
* ```
|
|
2405
2383
|
*
|
|
2384
|
+
*
|
|
2385
|
+
*
|
|
2406
2386
|
* **Note**: This option does not apply to the classic homepage.
|
|
2407
2387
|
* To access the updated modular homepage, set
|
|
2408
2388
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2409
|
-
*
|
|
2410
2389
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2411
2390
|
*/
|
|
2412
2391
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2414,7 +2393,6 @@ export interface ViewConfig {
|
|
|
2414
2393
|
* PreRender id to be used for PreRendering the embed.
|
|
2415
2394
|
* Use PreRender to render the embed in the background and then
|
|
2416
2395
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2417
|
-
*
|
|
2418
2396
|
* @example
|
|
2419
2397
|
* ```js
|
|
2420
2398
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2431,11 +2409,9 @@ export interface ViewConfig {
|
|
|
2431
2409
|
* of its embedding element and adjust its own size accordingly.
|
|
2432
2410
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2433
2411
|
* its dimensions based on changes to the size of the embedding element.
|
|
2434
|
-
*
|
|
2435
2412
|
* @type {boolean}
|
|
2436
2413
|
* @default false
|
|
2437
2414
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2438
|
-
*
|
|
2439
2415
|
* @example
|
|
2440
2416
|
* ```js
|
|
2441
2417
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2450,14 +2426,22 @@ export interface ViewConfig {
|
|
|
2450
2426
|
doNotTrackPreRenderSize?: boolean;
|
|
2451
2427
|
/**
|
|
2452
2428
|
* For internal tracking of the embed component type.
|
|
2453
|
-
*
|
|
2454
2429
|
* @hidden
|
|
2455
2430
|
*/
|
|
2456
2431
|
embedComponentType?: string;
|
|
2432
|
+
/**
|
|
2433
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
2434
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
2435
|
+
*
|
|
2436
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2437
|
+
* embedded view.
|
|
2438
|
+
* @default false
|
|
2439
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2440
|
+
*/
|
|
2441
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
2457
2442
|
}
|
|
2458
2443
|
/**
|
|
2459
2444
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
2460
|
-
*
|
|
2461
2445
|
* @group Events
|
|
2462
2446
|
*/
|
|
2463
2447
|
export type MessagePayload = {
|
|
@@ -2468,7 +2452,6 @@ export type MessagePayload = {
|
|
|
2468
2452
|
/**
|
|
2469
2453
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2470
2454
|
* option
|
|
2471
|
-
*
|
|
2472
2455
|
* @group Events
|
|
2473
2456
|
*/
|
|
2474
2457
|
export type MessageOptions = {
|
|
@@ -2480,7 +2463,6 @@ export type MessageOptions = {
|
|
|
2480
2463
|
};
|
|
2481
2464
|
/**
|
|
2482
2465
|
* MessageCallback: Embed event message callback
|
|
2483
|
-
*
|
|
2484
2466
|
* @group Events
|
|
2485
2467
|
*/
|
|
2486
2468
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -2570,7 +2552,6 @@ export declare enum RuntimeFilterOp {
|
|
|
2570
2552
|
* **Note**: This option does not apply to the classic homepage.
|
|
2571
2553
|
* To access the updated modular homepage, set
|
|
2572
2554
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2573
|
-
*
|
|
2574
2555
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2575
2556
|
*/
|
|
2576
2557
|
export declare enum HomepageModule {
|
|
@@ -2617,7 +2598,7 @@ export interface RuntimeFilter {
|
|
|
2617
2598
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
2618
2599
|
* operands.
|
|
2619
2600
|
*/
|
|
2620
|
-
values: (number | boolean | string)[];
|
|
2601
|
+
values: (number | boolean | string | bigint)[];
|
|
2621
2602
|
}
|
|
2622
2603
|
/**
|
|
2623
2604
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -2638,7 +2619,6 @@ export interface RuntimeParameter {
|
|
|
2638
2619
|
*
|
|
2639
2620
|
* To add an event listener use the corresponding
|
|
2640
2621
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
2641
|
-
*
|
|
2642
2622
|
* @example
|
|
2643
2623
|
* ```js
|
|
2644
2624
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2656,7 +2636,6 @@ export interface RuntimeParameter {
|
|
|
2656
2636
|
export declare enum EmbedEvent {
|
|
2657
2637
|
/**
|
|
2658
2638
|
* Rendering has initialized.
|
|
2659
|
-
*
|
|
2660
2639
|
* @example
|
|
2661
2640
|
*```js
|
|
2662
2641
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -2670,7 +2649,7 @@ export declare enum EmbedEvent {
|
|
|
2670
2649
|
Init = "init",
|
|
2671
2650
|
/**
|
|
2672
2651
|
* Authentication has either succeeded or failed.
|
|
2673
|
-
*
|
|
2652
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2674
2653
|
* @example
|
|
2675
2654
|
*```js
|
|
2676
2655
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -2682,8 +2661,8 @@ export declare enum EmbedEvent {
|
|
|
2682
2661
|
AuthInit = "authInit",
|
|
2683
2662
|
/**
|
|
2684
2663
|
* The embed object container has loaded.
|
|
2685
|
-
*
|
|
2686
2664
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2665
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2687
2666
|
* @example
|
|
2688
2667
|
*```js
|
|
2689
2668
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -2696,8 +2675,8 @@ export declare enum EmbedEvent {
|
|
|
2696
2675
|
Load = "load",
|
|
2697
2676
|
/**
|
|
2698
2677
|
* Data pertaining to answer or Liveboard is received
|
|
2699
|
-
*
|
|
2700
2678
|
* @return data - The answer or Liveboard data
|
|
2679
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2701
2680
|
* @example
|
|
2702
2681
|
*```js
|
|
2703
2682
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -2709,13 +2688,12 @@ export declare enum EmbedEvent {
|
|
|
2709
2688
|
Data = "data",
|
|
2710
2689
|
/**
|
|
2711
2690
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2712
|
-
*
|
|
2713
2691
|
* @hidden
|
|
2714
2692
|
*/
|
|
2715
2693
|
FiltersChanged = "filtersChanged",
|
|
2716
2694
|
/**
|
|
2717
2695
|
* Search query has been updated by the user.
|
|
2718
|
-
*
|
|
2696
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2719
2697
|
* @example
|
|
2720
2698
|
*```js
|
|
2721
2699
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -2724,13 +2702,13 @@ export declare enum EmbedEvent {
|
|
|
2724
2702
|
QueryChanged = "queryChanged",
|
|
2725
2703
|
/**
|
|
2726
2704
|
* A drill-down operation has been performed.
|
|
2727
|
-
*
|
|
2705
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2728
2706
|
* @returns additionalFilters - Any additional filters applied
|
|
2729
2707
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2730
2708
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
2731
2709
|
* @example
|
|
2732
2710
|
*```js
|
|
2733
|
-
* searchEmbed.
|
|
2711
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
2734
2712
|
* points: {
|
|
2735
2713
|
* clickedPoint,
|
|
2736
2714
|
* selectedPoints: selectedPoint
|
|
@@ -2761,8 +2739,8 @@ export declare enum EmbedEvent {
|
|
|
2761
2739
|
Drilldown = "drillDown",
|
|
2762
2740
|
/**
|
|
2763
2741
|
* One or more data sources have been selected.
|
|
2764
|
-
*
|
|
2765
2742
|
* @returns dataSourceIds - the list of data sources
|
|
2743
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2766
2744
|
* @example
|
|
2767
2745
|
* ```js
|
|
2768
2746
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -2773,7 +2751,6 @@ export declare enum EmbedEvent {
|
|
|
2773
2751
|
DataSourceSelected = "dataSourceSelected",
|
|
2774
2752
|
/**
|
|
2775
2753
|
* One or more data columns have been selected.
|
|
2776
|
-
*
|
|
2777
2754
|
* @returns columnIds - the list of columns
|
|
2778
2755
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2779
2756
|
* @example
|
|
@@ -2786,10 +2763,10 @@ export declare enum EmbedEvent {
|
|
|
2786
2763
|
AddRemoveColumns = "addRemoveColumns",
|
|
2787
2764
|
/**
|
|
2788
2765
|
* A custom action has been triggered.
|
|
2789
|
-
*
|
|
2790
2766
|
* @returns actionId - ID of the custom action
|
|
2791
2767
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
2792
2768
|
* Answer or Liveboard data
|
|
2769
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2793
2770
|
* @example
|
|
2794
2771
|
* ```js
|
|
2795
2772
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -2803,7 +2780,6 @@ export declare enum EmbedEvent {
|
|
|
2803
2780
|
CustomAction = "customAction",
|
|
2804
2781
|
/**
|
|
2805
2782
|
* Listen to double click actions on a visualization.
|
|
2806
|
-
*
|
|
2807
2783
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
2808
2784
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2809
2785
|
* @example
|
|
@@ -2816,7 +2792,6 @@ export declare enum EmbedEvent {
|
|
|
2816
2792
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
2817
2793
|
/**
|
|
2818
2794
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
2819
|
-
*
|
|
2820
2795
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
2821
2796
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2822
2797
|
* @important
|
|
@@ -2837,21 +2812,22 @@ export declare enum EmbedEvent {
|
|
|
2837
2812
|
/**
|
|
2838
2813
|
* An error has occurred. This event is fired for the following error types:
|
|
2839
2814
|
*
|
|
2840
|
-
*
|
|
2841
|
-
*
|
|
2842
|
-
* FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
|
|
2815
|
+
* `API`: API call failure error.
|
|
2843
2816
|
*
|
|
2844
|
-
*
|
|
2817
|
+
* `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
|
|
2818
|
+
* mode.
|
|
2845
2819
|
*
|
|
2846
|
-
*
|
|
2820
|
+
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
2847
2821
|
*
|
|
2848
|
-
*
|
|
2822
|
+
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
2849
2823
|
*
|
|
2850
|
-
*
|
|
2824
|
+
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
2851
2825
|
*
|
|
2852
|
-
*
|
|
2826
|
+
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
2853
2827
|
*
|
|
2828
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
2854
2829
|
* @returns error - An error object or message
|
|
2830
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2855
2831
|
* @example
|
|
2856
2832
|
* ```js
|
|
2857
2833
|
* // API error
|
|
@@ -2875,8 +2851,8 @@ export declare enum EmbedEvent {
|
|
|
2875
2851
|
Error = "Error",
|
|
2876
2852
|
/**
|
|
2877
2853
|
* The embedded object has sent an alert.
|
|
2878
|
-
*
|
|
2879
2854
|
* @returns alert - An alert object
|
|
2855
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2880
2856
|
* @example
|
|
2881
2857
|
* ```js
|
|
2882
2858
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -2885,7 +2861,7 @@ export declare enum EmbedEvent {
|
|
|
2885
2861
|
Alert = "alert",
|
|
2886
2862
|
/**
|
|
2887
2863
|
* The ThoughtSpot auth session has expired.
|
|
2888
|
-
*
|
|
2864
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2889
2865
|
* @example
|
|
2890
2866
|
*```js
|
|
2891
2867
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -2898,26 +2874,22 @@ export declare enum EmbedEvent {
|
|
|
2898
2874
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
2899
2875
|
/**
|
|
2900
2876
|
* ThoughtSpot failed to validate the auth session.
|
|
2901
|
-
*
|
|
2902
2877
|
* @hidden
|
|
2903
2878
|
*/
|
|
2904
2879
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
2905
2880
|
/**
|
|
2906
2881
|
* ThoughtSpot failed to validate the auth session.
|
|
2907
|
-
*
|
|
2908
2882
|
* @hidden
|
|
2909
2883
|
*/
|
|
2910
2884
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
2911
2885
|
/**
|
|
2912
2886
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
2913
|
-
*
|
|
2914
2887
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
2915
2888
|
* @hidden
|
|
2916
2889
|
*/
|
|
2917
2890
|
EmbedHeight = "EMBED_HEIGHT",
|
|
2918
2891
|
/**
|
|
2919
2892
|
* The center of visible iframe viewport is calculated.
|
|
2920
|
-
*
|
|
2921
2893
|
* @returns data - The center of the visible Iframe viewport.
|
|
2922
2894
|
* @hidden
|
|
2923
2895
|
*/
|
|
@@ -2925,7 +2897,6 @@ export declare enum EmbedEvent {
|
|
|
2925
2897
|
/**
|
|
2926
2898
|
* Emitted when the **Get Data** action is initiated.
|
|
2927
2899
|
* Applicable to `SearchBarEmbed` only.
|
|
2928
|
-
*
|
|
2929
2900
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
2930
2901
|
* @example
|
|
2931
2902
|
*```js
|
|
@@ -2938,7 +2909,7 @@ export declare enum EmbedEvent {
|
|
|
2938
2909
|
GetDataClick = "getDataClick",
|
|
2939
2910
|
/**
|
|
2940
2911
|
* Detects the route change.
|
|
2941
|
-
*
|
|
2912
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
2942
2913
|
* @example
|
|
2943
2914
|
*```js
|
|
2944
2915
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -2948,15 +2919,13 @@ export declare enum EmbedEvent {
|
|
|
2948
2919
|
RouteChange = "ROUTE_CHANGE",
|
|
2949
2920
|
/**
|
|
2950
2921
|
* The v1 event type for Data
|
|
2951
|
-
*
|
|
2952
2922
|
* @hidden
|
|
2953
2923
|
*/
|
|
2954
2924
|
V1Data = "exportVizDataToParent",
|
|
2955
2925
|
/**
|
|
2956
2926
|
* Emitted when the embed does not have cookie access. This happens
|
|
2957
2927
|
* when Safari and other Web browsers block third-party cookies
|
|
2958
|
-
* are blocked by default.
|
|
2959
|
-
*
|
|
2928
|
+
* are blocked by default.
|
|
2960
2929
|
* @example
|
|
2961
2930
|
*```js
|
|
2962
2931
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -2966,14 +2935,12 @@ export declare enum EmbedEvent {
|
|
|
2966
2935
|
NoCookieAccess = "noCookieAccess",
|
|
2967
2936
|
/**
|
|
2968
2937
|
* Emitted when SAML is complete
|
|
2969
|
-
*
|
|
2970
2938
|
* @private
|
|
2971
2939
|
* @hidden
|
|
2972
2940
|
*/
|
|
2973
2941
|
SAMLComplete = "samlComplete",
|
|
2974
2942
|
/**
|
|
2975
2943
|
* Emitted when any modal is opened in the app
|
|
2976
|
-
*
|
|
2977
2944
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2978
2945
|
* @example
|
|
2979
2946
|
*```js
|
|
@@ -2985,7 +2952,6 @@ export declare enum EmbedEvent {
|
|
|
2985
2952
|
DialogOpen = "dialog-open",
|
|
2986
2953
|
/**
|
|
2987
2954
|
* Emitted when any modal is closed in the app
|
|
2988
|
-
*
|
|
2989
2955
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2990
2956
|
* @example
|
|
2991
2957
|
*```js
|
|
@@ -2998,8 +2964,7 @@ export declare enum EmbedEvent {
|
|
|
2998
2964
|
/**
|
|
2999
2965
|
* Emitted when the Liveboard shell loads.
|
|
3000
2966
|
* You can use this event as a hook to trigger
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
2967
|
+
* actions on the rendered Liveboard.
|
|
3003
2968
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3004
2969
|
* @example
|
|
3005
2970
|
*```js
|
|
@@ -3019,9 +2984,7 @@ export declare enum EmbedEvent {
|
|
|
3019
2984
|
*/
|
|
3020
2985
|
LiveboardRendered = "PinboardRendered",
|
|
3021
2986
|
/**
|
|
3022
|
-
*
|
|
3023
|
-
* is triggered on all events.
|
|
3024
|
-
*
|
|
2987
|
+
* Emits all events.
|
|
3025
2988
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3026
2989
|
* @example
|
|
3027
2990
|
*```js
|
|
@@ -3033,17 +2996,16 @@ export declare enum EmbedEvent {
|
|
|
3033
2996
|
ALL = "*",
|
|
3034
2997
|
/**
|
|
3035
2998
|
* Emitted when an Answer is saved in the app
|
|
3036
|
-
*
|
|
3037
2999
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3038
3000
|
* @example
|
|
3039
3001
|
*```js
|
|
3040
|
-
* //
|
|
3002
|
+
* //Emit when action starts
|
|
3041
3003
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3042
3004
|
* console.log('Save', payload)
|
|
3043
3005
|
* }, {
|
|
3044
3006
|
* start: true
|
|
3045
3007
|
* })
|
|
3046
|
-
* //
|
|
3008
|
+
* //emit when action ends
|
|
3047
3009
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3048
3010
|
* console.log('Save', payload)
|
|
3049
3011
|
* })
|
|
@@ -3053,15 +3015,14 @@ export declare enum EmbedEvent {
|
|
|
3053
3015
|
/**
|
|
3054
3016
|
* Emitted when the download action is triggered on an answer
|
|
3055
3017
|
*
|
|
3056
|
-
* **Note**:
|
|
3018
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
3057
3019
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3058
3020
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3059
3021
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
3060
|
-
*
|
|
3061
3022
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3062
3023
|
* @example
|
|
3063
3024
|
*```js
|
|
3064
|
-
* liveboardEmbed.
|
|
3025
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3065
3026
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3066
3027
|
* })
|
|
3067
3028
|
*```
|
|
@@ -3069,14 +3030,13 @@ export declare enum EmbedEvent {
|
|
|
3069
3030
|
Download = "download",
|
|
3070
3031
|
/**
|
|
3071
3032
|
* Emitted when the download action is triggered on an answer
|
|
3072
|
-
*
|
|
3073
3033
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3074
3034
|
* @example
|
|
3075
3035
|
*```js
|
|
3076
|
-
* //
|
|
3036
|
+
* //emit when action starts
|
|
3077
3037
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3078
3038
|
* console.log('download PNG', payload)}, {start: true })
|
|
3079
|
-
* //
|
|
3039
|
+
* //emit when action ends
|
|
3080
3040
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3081
3041
|
* console.log('download PNG', payload)})
|
|
3082
3042
|
*```
|
|
@@ -3084,14 +3044,13 @@ export declare enum EmbedEvent {
|
|
|
3084
3044
|
DownloadAsPng = "downloadAsPng",
|
|
3085
3045
|
/**
|
|
3086
3046
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
3087
|
-
*
|
|
3088
3047
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3089
3048
|
* @example
|
|
3090
3049
|
*```js
|
|
3091
|
-
* //
|
|
3050
|
+
* //emit when action starts
|
|
3092
3051
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3093
3052
|
* console.log('download PDF', payload)}, {start: true })
|
|
3094
|
-
* //
|
|
3053
|
+
* //emit when action ends
|
|
3095
3054
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3096
3055
|
* console.log('download PDF', payload)})
|
|
3097
3056
|
*```
|
|
@@ -3099,14 +3058,13 @@ export declare enum EmbedEvent {
|
|
|
3099
3058
|
DownloadAsPdf = "downloadAsPdf",
|
|
3100
3059
|
/**
|
|
3101
3060
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
3102
|
-
*
|
|
3103
3061
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3104
3062
|
* @example
|
|
3105
3063
|
*```js
|
|
3106
|
-
* //
|
|
3064
|
+
* //emit when action starts
|
|
3107
3065
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3108
3066
|
* console.log('download CSV', payload)}, {start: true })
|
|
3109
|
-
* //
|
|
3067
|
+
* //emit when action ends
|
|
3110
3068
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3111
3069
|
* console.log('download CSV', payload)})
|
|
3112
3070
|
*```
|
|
@@ -3114,14 +3072,13 @@ export declare enum EmbedEvent {
|
|
|
3114
3072
|
DownloadAsCsv = "downloadAsCsv",
|
|
3115
3073
|
/**
|
|
3116
3074
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
3117
|
-
*
|
|
3118
3075
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3119
3076
|
* @example
|
|
3120
3077
|
*```js
|
|
3121
|
-
* //
|
|
3078
|
+
* //emit when action starts
|
|
3122
3079
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3123
3080
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3124
|
-
* //
|
|
3081
|
+
* //emit when action ends
|
|
3125
3082
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3126
3083
|
* console.log('download Xlsx', payload)})
|
|
3127
3084
|
*```
|
|
@@ -3129,14 +3086,13 @@ export declare enum EmbedEvent {
|
|
|
3129
3086
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3130
3087
|
/**
|
|
3131
3088
|
* Emitted when an Answer is deleted in the app
|
|
3132
|
-
*
|
|
3133
3089
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3134
3090
|
* @example
|
|
3135
3091
|
*```js
|
|
3136
|
-
* //
|
|
3092
|
+
* //emit when action starts
|
|
3137
3093
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3138
3094
|
* console.log('delete answer', payload)}, {start: true })
|
|
3139
|
-
* //
|
|
3095
|
+
* //emit when action is completed
|
|
3140
3096
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3141
3097
|
* console.log('delete answer', payload)})
|
|
3142
3098
|
*```
|
|
@@ -3144,17 +3100,16 @@ export declare enum EmbedEvent {
|
|
|
3144
3100
|
AnswerDelete = "answerDelete",
|
|
3145
3101
|
/**
|
|
3146
3102
|
* Emitted when an answer is pinned to a Liveboard
|
|
3147
|
-
*
|
|
3148
3103
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3149
3104
|
* @example
|
|
3150
3105
|
*```js
|
|
3151
|
-
* //
|
|
3106
|
+
* //emit when action starts
|
|
3152
3107
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3153
3108
|
* console.log('pin', payload)
|
|
3154
3109
|
* }, {
|
|
3155
3110
|
* start: true
|
|
3156
3111
|
* })
|
|
3157
|
-
* //
|
|
3112
|
+
* //emit when action ends
|
|
3158
3113
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3159
3114
|
* console.log('pin', payload)
|
|
3160
3115
|
* })
|
|
@@ -3163,17 +3118,16 @@ export declare enum EmbedEvent {
|
|
|
3163
3118
|
Pin = "pin",
|
|
3164
3119
|
/**
|
|
3165
3120
|
* Emitted when SpotIQ analysis is triggered
|
|
3166
|
-
*
|
|
3167
3121
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3168
3122
|
* @example
|
|
3169
3123
|
*```js
|
|
3170
|
-
* //
|
|
3124
|
+
* //emit when action starts
|
|
3171
3125
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3172
3126
|
* console.log('SpotIQAnalyze', payload)
|
|
3173
3127
|
* }, {
|
|
3174
3128
|
* start: true
|
|
3175
3129
|
* })
|
|
3176
|
-
* //
|
|
3130
|
+
* //emit when action ends
|
|
3177
3131
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3178
3132
|
* console.log('SpotIQ analyze', payload)
|
|
3179
3133
|
* })
|
|
@@ -3182,17 +3136,16 @@ export declare enum EmbedEvent {
|
|
|
3182
3136
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3183
3137
|
/**
|
|
3184
3138
|
* Emitted when a user shares an object with another user or group
|
|
3185
|
-
*
|
|
3186
3139
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3187
3140
|
* @example
|
|
3188
3141
|
*```js
|
|
3189
|
-
* //
|
|
3142
|
+
* //emit when action starts
|
|
3190
3143
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3191
3144
|
* console.log('Share', payload)
|
|
3192
3145
|
* }, {
|
|
3193
3146
|
* start: true
|
|
3194
3147
|
* })
|
|
3195
|
-
* //
|
|
3148
|
+
* //emit when action ends
|
|
3196
3149
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3197
3150
|
* console.log('Share', payload)
|
|
3198
3151
|
* })
|
|
@@ -3202,7 +3155,6 @@ export declare enum EmbedEvent {
|
|
|
3202
3155
|
/**
|
|
3203
3156
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
3204
3157
|
* data on a chart or table.
|
|
3205
|
-
*
|
|
3206
3158
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3207
3159
|
* @example
|
|
3208
3160
|
*```js
|
|
@@ -3215,7 +3167,6 @@ export declare enum EmbedEvent {
|
|
|
3215
3167
|
/**
|
|
3216
3168
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
3217
3169
|
* data on a chart or table
|
|
3218
|
-
*
|
|
3219
3170
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3220
3171
|
* @example
|
|
3221
3172
|
*```js
|
|
@@ -3227,7 +3178,6 @@ export declare enum EmbedEvent {
|
|
|
3227
3178
|
DrillExclude = "context-menu-item-exclude",
|
|
3228
3179
|
/**
|
|
3229
3180
|
* Emitted when a column value is copied in the embedded app.
|
|
3230
|
-
*
|
|
3231
3181
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3232
3182
|
* @example
|
|
3233
3183
|
*```js
|
|
@@ -3238,7 +3188,8 @@ export declare enum EmbedEvent {
|
|
|
3238
3188
|
*/
|
|
3239
3189
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3240
3190
|
/**
|
|
3241
|
-
* Emitted when a user clicks the **Update TML** action
|
|
3191
|
+
* Emitted when a user clicks the **Update TML** action on
|
|
3192
|
+
* embedded Liveboard.
|
|
3242
3193
|
*
|
|
3243
3194
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3244
3195
|
* @example
|
|
@@ -3250,6 +3201,7 @@ export declare enum EmbedEvent {
|
|
|
3250
3201
|
UpdateTML = "updateTSL",
|
|
3251
3202
|
/**
|
|
3252
3203
|
* Emitted when a user clicks the **Edit TML** action
|
|
3204
|
+
* on an embedded Liveboard.
|
|
3253
3205
|
*
|
|
3254
3206
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3255
3207
|
* @example
|
|
@@ -3263,14 +3215,13 @@ export declare enum EmbedEvent {
|
|
|
3263
3215
|
/**
|
|
3264
3216
|
* Emitted when the **Export TML** action is triggered on an
|
|
3265
3217
|
* an embedded object in the app
|
|
3266
|
-
*
|
|
3267
3218
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3268
3219
|
* @example
|
|
3269
3220
|
*```js
|
|
3270
|
-
* //
|
|
3221
|
+
* //emit when action starts
|
|
3271
3222
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3272
3223
|
* console.log('Export TML', payload)}, { start: true })
|
|
3273
|
-
* //
|
|
3224
|
+
* //emit when action ends
|
|
3274
3225
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3275
3226
|
* console.log('Export TML', payload)})
|
|
3276
3227
|
*```
|
|
@@ -3278,7 +3229,6 @@ export declare enum EmbedEvent {
|
|
|
3278
3229
|
ExportTML = "exportTSL",
|
|
3279
3230
|
/**
|
|
3280
3231
|
* Emitted when an Answer is saved as a View.
|
|
3281
|
-
*
|
|
3282
3232
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3283
3233
|
* @example
|
|
3284
3234
|
*```js
|
|
@@ -3290,14 +3240,13 @@ export declare enum EmbedEvent {
|
|
|
3290
3240
|
SaveAsView = "saveAsView",
|
|
3291
3241
|
/**
|
|
3292
3242
|
* Emitted when the user creates a copy of an Answer
|
|
3293
|
-
*
|
|
3294
3243
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3295
3244
|
* @example
|
|
3296
3245
|
*```js
|
|
3297
|
-
* //
|
|
3246
|
+
* //emit when action starts
|
|
3298
3247
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3299
3248
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3300
|
-
* //
|
|
3249
|
+
* //emit when action ends
|
|
3301
3250
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3302
3251
|
* console.log('Copy and edit', payload)})
|
|
3303
3252
|
*```
|
|
@@ -3305,7 +3254,6 @@ export declare enum EmbedEvent {
|
|
|
3305
3254
|
CopyAEdit = "copyAEdit",
|
|
3306
3255
|
/**
|
|
3307
3256
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
3308
|
-
*
|
|
3309
3257
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3310
3258
|
* @example
|
|
3311
3259
|
*```js
|
|
@@ -3317,7 +3265,6 @@ export declare enum EmbedEvent {
|
|
|
3317
3265
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3318
3266
|
/**
|
|
3319
3267
|
* Emitted when an answer is switched to a chart or table view.
|
|
3320
|
-
*
|
|
3321
3268
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3322
3269
|
* @example
|
|
3323
3270
|
*```js
|
|
@@ -3329,13 +3276,11 @@ export declare enum EmbedEvent {
|
|
|
3329
3276
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3330
3277
|
/**
|
|
3331
3278
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
3332
|
-
*
|
|
3333
3279
|
* @hidden
|
|
3334
3280
|
*/
|
|
3335
3281
|
APP_INIT = "appInit",
|
|
3336
3282
|
/**
|
|
3337
3283
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3338
|
-
*
|
|
3339
3284
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3340
3285
|
* @example
|
|
3341
3286
|
*```js
|
|
@@ -3347,7 +3292,6 @@ export declare enum EmbedEvent {
|
|
|
3347
3292
|
LiveboardInfo = "pinboardInfo",
|
|
3348
3293
|
/**
|
|
3349
3294
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3350
|
-
*
|
|
3351
3295
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3352
3296
|
* @example
|
|
3353
3297
|
*```js
|
|
@@ -3359,7 +3303,6 @@ export declare enum EmbedEvent {
|
|
|
3359
3303
|
AddToFavorites = "addToFavorites",
|
|
3360
3304
|
/**
|
|
3361
3305
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3362
|
-
*
|
|
3363
3306
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3364
3307
|
* @example
|
|
3365
3308
|
*```js
|
|
@@ -3371,7 +3314,6 @@ export declare enum EmbedEvent {
|
|
|
3371
3314
|
Schedule = "subscription",
|
|
3372
3315
|
/**
|
|
3373
3316
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3374
|
-
*
|
|
3375
3317
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3376
3318
|
* @example
|
|
3377
3319
|
*```js
|
|
@@ -3383,7 +3325,6 @@ export declare enum EmbedEvent {
|
|
|
3383
3325
|
Edit = "edit",
|
|
3384
3326
|
/**
|
|
3385
3327
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3386
|
-
*
|
|
3387
3328
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3388
3329
|
* @example
|
|
3389
3330
|
*```js
|
|
@@ -3395,11 +3336,10 @@ export declare enum EmbedEvent {
|
|
|
3395
3336
|
MakeACopy = "makeACopy",
|
|
3396
3337
|
/**
|
|
3397
3338
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3398
|
-
*
|
|
3399
3339
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3400
3340
|
* @example
|
|
3401
3341
|
*```js
|
|
3402
|
-
* liveboardEmbed.
|
|
3342
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3403
3343
|
*```
|
|
3404
3344
|
* @example
|
|
3405
3345
|
*```js
|
|
@@ -3411,71 +3351,64 @@ export declare enum EmbedEvent {
|
|
|
3411
3351
|
Present = "present",
|
|
3412
3352
|
/**
|
|
3413
3353
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3414
|
-
*
|
|
3415
3354
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3416
3355
|
* @example
|
|
3417
3356
|
*```js
|
|
3418
|
-
* liveboardEmbed.
|
|
3357
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3419
3358
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3420
3359
|
*```
|
|
3421
3360
|
*/
|
|
3422
3361
|
Delete = "delete",
|
|
3423
3362
|
/**
|
|
3424
3363
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3425
|
-
*
|
|
3426
3364
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3427
3365
|
* @example
|
|
3428
3366
|
*```js
|
|
3429
|
-
* liveboardEmbed.
|
|
3367
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3430
3368
|
*```
|
|
3431
3369
|
*/
|
|
3432
3370
|
SchedulesList = "schedule-list",
|
|
3433
3371
|
/**
|
|
3434
3372
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3435
|
-
*
|
|
3436
3373
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3437
3374
|
* @example
|
|
3438
3375
|
*```js
|
|
3439
|
-
* liveboardEmbed.
|
|
3376
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3440
3377
|
*```
|
|
3441
3378
|
*/
|
|
3442
3379
|
Cancel = "cancel",
|
|
3443
3380
|
/**
|
|
3444
3381
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3445
|
-
*
|
|
3446
3382
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3447
3383
|
* @example
|
|
3448
3384
|
*```js
|
|
3449
|
-
* liveboardEmbed.
|
|
3385
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3450
3386
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3451
3387
|
*```
|
|
3452
3388
|
*/
|
|
3453
3389
|
Explore = "explore",
|
|
3454
3390
|
/**
|
|
3455
3391
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3456
|
-
*
|
|
3457
3392
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3458
3393
|
* @example
|
|
3459
3394
|
*```js
|
|
3460
|
-
* liveboardEmbed.
|
|
3395
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3461
3396
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3462
3397
|
*```
|
|
3463
3398
|
*/
|
|
3464
3399
|
CopyLink = "embedDocument",
|
|
3465
3400
|
/**
|
|
3466
3401
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3467
|
-
*
|
|
3468
3402
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3469
3403
|
* @example
|
|
3470
3404
|
*```js
|
|
3471
|
-
* liveboardEmbed.
|
|
3405
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3472
3406
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3473
3407
|
*```
|
|
3474
3408
|
*/
|
|
3475
3409
|
CrossFilterChanged = "cross-filter-changed",
|
|
3476
3410
|
/**
|
|
3477
3411
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3478
|
-
*
|
|
3479
3412
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3480
3413
|
* @example
|
|
3481
3414
|
*```js
|
|
@@ -3487,44 +3420,53 @@ export declare enum EmbedEvent {
|
|
|
3487
3420
|
VizPointRightClick = "vizPointRightClick",
|
|
3488
3421
|
/**
|
|
3489
3422
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
3490
|
-
*
|
|
3491
3423
|
* @hidden
|
|
3492
3424
|
*/
|
|
3493
3425
|
InsertIntoSlide = "insertInToSlide",
|
|
3494
3426
|
/**
|
|
3495
|
-
* @hidden
|
|
3496
3427
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3428
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
3429
|
+
* filter details.
|
|
3430
|
+
* @example
|
|
3431
|
+
*
|
|
3432
|
+
*```js
|
|
3433
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3434
|
+
* console.log('payload', payload);
|
|
3435
|
+
* })
|
|
3436
|
+
*
|
|
3497
3437
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3438
|
+
* @example
|
|
3439
|
+
*
|
|
3440
|
+
*```js
|
|
3441
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3442
|
+
* console.log('payload', payload);
|
|
3443
|
+
* })
|
|
3444
|
+
*```
|
|
3498
3445
|
*/
|
|
3499
3446
|
FilterChanged = "filterChanged",
|
|
3500
3447
|
/**
|
|
3501
3448
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
3502
|
-
*
|
|
3503
3449
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3504
3450
|
*/
|
|
3505
3451
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3506
3452
|
/**
|
|
3507
3453
|
* Emitted when a user selects a data source.
|
|
3508
|
-
*
|
|
3509
3454
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3510
3455
|
*/
|
|
3511
3456
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3512
3457
|
/**
|
|
3513
3458
|
* Emitted when a user updates a connection on the **Data** page
|
|
3514
|
-
*
|
|
3515
3459
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3516
3460
|
*/
|
|
3517
3461
|
UpdateConnection = "updateConnection",
|
|
3518
3462
|
/**
|
|
3519
3463
|
* Emitted when a user updates a connection on the **Data** page
|
|
3520
|
-
*
|
|
3521
3464
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3522
3465
|
*/
|
|
3523
3466
|
CreateConnection = "createConnection",
|
|
3524
3467
|
/**
|
|
3525
3468
|
* Emitted when name, status (private or public) or filter values of a
|
|
3526
3469
|
* Personalised view is updated.
|
|
3527
|
-
*
|
|
3528
3470
|
* @returns viewName: string
|
|
3529
3471
|
* @returns viewId: string
|
|
3530
3472
|
* @returns liveboardId: string
|
|
@@ -3534,7 +3476,6 @@ export declare enum EmbedEvent {
|
|
|
3534
3476
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3535
3477
|
/**
|
|
3536
3478
|
* Emitted when a Personalised view is saved.
|
|
3537
|
-
*
|
|
3538
3479
|
* @returns viewName: string
|
|
3539
3480
|
* @returns viewId: string
|
|
3540
3481
|
* @returns liveboardId: string
|
|
@@ -3544,7 +3485,6 @@ export declare enum EmbedEvent {
|
|
|
3544
3485
|
SavePersonalisedView = "savePersonalisedView",
|
|
3545
3486
|
/**
|
|
3546
3487
|
* Emitted when a Liveboard is reset.
|
|
3547
|
-
*
|
|
3548
3488
|
* @returns viewName: string
|
|
3549
3489
|
* @returns viewId: string
|
|
3550
3490
|
* @returns liveboardId: string
|
|
@@ -3554,7 +3494,6 @@ export declare enum EmbedEvent {
|
|
|
3554
3494
|
ResetLiveboard = "resetLiveboard",
|
|
3555
3495
|
/**
|
|
3556
3496
|
* Emitted when a PersonalisedView is deleted.
|
|
3557
|
-
*
|
|
3558
3497
|
* @returns views: string[]
|
|
3559
3498
|
* @returns liveboardId: string
|
|
3560
3499
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -3562,13 +3501,11 @@ export declare enum EmbedEvent {
|
|
|
3562
3501
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3563
3502
|
/**
|
|
3564
3503
|
* Emitted when a user creates a new worksheet
|
|
3565
|
-
*
|
|
3566
3504
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3567
3505
|
*/
|
|
3568
3506
|
CreateWorksheet = "createWorksheet",
|
|
3569
3507
|
/**
|
|
3570
3508
|
* Emitted when Ask Sage is initialized.
|
|
3571
|
-
*
|
|
3572
3509
|
* @returns viewName: string
|
|
3573
3510
|
* @returns viewId: string
|
|
3574
3511
|
* @returns liveboardId: string
|
|
@@ -3578,10 +3515,32 @@ export declare enum EmbedEvent {
|
|
|
3578
3515
|
AskSageInit = "AskSageInit",
|
|
3579
3516
|
/**
|
|
3580
3517
|
* Emitted when a LB/viz is renamed
|
|
3581
|
-
*
|
|
3582
3518
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3583
3519
|
*/
|
|
3584
|
-
Rename = "rename"
|
|
3520
|
+
Rename = "rename",
|
|
3521
|
+
/**
|
|
3522
|
+
* Emitted when user wants to intercept the search execution
|
|
3523
|
+
*
|
|
3524
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
3525
|
+
* event
|
|
3526
|
+
*
|
|
3527
|
+
*```js
|
|
3528
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
3529
|
+
* responder({
|
|
3530
|
+
* data: {
|
|
3531
|
+
* execute: true,
|
|
3532
|
+
* error: {errorText: "My own customised error"}
|
|
3533
|
+
* }})
|
|
3534
|
+
* })
|
|
3535
|
+
*```
|
|
3536
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3537
|
+
*/
|
|
3538
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
3539
|
+
/**
|
|
3540
|
+
* Emitted when runtime parameters changes
|
|
3541
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3542
|
+
*/
|
|
3543
|
+
ParameterChanged = "ParameterChanged"
|
|
3585
3544
|
}
|
|
3586
3545
|
/**
|
|
3587
3546
|
* Event types that can be triggered by the host application
|
|
@@ -3590,7 +3549,6 @@ export declare enum EmbedEvent {
|
|
|
3590
3549
|
* To trigger an event use the corresponding
|
|
3591
3550
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
3592
3551
|
* SearchEmbed.trigger} method.
|
|
3593
|
-
*
|
|
3594
3552
|
* @example
|
|
3595
3553
|
* ```js
|
|
3596
3554
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3611,7 +3569,6 @@ export declare enum HostEvent {
|
|
|
3611
3569
|
* the search query string.
|
|
3612
3570
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3613
3571
|
* Includes the following properties:
|
|
3614
|
-
*
|
|
3615
3572
|
* @param - `searchQuery` - query string with search tokens
|
|
3616
3573
|
* @param - `dataSources` - Data source GUID to Search on
|
|
3617
3574
|
* - Although an array, only a single source
|
|
@@ -3630,7 +3587,6 @@ export declare enum HostEvent {
|
|
|
3630
3587
|
/**
|
|
3631
3588
|
* Triggers a drill on certain points of the specified column
|
|
3632
3589
|
* Includes the following properties:
|
|
3633
|
-
*
|
|
3634
3590
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
3635
3591
|
* to drill to. For example, { selectedPoints: []}
|
|
3636
3592
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -3680,19 +3636,16 @@ export declare enum HostEvent {
|
|
|
3680
3636
|
DrillDown = "triggerDrillDown",
|
|
3681
3637
|
/**
|
|
3682
3638
|
* Apply filters
|
|
3683
|
-
*
|
|
3684
3639
|
* @hidden
|
|
3685
3640
|
*/
|
|
3686
3641
|
Filter = "filter",
|
|
3687
3642
|
/**
|
|
3688
3643
|
* Reload the answer or visualization
|
|
3689
|
-
*
|
|
3690
3644
|
* @hidden
|
|
3691
3645
|
*/
|
|
3692
3646
|
Reload = "reload",
|
|
3693
3647
|
/**
|
|
3694
3648
|
* Display specific visualizations on a Liveboard.
|
|
3695
|
-
*
|
|
3696
3649
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
3697
3650
|
* in this parameter will be hidden.
|
|
3698
3651
|
* @example
|
|
@@ -3706,7 +3659,6 @@ export declare enum HostEvent {
|
|
|
3706
3659
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
3707
3660
|
/**
|
|
3708
3661
|
* Set a Liveboard tab as an active tab.
|
|
3709
|
-
*
|
|
3710
3662
|
* @param - tabId - string of id of Tab to show
|
|
3711
3663
|
* @example
|
|
3712
3664
|
* ```js
|
|
@@ -3722,18 +3674,21 @@ export declare enum HostEvent {
|
|
|
3722
3674
|
* runtime filters passed here are appended to the existing runtime
|
|
3723
3675
|
* filters.
|
|
3724
3676
|
* Pass an array of runtime filters with the following attributes:
|
|
3677
|
+
*
|
|
3725
3678
|
* `columnName`
|
|
3726
3679
|
* _String_. The name of the column to filter on.
|
|
3680
|
+
*
|
|
3727
3681
|
* `operator`
|
|
3728
3682
|
* Runtime filter operator to apply. For information,
|
|
3729
|
-
* see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
|
|
3683
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
3684
|
+
*
|
|
3730
3685
|
* `values`
|
|
3731
|
-
*
|
|
3732
|
-
*
|
|
3733
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3734
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3735
|
-
* embedding (SageEmbed).
|
|
3686
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
3687
|
+
* operators such as BW and IN accept multiple operands.
|
|
3736
3688
|
*
|
|
3689
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3690
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3691
|
+
* embedding (SageEmbed).
|
|
3737
3692
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
3738
3693
|
* @example
|
|
3739
3694
|
* ```js
|
|
@@ -3749,7 +3704,6 @@ export declare enum HostEvent {
|
|
|
3749
3704
|
/**
|
|
3750
3705
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
3751
3706
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
3752
|
-
*
|
|
3753
3707
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
3754
3708
|
* be a number; for example, `1`, `-1`.
|
|
3755
3709
|
* @example
|
|
@@ -3762,7 +3716,6 @@ export declare enum HostEvent {
|
|
|
3762
3716
|
/**
|
|
3763
3717
|
* Open the filter panel for a particular column.
|
|
3764
3718
|
* Works with Search and Liveboard embed.
|
|
3765
|
-
*
|
|
3766
3719
|
* @param - { columnId: string,
|
|
3767
3720
|
* name: string,
|
|
3768
3721
|
* type: INT64/CHAR/DATE,
|
|
@@ -3779,7 +3732,6 @@ export declare enum HostEvent {
|
|
|
3779
3732
|
OpenFilter = "openFilter",
|
|
3780
3733
|
/**
|
|
3781
3734
|
* Add columns to the current search query.
|
|
3782
|
-
*
|
|
3783
3735
|
* @param - { columnIds: string[] }
|
|
3784
3736
|
* @example
|
|
3785
3737
|
* ```js
|
|
@@ -3790,7 +3742,6 @@ export declare enum HostEvent {
|
|
|
3790
3742
|
AddColumns = "addColumns",
|
|
3791
3743
|
/**
|
|
3792
3744
|
* Remove a column from the current search query.
|
|
3793
|
-
*
|
|
3794
3745
|
* @param - { columnId: string }
|
|
3795
3746
|
* @example
|
|
3796
3747
|
* ```js
|
|
@@ -3805,10 +3756,9 @@ export declare enum HostEvent {
|
|
|
3805
3756
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
3806
3757
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
3807
3758
|
* sorting, toggling of legends, and data drill down.
|
|
3808
|
-
*
|
|
3809
3759
|
* @example
|
|
3810
3760
|
* ```js
|
|
3811
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
3761
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
3812
3762
|
* data=>console.log(data))
|
|
3813
3763
|
* ```
|
|
3814
3764
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -3816,7 +3766,6 @@ export declare enum HostEvent {
|
|
|
3816
3766
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
3817
3767
|
/**
|
|
3818
3768
|
* Trigger the **Pin** action on an embedded object
|
|
3819
|
-
*
|
|
3820
3769
|
* @param - Liveboard embed takes the `vizId` as a
|
|
3821
3770
|
* key. Can be left undefined when embedding Search, full app, or
|
|
3822
3771
|
* a visualization.
|
|
@@ -3833,7 +3782,6 @@ export declare enum HostEvent {
|
|
|
3833
3782
|
/**
|
|
3834
3783
|
* Trigger the **Show Liveboard details** action
|
|
3835
3784
|
* on an embedded Liveboard.
|
|
3836
|
-
*
|
|
3837
3785
|
* @example
|
|
3838
3786
|
*```js
|
|
3839
3787
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -3843,7 +3791,6 @@ export declare enum HostEvent {
|
|
|
3843
3791
|
LiveboardInfo = "pinboardInfo",
|
|
3844
3792
|
/**
|
|
3845
3793
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
3846
|
-
*
|
|
3847
3794
|
* @example
|
|
3848
3795
|
* ```js
|
|
3849
3796
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -3853,7 +3800,6 @@ export declare enum HostEvent {
|
|
|
3853
3800
|
Schedule = "subscription",
|
|
3854
3801
|
/**
|
|
3855
3802
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
3856
|
-
*
|
|
3857
3803
|
* @example
|
|
3858
3804
|
* ```js
|
|
3859
3805
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -3862,17 +3808,21 @@ export declare enum HostEvent {
|
|
|
3862
3808
|
*/
|
|
3863
3809
|
SchedulesList = "schedule-list",
|
|
3864
3810
|
/**
|
|
3865
|
-
* Trigger the **Export TML** action on an embedded Liveboard
|
|
3811
|
+
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
3812
|
+
* Answer.
|
|
3866
3813
|
*
|
|
3867
3814
|
* @example
|
|
3868
3815
|
* ```js
|
|
3869
3816
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
3870
3817
|
* ```
|
|
3818
|
+
*
|
|
3871
3819
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3872
3820
|
*/
|
|
3873
3821
|
ExportTML = "exportTSL",
|
|
3874
3822
|
/**
|
|
3875
|
-
* Trigger the **Edit TML** action on an embedded Liveboard
|
|
3823
|
+
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
3824
|
+
* saved Answers in the full application embedding.
|
|
3825
|
+
*
|
|
3876
3826
|
*
|
|
3877
3827
|
* @example
|
|
3878
3828
|
* ```js
|
|
@@ -3883,7 +3833,6 @@ export declare enum HostEvent {
|
|
|
3883
3833
|
EditTML = "editTSL",
|
|
3884
3834
|
/**
|
|
3885
3835
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
3886
|
-
*
|
|
3887
3836
|
* @example
|
|
3888
3837
|
* ```js
|
|
3889
3838
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -3892,7 +3841,11 @@ export declare enum HostEvent {
|
|
|
3892
3841
|
*/
|
|
3893
3842
|
UpdateTML = "updateTSL",
|
|
3894
3843
|
/**
|
|
3895
|
-
* Trigger the **Download PDF** action on an embedded Liveboard
|
|
3844
|
+
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
3845
|
+
* visualization or Answer.
|
|
3846
|
+
*
|
|
3847
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
3848
|
+
* visualizations and Answers if the data is in tabular format.
|
|
3896
3849
|
*
|
|
3897
3850
|
* @example
|
|
3898
3851
|
* ```js
|
|
@@ -3904,7 +3857,6 @@ export declare enum HostEvent {
|
|
|
3904
3857
|
/**
|
|
3905
3858
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
3906
3859
|
* visualization page.
|
|
3907
|
-
*
|
|
3908
3860
|
* @example
|
|
3909
3861
|
* ```js
|
|
3910
3862
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -3920,7 +3872,6 @@ export declare enum HostEvent {
|
|
|
3920
3872
|
MakeACopy = "makeACopy",
|
|
3921
3873
|
/**
|
|
3922
3874
|
* Trigger the **Delete** action for a Liveboard.
|
|
3923
|
-
*
|
|
3924
3875
|
* @example
|
|
3925
3876
|
* ```js
|
|
3926
3877
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -3930,7 +3881,6 @@ export declare enum HostEvent {
|
|
|
3930
3881
|
Remove = "delete",
|
|
3931
3882
|
/**
|
|
3932
3883
|
* Trigger the **Explore** action on a visualization.
|
|
3933
|
-
*
|
|
3934
3884
|
* @param - an object with `vizId` as a key
|
|
3935
3885
|
* @example
|
|
3936
3886
|
* ```js
|
|
@@ -3941,7 +3891,6 @@ export declare enum HostEvent {
|
|
|
3941
3891
|
Explore = "explore",
|
|
3942
3892
|
/**
|
|
3943
3893
|
* Trigger the **Create alert** action on a visualization
|
|
3944
|
-
*
|
|
3945
3894
|
* @param - an object with `vizId` as a key
|
|
3946
3895
|
* @example
|
|
3947
3896
|
* ```js
|
|
@@ -3954,7 +3903,6 @@ export declare enum HostEvent {
|
|
|
3954
3903
|
CreateMonitor = "createMonitor",
|
|
3955
3904
|
/**
|
|
3956
3905
|
* Trigger the **Manage alerts** action on a visualization
|
|
3957
|
-
*
|
|
3958
3906
|
* @param - an object with `vizId` as a key
|
|
3959
3907
|
* @example
|
|
3960
3908
|
* ```js
|
|
@@ -3966,29 +3914,28 @@ export declare enum HostEvent {
|
|
|
3966
3914
|
*/
|
|
3967
3915
|
ManageMonitor = "manageMonitor",
|
|
3968
3916
|
/**
|
|
3969
|
-
* Trigger the **Edit** action on a Liveboard or visualization
|
|
3917
|
+
* Trigger the **Edit** action on a Liveboard or a visualization
|
|
3918
|
+
* on a Liveboard.
|
|
3919
|
+
*
|
|
3920
|
+
* This event is not supported in visualization embed and search embed.
|
|
3970
3921
|
*
|
|
3971
3922
|
* @param - object - To trigger the action for a specific visualization
|
|
3972
3923
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
3973
|
-
*
|
|
3974
|
-
* a visualization.
|
|
3924
|
+
*
|
|
3975
3925
|
* @example
|
|
3976
3926
|
* ```js
|
|
3977
3927
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
3978
3928
|
* ```
|
|
3929
|
+
* @example
|
|
3979
3930
|
* ```js
|
|
3980
3931
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
3981
3932
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3982
3933
|
* ```
|
|
3983
|
-
* ```js
|
|
3984
|
-
* vizEmbed.trigger((HostEvent.Edit)
|
|
3985
|
-
* ```
|
|
3986
3934
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3987
3935
|
*/
|
|
3988
3936
|
Edit = "edit",
|
|
3989
3937
|
/**
|
|
3990
3938
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
3991
|
-
*
|
|
3992
3939
|
* @param - object - to trigger the action for a
|
|
3993
3940
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
3994
3941
|
* @example
|
|
@@ -4006,7 +3953,6 @@ export declare enum HostEvent {
|
|
|
4006
3953
|
CopyLink = "embedDocument",
|
|
4007
3954
|
/**
|
|
4008
3955
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
4009
|
-
*
|
|
4010
3956
|
* @param - object - to trigger the action for a specific visualization
|
|
4011
3957
|
* in Liveboard embed, pass in `vizId` as a key
|
|
4012
3958
|
* @example
|
|
@@ -4024,12 +3970,11 @@ export declare enum HostEvent {
|
|
|
4024
3970
|
Present = "present",
|
|
4025
3971
|
/**
|
|
4026
3972
|
* Get TML for the current search.
|
|
4027
|
-
*
|
|
4028
3973
|
* @example
|
|
4029
3974
|
* ```js
|
|
4030
3975
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
4031
3976
|
* console.log(
|
|
4032
|
-
* tml.search_query // TML representation of the search query
|
|
3977
|
+
* tml.answer.search_query // TML representation of the search query
|
|
4033
3978
|
* );
|
|
4034
3979
|
* })
|
|
4035
3980
|
* ```
|
|
@@ -4039,7 +3984,6 @@ export declare enum HostEvent {
|
|
|
4039
3984
|
GetTML = "getTML",
|
|
4040
3985
|
/**
|
|
4041
3986
|
* Trigger the **Show underlying data** action on visualization or search
|
|
4042
|
-
*
|
|
4043
3987
|
* @param - an object with vizId as a key
|
|
4044
3988
|
* @example
|
|
4045
3989
|
* ```js
|
|
@@ -4059,7 +4003,6 @@ export declare enum HostEvent {
|
|
|
4059
4003
|
* Trigger the **Delete** action for a visualization
|
|
4060
4004
|
* in an embedded Liveboard, or a chart or table
|
|
4061
4005
|
* generated from Search.
|
|
4062
|
-
*
|
|
4063
4006
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
4064
4007
|
* Can be left empty if embedding Search or visualization.
|
|
4065
4008
|
* @example
|
|
@@ -4076,7 +4019,6 @@ export declare enum HostEvent {
|
|
|
4076
4019
|
/**
|
|
4077
4020
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
4078
4021
|
* or search.
|
|
4079
|
-
*
|
|
4080
4022
|
* @param - Liveboard embed takes `vizId` as a
|
|
4081
4023
|
* key. Can be left undefined when embedding Search or
|
|
4082
4024
|
* visualization.
|
|
@@ -4097,7 +4039,6 @@ export declare enum HostEvent {
|
|
|
4097
4039
|
/**
|
|
4098
4040
|
* Trigger the **Download** action on charts in
|
|
4099
4041
|
* the embedded view.
|
|
4100
|
-
*
|
|
4101
4042
|
* @example
|
|
4102
4043
|
* ```js
|
|
4103
4044
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -4114,7 +4055,6 @@ export declare enum HostEvent {
|
|
|
4114
4055
|
/**
|
|
4115
4056
|
* Trigger the **Download** > **PNG** action on
|
|
4116
4057
|
* charts in the embedded view.
|
|
4117
|
-
*
|
|
4118
4058
|
* @example
|
|
4119
4059
|
* ```js
|
|
4120
4060
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -4130,7 +4070,6 @@ export declare enum HostEvent {
|
|
|
4130
4070
|
/**
|
|
4131
4071
|
* Trigger the **Download** > **CSV** action on tables in
|
|
4132
4072
|
* the embedded view.
|
|
4133
|
-
*
|
|
4134
4073
|
* @example
|
|
4135
4074
|
* ```js
|
|
4136
4075
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -4148,7 +4087,6 @@ export declare enum HostEvent {
|
|
|
4148
4087
|
/**
|
|
4149
4088
|
* Trigger the **Download** > **XLSX** action on tables
|
|
4150
4089
|
* in the embedded view.
|
|
4151
|
-
*
|
|
4152
4090
|
* @example
|
|
4153
4091
|
* ```js
|
|
4154
4092
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -4166,7 +4104,6 @@ export declare enum HostEvent {
|
|
|
4166
4104
|
/**
|
|
4167
4105
|
* Trigger the **Share** action on an embedded
|
|
4168
4106
|
* Liveboard or Answer.
|
|
4169
|
-
*
|
|
4170
4107
|
* @example
|
|
4171
4108
|
* ```js
|
|
4172
4109
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -4180,7 +4117,6 @@ export declare enum HostEvent {
|
|
|
4180
4117
|
/**
|
|
4181
4118
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
4182
4119
|
* Saves the changes.
|
|
4183
|
-
*
|
|
4184
4120
|
* @example
|
|
4185
4121
|
* ```js
|
|
4186
4122
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -4194,7 +4130,6 @@ export declare enum HostEvent {
|
|
|
4194
4130
|
/**
|
|
4195
4131
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
4196
4132
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
4197
|
-
*
|
|
4198
4133
|
* @param - an object with `vizId` as a key
|
|
4199
4134
|
* @example
|
|
4200
4135
|
* ```js
|
|
@@ -4211,7 +4146,6 @@ export declare enum HostEvent {
|
|
|
4211
4146
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
4212
4147
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
4213
4148
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
4214
|
-
*
|
|
4215
4149
|
* @param - an object with vizId as a key
|
|
4216
4150
|
* @example
|
|
4217
4151
|
* ```js
|
|
@@ -4228,7 +4162,6 @@ export declare enum HostEvent {
|
|
|
4228
4162
|
* Trigger the **Manage pipelines** action on an embedded
|
|
4229
4163
|
* visualization or Answer.
|
|
4230
4164
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
4231
|
-
*
|
|
4232
4165
|
* @param - an object with `vizId` as a key
|
|
4233
4166
|
* @example
|
|
4234
4167
|
* ```js
|
|
@@ -4243,7 +4176,6 @@ export declare enum HostEvent {
|
|
|
4243
4176
|
ManagePipelines = "manage-pipeline",
|
|
4244
4177
|
/**
|
|
4245
4178
|
* Reset search operation on the Search or Answer page.
|
|
4246
|
-
*
|
|
4247
4179
|
* @example
|
|
4248
4180
|
* ```js
|
|
4249
4181
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -4255,32 +4187,73 @@ export declare enum HostEvent {
|
|
|
4255
4187
|
*/
|
|
4256
4188
|
ResetSearch = "resetSearch",
|
|
4257
4189
|
/**
|
|
4258
|
-
*
|
|
4259
|
-
*
|
|
4190
|
+
* Get details of filters applied on the Liveboard.
|
|
4191
|
+
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
4260
4192
|
*
|
|
4261
4193
|
* @example
|
|
4262
|
-
*
|
|
4194
|
+
* ```js
|
|
4195
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
4196
|
+
* console.log('data', data);
|
|
4197
|
+
* ```
|
|
4263
4198
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4264
4199
|
*/
|
|
4265
4200
|
GetFilters = "getFilters",
|
|
4266
4201
|
/**
|
|
4202
|
+
* Update one or several filters applied on a Liveboard.
|
|
4203
|
+
* @param - `filter`: a single filter object containing column name,
|
|
4204
|
+
* filter operator, and values.
|
|
4205
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
4206
|
+
* and values for each.
|
|
4207
|
+
*
|
|
4208
|
+
* Each filter object must include the following attributes:
|
|
4209
|
+
*
|
|
4210
|
+
* `column` - Name of the column to filter on.
|
|
4211
|
+
*
|
|
4212
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
4213
|
+
* For information about the supported filter operators,
|
|
4214
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
4267
4215
|
*
|
|
4268
|
-
*
|
|
4216
|
+
* `values` - An array of one or several values. The value definition on the
|
|
4217
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
4218
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
4269
4219
|
*
|
|
4270
|
-
* @
|
|
4220
|
+
* @example
|
|
4221
|
+
* ```js
|
|
4222
|
+
*
|
|
4223
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4224
|
+
* filter: {
|
|
4225
|
+
* column: "item type",
|
|
4226
|
+
* oper: "IN",
|
|
4227
|
+
* values: ["bags","shirts"],
|
|
4228
|
+
* }
|
|
4229
|
+
* });
|
|
4230
|
+
* ```
|
|
4271
4231
|
* @example
|
|
4272
4232
|
*
|
|
4273
4233
|
* ```js
|
|
4274
4234
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4275
|
-
*
|
|
4276
|
-
*
|
|
4235
|
+
* filters: [{
|
|
4236
|
+
* column: "Item Type",
|
|
4237
|
+
* oper: 'IN',
|
|
4238
|
+
* values: ["bags","shirts"]
|
|
4239
|
+
* },
|
|
4240
|
+
* {
|
|
4241
|
+
* column: "Region",
|
|
4242
|
+
* oper: 'IN',
|
|
4243
|
+
* values: ["West","Midwest"]
|
|
4244
|
+
* },
|
|
4245
|
+
* {
|
|
4246
|
+
* column: "Date",
|
|
4247
|
+
* oper: 'EQ',
|
|
4248
|
+
* values: ["1656680400"]
|
|
4249
|
+
* }]
|
|
4250
|
+
* });
|
|
4277
4251
|
* ```
|
|
4278
4252
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4279
4253
|
*/
|
|
4280
4254
|
UpdateFilters = "updateFilters",
|
|
4281
4255
|
/**
|
|
4282
4256
|
* Get tab details for the current Liveboard.
|
|
4283
|
-
*
|
|
4284
4257
|
* @example
|
|
4285
4258
|
* ```js
|
|
4286
4259
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -4294,7 +4267,6 @@ export declare enum HostEvent {
|
|
|
4294
4267
|
GetTabs = "getTabs",
|
|
4295
4268
|
/**
|
|
4296
4269
|
* Set the visible tabs on a Liveboard.
|
|
4297
|
-
*
|
|
4298
4270
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
4299
4271
|
* will be hidden.
|
|
4300
4272
|
* @example
|
|
@@ -4308,7 +4280,6 @@ export declare enum HostEvent {
|
|
|
4308
4280
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4309
4281
|
/**
|
|
4310
4282
|
* Set the hidden tabs on a Liveboard.
|
|
4311
|
-
*
|
|
4312
4283
|
* @param - an array of the IDs of the tabs to hide.
|
|
4313
4284
|
* The IDs not passed will be shown.
|
|
4314
4285
|
* @example
|
|
@@ -4322,7 +4293,6 @@ export declare enum HostEvent {
|
|
|
4322
4293
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4323
4294
|
/**
|
|
4324
4295
|
* Updates the search query string for Natural Language Search operations.
|
|
4325
|
-
*
|
|
4326
4296
|
* @param - `queryString`: Text string in Natural Language format
|
|
4327
4297
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
4328
4298
|
* @example
|
|
@@ -4337,7 +4307,6 @@ export declare enum HostEvent {
|
|
|
4337
4307
|
UpdateSageQuery = "updateSageQuery",
|
|
4338
4308
|
/**
|
|
4339
4309
|
* Get the answer session for a Search / Visualization.
|
|
4340
|
-
*
|
|
4341
4310
|
* @example
|
|
4342
4311
|
* ```js
|
|
4343
4312
|
* const {session} = await embed.trigger(
|
|
@@ -4350,7 +4319,6 @@ export declare enum HostEvent {
|
|
|
4350
4319
|
GetAnswerSession = "getAnswerSession",
|
|
4351
4320
|
/**
|
|
4352
4321
|
* Trigger Ask Sage for viz
|
|
4353
|
-
*
|
|
4354
4322
|
* @example
|
|
4355
4323
|
* ```js
|
|
4356
4324
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -4361,7 +4329,6 @@ export declare enum HostEvent {
|
|
|
4361
4329
|
AskSage = "AskSage",
|
|
4362
4330
|
/**
|
|
4363
4331
|
* Trigger UpdateCrossFilter for Liveboard
|
|
4364
|
-
*
|
|
4365
4332
|
* @example
|
|
4366
4333
|
* ```js
|
|
4367
4334
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4377,14 +4344,42 @@ export declare enum HostEvent {
|
|
|
4377
4344
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4378
4345
|
/**
|
|
4379
4346
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
4380
|
-
*
|
|
4381
4347
|
* @example
|
|
4382
4348
|
* ```js
|
|
4383
4349
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
4384
4350
|
* ```
|
|
4385
4351
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4386
4352
|
*/
|
|
4387
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
4353
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4354
|
+
/**
|
|
4355
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4356
|
+
* @example
|
|
4357
|
+
* ```js
|
|
4358
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
4359
|
+
*
|
|
4360
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4361
|
+
*/
|
|
4362
|
+
CreateLiveboard = "CreateLiveboard",
|
|
4363
|
+
/**
|
|
4364
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
4365
|
+
* @example
|
|
4366
|
+
* ```js
|
|
4367
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
4368
|
+
* name: "Color",
|
|
4369
|
+
* value: "almond"
|
|
4370
|
+
* }])
|
|
4371
|
+
*
|
|
4372
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4373
|
+
*/
|
|
4374
|
+
UpdateParameters = "UpdateParameters",
|
|
4375
|
+
/**
|
|
4376
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
4377
|
+
* ```js
|
|
4378
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters);
|
|
4379
|
+
*
|
|
4380
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4381
|
+
*/
|
|
4382
|
+
GetParameters = "GetParameters"
|
|
4388
4383
|
}
|
|
4389
4384
|
/**
|
|
4390
4385
|
* The different visual modes that the data sources panel within
|
|
@@ -4481,7 +4476,15 @@ export declare enum Param {
|
|
|
4481
4476
|
ClientLogLevel = "clientLogLevel",
|
|
4482
4477
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
4483
4478
|
enableAskSage = "enableAskSage",
|
|
4484
|
-
CollapseSearchBarInitially = "collapseSearchBarInitially"
|
|
4479
|
+
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
4480
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
4481
|
+
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
4482
|
+
DateFormatLocale = "dateFormatLocale",
|
|
4483
|
+
NumberFormatLocale = "numberFormatLocale",
|
|
4484
|
+
CurrencyFormat = "currencyFormat",
|
|
4485
|
+
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4486
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
4487
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4485
4488
|
}
|
|
4486
4489
|
/**
|
|
4487
4490
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -4490,7 +4493,6 @@ export declare enum Param {
|
|
|
4490
4493
|
* specific actions in the embedded view, define the Action
|
|
4491
4494
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
4492
4495
|
* or `hiddenActions` array.
|
|
4493
|
-
*
|
|
4494
4496
|
* @example
|
|
4495
4497
|
* ```js
|
|
4496
4498
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -4514,10 +4516,9 @@ export declare enum Action {
|
|
|
4514
4516
|
/**
|
|
4515
4517
|
* The **Save** action on an Answer or Liveboard.
|
|
4516
4518
|
* Allows users to save the changes.
|
|
4517
|
-
*
|
|
4518
4519
|
* @example
|
|
4519
4520
|
* ```js
|
|
4520
|
-
* disabledActions: [Action.
|
|
4521
|
+
* disabledActions: [Action.Save]
|
|
4521
4522
|
* ```
|
|
4522
4523
|
*/
|
|
4523
4524
|
Save = "save",
|
|
@@ -4531,7 +4532,8 @@ export declare enum Action {
|
|
|
4531
4532
|
SaveUntitled = "saveUntitled",
|
|
4532
4533
|
/**
|
|
4533
4534
|
* The **Save as View** action on the Answer
|
|
4534
|
-
* page. Saves an Answer as a View object
|
|
4535
|
+
* page. Saves an Answer as a View object in the full
|
|
4536
|
+
* application embedding mode.
|
|
4535
4537
|
*
|
|
4536
4538
|
* @example
|
|
4537
4539
|
* ```js
|
|
@@ -4546,7 +4548,6 @@ export declare enum Action {
|
|
|
4546
4548
|
* visualizations in the embedded Liveboard view.
|
|
4547
4549
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
4548
4550
|
* Liveboards and visualizations.
|
|
4549
|
-
*
|
|
4550
4551
|
* @example
|
|
4551
4552
|
* ```js
|
|
4552
4553
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -4556,7 +4557,6 @@ export declare enum Action {
|
|
|
4556
4557
|
/**
|
|
4557
4558
|
* The **Copy and Edit** action on a Liveboard.
|
|
4558
4559
|
* This action is now replaced with `Action.MakeACopy`.
|
|
4559
|
-
*
|
|
4560
4560
|
* @example
|
|
4561
4561
|
* ```js
|
|
4562
4562
|
* disabledActions: [Action.EditACopy]
|
|
@@ -4566,7 +4566,6 @@ export declare enum Action {
|
|
|
4566
4566
|
/**
|
|
4567
4567
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
4568
4568
|
* Copies the visualization URL
|
|
4569
|
-
*
|
|
4570
4569
|
* @example
|
|
4571
4570
|
* ```js
|
|
4572
4571
|
* disabledActions: [Action.CopyLink]
|
|
@@ -4580,7 +4579,6 @@ export declare enum Action {
|
|
|
4580
4579
|
/**
|
|
4581
4580
|
* The **Schedule** menu action on a Liveboard.
|
|
4582
4581
|
* Allows scheduling a Liveboard notification.
|
|
4583
|
-
*
|
|
4584
4582
|
* @example
|
|
4585
4583
|
* ```js
|
|
4586
4584
|
* disabledActions: [Action.Schedule]
|
|
@@ -4590,7 +4588,6 @@ export declare enum Action {
|
|
|
4590
4588
|
/**
|
|
4591
4589
|
* The **Manage schedules** menu action on a Liveboard.
|
|
4592
4590
|
* Allows users to manage scheduled Liveboard jobs.
|
|
4593
|
-
*
|
|
4594
4591
|
* @example
|
|
4595
4592
|
* ```js
|
|
4596
4593
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -4600,7 +4597,6 @@ export declare enum Action {
|
|
|
4600
4597
|
/**
|
|
4601
4598
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
4602
4599
|
* Allows users to share an object with other users and groups.
|
|
4603
|
-
*
|
|
4604
4600
|
* @example
|
|
4605
4601
|
* ```js
|
|
4606
4602
|
* disabledActions: [Action.Share]
|
|
@@ -4610,7 +4606,6 @@ export declare enum Action {
|
|
|
4610
4606
|
/**
|
|
4611
4607
|
* The **Add filter** action on a Liveboard and Search page.
|
|
4612
4608
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
4613
|
-
*
|
|
4614
4609
|
* @example
|
|
4615
4610
|
* ```js
|
|
4616
4611
|
* disabledActions: [Action.AddFilter]
|
|
@@ -4621,7 +4616,6 @@ export declare enum Action {
|
|
|
4621
4616
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
4622
4617
|
* Allows to show action menu to add different objects (like
|
|
4623
4618
|
* formulas, parameters) in data panel v2.
|
|
4624
|
-
*
|
|
4625
4619
|
* @example
|
|
4626
4620
|
* ```js
|
|
4627
4621
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -4633,7 +4627,6 @@ export declare enum Action {
|
|
|
4633
4627
|
* Filter configuration options on a Liveboard and Search page.
|
|
4634
4628
|
* Allows configuring filter options when adding filters to a
|
|
4635
4629
|
* Liveboard or Answer.
|
|
4636
|
-
*
|
|
4637
4630
|
* @example
|
|
4638
4631
|
* ```js
|
|
4639
4632
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -4644,7 +4637,6 @@ export declare enum Action {
|
|
|
4644
4637
|
/**
|
|
4645
4638
|
* The **Choose sources** button on Search page.
|
|
4646
4639
|
* Allows selecting data sources for search queries.
|
|
4647
|
-
*
|
|
4648
4640
|
* @example
|
|
4649
4641
|
* ```js
|
|
4650
4642
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -4654,7 +4646,6 @@ export declare enum Action {
|
|
|
4654
4646
|
/**
|
|
4655
4647
|
* The **Create formula** action on a Search or Answer page.
|
|
4656
4648
|
* Allows adding formulas to an Answer.
|
|
4657
|
-
*
|
|
4658
4649
|
* @example
|
|
4659
4650
|
* ```js
|
|
4660
4651
|
* disabledActions: [Action.AddFormula]
|
|
@@ -4664,7 +4655,6 @@ export declare enum Action {
|
|
|
4664
4655
|
/**
|
|
4665
4656
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
4666
4657
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
4667
|
-
*
|
|
4668
4658
|
* @example
|
|
4669
4659
|
* ```js
|
|
4670
4660
|
* disabledActions: [Action.AddParameter]
|
|
@@ -4674,7 +4664,6 @@ export declare enum Action {
|
|
|
4674
4664
|
/**
|
|
4675
4665
|
* The **Add Column Set** action on a Answer.
|
|
4676
4666
|
* Allows adding column sets to a Answer.
|
|
4677
|
-
*
|
|
4678
4667
|
* @example
|
|
4679
4668
|
* ```js
|
|
4680
4669
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -4685,7 +4674,6 @@ export declare enum Action {
|
|
|
4685
4674
|
/**
|
|
4686
4675
|
* The **Add Query Set** action on a Answer.
|
|
4687
4676
|
* Allows adding query sets to a Answer.
|
|
4688
|
-
*
|
|
4689
4677
|
* @example
|
|
4690
4678
|
* ```js
|
|
4691
4679
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -4700,7 +4688,6 @@ export declare enum Action {
|
|
|
4700
4688
|
/**
|
|
4701
4689
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
4702
4690
|
* Answer page.
|
|
4703
|
-
*
|
|
4704
4691
|
* @example
|
|
4705
4692
|
* ```js
|
|
4706
4693
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -4723,7 +4710,6 @@ export declare enum Action {
|
|
|
4723
4710
|
/**
|
|
4724
4711
|
* The **Show underlying data** menu action on a visualization or
|
|
4725
4712
|
* Answer page.
|
|
4726
|
-
*
|
|
4727
4713
|
* @example
|
|
4728
4714
|
* ```js
|
|
4729
4715
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -4734,7 +4720,6 @@ export declare enum Action {
|
|
|
4734
4720
|
* The **Download** menu action on Liveboard visualizations
|
|
4735
4721
|
* and Answers.
|
|
4736
4722
|
* Allows downloading a visualization or Answer.
|
|
4737
|
-
*
|
|
4738
4723
|
* @example
|
|
4739
4724
|
* ```js
|
|
4740
4725
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -4745,7 +4730,6 @@ export declare enum Action {
|
|
|
4745
4730
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
4746
4731
|
* or Answer page.
|
|
4747
4732
|
* Downloads a visualization or Answer as a PNG file.
|
|
4748
|
-
*
|
|
4749
4733
|
* @example
|
|
4750
4734
|
* ```js
|
|
4751
4735
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -4753,9 +4737,16 @@ export declare enum Action {
|
|
|
4753
4737
|
*/
|
|
4754
4738
|
DownloadAsPng = "downloadAsPng",
|
|
4755
4739
|
/**
|
|
4756
|
-
* The **Download** > **PDF** menu action on a Liveboard.
|
|
4757
|
-
* Downloads a visualization or Answer as a PDF file.
|
|
4758
4740
|
*
|
|
4741
|
+
* The **Download PDF** action that downloads a Liveboard,
|
|
4742
|
+
* visualization, or Answer as a PDF file.
|
|
4743
|
+
*
|
|
4744
|
+
*
|
|
4745
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
4746
|
+
* visualizations and Answers if the data is in tabular format.
|
|
4747
|
+
*
|
|
4748
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
4749
|
+
*visualizations and Answers if the data is in tabular format.
|
|
4759
4750
|
* @example
|
|
4760
4751
|
* ```js
|
|
4761
4752
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -4766,7 +4757,6 @@ export declare enum Action {
|
|
|
4766
4757
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
4767
4758
|
* or Answer page.
|
|
4768
4759
|
* Downloads a visualization or Answer in the XLSX format.
|
|
4769
|
-
*
|
|
4770
4760
|
* @example
|
|
4771
4761
|
* ```js
|
|
4772
4762
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -4777,7 +4767,6 @@ export declare enum Action {
|
|
|
4777
4767
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
4778
4768
|
* or Answer page.
|
|
4779
4769
|
* Downloads a visualization or Answer in the XLSX format.
|
|
4780
|
-
*
|
|
4781
4770
|
* @example
|
|
4782
4771
|
* ```js
|
|
4783
4772
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -4792,7 +4781,6 @@ export declare enum Action {
|
|
|
4792
4781
|
* The **Export TML** menu action on Liveboard, Answers
|
|
4793
4782
|
* Worksheets and Data Connections page.
|
|
4794
4783
|
* Exports an object as a TML file.
|
|
4795
|
-
*
|
|
4796
4784
|
* @example
|
|
4797
4785
|
* ```js
|
|
4798
4786
|
* disabledActions: [Action.ExportTML]
|
|
@@ -4802,7 +4790,6 @@ export declare enum Action {
|
|
|
4802
4790
|
/**
|
|
4803
4791
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
4804
4792
|
* Imports TML representation of ThoughtSpot objects.
|
|
4805
|
-
*
|
|
4806
4793
|
* @example
|
|
4807
4794
|
* ```js
|
|
4808
4795
|
* disabledActions: [Action.ImportTML]
|
|
@@ -4812,7 +4799,6 @@ export declare enum Action {
|
|
|
4812
4799
|
/**
|
|
4813
4800
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
4814
4801
|
* Update TML representation of ThoughtSpot objects.
|
|
4815
|
-
*
|
|
4816
4802
|
* @example
|
|
4817
4803
|
* ```js
|
|
4818
4804
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -4822,7 +4808,6 @@ export declare enum Action {
|
|
|
4822
4808
|
/**
|
|
4823
4809
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
4824
4810
|
* Opens the TML editor.
|
|
4825
|
-
*
|
|
4826
4811
|
* @example
|
|
4827
4812
|
* ```js
|
|
4828
4813
|
* disabledActions: [Action.EditTML]
|
|
@@ -4833,7 +4818,6 @@ export declare enum Action {
|
|
|
4833
4818
|
* The **Present** menu action for Liveboards and Answers.
|
|
4834
4819
|
* Allows presenting a Liveboard or visualization in
|
|
4835
4820
|
* slideshow mode.
|
|
4836
|
-
*
|
|
4837
4821
|
* @example
|
|
4838
4822
|
* ```js
|
|
4839
4823
|
* disabledActions: [Action.Present]
|
|
@@ -4843,7 +4827,6 @@ export declare enum Action {
|
|
|
4843
4827
|
/**
|
|
4844
4828
|
* The tile resize options in the visualization menu.
|
|
4845
4829
|
* Allows switching between different preset layouts.
|
|
4846
|
-
*
|
|
4847
4830
|
* @example
|
|
4848
4831
|
* ```js
|
|
4849
4832
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -4854,7 +4837,6 @@ export declare enum Action {
|
|
|
4854
4837
|
* The *Edit* action on the Liveboard page and in the
|
|
4855
4838
|
* visualization menu.
|
|
4856
4839
|
* Opens a Liveboard or visualization in edit mode.
|
|
4857
|
-
*
|
|
4858
4840
|
* @example
|
|
4859
4841
|
* ```js
|
|
4860
4842
|
* disabledActions: [Action.Edit]
|
|
@@ -4863,7 +4845,6 @@ export declare enum Action {
|
|
|
4863
4845
|
Edit = "edit",
|
|
4864
4846
|
/**
|
|
4865
4847
|
* The text edit option for Liveboard and visualization titles.
|
|
4866
|
-
*
|
|
4867
4848
|
* @example
|
|
4868
4849
|
* ```js
|
|
4869
4850
|
* disabledActions: [Action.EditTitle]
|
|
@@ -4873,7 +4854,6 @@ export declare enum Action {
|
|
|
4873
4854
|
/**
|
|
4874
4855
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
4875
4856
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
4876
|
-
*
|
|
4877
4857
|
* @example
|
|
4878
4858
|
* ```js
|
|
4879
4859
|
* disabledActions: [Action.Remove]
|
|
@@ -4905,7 +4885,6 @@ export declare enum Action {
|
|
|
4905
4885
|
* Displays details such as the name, description, and
|
|
4906
4886
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
4907
4887
|
* and update.
|
|
4908
|
-
*
|
|
4909
4888
|
* @example
|
|
4910
4889
|
* ```js
|
|
4911
4890
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -4923,7 +4902,6 @@ export declare enum Action {
|
|
|
4923
4902
|
/**
|
|
4924
4903
|
* The **Pin** menu action on an Answer or
|
|
4925
4904
|
* Search results page.
|
|
4926
|
-
*
|
|
4927
4905
|
* @example
|
|
4928
4906
|
* ```js
|
|
4929
4907
|
* disabledActions: [Action.Pin]
|
|
@@ -4936,7 +4914,6 @@ export declare enum Action {
|
|
|
4936
4914
|
AnalysisInfo = "analysisInfo",
|
|
4937
4915
|
/**
|
|
4938
4916
|
* The **Schedule** menu action on a Liveboard.
|
|
4939
|
-
*
|
|
4940
4917
|
* @example
|
|
4941
4918
|
* ```js
|
|
4942
4919
|
* disabledActions: [Action.Subscription]
|
|
@@ -4945,7 +4922,6 @@ export declare enum Action {
|
|
|
4945
4922
|
Subscription = "subscription",
|
|
4946
4923
|
/**
|
|
4947
4924
|
* The **Explore** action on Liveboard visualizations
|
|
4948
|
-
*
|
|
4949
4925
|
* @example
|
|
4950
4926
|
* ```js
|
|
4951
4927
|
* disabledActions: [Action.Explore]
|
|
@@ -4955,7 +4931,6 @@ export declare enum Action {
|
|
|
4955
4931
|
/**
|
|
4956
4932
|
* The action to include data points on a drilled-down Answer
|
|
4957
4933
|
* or visualization
|
|
4958
|
-
*
|
|
4959
4934
|
* @example
|
|
4960
4935
|
* ```js
|
|
4961
4936
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -4965,7 +4940,6 @@ export declare enum Action {
|
|
|
4965
4940
|
/**
|
|
4966
4941
|
* The action to exclude data points on a drilled-down Answer
|
|
4967
4942
|
* or visualization
|
|
4968
|
-
*
|
|
4969
4943
|
* @example
|
|
4970
4944
|
* ```js
|
|
4971
4945
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -4976,7 +4950,6 @@ export declare enum Action {
|
|
|
4976
4950
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
4977
4951
|
* or Liveboard.
|
|
4978
4952
|
* Copies the selected data point.
|
|
4979
|
-
*
|
|
4980
4953
|
* @example
|
|
4981
4954
|
* ```js
|
|
4982
4955
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -4994,7 +4967,6 @@ export declare enum Action {
|
|
|
4994
4967
|
* The **Drill down** menu action on Answers and Liveboard
|
|
4995
4968
|
* visualizations.
|
|
4996
4969
|
* Allows drilling down to a specific data point on a chart or table.
|
|
4997
|
-
*
|
|
4998
4970
|
* @example
|
|
4999
4971
|
* ```js
|
|
5000
4972
|
* disabledActions: [Action.DrillDown]
|
|
@@ -5004,7 +4976,6 @@ export declare enum Action {
|
|
|
5004
4976
|
/**
|
|
5005
4977
|
* The request access action on Liveboards.
|
|
5006
4978
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
5007
|
-
*
|
|
5008
4979
|
* @example
|
|
5009
4980
|
* ```js
|
|
5010
4981
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -5014,7 +4985,6 @@ export declare enum Action {
|
|
|
5014
4985
|
/**
|
|
5015
4986
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
5016
4987
|
* of the Answer page
|
|
5017
|
-
*
|
|
5018
4988
|
* @example
|
|
5019
4989
|
* ```js
|
|
5020
4990
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5022,7 +4992,8 @@ export declare enum Action {
|
|
|
5022
4992
|
*/
|
|
5023
4993
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
5024
4994
|
/**
|
|
5025
|
-
* The **Delete** action for Answers
|
|
4995
|
+
* The **Delete** action for Answers in the full application
|
|
4996
|
+
* embedding mode.
|
|
5026
4997
|
*
|
|
5027
4998
|
* @example
|
|
5028
4999
|
* ```js
|
|
@@ -5033,7 +5004,6 @@ export declare enum Action {
|
|
|
5033
5004
|
AnswerDelete = "onDeleteAnswer",
|
|
5034
5005
|
/**
|
|
5035
5006
|
* The Chart switcher icon on Answer and visualization pages.
|
|
5036
|
-
*
|
|
5037
5007
|
* @example
|
|
5038
5008
|
* ```js
|
|
5039
5009
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5043,7 +5013,6 @@ export declare enum Action {
|
|
|
5043
5013
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5044
5014
|
/**
|
|
5045
5015
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
5046
|
-
*
|
|
5047
5016
|
* @example
|
|
5048
5017
|
* ```js
|
|
5049
5018
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5053,7 +5022,6 @@ export declare enum Action {
|
|
|
5053
5022
|
AddToFavorites = "addToFavorites",
|
|
5054
5023
|
/**
|
|
5055
5024
|
* The edit icon on Liveboards (Classic experience).
|
|
5056
|
-
*
|
|
5057
5025
|
* @example
|
|
5058
5026
|
* ```js
|
|
5059
5027
|
* disabledActions: [Action.EditDetails]
|
|
@@ -5063,7 +5031,6 @@ export declare enum Action {
|
|
|
5063
5031
|
EditDetails = "editDetails",
|
|
5064
5032
|
/**
|
|
5065
5033
|
* The Create alert action on KPI charts.
|
|
5066
|
-
*
|
|
5067
5034
|
* @example
|
|
5068
5035
|
* ```js
|
|
5069
5036
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -5082,7 +5049,6 @@ export declare enum Action {
|
|
|
5082
5049
|
/**
|
|
5083
5050
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
5084
5051
|
* Allows sending data to a Google Sheet.
|
|
5085
|
-
*
|
|
5086
5052
|
* @example
|
|
5087
5053
|
* ```js
|
|
5088
5054
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -5094,7 +5060,6 @@ export declare enum Action {
|
|
|
5094
5060
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
5095
5061
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
5096
5062
|
* Microsoft Teams, and so on.
|
|
5097
|
-
*
|
|
5098
5063
|
* @example
|
|
5099
5064
|
* ```js
|
|
5100
5065
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5105,7 +5070,6 @@ export declare enum Action {
|
|
|
5105
5070
|
/**
|
|
5106
5071
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
5107
5072
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5108
|
-
*
|
|
5109
5073
|
* @example
|
|
5110
5074
|
* ```js
|
|
5111
5075
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5116,7 +5080,6 @@ export declare enum Action {
|
|
|
5116
5080
|
/**
|
|
5117
5081
|
* The **Filter** action on Liveboard visualizations.
|
|
5118
5082
|
* Allows users to apply cross-filters on a Liveboard.
|
|
5119
|
-
*
|
|
5120
5083
|
* @example
|
|
5121
5084
|
* ```js
|
|
5122
5085
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -5127,7 +5090,6 @@ export declare enum Action {
|
|
|
5127
5090
|
/**
|
|
5128
5091
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5129
5092
|
* Allows sending data to third-party apps Slack
|
|
5130
|
-
*
|
|
5131
5093
|
* @example
|
|
5132
5094
|
* ```js
|
|
5133
5095
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -5138,7 +5100,6 @@ export declare enum Action {
|
|
|
5138
5100
|
/**
|
|
5139
5101
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5140
5102
|
* Allows sending data to third-party apps Team
|
|
5141
|
-
*
|
|
5142
5103
|
* @example
|
|
5143
5104
|
* ```js
|
|
5144
5105
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -5150,7 +5111,6 @@ export declare enum Action {
|
|
|
5150
5111
|
* The **Remove** action that appears when cross filters are applied
|
|
5151
5112
|
* on a Liveboard.
|
|
5152
5113
|
* Removes filters applied o a visualization.
|
|
5153
|
-
*
|
|
5154
5114
|
* @example
|
|
5155
5115
|
* ```js
|
|
5156
5116
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5162,7 +5122,6 @@ export declare enum Action {
|
|
|
5162
5122
|
* The **Aggregate** option in the chart axis or the
|
|
5163
5123
|
* table column customization menu.
|
|
5164
5124
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
5165
|
-
*
|
|
5166
5125
|
* @example
|
|
5167
5126
|
* ```js
|
|
5168
5127
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -5174,7 +5133,6 @@ export declare enum Action {
|
|
|
5174
5133
|
* The **Time bucket** option in the chart axis or table column
|
|
5175
5134
|
* customization menu.
|
|
5176
5135
|
* Allows defining time metric for date comparison.
|
|
5177
|
-
*
|
|
5178
5136
|
* @example
|
|
5179
5137
|
* ```js
|
|
5180
5138
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -5185,7 +5143,6 @@ export declare enum Action {
|
|
|
5185
5143
|
/**
|
|
5186
5144
|
* The **Filter** action in the chart axis or table column
|
|
5187
5145
|
* customization menu.
|
|
5188
|
-
*
|
|
5189
5146
|
* @example
|
|
5190
5147
|
* ```js
|
|
5191
5148
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -5197,7 +5154,6 @@ export declare enum Action {
|
|
|
5197
5154
|
* The **Conditional formatting** action on chart or table.
|
|
5198
5155
|
* Allows adding rules for conditional formatting of data
|
|
5199
5156
|
* points on a chart or table.
|
|
5200
|
-
*
|
|
5201
5157
|
* @example
|
|
5202
5158
|
* ```js
|
|
5203
5159
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5209,7 +5165,6 @@ export declare enum Action {
|
|
|
5209
5165
|
* The **Sort** menu action on a table or chart axis
|
|
5210
5166
|
* Sorts data in ascending or descending order.
|
|
5211
5167
|
* Allows adding, editing, or removing filters.
|
|
5212
|
-
*
|
|
5213
5168
|
* @example
|
|
5214
5169
|
* ```js
|
|
5215
5170
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5222,7 +5177,6 @@ export declare enum Action {
|
|
|
5222
5177
|
* customization menu.
|
|
5223
5178
|
* Allows grouping data points if the axes use the same
|
|
5224
5179
|
* unit of measurement and a similar scale.
|
|
5225
|
-
*
|
|
5226
5180
|
* @example
|
|
5227
5181
|
* ```js
|
|
5228
5182
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -5234,7 +5188,6 @@ export declare enum Action {
|
|
|
5234
5188
|
* The **Position** option in the axis customization menu.
|
|
5235
5189
|
* Allows changing the position of the axis to the
|
|
5236
5190
|
* left or right side of the chart.
|
|
5237
|
-
*
|
|
5238
5191
|
* @example
|
|
5239
5192
|
* ```js
|
|
5240
5193
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -5245,7 +5198,6 @@ export declare enum Action {
|
|
|
5245
5198
|
/**
|
|
5246
5199
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
5247
5200
|
* Renames the axis label on a chart or the column header on a table.
|
|
5248
|
-
*
|
|
5249
5201
|
* @example
|
|
5250
5202
|
* ```js
|
|
5251
5203
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -5257,7 +5209,6 @@ export declare enum Action {
|
|
|
5257
5209
|
* The **Edit** action in the axis customization menu.
|
|
5258
5210
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
5259
5211
|
* and format of a column.
|
|
5260
|
-
*
|
|
5261
5212
|
* @example
|
|
5262
5213
|
* ```js
|
|
5263
5214
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -5268,7 +5219,6 @@ export declare enum Action {
|
|
|
5268
5219
|
/**
|
|
5269
5220
|
* The **Number format** action to customize the format of
|
|
5270
5221
|
* the data labels on a chart or table.
|
|
5271
|
-
*
|
|
5272
5222
|
* @example
|
|
5273
5223
|
* ```js
|
|
5274
5224
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -5279,7 +5229,6 @@ export declare enum Action {
|
|
|
5279
5229
|
/**
|
|
5280
5230
|
* The **Text wrapping** action on a table.
|
|
5281
5231
|
* Wraps or clips column text on a table.
|
|
5282
|
-
*
|
|
5283
5232
|
* @example
|
|
5284
5233
|
* ```js
|
|
5285
5234
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -5292,7 +5241,6 @@ export declare enum Action {
|
|
|
5292
5241
|
* customization menu.
|
|
5293
5242
|
* Removes the data labels from a chart or the column of a
|
|
5294
5243
|
* table visualization.
|
|
5295
|
-
*
|
|
5296
5244
|
* @example
|
|
5297
5245
|
* ```js
|
|
5298
5246
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -5307,7 +5255,6 @@ export declare enum Action {
|
|
|
5307
5255
|
/**
|
|
5308
5256
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
5309
5257
|
* Allows renaming a Liveboard or visualization.
|
|
5310
|
-
*
|
|
5311
5258
|
* @example
|
|
5312
5259
|
* ```js
|
|
5313
5260
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -5351,7 +5298,6 @@ export declare enum Action {
|
|
|
5351
5298
|
/**
|
|
5352
5299
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
5353
5300
|
* Allows moving a visualization to a different tab.
|
|
5354
|
-
*
|
|
5355
5301
|
* @example
|
|
5356
5302
|
* ```js
|
|
5357
5303
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -5360,7 +5306,6 @@ export declare enum Action {
|
|
|
5360
5306
|
MoveToTab = "onContainerMove",
|
|
5361
5307
|
/**
|
|
5362
5308
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
5363
|
-
*
|
|
5364
5309
|
* @example
|
|
5365
5310
|
* ```js
|
|
5366
5311
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5369,7 +5314,6 @@ export declare enum Action {
|
|
|
5369
5314
|
ManageMonitor = "ManageMonitor",
|
|
5370
5315
|
/**
|
|
5371
5316
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5372
|
-
*
|
|
5373
5317
|
* @example
|
|
5374
5318
|
* ```js
|
|
5375
5319
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -5379,7 +5323,6 @@ export declare enum Action {
|
|
|
5379
5323
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5380
5324
|
/**
|
|
5381
5325
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
5382
|
-
*
|
|
5383
5326
|
* @example
|
|
5384
5327
|
* ```js
|
|
5385
5328
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -5391,7 +5334,6 @@ export declare enum Action {
|
|
|
5391
5334
|
* Action ID for the Parent TML action
|
|
5392
5335
|
* The parent action **TML** must be included to access TML-related options
|
|
5393
5336
|
* within the cascading menu (specific to the answer page)
|
|
5394
|
-
*
|
|
5395
5337
|
* @example
|
|
5396
5338
|
* ```js
|
|
5397
5339
|
* // to include specific TML actions
|
|
@@ -5403,13 +5345,11 @@ export declare enum Action {
|
|
|
5403
5345
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5404
5346
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5405
5347
|
* ```
|
|
5406
|
-
*
|
|
5407
|
-
* @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
|
|
5348
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5408
5349
|
*/
|
|
5409
5350
|
TML = "tml",
|
|
5410
5351
|
/**
|
|
5411
5352
|
* Action ID for to hide Verified Liveboard Banner
|
|
5412
|
-
*
|
|
5413
5353
|
* @example
|
|
5414
5354
|
* ```js
|
|
5415
5355
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -5419,7 +5359,6 @@ export declare enum Action {
|
|
|
5419
5359
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
5420
5360
|
/**
|
|
5421
5361
|
* Action ID for ask sage button
|
|
5422
|
-
*
|
|
5423
5362
|
* @example
|
|
5424
5363
|
* ```js
|
|
5425
5364
|
* hiddenAction: [Action.AskAi]
|
|
@@ -5429,7 +5368,6 @@ export declare enum Action {
|
|
|
5429
5368
|
AskAi = "AskAi",
|
|
5430
5369
|
/**
|
|
5431
5370
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
5432
|
-
*
|
|
5433
5371
|
* @example
|
|
5434
5372
|
* ```js
|
|
5435
5373
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -5439,7 +5377,6 @@ export declare enum Action {
|
|
|
5439
5377
|
AddToWatchlist = "addToWatchlist",
|
|
5440
5378
|
/**
|
|
5441
5379
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
5442
|
-
*
|
|
5443
5380
|
* @example
|
|
5444
5381
|
* ```js
|
|
5445
5382
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -5447,19 +5384,8 @@ export declare enum Action {
|
|
|
5447
5384
|
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
5448
5385
|
*/
|
|
5449
5386
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
5450
|
-
/**
|
|
5451
|
-
* The **Copy KPI Link** menu action on KPI watchlist.
|
|
5452
|
-
*
|
|
5453
|
-
* @example
|
|
5454
|
-
* ```js
|
|
5455
|
-
* disabledActions: [Action.CopyKpiLink]
|
|
5456
|
-
* ```
|
|
5457
|
-
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
5458
|
-
*/
|
|
5459
|
-
CopyKpiLink = "copyKpiLink",
|
|
5460
5387
|
/**
|
|
5461
5388
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
5462
|
-
*
|
|
5463
5389
|
* @example
|
|
5464
5390
|
* ```js
|
|
5465
5391
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -5469,7 +5395,6 @@ export declare enum Action {
|
|
|
5469
5395
|
OrganiseFavourites = "organiseFavourites",
|
|
5470
5396
|
/**
|
|
5471
5397
|
* Action ID for AI Highlights button
|
|
5472
|
-
*
|
|
5473
5398
|
* @example
|
|
5474
5399
|
* ```js
|
|
5475
5400
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -5538,7 +5463,6 @@ export interface CustomActionPayload {
|
|
|
5538
5463
|
export declare enum LogLevel {
|
|
5539
5464
|
/**
|
|
5540
5465
|
* No logs will be logged in the console.
|
|
5541
|
-
*
|
|
5542
5466
|
* @example
|
|
5543
5467
|
* ```js
|
|
5544
5468
|
* init({
|
|
@@ -5551,7 +5475,6 @@ export declare enum LogLevel {
|
|
|
5551
5475
|
SILENT = "SILENT",
|
|
5552
5476
|
/**
|
|
5553
5477
|
* Only ERROR logs will be logged in the console.
|
|
5554
|
-
*
|
|
5555
5478
|
* @example
|
|
5556
5479
|
* ```js
|
|
5557
5480
|
* init({
|
|
@@ -5564,7 +5487,6 @@ export declare enum LogLevel {
|
|
|
5564
5487
|
ERROR = "ERROR",
|
|
5565
5488
|
/**
|
|
5566
5489
|
* Only WARN and ERROR logs will be logged in the console.
|
|
5567
|
-
*
|
|
5568
5490
|
* @example
|
|
5569
5491
|
* ```js
|
|
5570
5492
|
* init({
|
|
@@ -5577,7 +5499,6 @@ export declare enum LogLevel {
|
|
|
5577
5499
|
WARN = "WARN",
|
|
5578
5500
|
/**
|
|
5579
5501
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
5580
|
-
*
|
|
5581
5502
|
* @example
|
|
5582
5503
|
* ```js
|
|
5583
5504
|
* init({
|
|
@@ -5590,7 +5511,6 @@ export declare enum LogLevel {
|
|
|
5590
5511
|
INFO = "INFO",
|
|
5591
5512
|
/**
|
|
5592
5513
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
5593
|
-
*
|
|
5594
5514
|
* @example
|
|
5595
5515
|
* ```js
|
|
5596
5516
|
* init({
|
|
@@ -5603,7 +5523,6 @@ export declare enum LogLevel {
|
|
|
5603
5523
|
DEBUG = "DEBUG",
|
|
5604
5524
|
/**
|
|
5605
5525
|
* All logs will be logged in the console.
|
|
5606
|
-
*
|
|
5607
5526
|
* @example
|
|
5608
5527
|
* ```js
|
|
5609
5528
|
* init({
|
|
@@ -5620,7 +5539,6 @@ export declare enum LogLevel {
|
|
|
5620
5539
|
* Copyright (c) 2022
|
|
5621
5540
|
*
|
|
5622
5541
|
* Base classes
|
|
5623
|
-
*
|
|
5624
5542
|
* @summary Base classes
|
|
5625
5543
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
5626
5544
|
*/
|
|
@@ -5669,19 +5587,16 @@ export declare class TsEmbed {
|
|
|
5669
5587
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
5670
5588
|
/**
|
|
5671
5589
|
* Handles errors within the SDK
|
|
5672
|
-
*
|
|
5673
5590
|
* @param error The error message or object
|
|
5674
5591
|
*/
|
|
5675
5592
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
5676
5593
|
/**
|
|
5677
5594
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
5678
|
-
*
|
|
5679
5595
|
* @param query
|
|
5680
5596
|
*/
|
|
5681
5597
|
protected getEmbedBasePath(query: string): string;
|
|
5682
5598
|
/**
|
|
5683
5599
|
* Common query params set for all the embed modes.
|
|
5684
|
-
*
|
|
5685
5600
|
* @param queryParams
|
|
5686
5601
|
* @returns queryParams
|
|
5687
5602
|
*/
|
|
@@ -5689,7 +5604,6 @@ export declare class TsEmbed {
|
|
|
5689
5604
|
/**
|
|
5690
5605
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
5691
5606
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
5692
|
-
*
|
|
5693
5607
|
* @param queryString The query string to append to the URL.
|
|
5694
5608
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
5695
5609
|
* the full application.
|
|
@@ -5702,7 +5616,6 @@ export declare class TsEmbed {
|
|
|
5702
5616
|
/**
|
|
5703
5617
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
5704
5618
|
* event listeners.
|
|
5705
|
-
*
|
|
5706
5619
|
* @param url - The URL of the embedded ThoughtSpot app.
|
|
5707
5620
|
*/
|
|
5708
5621
|
protected renderIFrame(url: string): Promise<any>;
|
|
@@ -5716,13 +5629,11 @@ export declare class TsEmbed {
|
|
|
5716
5629
|
protected insertIntoDOM(child: string | Node): void;
|
|
5717
5630
|
/**
|
|
5718
5631
|
* Sets the height of the iframe
|
|
5719
|
-
*
|
|
5720
5632
|
* @param height The height in pixels
|
|
5721
5633
|
*/
|
|
5722
5634
|
protected setIFrameHeight(height: number | string): void;
|
|
5723
5635
|
/**
|
|
5724
5636
|
* Executes all registered event handlers for a particular event type
|
|
5725
|
-
*
|
|
5726
5637
|
* @param eventType The event type
|
|
5727
5638
|
* @param data The payload invoked with the event handler
|
|
5728
5639
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -5734,7 +5645,6 @@ export declare class TsEmbed {
|
|
|
5734
5645
|
protected getThoughtSpotHost(): string;
|
|
5735
5646
|
/**
|
|
5736
5647
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
5737
|
-
*
|
|
5738
5648
|
* @param eventType The v2 event type
|
|
5739
5649
|
* @returns The corresponding v1 event type if one exists
|
|
5740
5650
|
* or else the v2 event type itself
|
|
@@ -5744,7 +5654,6 @@ export declare class TsEmbed {
|
|
|
5744
5654
|
* Calculates the iframe center for the current visible viewPort
|
|
5745
5655
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
5746
5656
|
* in Host app. ViewPort height of the tab.
|
|
5747
|
-
*
|
|
5748
5657
|
* @returns iframe Center in visible viewport,
|
|
5749
5658
|
* Iframe height,
|
|
5750
5659
|
* View port height.
|
|
@@ -5759,7 +5668,6 @@ export declare class TsEmbed {
|
|
|
5759
5668
|
/**
|
|
5760
5669
|
* Registers an event listener to trigger an alert when the ThoughtSpot app
|
|
5761
5670
|
* sends an event of a particular message type to the host application.
|
|
5762
|
-
*
|
|
5763
5671
|
* @param messageType The message type
|
|
5764
5672
|
* @param callback A callback as a function
|
|
5765
5673
|
* @param options The message options
|
|
@@ -5783,7 +5691,6 @@ export declare class TsEmbed {
|
|
|
5783
5691
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
|
|
5784
5692
|
/**
|
|
5785
5693
|
* Removes an event listener for a particular event type.
|
|
5786
|
-
*
|
|
5787
5694
|
* @param messageType The message type
|
|
5788
5695
|
* @param callback The callback to remove
|
|
5789
5696
|
* @example
|
|
@@ -5796,7 +5703,6 @@ export declare class TsEmbed {
|
|
|
5796
5703
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
5797
5704
|
/**
|
|
5798
5705
|
* Triggers an event to the embedded app
|
|
5799
|
-
*
|
|
5800
5706
|
* @param messageType The event type
|
|
5801
5707
|
* @param data The payload to send with the message
|
|
5802
5708
|
*/
|
|
@@ -5805,7 +5711,6 @@ export declare class TsEmbed {
|
|
|
5805
5711
|
* Marks the ThoughtSpot object to have been rendered
|
|
5806
5712
|
* Needs to be overridden by subclasses to do the actual
|
|
5807
5713
|
* rendering of the iframe.
|
|
5808
|
-
*
|
|
5809
5714
|
* @param args
|
|
5810
5715
|
*/
|
|
5811
5716
|
render(): Promise<TsEmbed>;
|
|
@@ -5813,7 +5718,6 @@ export declare class TsEmbed {
|
|
|
5813
5718
|
protected handleRenderForPrerender(): void;
|
|
5814
5719
|
/**
|
|
5815
5720
|
* Creates the preRender shell
|
|
5816
|
-
*
|
|
5817
5721
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
5818
5722
|
*/
|
|
5819
5723
|
preRender(showPreRenderByDefault?: boolean): TsEmbed;
|
|
@@ -5821,13 +5725,11 @@ export declare class TsEmbed {
|
|
|
5821
5725
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
5822
5726
|
* host app URL.
|
|
5823
5727
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
5824
|
-
*
|
|
5825
5728
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
5826
5729
|
*/
|
|
5827
5730
|
getThoughtSpotPostUrlParams(): string;
|
|
5828
5731
|
/**
|
|
5829
5732
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
5830
|
-
*
|
|
5831
5733
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
5832
5734
|
*/
|
|
5833
5735
|
destroy(): void;
|
|
@@ -5836,7 +5738,6 @@ export declare class TsEmbed {
|
|
|
5836
5738
|
* Prerenders a generic instance of the TS component.
|
|
5837
5739
|
* This means without the path but with the flags already applied.
|
|
5838
5740
|
* This is useful for prerendering the component in the background.
|
|
5839
|
-
*
|
|
5840
5741
|
* @version SDK: 1.22.0
|
|
5841
5742
|
* @returns
|
|
5842
5743
|
*/
|
|
@@ -5854,7 +5755,6 @@ export declare class TsEmbed {
|
|
|
5854
5755
|
* element. This function adjusts the position, width, and height of the PreRender
|
|
5855
5756
|
* component
|
|
5856
5757
|
* to match the dimensions and position of the embedding element.
|
|
5857
|
-
*
|
|
5858
5758
|
* @throws {Error} Throws an error if the embedding element (passed as domSelector)
|
|
5859
5759
|
* is not defined or not found.
|
|
5860
5760
|
*/
|
|
@@ -5867,7 +5767,6 @@ export declare class TsEmbed {
|
|
|
5867
5767
|
/**
|
|
5868
5768
|
* Retrieves unique HTML element IDs for PreRender-related elements.
|
|
5869
5769
|
* These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
|
|
5870
|
-
*
|
|
5871
5770
|
* @returns {object} An object containing the IDs for the PreRender elements.
|
|
5872
5771
|
* @property {string} wrapper - The HTML element ID for the PreRender wrapper.
|
|
5873
5772
|
* @property {string} child - The HTML element ID for the PreRender child.
|
|
@@ -5879,7 +5778,6 @@ export declare class TsEmbed {
|
|
|
5879
5778
|
/**
|
|
5880
5779
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
5881
5780
|
* session.
|
|
5882
|
-
*
|
|
5883
5781
|
* @param vizId [Optional] to get for a specific viz in case of a liveboard.
|
|
5884
5782
|
* @version SDK: 1.25.0 / ThoughtSpot 9.10.0
|
|
5885
5783
|
*/
|
|
@@ -5889,7 +5787,6 @@ export declare class TsEmbed {
|
|
|
5889
5787
|
* Base class for embedding v1 experience
|
|
5890
5788
|
* Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
|
|
5891
5789
|
* which is currently under migration to v2
|
|
5892
|
-
*
|
|
5893
5790
|
* @inheritdoc
|
|
5894
5791
|
*/
|
|
5895
5792
|
export declare class V1Embed extends TsEmbed {
|
|
@@ -5897,7 +5794,6 @@ export declare class V1Embed extends TsEmbed {
|
|
|
5897
5794
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
5898
5795
|
/**
|
|
5899
5796
|
* Render the app in an iframe and set up event handlers
|
|
5900
|
-
*
|
|
5901
5797
|
* @param iframeSrc
|
|
5902
5798
|
*/
|
|
5903
5799
|
protected renderV1Embed(iframeSrc: string): Promise<any>;
|
|
@@ -5947,7 +5843,6 @@ export declare const handleAuth: () => Promise<boolean>;
|
|
|
5947
5843
|
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
5948
5844
|
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
5949
5845
|
* to your app.
|
|
5950
|
-
*
|
|
5951
5846
|
* @param url The URL provided for prefetch
|
|
5952
5847
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
5953
5848
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -5959,7 +5854,6 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
|
|
|
5959
5854
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
5960
5855
|
* component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
|
|
5961
5856
|
* to actually embed. That is handled internally.
|
|
5962
|
-
*
|
|
5963
5857
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
5964
5858
|
* authentication mechanism and so on.
|
|
5965
5859
|
* @example
|
|
@@ -5986,7 +5880,6 @@ export declare function disableAutoLogin(): void;
|
|
|
5986
5880
|
*
|
|
5987
5881
|
* You can call the `init` method again to re login, if autoLogin is set to
|
|
5988
5882
|
* true in this second call it will be honored.
|
|
5989
|
-
*
|
|
5990
5883
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
5991
5884
|
* @returns Promise which resolves when logout completes.
|
|
5992
5885
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
@@ -5996,13 +5889,11 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
5996
5889
|
/**
|
|
5997
5890
|
* Renders functions in a queue, resolves to next function only after the callback next
|
|
5998
5891
|
* is called
|
|
5999
|
-
*
|
|
6000
5892
|
* @param fn The function being registered
|
|
6001
5893
|
*/
|
|
6002
5894
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
6003
5895
|
/**
|
|
6004
5896
|
* Imports TML representation of the metadata objects into ThoughtSpot.
|
|
6005
|
-
*
|
|
6006
5897
|
* @param data
|
|
6007
5898
|
* @example
|
|
6008
5899
|
* ```js
|
|
@@ -6027,7 +5918,6 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
6027
5918
|
/**
|
|
6028
5919
|
* Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
|
|
6029
5920
|
* format.
|
|
6030
|
-
*
|
|
6031
5921
|
* @param data
|
|
6032
5922
|
* @example
|
|
6033
5923
|
* ```js
|
|
@@ -6064,10 +5954,15 @@ export declare let loggedInStatus: boolean;
|
|
|
6064
5954
|
export declare let samlAuthWindow: Window;
|
|
6065
5955
|
export declare let samlCompletionPromise: Promise<void>;
|
|
6066
5956
|
export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
|
|
5957
|
+
interface sessionInfoInterface {
|
|
5958
|
+
userGUID: any;
|
|
5959
|
+
isPublicUser: any;
|
|
5960
|
+
mixpanelToken: any;
|
|
5961
|
+
[key: string]: any;
|
|
5962
|
+
}
|
|
6067
5963
|
/**
|
|
6068
5964
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
6069
5965
|
* of {@link AuthStatus.FAILURE}.
|
|
6070
|
-
*
|
|
6071
5966
|
* @group Authentication / Init
|
|
6072
5967
|
*/
|
|
6073
5968
|
export declare enum AuthFailureType {
|
|
@@ -6078,7 +5973,6 @@ export declare enum AuthFailureType {
|
|
|
6078
5973
|
}
|
|
6079
5974
|
/**
|
|
6080
5975
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
6081
|
-
*
|
|
6082
5976
|
* @group Authentication / Init
|
|
6083
5977
|
*/
|
|
6084
5978
|
export declare enum AuthStatus {
|
|
@@ -6102,27 +5996,23 @@ export declare enum AuthStatus {
|
|
|
6102
5996
|
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
6103
5997
|
* popup is waiting to be triggered either programmatically
|
|
6104
5998
|
* or by the trigger button.
|
|
6105
|
-
*
|
|
6106
5999
|
* @version SDK: 1.19.0
|
|
6107
6000
|
*/
|
|
6108
6001
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
6109
6002
|
}
|
|
6110
6003
|
/**
|
|
6111
6004
|
* Event emitter returned from {@link init}.
|
|
6112
|
-
*
|
|
6113
6005
|
* @group Authentication / Init
|
|
6114
6006
|
*/
|
|
6115
6007
|
export interface AuthEventEmitter {
|
|
6116
6008
|
/**
|
|
6117
6009
|
* Register a listener on Auth failure.
|
|
6118
|
-
*
|
|
6119
6010
|
* @param event
|
|
6120
6011
|
* @param listener
|
|
6121
6012
|
*/
|
|
6122
6013
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
6123
6014
|
/**
|
|
6124
6015
|
* Register a listener on Auth SDK success.
|
|
6125
|
-
*
|
|
6126
6016
|
* @param event
|
|
6127
6017
|
* @param listener
|
|
6128
6018
|
*/
|
|
@@ -6133,13 +6023,11 @@ export interface AuthEventEmitter {
|
|
|
6133
6023
|
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
6134
6024
|
/**
|
|
6135
6025
|
* Trigger an event on the emitter returned from init.
|
|
6136
|
-
*
|
|
6137
6026
|
* @param {@link AuthEvent}
|
|
6138
6027
|
*/
|
|
6139
6028
|
emit(event: AuthEvent, ...args: any[]): boolean;
|
|
6140
6029
|
/**
|
|
6141
6030
|
* Remove listener from the emitter returned from init.
|
|
6142
|
-
*
|
|
6143
6031
|
* @param event
|
|
6144
6032
|
* @param listener
|
|
6145
6033
|
* @param context
|
|
@@ -6148,14 +6036,12 @@ export interface AuthEventEmitter {
|
|
|
6148
6036
|
off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
|
|
6149
6037
|
/**
|
|
6150
6038
|
* Remove all the event listeners
|
|
6151
|
-
*
|
|
6152
6039
|
* @param event
|
|
6153
6040
|
*/
|
|
6154
6041
|
removeAllListeners(event: AuthStatus): this;
|
|
6155
6042
|
}
|
|
6156
6043
|
/**
|
|
6157
6044
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
6158
|
-
*
|
|
6159
6045
|
* @group Authentication / Init
|
|
6160
6046
|
*/
|
|
6161
6047
|
export declare enum AuthEvent {
|
|
@@ -6181,7 +6067,7 @@ export declare function notifyAuthSDKSuccess(): void;
|
|
|
6181
6067
|
/**
|
|
6182
6068
|
*
|
|
6183
6069
|
*/
|
|
6184
|
-
export declare function notifyAuthSuccess():
|
|
6070
|
+
export declare function notifyAuthSuccess(): void;
|
|
6185
6071
|
/**
|
|
6186
6072
|
*
|
|
6187
6073
|
* @param failureType
|
|
@@ -6191,32 +6077,25 @@ export declare function notifyAuthFailure(failureType: AuthFailureType): void;
|
|
|
6191
6077
|
*
|
|
6192
6078
|
*/
|
|
6193
6079
|
export declare function notifyLogout(): void;
|
|
6194
|
-
|
|
6195
|
-
|
|
6196
|
-
* This should be called after the cookie is set for cookie auth or
|
|
6197
|
-
* after the token is set for cookieless.
|
|
6198
|
-
*
|
|
6199
|
-
* @return {Promise<void>}
|
|
6200
|
-
* @example
|
|
6201
|
-
* ```js
|
|
6202
|
-
* await postLoginService();
|
|
6203
|
-
* ```
|
|
6204
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
6205
|
-
*/
|
|
6206
|
-
export declare function postLoginService(): Promise<void>;
|
|
6080
|
+
export declare const initSession: (sessionDetails: sessionInfoInterface) => void;
|
|
6081
|
+
export declare const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
|
|
6207
6082
|
/**
|
|
6208
6083
|
* Return releaseVersion if available
|
|
6209
6084
|
*/
|
|
6210
6085
|
export declare function getReleaseVersion(): string;
|
|
6086
|
+
/**
|
|
6087
|
+
* Return a promise that resolves with the session information when
|
|
6088
|
+
* authentication is successful. And info is available.
|
|
6089
|
+
* @group Global methods
|
|
6090
|
+
*/
|
|
6091
|
+
export declare function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
6211
6092
|
/**
|
|
6212
6093
|
* Perform token based authentication
|
|
6213
|
-
*
|
|
6214
6094
|
* @param embedConfig The embed configuration
|
|
6215
6095
|
*/
|
|
6216
6096
|
export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
6217
6097
|
/**
|
|
6218
6098
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
6219
|
-
*
|
|
6220
6099
|
* @param embedConfig The embed configuration
|
|
6221
6100
|
*/
|
|
6222
6101
|
export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -6226,7 +6105,6 @@ export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promis
|
|
|
6226
6105
|
*
|
|
6227
6106
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
6228
6107
|
* strongly advised not to use this authentication method in production.
|
|
6229
|
-
*
|
|
6230
6108
|
* @param embedConfig The embed configuration
|
|
6231
6109
|
*/
|
|
6232
6110
|
export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -6235,7 +6113,6 @@ export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
6235
6113
|
export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
6236
6114
|
/**
|
|
6237
6115
|
* Perform authentication on the ThoughtSpot cluster
|
|
6238
|
-
*
|
|
6239
6116
|
* @param embedConfig The embed configuration
|
|
6240
6117
|
*/
|
|
6241
6118
|
export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -6243,72 +6120,7 @@ export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean
|
|
|
6243
6120
|
* Check if we are authenticated to the ThoughtSpot cluster
|
|
6244
6121
|
*/
|
|
6245
6122
|
export declare const isAuthenticated: () => boolean;
|
|
6246
|
-
|
|
6247
|
-
export type SessionInfo = {
|
|
6248
|
-
releaseVersion: string;
|
|
6249
|
-
userGUID: string;
|
|
6250
|
-
currentOrgId: number;
|
|
6251
|
-
privileges: string[];
|
|
6252
|
-
mixpanelToken: string;
|
|
6253
|
-
isPublicUser: boolean;
|
|
6254
|
-
clusterId: string;
|
|
6255
|
-
clusterName: string;
|
|
6256
|
-
[key: string]: any;
|
|
6257
|
-
};
|
|
6258
|
-
/**
|
|
6259
|
-
* Returns the session info object and caches it for future use.
|
|
6260
|
-
* Once fetched the session info object is cached and returned from the cache on
|
|
6261
|
-
* subsequent calls.
|
|
6262
|
-
*
|
|
6263
|
-
* @example ```js
|
|
6264
|
-
* const sessionInfo = await getSessionInfo();
|
|
6265
|
-
* console.log(sessionInfo);
|
|
6266
|
-
* ```
|
|
6267
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
6268
|
-
* @returns {Promise<SessionInfo>} The session info object.
|
|
6269
|
-
*/
|
|
6270
|
-
export declare function getSessionInfo(): Promise<SessionInfo>;
|
|
6271
|
-
/**
|
|
6272
|
-
* Returns the cached session info object. If the client is not authenticated the
|
|
6273
|
-
* function will return null.
|
|
6274
|
-
*
|
|
6275
|
-
* @example ```js
|
|
6276
|
-
* const sessionInfo = getCachedSessionInfo();
|
|
6277
|
-
* if (sessionInfo) {
|
|
6278
|
-
* console.log(sessionInfo);
|
|
6279
|
-
* } else {
|
|
6280
|
-
* console.log('Not authenticated');
|
|
6281
|
-
* }
|
|
6282
|
-
* ```
|
|
6283
|
-
* @returns {SessionInfo | null} The session info object.
|
|
6284
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
6285
|
-
*/
|
|
6286
|
-
export declare function getCachedSessionInfo(): SessionInfo | null;
|
|
6287
|
-
/**
|
|
6288
|
-
* Processes the session info response and returns the session info object.
|
|
6289
|
-
*
|
|
6290
|
-
* @param sessionInfoResp {any} Response from the session info API.
|
|
6291
|
-
* @returns {SessionInfo} The session info object.
|
|
6292
|
-
* @example ```js
|
|
6293
|
-
* const sessionInfoResp = await fetch(sessionInfoPath);
|
|
6294
|
-
* const sessionInfo = getSessionDetails(sessionInfoResp);
|
|
6295
|
-
* console.log(sessionInfo);
|
|
6296
|
-
* ```
|
|
6297
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
6298
|
-
*/
|
|
6299
|
-
export declare const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
|
|
6300
|
-
/**
|
|
6301
|
-
* Resets the cached session info object and forces a new fetch on the next call.
|
|
6302
|
-
*
|
|
6303
|
-
* @example ```js
|
|
6304
|
-
* resetCachedSessionInfo();
|
|
6305
|
-
* const sessionInfo = await getSessionInfo();
|
|
6306
|
-
* console.log(sessionInfo);
|
|
6307
|
-
* ```
|
|
6308
|
-
* @version SDK: 1.28.3 | ThoughtSpot ts7.april.cl, 7.2.1
|
|
6309
|
-
* @returns {void}
|
|
6310
|
-
*/
|
|
6311
|
-
export declare function resetCachedSessionInfo(): void;
|
|
6123
|
+
export {};
|
|
6312
6124
|
|
|
6313
6125
|
/**
|
|
6314
6126
|
* The list of customization css variables. These
|
|
@@ -6672,7 +6484,6 @@ export interface UnderlyingDataPoint {
|
|
|
6672
6484
|
* custom action payload. This service could be used to run
|
|
6673
6485
|
* graphql queries in the context of the answer on which the
|
|
6674
6486
|
* custom action was triggered.
|
|
6675
|
-
*
|
|
6676
6487
|
* @example
|
|
6677
6488
|
* ```js
|
|
6678
6489
|
* embed.on(EmbedEvent.CustomAction, e => {
|
|
@@ -6682,13 +6493,22 @@ export interface UnderlyingDataPoint {
|
|
|
6682
6493
|
* const data = await underlying.fetchData(0, 100);
|
|
6683
6494
|
* })
|
|
6684
6495
|
* ```
|
|
6496
|
+
* @example
|
|
6497
|
+
* ```js
|
|
6498
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6499
|
+
* const service = await embed.getAnswerService();
|
|
6500
|
+
* await service.addColumns([
|
|
6501
|
+
* "<column guid>"
|
|
6502
|
+
* ]);
|
|
6503
|
+
* console.log(await service.fetchData());
|
|
6504
|
+
* });
|
|
6505
|
+
* ```
|
|
6685
6506
|
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
6686
6507
|
* @group Events
|
|
6687
6508
|
*/
|
|
6688
6509
|
export declare class AnswerService {
|
|
6689
6510
|
/**
|
|
6690
6511
|
* Should not need to be called directly.
|
|
6691
|
-
*
|
|
6692
6512
|
* @param session
|
|
6693
6513
|
* @param answer
|
|
6694
6514
|
* @param thoughtSpotHost
|
|
@@ -6702,21 +6522,42 @@ export declare class AnswerService {
|
|
|
6702
6522
|
getSourceDetail(): Promise<any>;
|
|
6703
6523
|
/**
|
|
6704
6524
|
* Remove columnIds and return updated answer session.
|
|
6705
|
-
*
|
|
6706
6525
|
* @param columnIds
|
|
6707
6526
|
* @returns
|
|
6708
6527
|
*/
|
|
6709
6528
|
removeColumns(columnIds: string[]): Promise<any>;
|
|
6710
6529
|
/**
|
|
6711
6530
|
* Add columnIds and return updated answer session.
|
|
6712
|
-
*
|
|
6713
6531
|
* @param columnIds
|
|
6714
6532
|
* @returns
|
|
6715
6533
|
*/
|
|
6716
6534
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6535
|
+
/**
|
|
6536
|
+
* Add columns by names and return updated answer session.
|
|
6537
|
+
* @param columnNames
|
|
6538
|
+
* @returns
|
|
6539
|
+
* @example
|
|
6540
|
+
* ```js
|
|
6541
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6542
|
+
* const service = await embed.getAnswerService();
|
|
6543
|
+
* await service.addColumnsByNames([
|
|
6544
|
+
* "col name 1",
|
|
6545
|
+
* "col name 2"
|
|
6546
|
+
* ]);
|
|
6547
|
+
* console.log(await service.fetchData());
|
|
6548
|
+
* });
|
|
6549
|
+
*/
|
|
6550
|
+
addColumnsByNames(columnNames: string[]): Promise<any>;
|
|
6551
|
+
/**
|
|
6552
|
+
* Add a filter to the answer.
|
|
6553
|
+
* @param columnName
|
|
6554
|
+
* @param operator
|
|
6555
|
+
* @param values
|
|
6556
|
+
* @returns
|
|
6557
|
+
*/
|
|
6558
|
+
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6717
6559
|
/**
|
|
6718
6560
|
* Fetch data from the answer.
|
|
6719
|
-
*
|
|
6720
6561
|
* @param offset
|
|
6721
6562
|
* @param size
|
|
6722
6563
|
* @returns
|
|
@@ -6728,7 +6569,6 @@ export declare class AnswerService {
|
|
|
6728
6569
|
/**
|
|
6729
6570
|
* Fetch the data for the answer as a CSV blob. This might be
|
|
6730
6571
|
* quicker for larger data.
|
|
6731
|
-
*
|
|
6732
6572
|
* @param userLocale
|
|
6733
6573
|
* @param includeInfo Include the CSV header in the output
|
|
6734
6574
|
* @returns Response
|
|
@@ -6737,7 +6577,6 @@ export declare class AnswerService {
|
|
|
6737
6577
|
/**
|
|
6738
6578
|
* Just get the internal URL for this answer's data
|
|
6739
6579
|
* as a CSV blob.
|
|
6740
|
-
*
|
|
6741
6580
|
* @param userLocale
|
|
6742
6581
|
* @param includeInfo
|
|
6743
6582
|
* @returns
|
|
@@ -6747,7 +6586,6 @@ export declare class AnswerService {
|
|
|
6747
6586
|
* Get underlying data given a point and the output column names.
|
|
6748
6587
|
* In case of a context menu action, the selectedPoints are
|
|
6749
6588
|
* automatically passed.
|
|
6750
|
-
*
|
|
6751
6589
|
* @param outputColumnNames
|
|
6752
6590
|
* @param selectedPoints
|
|
6753
6591
|
* @example
|
|
@@ -6764,7 +6602,6 @@ export declare class AnswerService {
|
|
|
6764
6602
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
6765
6603
|
/**
|
|
6766
6604
|
* Execute a custom graphql query in the context of the answer.
|
|
6767
|
-
*
|
|
6768
6605
|
* @param query graphql query
|
|
6769
6606
|
* @param variables graphql variables
|
|
6770
6607
|
* @returns
|
|
@@ -6772,15 +6609,14 @@ export declare class AnswerService {
|
|
|
6772
6609
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
6773
6610
|
/**
|
|
6774
6611
|
* Get the internal session details for the answer.
|
|
6775
|
-
*
|
|
6776
6612
|
* @returns
|
|
6777
6613
|
*/
|
|
6778
6614
|
getSession(): SessionInterface;
|
|
6615
|
+
getAnswer(): Promise<any>;
|
|
6779
6616
|
}
|
|
6780
6617
|
|
|
6781
6618
|
/**
|
|
6782
6619
|
* Gets the configuration embed was initialized with.
|
|
6783
|
-
*
|
|
6784
6620
|
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
6785
6621
|
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
6786
6622
|
* @group Global methods
|
|
@@ -6789,7 +6625,6 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
6789
6625
|
/**
|
|
6790
6626
|
* Sets the configuration embed was initialized with.
|
|
6791
6627
|
* And returns the new configuration.
|
|
6792
|
-
*
|
|
6793
6628
|
* @param newConfig The configuration to set.
|
|
6794
6629
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
6795
6630
|
* @group Global methods
|
|
@@ -6812,7 +6647,6 @@ export declare const MIXPANEL_EVENT: {
|
|
|
6812
6647
|
};
|
|
6813
6648
|
/**
|
|
6814
6649
|
* Pushes the event with its Property key-value map to mixpanel.
|
|
6815
|
-
*
|
|
6816
6650
|
* @param eventId
|
|
6817
6651
|
* @param eventProps
|
|
6818
6652
|
*/
|
|
@@ -6821,7 +6655,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
|
|
|
6821
6655
|
*
|
|
6822
6656
|
* @param sessionInfo
|
|
6823
6657
|
*/
|
|
6824
|
-
export declare function initMixpanel(sessionInfo:
|
|
6658
|
+
export declare function initMixpanel(sessionInfo: any): void;
|
|
6825
6659
|
/**
|
|
6826
6660
|
*
|
|
6827
6661
|
*/
|
|
@@ -6830,7 +6664,6 @@ export declare function testResetMixpanel(): void;
|
|
|
6830
6664
|
/**
|
|
6831
6665
|
* Fetch wrapper that adds the authentication token to the request.
|
|
6832
6666
|
* Use this to call the ThoughtSpot APIs when using the visual embed sdk.
|
|
6833
|
-
*
|
|
6834
6667
|
* @param input
|
|
6835
6668
|
* @param init
|
|
6836
6669
|
* @version SDK: 1.28.0
|
|
@@ -6838,15 +6671,14 @@ export declare function testResetMixpanel(): void;
|
|
|
6838
6671
|
*/
|
|
6839
6672
|
export declare const tokenizedFetch: typeof fetch;
|
|
6840
6673
|
|
|
6841
|
-
export declare
|
|
6674
|
+
export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
|
|
6842
6675
|
/**
|
|
6843
6676
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
6844
|
-
*
|
|
6845
6677
|
* @example
|
|
6846
6678
|
* ```js
|
|
6847
6679
|
* resetCachedAuthToken();
|
|
6848
6680
|
* ```
|
|
6849
|
-
* @version SDK: 1.28.
|
|
6681
|
+
* @version SDK: 1.28.2 | ThoughtSpot: *
|
|
6850
6682
|
* @group Authentication / Init
|
|
6851
6683
|
*/
|
|
6852
6684
|
export declare const resetCachedAuthToken: () => void;
|