@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
package/dist/src/types.d.ts
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
* Copyright (c) 2023
|
|
3
3
|
*
|
|
4
4
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
5
|
-
*
|
|
6
5
|
* @summary Type definitions for Embed SDK
|
|
7
6
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
8
7
|
*/
|
|
@@ -11,14 +10,12 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
|
|
|
11
10
|
/**
|
|
12
11
|
* The authentication mechanism for allowing access to the
|
|
13
12
|
* the embedded app
|
|
14
|
-
*
|
|
15
13
|
* @group Authentication / Init
|
|
16
14
|
*/
|
|
17
15
|
export declare enum AuthType {
|
|
18
16
|
/**
|
|
19
17
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
20
18
|
* `Passthrough`.
|
|
21
|
-
*
|
|
22
19
|
* @example
|
|
23
20
|
* ```js
|
|
24
21
|
* init({
|
|
@@ -36,7 +33,6 @@ export declare enum AuthType {
|
|
|
36
33
|
* To use this:
|
|
37
34
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
38
35
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
39
|
-
*
|
|
40
36
|
* @example
|
|
41
37
|
* ```js
|
|
42
38
|
* init({
|
|
@@ -49,14 +45,12 @@ export declare enum AuthType {
|
|
|
49
45
|
EmbeddedSSO = "EmbeddedSSO",
|
|
50
46
|
/**
|
|
51
47
|
* SSO using SAML
|
|
52
|
-
*
|
|
53
48
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
54
49
|
* @hidden
|
|
55
50
|
*/
|
|
56
51
|
SSO = "SSO_SAML",
|
|
57
52
|
/**
|
|
58
53
|
* SSO using SAML
|
|
59
|
-
*
|
|
60
54
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
61
55
|
* @hidden
|
|
62
56
|
*/
|
|
@@ -68,7 +62,6 @@ export declare enum AuthType {
|
|
|
68
62
|
*
|
|
69
63
|
* This redirects the host application to the SAML IdP. The host application
|
|
70
64
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
71
|
-
*
|
|
72
65
|
* @example
|
|
73
66
|
* ```js
|
|
74
67
|
* init({
|
|
@@ -109,7 +102,6 @@ export declare enum AuthType {
|
|
|
109
102
|
SAMLRedirect = "SSO_SAML",
|
|
110
103
|
/**
|
|
111
104
|
* SSO using OIDC
|
|
112
|
-
*
|
|
113
105
|
* @hidden
|
|
114
106
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
115
107
|
*/
|
|
@@ -122,7 +114,6 @@ export declare enum AuthType {
|
|
|
122
114
|
OIDCRedirect = "SSO_OIDC",
|
|
123
115
|
/**
|
|
124
116
|
* Trusted authentication server
|
|
125
|
-
*
|
|
126
117
|
* @hidden
|
|
127
118
|
* @deprecated Use {@link TrustedAuth} instead
|
|
128
119
|
*/
|
|
@@ -131,7 +122,6 @@ export declare enum AuthType {
|
|
|
131
122
|
* Trusted authentication server. Use your own authentication server
|
|
132
123
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
133
124
|
* from ThoughtSpot.
|
|
134
|
-
*
|
|
135
125
|
* @example
|
|
136
126
|
* ```js
|
|
137
127
|
* init({
|
|
@@ -143,6 +133,7 @@ export declare enum AuthType {
|
|
|
143
133
|
* .then((data) => data.token);
|
|
144
134
|
* }
|
|
145
135
|
* });
|
|
136
|
+
* });
|
|
146
137
|
* ```
|
|
147
138
|
*/
|
|
148
139
|
TrustedAuthToken = "AuthServer",
|
|
@@ -152,7 +143,6 @@ export declare enum AuthType {
|
|
|
152
143
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
153
144
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
154
145
|
* implemented by some browsers.
|
|
155
|
-
*
|
|
156
146
|
* @example
|
|
157
147
|
* ```js
|
|
158
148
|
* init({
|
|
@@ -225,7 +215,6 @@ export interface customCssInterface {
|
|
|
225
215
|
/**
|
|
226
216
|
* Can be used to define a custom font face
|
|
227
217
|
* like:
|
|
228
|
-
*
|
|
229
218
|
* @example
|
|
230
219
|
* ```js
|
|
231
220
|
* rules_UNSTABLE?: {
|
|
@@ -265,7 +254,6 @@ export interface CustomStyles {
|
|
|
265
254
|
* Thoughtspot components.
|
|
266
255
|
* You can customize styles, text strings, and icons.
|
|
267
256
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
268
|
-
*
|
|
269
257
|
* @example
|
|
270
258
|
* ```js
|
|
271
259
|
* init({
|
|
@@ -308,7 +296,6 @@ export interface CustomisationsInterface {
|
|
|
308
296
|
* It includes the ThoughtSpot hostname or IP address,
|
|
309
297
|
* the type of authentication, and the authentication endpoint
|
|
310
298
|
* if a trusted authentication server is used.
|
|
311
|
-
*
|
|
312
299
|
* @group Authentication / Init
|
|
313
300
|
*/
|
|
314
301
|
export interface EmbedConfig {
|
|
@@ -356,7 +343,6 @@ export interface EmbedConfig {
|
|
|
356
343
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
357
344
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
358
345
|
* place.
|
|
359
|
-
*
|
|
360
346
|
* @default false
|
|
361
347
|
* @deprecated
|
|
362
348
|
*/
|
|
@@ -367,7 +353,6 @@ export interface EmbedConfig {
|
|
|
367
353
|
*
|
|
368
354
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
369
355
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
370
|
-
*
|
|
371
356
|
* @default false
|
|
372
357
|
* @version SDK: 1.18.0
|
|
373
358
|
*/
|
|
@@ -378,7 +363,6 @@ export interface EmbedConfig {
|
|
|
378
363
|
* terminated.
|
|
379
364
|
*
|
|
380
365
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
381
|
-
*
|
|
382
366
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
383
367
|
*/
|
|
384
368
|
redirectPath?: string;
|
|
@@ -388,7 +372,6 @@ export interface EmbedConfig {
|
|
|
388
372
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
389
373
|
* should be encoded in base64. This provides additional security to
|
|
390
374
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
391
|
-
*
|
|
392
375
|
* @default false
|
|
393
376
|
*/
|
|
394
377
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -398,7 +381,6 @@ export interface EmbedConfig {
|
|
|
398
381
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
399
382
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
400
383
|
* in this case.
|
|
401
|
-
*
|
|
402
384
|
* @default false
|
|
403
385
|
*/
|
|
404
386
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -406,14 +388,12 @@ export interface EmbedConfig {
|
|
|
406
388
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
407
389
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
408
390
|
* persists even in the case of a non-logged-in user.
|
|
409
|
-
*
|
|
410
391
|
* @default false
|
|
411
392
|
*/
|
|
412
393
|
ignoreNoCookieAccess?: boolean;
|
|
413
394
|
/**
|
|
414
395
|
* Re-login a user with the previous login options
|
|
415
396
|
* when a user session expires.
|
|
416
|
-
*
|
|
417
397
|
* @default false
|
|
418
398
|
*/
|
|
419
399
|
autoLogin?: boolean;
|
|
@@ -422,20 +402,17 @@ export interface EmbedConfig {
|
|
|
422
402
|
* This flag is typically used alongside the combination of authentication modes such
|
|
423
403
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
424
404
|
* EmbedConfig.autoLogin}
|
|
425
|
-
*
|
|
426
405
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
427
406
|
* @default false
|
|
428
407
|
*/
|
|
429
408
|
disableLoginRedirect?: boolean;
|
|
430
409
|
/**
|
|
431
410
|
* This message is displayed in the embedded view when a user login fails.
|
|
432
|
-
*
|
|
433
411
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
434
412
|
*/
|
|
435
413
|
loginFailedMessage?: string;
|
|
436
414
|
/**
|
|
437
415
|
* Calls the prefetch method internally when set to `true`
|
|
438
|
-
*
|
|
439
416
|
* @default false
|
|
440
417
|
*/
|
|
441
418
|
callPrefetch?: boolean;
|
|
@@ -443,7 +420,6 @@ export interface EmbedConfig {
|
|
|
443
420
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
444
421
|
* to start after the previous embed's render is complete. This helps improve
|
|
445
422
|
* performance by decreasing the load on the browser.
|
|
446
|
-
*
|
|
447
423
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
448
424
|
* @default false
|
|
449
425
|
*/
|
|
@@ -451,7 +427,6 @@ export interface EmbedConfig {
|
|
|
451
427
|
/**
|
|
452
428
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
453
429
|
* You would also need to set `style-src` in the CSP settings.
|
|
454
|
-
*
|
|
455
430
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
456
431
|
* @default ''
|
|
457
432
|
*/
|
|
@@ -463,13 +438,11 @@ export interface EmbedConfig {
|
|
|
463
438
|
*
|
|
464
439
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
465
440
|
* involves an extra network call.
|
|
466
|
-
*
|
|
467
441
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
468
442
|
*/
|
|
469
443
|
detectCookieAccessSlow?: boolean;
|
|
470
444
|
/**
|
|
471
445
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
472
|
-
*
|
|
473
446
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
474
447
|
*/
|
|
475
448
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -480,7 +453,6 @@ export interface EmbedConfig {
|
|
|
480
453
|
suppressSageEmbedBetaWarning?: boolean;
|
|
481
454
|
/**
|
|
482
455
|
* Custom style params for embed Config.
|
|
483
|
-
*
|
|
484
456
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
485
457
|
*/
|
|
486
458
|
customizations?: CustomisationsInterface;
|
|
@@ -488,7 +460,6 @@ export interface EmbedConfig {
|
|
|
488
460
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
489
461
|
* button that the user can click to trigger the flow.
|
|
490
462
|
* This attribute sets a containing element for that button.
|
|
491
|
-
*
|
|
492
463
|
* @example
|
|
493
464
|
* ```js
|
|
494
465
|
* init({
|
|
@@ -510,7 +481,6 @@ export interface EmbedConfig {
|
|
|
510
481
|
/**
|
|
511
482
|
* Text to show in the button which triggers the popup auth flow.
|
|
512
483
|
* Default: `Authorize`.
|
|
513
|
-
*
|
|
514
484
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
515
485
|
*/
|
|
516
486
|
authTriggerText?: string;
|
|
@@ -518,14 +488,12 @@ export interface EmbedConfig {
|
|
|
518
488
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
519
489
|
* access to the embedded application users
|
|
520
490
|
* outside of the iframe.
|
|
521
|
-
*
|
|
522
491
|
* @default true
|
|
523
492
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
524
493
|
*/
|
|
525
494
|
blockNonEmbedFullAppAccess?: boolean;
|
|
526
495
|
/**
|
|
527
496
|
* Host config in case embedded app is inside TS app itself
|
|
528
|
-
*
|
|
529
497
|
* @hidden
|
|
530
498
|
*/
|
|
531
499
|
hostConfig?: {
|
|
@@ -535,20 +503,18 @@ export interface EmbedConfig {
|
|
|
535
503
|
};
|
|
536
504
|
/**
|
|
537
505
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
538
|
-
* is added as an additional key to the embed, as per this
|
|
506
|
+
* 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].
|
|
539
507
|
*
|
|
540
508
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
541
509
|
*/
|
|
542
510
|
pendoTrackingKey?: string;
|
|
543
511
|
/**
|
|
544
512
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
545
|
-
*
|
|
546
513
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
547
514
|
*/
|
|
548
515
|
suppressErrorAlerts?: boolean;
|
|
549
516
|
/**
|
|
550
517
|
* Log level for the SDK.
|
|
551
|
-
*
|
|
552
518
|
* @default LogLevel.ERROR
|
|
553
519
|
* @example
|
|
554
520
|
* ```js
|
|
@@ -562,16 +528,43 @@ export interface EmbedConfig {
|
|
|
562
528
|
logLevel?: LogLevel;
|
|
563
529
|
/**
|
|
564
530
|
* Disables the Mixpanel tracking from the SDK.
|
|
565
|
-
*
|
|
566
531
|
* @version SDK: 1.27.9
|
|
567
532
|
*/
|
|
568
533
|
disableSDKTracking?: boolean;
|
|
534
|
+
/**
|
|
535
|
+
* Overrides default/user preffered locale for date formatting
|
|
536
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
537
|
+
*/
|
|
538
|
+
dateFormatLocale?: string;
|
|
539
|
+
/**
|
|
540
|
+
* Overrides default/user preffered locale for number formatting
|
|
541
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
542
|
+
*/
|
|
543
|
+
numberFormatLocale?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
546
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
547
|
+
*/
|
|
548
|
+
currencyFormat?: string;
|
|
549
|
+
/**
|
|
550
|
+
* This flag is used to disable the token verification in the SDK.
|
|
551
|
+
* Enabling this flag will also disable the caching of the token.
|
|
552
|
+
* @hidden
|
|
553
|
+
* @example
|
|
554
|
+
* ```js
|
|
555
|
+
* init({
|
|
556
|
+
* ...embedConfig,
|
|
557
|
+
* disableTokenVerification : true
|
|
558
|
+
* })
|
|
559
|
+
* ```
|
|
560
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
561
|
+
*/
|
|
562
|
+
disableTokenVerification?: boolean;
|
|
569
563
|
}
|
|
570
564
|
export interface LayoutConfig {
|
|
571
565
|
}
|
|
572
566
|
/**
|
|
573
567
|
* Embedded iframe configuration
|
|
574
|
-
*
|
|
575
568
|
* @group Embed components
|
|
576
569
|
*/
|
|
577
570
|
export interface FrameParams {
|
|
@@ -606,9 +599,7 @@ export interface ViewConfig {
|
|
|
606
599
|
/**
|
|
607
600
|
* The width and height dimensions to render an embedded
|
|
608
601
|
* object inside your app. Specify the values in pixels or percentage.
|
|
609
|
-
*
|
|
610
602
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
611
|
-
*
|
|
612
603
|
* @example
|
|
613
604
|
* ```js
|
|
614
605
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -634,7 +625,6 @@ export interface ViewConfig {
|
|
|
634
625
|
* (...), and the contextual menu. These actions will be disabled
|
|
635
626
|
* for the user.
|
|
636
627
|
* Use this to disable actions.
|
|
637
|
-
*
|
|
638
628
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
639
629
|
* @example
|
|
640
630
|
* ```js
|
|
@@ -662,9 +652,7 @@ export interface ViewConfig {
|
|
|
662
652
|
* The list of actions to hide from the embedded.
|
|
663
653
|
* This actions will be hidden from the user.
|
|
664
654
|
* Use this to hide an action.
|
|
665
|
-
*
|
|
666
655
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
667
|
-
*
|
|
668
656
|
* @example
|
|
669
657
|
* ```js
|
|
670
658
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -682,10 +670,8 @@ export interface ViewConfig {
|
|
|
682
670
|
* Use this to hide all actions except the ones you want to show.
|
|
683
671
|
*
|
|
684
672
|
* Use either this or hiddenActions.
|
|
685
|
-
*
|
|
686
673
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
687
674
|
* @important
|
|
688
|
-
*
|
|
689
675
|
* @example
|
|
690
676
|
* ```js
|
|
691
677
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -697,9 +683,7 @@ export interface ViewConfig {
|
|
|
697
683
|
visibleActions?: Action[];
|
|
698
684
|
/**
|
|
699
685
|
* Show alert messages and toast messages in the embedded view.
|
|
700
|
-
*
|
|
701
686
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
702
|
-
*
|
|
703
687
|
* @example
|
|
704
688
|
* ```js
|
|
705
689
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -712,9 +696,7 @@ export interface ViewConfig {
|
|
|
712
696
|
/**
|
|
713
697
|
* The list of runtime filters to apply to a search answer,
|
|
714
698
|
* visualization, or Liveboard.
|
|
715
|
-
*
|
|
716
699
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
717
|
-
*
|
|
718
700
|
* @example
|
|
719
701
|
* ```js
|
|
720
702
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -733,9 +715,7 @@ export interface ViewConfig {
|
|
|
733
715
|
/**
|
|
734
716
|
* The list of parameter override to apply to a search answer,
|
|
735
717
|
* visualization, or Liveboard.
|
|
736
|
-
*
|
|
737
718
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
738
|
-
*
|
|
739
719
|
* @example
|
|
740
720
|
* ```js
|
|
741
721
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -752,7 +732,6 @@ export interface ViewConfig {
|
|
|
752
732
|
runtimeParameters?: RuntimeParameter[];
|
|
753
733
|
/**
|
|
754
734
|
* The locale/language to use for the embedded view.
|
|
755
|
-
*
|
|
756
735
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
757
736
|
* @example
|
|
758
737
|
* ```js
|
|
@@ -788,7 +767,6 @@ export interface ViewConfig {
|
|
|
788
767
|
/**
|
|
789
768
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
790
769
|
* You would also need to set `style-src` in the CSP settings.
|
|
791
|
-
*
|
|
792
770
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
793
771
|
* @default ''
|
|
794
772
|
*/
|
|
@@ -796,9 +774,7 @@ export interface ViewConfig {
|
|
|
796
774
|
/**
|
|
797
775
|
* Insert as a sibling of the target container, instead of appending to a
|
|
798
776
|
* child inside it.
|
|
799
|
-
*
|
|
800
777
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
801
|
-
*
|
|
802
778
|
* @example
|
|
803
779
|
* ```js
|
|
804
780
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -810,7 +786,6 @@ export interface ViewConfig {
|
|
|
810
786
|
insertAsSibling?: boolean;
|
|
811
787
|
/**
|
|
812
788
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
813
|
-
*
|
|
814
789
|
* @example
|
|
815
790
|
* ```js
|
|
816
791
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -823,7 +798,6 @@ export interface ViewConfig {
|
|
|
823
798
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
824
799
|
/**
|
|
825
800
|
* Flag to override openNew tab context menu link
|
|
826
|
-
*
|
|
827
801
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
828
802
|
* @example
|
|
829
803
|
* ```js
|
|
@@ -836,7 +810,6 @@ export interface ViewConfig {
|
|
|
836
810
|
linkOverride?: boolean;
|
|
837
811
|
/**
|
|
838
812
|
* flag to enable insert into slides action
|
|
839
|
-
*
|
|
840
813
|
* @hidden
|
|
841
814
|
* @private
|
|
842
815
|
*/
|
|
@@ -844,7 +817,6 @@ export interface ViewConfig {
|
|
|
844
817
|
/**
|
|
845
818
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
846
819
|
* if available and matches the configuration.
|
|
847
|
-
*
|
|
848
820
|
* @version SDK: 1.22.0
|
|
849
821
|
* @hidden
|
|
850
822
|
*
|
|
@@ -858,7 +830,6 @@ export interface ViewConfig {
|
|
|
858
830
|
*
|
|
859
831
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
860
832
|
* embedded view.
|
|
861
|
-
*
|
|
862
833
|
* @default false
|
|
863
834
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
864
835
|
*/
|
|
@@ -867,7 +838,6 @@ export interface ViewConfig {
|
|
|
867
838
|
* The list of tab IDs to hide from the embedded.
|
|
868
839
|
* This Tabs will be hidden from their respective LBs.
|
|
869
840
|
* Use this to hide an tabID.
|
|
870
|
-
*
|
|
871
841
|
* @example
|
|
872
842
|
* ```js
|
|
873
843
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -884,10 +854,11 @@ export interface ViewConfig {
|
|
|
884
854
|
* Hide the home page modules
|
|
885
855
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
886
856
|
*
|
|
857
|
+
*
|
|
858
|
+
*
|
|
887
859
|
* **Note**: This option does not apply to the classic homepage.
|
|
888
860
|
* To access the updated modular homepage, set
|
|
889
861
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
890
|
-
*
|
|
891
862
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
892
863
|
* @example
|
|
893
864
|
* ```js
|
|
@@ -896,19 +867,17 @@ export interface ViewConfig {
|
|
|
896
867
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
897
868
|
* })
|
|
898
869
|
* ```
|
|
899
|
-
*
|
|
900
870
|
*/
|
|
901
871
|
hiddenHomepageModules?: HomepageModule[];
|
|
902
872
|
/**
|
|
903
873
|
* reordering the home page modules
|
|
904
874
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
905
875
|
*
|
|
876
|
+
*
|
|
906
877
|
* **Note**: This option does not apply to the classic homepage.
|
|
907
878
|
* To access the updated modular homepage, set
|
|
908
879
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
909
|
-
*
|
|
910
880
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
911
|
-
*
|
|
912
881
|
* @example
|
|
913
882
|
* ```js
|
|
914
883
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -923,9 +892,7 @@ export interface ViewConfig {
|
|
|
923
892
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
924
893
|
*
|
|
925
894
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
926
|
-
*
|
|
927
895
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
928
|
-
*
|
|
929
896
|
* @example
|
|
930
897
|
* ```js
|
|
931
898
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -942,8 +909,7 @@ export interface ViewConfig {
|
|
|
942
909
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
943
910
|
* There are 8 eight home navigation list items.
|
|
944
911
|
* To hide these items, specify the string in the array.
|
|
945
|
-
*
|
|
946
|
-
* * @example
|
|
912
|
+
* @example
|
|
947
913
|
* ```js
|
|
948
914
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
949
915
|
* ... // other options
|
|
@@ -951,10 +917,11 @@ export interface ViewConfig {
|
|
|
951
917
|
* })
|
|
952
918
|
* ```
|
|
953
919
|
*
|
|
920
|
+
*
|
|
921
|
+
*
|
|
954
922
|
* **Note**: This option does not apply to the classic homepage.
|
|
955
923
|
* To access the updated modular homepage, set
|
|
956
924
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
957
|
-
*
|
|
958
925
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
959
926
|
*/
|
|
960
927
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -962,7 +929,6 @@ export interface ViewConfig {
|
|
|
962
929
|
* PreRender id to be used for PreRendering the embed.
|
|
963
930
|
* Use PreRender to render the embed in the background and then
|
|
964
931
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
965
|
-
*
|
|
966
932
|
* @example
|
|
967
933
|
* ```js
|
|
968
934
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -979,11 +945,9 @@ export interface ViewConfig {
|
|
|
979
945
|
* of its embedding element and adjust its own size accordingly.
|
|
980
946
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
981
947
|
* its dimensions based on changes to the size of the embedding element.
|
|
982
|
-
*
|
|
983
948
|
* @type {boolean}
|
|
984
949
|
* @default false
|
|
985
950
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
986
|
-
*
|
|
987
951
|
* @example
|
|
988
952
|
* ```js
|
|
989
953
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -998,14 +962,22 @@ export interface ViewConfig {
|
|
|
998
962
|
doNotTrackPreRenderSize?: boolean;
|
|
999
963
|
/**
|
|
1000
964
|
* For internal tracking of the embed component type.
|
|
1001
|
-
*
|
|
1002
965
|
* @hidden
|
|
1003
966
|
*/
|
|
1004
967
|
embedComponentType?: string;
|
|
968
|
+
/**
|
|
969
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
970
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
971
|
+
*
|
|
972
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
973
|
+
* embedded view.
|
|
974
|
+
* @default false
|
|
975
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
976
|
+
*/
|
|
977
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
1005
978
|
}
|
|
1006
979
|
/**
|
|
1007
980
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
1008
|
-
*
|
|
1009
981
|
* @group Events
|
|
1010
982
|
*/
|
|
1011
983
|
export type MessagePayload = {
|
|
@@ -1016,7 +988,6 @@ export type MessagePayload = {
|
|
|
1016
988
|
/**
|
|
1017
989
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
1018
990
|
* option
|
|
1019
|
-
*
|
|
1020
991
|
* @group Events
|
|
1021
992
|
*/
|
|
1022
993
|
export type MessageOptions = {
|
|
@@ -1028,7 +999,6 @@ export type MessageOptions = {
|
|
|
1028
999
|
};
|
|
1029
1000
|
/**
|
|
1030
1001
|
* MessageCallback: Embed event message callback
|
|
1031
|
-
*
|
|
1032
1002
|
* @group Events
|
|
1033
1003
|
*/
|
|
1034
1004
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -1118,7 +1088,6 @@ export declare enum RuntimeFilterOp {
|
|
|
1118
1088
|
* **Note**: This option does not apply to the classic homepage.
|
|
1119
1089
|
* To access the updated modular homepage, set
|
|
1120
1090
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1121
|
-
*
|
|
1122
1091
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1123
1092
|
*/
|
|
1124
1093
|
export declare enum HomepageModule {
|
|
@@ -1165,7 +1134,7 @@ export interface RuntimeFilter {
|
|
|
1165
1134
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
1166
1135
|
* operands.
|
|
1167
1136
|
*/
|
|
1168
|
-
values: (number | boolean | string)[];
|
|
1137
|
+
values: (number | boolean | string | bigint)[];
|
|
1169
1138
|
}
|
|
1170
1139
|
/**
|
|
1171
1140
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -1186,7 +1155,6 @@ export interface RuntimeParameter {
|
|
|
1186
1155
|
*
|
|
1187
1156
|
* To add an event listener use the corresponding
|
|
1188
1157
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
1189
|
-
*
|
|
1190
1158
|
* @example
|
|
1191
1159
|
* ```js
|
|
1192
1160
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1204,7 +1172,6 @@ export interface RuntimeParameter {
|
|
|
1204
1172
|
export declare enum EmbedEvent {
|
|
1205
1173
|
/**
|
|
1206
1174
|
* Rendering has initialized.
|
|
1207
|
-
*
|
|
1208
1175
|
* @example
|
|
1209
1176
|
*```js
|
|
1210
1177
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -1218,7 +1185,7 @@ export declare enum EmbedEvent {
|
|
|
1218
1185
|
Init = "init",
|
|
1219
1186
|
/**
|
|
1220
1187
|
* Authentication has either succeeded or failed.
|
|
1221
|
-
*
|
|
1188
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1222
1189
|
* @example
|
|
1223
1190
|
*```js
|
|
1224
1191
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -1230,8 +1197,8 @@ export declare enum EmbedEvent {
|
|
|
1230
1197
|
AuthInit = "authInit",
|
|
1231
1198
|
/**
|
|
1232
1199
|
* The embed object container has loaded.
|
|
1233
|
-
*
|
|
1234
1200
|
* @returns timestamp - The timestamp when the event was generated.
|
|
1201
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1235
1202
|
* @example
|
|
1236
1203
|
*```js
|
|
1237
1204
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -1244,8 +1211,8 @@ export declare enum EmbedEvent {
|
|
|
1244
1211
|
Load = "load",
|
|
1245
1212
|
/**
|
|
1246
1213
|
* Data pertaining to answer or Liveboard is received
|
|
1247
|
-
*
|
|
1248
1214
|
* @return data - The answer or Liveboard data
|
|
1215
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1249
1216
|
* @example
|
|
1250
1217
|
*```js
|
|
1251
1218
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -1257,13 +1224,12 @@ export declare enum EmbedEvent {
|
|
|
1257
1224
|
Data = "data",
|
|
1258
1225
|
/**
|
|
1259
1226
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
1260
|
-
*
|
|
1261
1227
|
* @hidden
|
|
1262
1228
|
*/
|
|
1263
1229
|
FiltersChanged = "filtersChanged",
|
|
1264
1230
|
/**
|
|
1265
1231
|
* Search query has been updated by the user.
|
|
1266
|
-
*
|
|
1232
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1267
1233
|
* @example
|
|
1268
1234
|
*```js
|
|
1269
1235
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -1272,13 +1238,13 @@ export declare enum EmbedEvent {
|
|
|
1272
1238
|
QueryChanged = "queryChanged",
|
|
1273
1239
|
/**
|
|
1274
1240
|
* A drill-down operation has been performed.
|
|
1275
|
-
*
|
|
1241
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1276
1242
|
* @returns additionalFilters - Any additional filters applied
|
|
1277
1243
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
1278
1244
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
1279
1245
|
* @example
|
|
1280
1246
|
*```js
|
|
1281
|
-
* searchEmbed.
|
|
1247
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
1282
1248
|
* points: {
|
|
1283
1249
|
* clickedPoint,
|
|
1284
1250
|
* selectedPoints: selectedPoint
|
|
@@ -1309,8 +1275,8 @@ export declare enum EmbedEvent {
|
|
|
1309
1275
|
Drilldown = "drillDown",
|
|
1310
1276
|
/**
|
|
1311
1277
|
* One or more data sources have been selected.
|
|
1312
|
-
*
|
|
1313
1278
|
* @returns dataSourceIds - the list of data sources
|
|
1279
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1314
1280
|
* @example
|
|
1315
1281
|
* ```js
|
|
1316
1282
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -1321,7 +1287,6 @@ export declare enum EmbedEvent {
|
|
|
1321
1287
|
DataSourceSelected = "dataSourceSelected",
|
|
1322
1288
|
/**
|
|
1323
1289
|
* One or more data columns have been selected.
|
|
1324
|
-
*
|
|
1325
1290
|
* @returns columnIds - the list of columns
|
|
1326
1291
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1327
1292
|
* @example
|
|
@@ -1334,10 +1299,10 @@ export declare enum EmbedEvent {
|
|
|
1334
1299
|
AddRemoveColumns = "addRemoveColumns",
|
|
1335
1300
|
/**
|
|
1336
1301
|
* A custom action has been triggered.
|
|
1337
|
-
*
|
|
1338
1302
|
* @returns actionId - ID of the custom action
|
|
1339
1303
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
1340
1304
|
* Answer or Liveboard data
|
|
1305
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1341
1306
|
* @example
|
|
1342
1307
|
* ```js
|
|
1343
1308
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -1351,7 +1316,6 @@ export declare enum EmbedEvent {
|
|
|
1351
1316
|
CustomAction = "customAction",
|
|
1352
1317
|
/**
|
|
1353
1318
|
* Listen to double click actions on a visualization.
|
|
1354
|
-
*
|
|
1355
1319
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
1356
1320
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1357
1321
|
* @example
|
|
@@ -1364,7 +1328,6 @@ export declare enum EmbedEvent {
|
|
|
1364
1328
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
1365
1329
|
/**
|
|
1366
1330
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
1367
|
-
*
|
|
1368
1331
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
1369
1332
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1370
1333
|
* @important
|
|
@@ -1385,21 +1348,22 @@ export declare enum EmbedEvent {
|
|
|
1385
1348
|
/**
|
|
1386
1349
|
* An error has occurred. This event is fired for the following error types:
|
|
1387
1350
|
*
|
|
1388
|
-
*
|
|
1351
|
+
* `API`: API call failure error.
|
|
1389
1352
|
*
|
|
1390
|
-
*
|
|
1353
|
+
* `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
|
|
1354
|
+
* mode.
|
|
1391
1355
|
*
|
|
1392
|
-
*
|
|
1356
|
+
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
1393
1357
|
*
|
|
1394
|
-
*
|
|
1358
|
+
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
1395
1359
|
*
|
|
1396
|
-
*
|
|
1360
|
+
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
1397
1361
|
*
|
|
1398
|
-
*
|
|
1399
|
-
*
|
|
1400
|
-
* For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
|
|
1362
|
+
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
1401
1363
|
*
|
|
1364
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
1402
1365
|
* @returns error - An error object or message
|
|
1366
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1403
1367
|
* @example
|
|
1404
1368
|
* ```js
|
|
1405
1369
|
* // API error
|
|
@@ -1423,8 +1387,8 @@ export declare enum EmbedEvent {
|
|
|
1423
1387
|
Error = "Error",
|
|
1424
1388
|
/**
|
|
1425
1389
|
* The embedded object has sent an alert.
|
|
1426
|
-
*
|
|
1427
1390
|
* @returns alert - An alert object
|
|
1391
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1428
1392
|
* @example
|
|
1429
1393
|
* ```js
|
|
1430
1394
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -1433,7 +1397,7 @@ export declare enum EmbedEvent {
|
|
|
1433
1397
|
Alert = "alert",
|
|
1434
1398
|
/**
|
|
1435
1399
|
* The ThoughtSpot auth session has expired.
|
|
1436
|
-
*
|
|
1400
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1437
1401
|
* @example
|
|
1438
1402
|
*```js
|
|
1439
1403
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -1446,26 +1410,22 @@ export declare enum EmbedEvent {
|
|
|
1446
1410
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
1447
1411
|
/**
|
|
1448
1412
|
* ThoughtSpot failed to validate the auth session.
|
|
1449
|
-
*
|
|
1450
1413
|
* @hidden
|
|
1451
1414
|
*/
|
|
1452
1415
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
1453
1416
|
/**
|
|
1454
1417
|
* ThoughtSpot failed to validate the auth session.
|
|
1455
|
-
*
|
|
1456
1418
|
* @hidden
|
|
1457
1419
|
*/
|
|
1458
1420
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
1459
1421
|
/**
|
|
1460
1422
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
1461
|
-
*
|
|
1462
1423
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
1463
1424
|
* @hidden
|
|
1464
1425
|
*/
|
|
1465
1426
|
EmbedHeight = "EMBED_HEIGHT",
|
|
1466
1427
|
/**
|
|
1467
1428
|
* The center of visible iframe viewport is calculated.
|
|
1468
|
-
*
|
|
1469
1429
|
* @returns data - The center of the visible Iframe viewport.
|
|
1470
1430
|
* @hidden
|
|
1471
1431
|
*/
|
|
@@ -1473,7 +1433,6 @@ export declare enum EmbedEvent {
|
|
|
1473
1433
|
/**
|
|
1474
1434
|
* Emitted when the **Get Data** action is initiated.
|
|
1475
1435
|
* Applicable to `SearchBarEmbed` only.
|
|
1476
|
-
*
|
|
1477
1436
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1478
1437
|
* @example
|
|
1479
1438
|
*```js
|
|
@@ -1486,7 +1445,7 @@ export declare enum EmbedEvent {
|
|
|
1486
1445
|
GetDataClick = "getDataClick",
|
|
1487
1446
|
/**
|
|
1488
1447
|
* Detects the route change.
|
|
1489
|
-
*
|
|
1448
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
1490
1449
|
* @example
|
|
1491
1450
|
*```js
|
|
1492
1451
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -1496,15 +1455,13 @@ export declare enum EmbedEvent {
|
|
|
1496
1455
|
RouteChange = "ROUTE_CHANGE",
|
|
1497
1456
|
/**
|
|
1498
1457
|
* The v1 event type for Data
|
|
1499
|
-
*
|
|
1500
1458
|
* @hidden
|
|
1501
1459
|
*/
|
|
1502
1460
|
V1Data = "exportVizDataToParent",
|
|
1503
1461
|
/**
|
|
1504
1462
|
* Emitted when the embed does not have cookie access. This happens
|
|
1505
1463
|
* when Safari and other Web browsers block third-party cookies
|
|
1506
|
-
* are blocked by default.
|
|
1507
|
-
*
|
|
1464
|
+
* are blocked by default.
|
|
1508
1465
|
* @example
|
|
1509
1466
|
*```js
|
|
1510
1467
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -1514,14 +1471,12 @@ export declare enum EmbedEvent {
|
|
|
1514
1471
|
NoCookieAccess = "noCookieAccess",
|
|
1515
1472
|
/**
|
|
1516
1473
|
* Emitted when SAML is complete
|
|
1517
|
-
*
|
|
1518
1474
|
* @private
|
|
1519
1475
|
* @hidden
|
|
1520
1476
|
*/
|
|
1521
1477
|
SAMLComplete = "samlComplete",
|
|
1522
1478
|
/**
|
|
1523
1479
|
* Emitted when any modal is opened in the app
|
|
1524
|
-
*
|
|
1525
1480
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1526
1481
|
* @example
|
|
1527
1482
|
*```js
|
|
@@ -1533,7 +1488,6 @@ export declare enum EmbedEvent {
|
|
|
1533
1488
|
DialogOpen = "dialog-open",
|
|
1534
1489
|
/**
|
|
1535
1490
|
* Emitted when any modal is closed in the app
|
|
1536
|
-
*
|
|
1537
1491
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1538
1492
|
* @example
|
|
1539
1493
|
*```js
|
|
@@ -1546,8 +1500,7 @@ export declare enum EmbedEvent {
|
|
|
1546
1500
|
/**
|
|
1547
1501
|
* Emitted when the Liveboard shell loads.
|
|
1548
1502
|
* You can use this event as a hook to trigger
|
|
1549
|
-
*
|
|
1550
|
-
*
|
|
1503
|
+
* actions on the rendered Liveboard.
|
|
1551
1504
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1552
1505
|
* @example
|
|
1553
1506
|
*```js
|
|
@@ -1567,9 +1520,7 @@ export declare enum EmbedEvent {
|
|
|
1567
1520
|
*/
|
|
1568
1521
|
LiveboardRendered = "PinboardRendered",
|
|
1569
1522
|
/**
|
|
1570
|
-
*
|
|
1571
|
-
* is triggered on all events.
|
|
1572
|
-
*
|
|
1523
|
+
* Emits all events.
|
|
1573
1524
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1574
1525
|
* @example
|
|
1575
1526
|
*```js
|
|
@@ -1581,17 +1532,16 @@ export declare enum EmbedEvent {
|
|
|
1581
1532
|
ALL = "*",
|
|
1582
1533
|
/**
|
|
1583
1534
|
* Emitted when an Answer is saved in the app
|
|
1584
|
-
*
|
|
1585
1535
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1586
1536
|
* @example
|
|
1587
1537
|
*```js
|
|
1588
|
-
* //
|
|
1538
|
+
* //Emit when action starts
|
|
1589
1539
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1590
1540
|
* console.log('Save', payload)
|
|
1591
1541
|
* }, {
|
|
1592
1542
|
* start: true
|
|
1593
1543
|
* })
|
|
1594
|
-
* //
|
|
1544
|
+
* //emit when action ends
|
|
1595
1545
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1596
1546
|
* console.log('Save', payload)
|
|
1597
1547
|
* })
|
|
@@ -1601,15 +1551,14 @@ export declare enum EmbedEvent {
|
|
|
1601
1551
|
/**
|
|
1602
1552
|
* Emitted when the download action is triggered on an answer
|
|
1603
1553
|
*
|
|
1604
|
-
* **Note**:
|
|
1554
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
1605
1555
|
* To fire an event when a download action is initiated on a chart or table,
|
|
1606
1556
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
1607
1557
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
1608
|
-
*
|
|
1609
1558
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1610
1559
|
* @example
|
|
1611
1560
|
*```js
|
|
1612
|
-
* liveboardEmbed.
|
|
1561
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
1613
1562
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1614
1563
|
* })
|
|
1615
1564
|
*```
|
|
@@ -1617,14 +1566,13 @@ export declare enum EmbedEvent {
|
|
|
1617
1566
|
Download = "download",
|
|
1618
1567
|
/**
|
|
1619
1568
|
* Emitted when the download action is triggered on an answer
|
|
1620
|
-
*
|
|
1621
1569
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1622
1570
|
* @example
|
|
1623
1571
|
*```js
|
|
1624
|
-
* //
|
|
1572
|
+
* //emit when action starts
|
|
1625
1573
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1626
1574
|
* console.log('download PNG', payload)}, {start: true })
|
|
1627
|
-
* //
|
|
1575
|
+
* //emit when action ends
|
|
1628
1576
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1629
1577
|
* console.log('download PNG', payload)})
|
|
1630
1578
|
*```
|
|
@@ -1632,14 +1580,13 @@ export declare enum EmbedEvent {
|
|
|
1632
1580
|
DownloadAsPng = "downloadAsPng",
|
|
1633
1581
|
/**
|
|
1634
1582
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
1635
|
-
*
|
|
1636
1583
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1637
1584
|
* @example
|
|
1638
1585
|
*```js
|
|
1639
|
-
* //
|
|
1586
|
+
* //emit when action starts
|
|
1640
1587
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1641
1588
|
* console.log('download PDF', payload)}, {start: true })
|
|
1642
|
-
* //
|
|
1589
|
+
* //emit when action ends
|
|
1643
1590
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1644
1591
|
* console.log('download PDF', payload)})
|
|
1645
1592
|
*```
|
|
@@ -1647,14 +1594,13 @@ export declare enum EmbedEvent {
|
|
|
1647
1594
|
DownloadAsPdf = "downloadAsPdf",
|
|
1648
1595
|
/**
|
|
1649
1596
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
1650
|
-
*
|
|
1651
1597
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1652
1598
|
* @example
|
|
1653
1599
|
*```js
|
|
1654
|
-
* //
|
|
1600
|
+
* //emit when action starts
|
|
1655
1601
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1656
1602
|
* console.log('download CSV', payload)}, {start: true })
|
|
1657
|
-
* //
|
|
1603
|
+
* //emit when action ends
|
|
1658
1604
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1659
1605
|
* console.log('download CSV', payload)})
|
|
1660
1606
|
*```
|
|
@@ -1662,14 +1608,13 @@ export declare enum EmbedEvent {
|
|
|
1662
1608
|
DownloadAsCsv = "downloadAsCsv",
|
|
1663
1609
|
/**
|
|
1664
1610
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1665
|
-
*
|
|
1666
1611
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1667
1612
|
* @example
|
|
1668
1613
|
*```js
|
|
1669
|
-
* //
|
|
1614
|
+
* //emit when action starts
|
|
1670
1615
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1671
1616
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
1672
|
-
* //
|
|
1617
|
+
* //emit when action ends
|
|
1673
1618
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1674
1619
|
* console.log('download Xlsx', payload)})
|
|
1675
1620
|
*```
|
|
@@ -1677,14 +1622,13 @@ export declare enum EmbedEvent {
|
|
|
1677
1622
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
1678
1623
|
/**
|
|
1679
1624
|
* Emitted when an Answer is deleted in the app
|
|
1680
|
-
*
|
|
1681
1625
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1682
1626
|
* @example
|
|
1683
1627
|
*```js
|
|
1684
|
-
* //
|
|
1628
|
+
* //emit when action starts
|
|
1685
1629
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1686
1630
|
* console.log('delete answer', payload)}, {start: true })
|
|
1687
|
-
* //
|
|
1631
|
+
* //emit when action is completed
|
|
1688
1632
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1689
1633
|
* console.log('delete answer', payload)})
|
|
1690
1634
|
*```
|
|
@@ -1692,17 +1636,16 @@ export declare enum EmbedEvent {
|
|
|
1692
1636
|
AnswerDelete = "answerDelete",
|
|
1693
1637
|
/**
|
|
1694
1638
|
* Emitted when an answer is pinned to a Liveboard
|
|
1695
|
-
*
|
|
1696
1639
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1697
1640
|
* @example
|
|
1698
1641
|
*```js
|
|
1699
|
-
* //
|
|
1642
|
+
* //emit when action starts
|
|
1700
1643
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1701
1644
|
* console.log('pin', payload)
|
|
1702
1645
|
* }, {
|
|
1703
1646
|
* start: true
|
|
1704
1647
|
* })
|
|
1705
|
-
* //
|
|
1648
|
+
* //emit when action ends
|
|
1706
1649
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1707
1650
|
* console.log('pin', payload)
|
|
1708
1651
|
* })
|
|
@@ -1711,17 +1654,16 @@ export declare enum EmbedEvent {
|
|
|
1711
1654
|
Pin = "pin",
|
|
1712
1655
|
/**
|
|
1713
1656
|
* Emitted when SpotIQ analysis is triggered
|
|
1714
|
-
*
|
|
1715
1657
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1716
1658
|
* @example
|
|
1717
1659
|
*```js
|
|
1718
|
-
* //
|
|
1660
|
+
* //emit when action starts
|
|
1719
1661
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1720
1662
|
* console.log('SpotIQAnalyze', payload)
|
|
1721
1663
|
* }, {
|
|
1722
1664
|
* start: true
|
|
1723
1665
|
* })
|
|
1724
|
-
* //
|
|
1666
|
+
* //emit when action ends
|
|
1725
1667
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1726
1668
|
* console.log('SpotIQ analyze', payload)
|
|
1727
1669
|
* })
|
|
@@ -1730,17 +1672,16 @@ export declare enum EmbedEvent {
|
|
|
1730
1672
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1731
1673
|
/**
|
|
1732
1674
|
* Emitted when a user shares an object with another user or group
|
|
1733
|
-
*
|
|
1734
1675
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1735
1676
|
* @example
|
|
1736
1677
|
*```js
|
|
1737
|
-
* //
|
|
1678
|
+
* //emit when action starts
|
|
1738
1679
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1739
1680
|
* console.log('Share', payload)
|
|
1740
1681
|
* }, {
|
|
1741
1682
|
* start: true
|
|
1742
1683
|
* })
|
|
1743
|
-
* //
|
|
1684
|
+
* //emit when action ends
|
|
1744
1685
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1745
1686
|
* console.log('Share', payload)
|
|
1746
1687
|
* })
|
|
@@ -1750,7 +1691,6 @@ export declare enum EmbedEvent {
|
|
|
1750
1691
|
/**
|
|
1751
1692
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
1752
1693
|
* data on a chart or table.
|
|
1753
|
-
*
|
|
1754
1694
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1755
1695
|
* @example
|
|
1756
1696
|
*```js
|
|
@@ -1763,7 +1703,6 @@ export declare enum EmbedEvent {
|
|
|
1763
1703
|
/**
|
|
1764
1704
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
1765
1705
|
* data on a chart or table
|
|
1766
|
-
*
|
|
1767
1706
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1768
1707
|
* @example
|
|
1769
1708
|
*```js
|
|
@@ -1775,7 +1714,6 @@ export declare enum EmbedEvent {
|
|
|
1775
1714
|
DrillExclude = "context-menu-item-exclude",
|
|
1776
1715
|
/**
|
|
1777
1716
|
* Emitted when a column value is copied in the embedded app.
|
|
1778
|
-
*
|
|
1779
1717
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1780
1718
|
* @example
|
|
1781
1719
|
*```js
|
|
@@ -1786,7 +1724,8 @@ export declare enum EmbedEvent {
|
|
|
1786
1724
|
*/
|
|
1787
1725
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
1788
1726
|
/**
|
|
1789
|
-
* Emitted when a user clicks the **Update TML** action
|
|
1727
|
+
* Emitted when a user clicks the **Update TML** action on
|
|
1728
|
+
* embedded Liveboard.
|
|
1790
1729
|
*
|
|
1791
1730
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1792
1731
|
* @example
|
|
@@ -1798,6 +1737,7 @@ export declare enum EmbedEvent {
|
|
|
1798
1737
|
UpdateTML = "updateTSL",
|
|
1799
1738
|
/**
|
|
1800
1739
|
* Emitted when a user clicks the **Edit TML** action
|
|
1740
|
+
* on an embedded Liveboard.
|
|
1801
1741
|
*
|
|
1802
1742
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1803
1743
|
* @example
|
|
@@ -1811,14 +1751,13 @@ export declare enum EmbedEvent {
|
|
|
1811
1751
|
/**
|
|
1812
1752
|
* Emitted when the **Export TML** action is triggered on an
|
|
1813
1753
|
* an embedded object in the app
|
|
1814
|
-
*
|
|
1815
1754
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1816
1755
|
* @example
|
|
1817
1756
|
*```js
|
|
1818
|
-
* //
|
|
1757
|
+
* //emit when action starts
|
|
1819
1758
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1820
1759
|
* console.log('Export TML', payload)}, { start: true })
|
|
1821
|
-
* //
|
|
1760
|
+
* //emit when action ends
|
|
1822
1761
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1823
1762
|
* console.log('Export TML', payload)})
|
|
1824
1763
|
*```
|
|
@@ -1826,7 +1765,6 @@ export declare enum EmbedEvent {
|
|
|
1826
1765
|
ExportTML = "exportTSL",
|
|
1827
1766
|
/**
|
|
1828
1767
|
* Emitted when an Answer is saved as a View.
|
|
1829
|
-
*
|
|
1830
1768
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1831
1769
|
* @example
|
|
1832
1770
|
*```js
|
|
@@ -1838,14 +1776,13 @@ export declare enum EmbedEvent {
|
|
|
1838
1776
|
SaveAsView = "saveAsView",
|
|
1839
1777
|
/**
|
|
1840
1778
|
* Emitted when the user creates a copy of an Answer
|
|
1841
|
-
*
|
|
1842
1779
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1843
1780
|
* @example
|
|
1844
1781
|
*```js
|
|
1845
|
-
* //
|
|
1782
|
+
* //emit when action starts
|
|
1846
1783
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1847
1784
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1848
|
-
* //
|
|
1785
|
+
* //emit when action ends
|
|
1849
1786
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1850
1787
|
* console.log('Copy and edit', payload)})
|
|
1851
1788
|
*```
|
|
@@ -1853,7 +1790,6 @@ export declare enum EmbedEvent {
|
|
|
1853
1790
|
CopyAEdit = "copyAEdit",
|
|
1854
1791
|
/**
|
|
1855
1792
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
1856
|
-
*
|
|
1857
1793
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1858
1794
|
* @example
|
|
1859
1795
|
*```js
|
|
@@ -1865,7 +1801,6 @@ export declare enum EmbedEvent {
|
|
|
1865
1801
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1866
1802
|
/**
|
|
1867
1803
|
* Emitted when an answer is switched to a chart or table view.
|
|
1868
|
-
*
|
|
1869
1804
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1870
1805
|
* @example
|
|
1871
1806
|
*```js
|
|
@@ -1877,13 +1812,11 @@ export declare enum EmbedEvent {
|
|
|
1877
1812
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
1878
1813
|
/**
|
|
1879
1814
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
1880
|
-
*
|
|
1881
1815
|
* @hidden
|
|
1882
1816
|
*/
|
|
1883
1817
|
APP_INIT = "appInit",
|
|
1884
1818
|
/**
|
|
1885
1819
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1886
|
-
*
|
|
1887
1820
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1888
1821
|
* @example
|
|
1889
1822
|
*```js
|
|
@@ -1895,7 +1828,6 @@ export declare enum EmbedEvent {
|
|
|
1895
1828
|
LiveboardInfo = "pinboardInfo",
|
|
1896
1829
|
/**
|
|
1897
1830
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1898
|
-
*
|
|
1899
1831
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1900
1832
|
* @example
|
|
1901
1833
|
*```js
|
|
@@ -1907,7 +1839,6 @@ export declare enum EmbedEvent {
|
|
|
1907
1839
|
AddToFavorites = "addToFavorites",
|
|
1908
1840
|
/**
|
|
1909
1841
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1910
|
-
*
|
|
1911
1842
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1912
1843
|
* @example
|
|
1913
1844
|
*```js
|
|
@@ -1919,7 +1850,6 @@ export declare enum EmbedEvent {
|
|
|
1919
1850
|
Schedule = "subscription",
|
|
1920
1851
|
/**
|
|
1921
1852
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1922
|
-
*
|
|
1923
1853
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1924
1854
|
* @example
|
|
1925
1855
|
*```js
|
|
@@ -1931,7 +1861,6 @@ export declare enum EmbedEvent {
|
|
|
1931
1861
|
Edit = "edit",
|
|
1932
1862
|
/**
|
|
1933
1863
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1934
|
-
*
|
|
1935
1864
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1936
1865
|
* @example
|
|
1937
1866
|
*```js
|
|
@@ -1943,11 +1872,10 @@ export declare enum EmbedEvent {
|
|
|
1943
1872
|
MakeACopy = "makeACopy",
|
|
1944
1873
|
/**
|
|
1945
1874
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1946
|
-
*
|
|
1947
1875
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1948
1876
|
* @example
|
|
1949
1877
|
*```js
|
|
1950
|
-
* liveboardEmbed.
|
|
1878
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1951
1879
|
*```
|
|
1952
1880
|
* @example
|
|
1953
1881
|
*```js
|
|
@@ -1959,71 +1887,64 @@ export declare enum EmbedEvent {
|
|
|
1959
1887
|
Present = "present",
|
|
1960
1888
|
/**
|
|
1961
1889
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1962
|
-
*
|
|
1963
1890
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1964
1891
|
* @example
|
|
1965
1892
|
*```js
|
|
1966
|
-
* liveboardEmbed.
|
|
1893
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1967
1894
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1968
1895
|
*```
|
|
1969
1896
|
*/
|
|
1970
1897
|
Delete = "delete",
|
|
1971
1898
|
/**
|
|
1972
1899
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1973
|
-
*
|
|
1974
1900
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1975
1901
|
* @example
|
|
1976
1902
|
*```js
|
|
1977
|
-
* liveboardEmbed.
|
|
1903
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1978
1904
|
*```
|
|
1979
1905
|
*/
|
|
1980
1906
|
SchedulesList = "schedule-list",
|
|
1981
1907
|
/**
|
|
1982
1908
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1983
|
-
*
|
|
1984
1909
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1985
1910
|
* @example
|
|
1986
1911
|
*```js
|
|
1987
|
-
* liveboardEmbed.
|
|
1912
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1988
1913
|
*```
|
|
1989
1914
|
*/
|
|
1990
1915
|
Cancel = "cancel",
|
|
1991
1916
|
/**
|
|
1992
1917
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1993
|
-
*
|
|
1994
1918
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1995
1919
|
* @example
|
|
1996
1920
|
*```js
|
|
1997
|
-
* liveboardEmbed.
|
|
1921
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1998
1922
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1999
1923
|
*```
|
|
2000
1924
|
*/
|
|
2001
1925
|
Explore = "explore",
|
|
2002
1926
|
/**
|
|
2003
1927
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2004
|
-
*
|
|
2005
1928
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2006
1929
|
* @example
|
|
2007
1930
|
*```js
|
|
2008
|
-
* liveboardEmbed.
|
|
1931
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
2009
1932
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2010
1933
|
*```
|
|
2011
1934
|
*/
|
|
2012
1935
|
CopyLink = "embedDocument",
|
|
2013
1936
|
/**
|
|
2014
1937
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
2015
|
-
*
|
|
2016
1938
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2017
1939
|
* @example
|
|
2018
1940
|
*```js
|
|
2019
|
-
* liveboardEmbed.
|
|
1941
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
2020
1942
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2021
1943
|
*```
|
|
2022
1944
|
*/
|
|
2023
1945
|
CrossFilterChanged = "cross-filter-changed",
|
|
2024
1946
|
/**
|
|
2025
1947
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2026
|
-
*
|
|
2027
1948
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2028
1949
|
* @example
|
|
2029
1950
|
*```js
|
|
@@ -2035,44 +1956,53 @@ export declare enum EmbedEvent {
|
|
|
2035
1956
|
VizPointRightClick = "vizPointRightClick",
|
|
2036
1957
|
/**
|
|
2037
1958
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2038
|
-
*
|
|
2039
1959
|
* @hidden
|
|
2040
1960
|
*/
|
|
2041
1961
|
InsertIntoSlide = "insertInToSlide",
|
|
2042
1962
|
/**
|
|
2043
|
-
* @hidden
|
|
2044
1963
|
* Emitted when a user changes any filter on a Liveboard.
|
|
1964
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
1965
|
+
* filter details.
|
|
1966
|
+
* @example
|
|
1967
|
+
*
|
|
1968
|
+
*```js
|
|
1969
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1970
|
+
* console.log('payload', payload);
|
|
1971
|
+
* })
|
|
1972
|
+
*
|
|
2045
1973
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1974
|
+
* @example
|
|
1975
|
+
*
|
|
1976
|
+
*```js
|
|
1977
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1978
|
+
* console.log('payload', payload);
|
|
1979
|
+
* })
|
|
1980
|
+
*```
|
|
2046
1981
|
*/
|
|
2047
1982
|
FilterChanged = "filterChanged",
|
|
2048
1983
|
/**
|
|
2049
1984
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
2050
|
-
*
|
|
2051
1985
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2052
1986
|
*/
|
|
2053
1987
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2054
1988
|
/**
|
|
2055
1989
|
* Emitted when a user selects a data source.
|
|
2056
|
-
*
|
|
2057
1990
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2058
1991
|
*/
|
|
2059
1992
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2060
1993
|
/**
|
|
2061
1994
|
* Emitted when a user updates a connection on the **Data** page
|
|
2062
|
-
*
|
|
2063
1995
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2064
1996
|
*/
|
|
2065
1997
|
UpdateConnection = "updateConnection",
|
|
2066
1998
|
/**
|
|
2067
1999
|
* Emitted when a user updates a connection on the **Data** page
|
|
2068
|
-
*
|
|
2069
2000
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2070
2001
|
*/
|
|
2071
2002
|
CreateConnection = "createConnection",
|
|
2072
2003
|
/**
|
|
2073
2004
|
* Emitted when name, status (private or public) or filter values of a
|
|
2074
2005
|
* Personalised view is updated.
|
|
2075
|
-
*
|
|
2076
2006
|
* @returns viewName: string
|
|
2077
2007
|
* @returns viewId: string
|
|
2078
2008
|
* @returns liveboardId: string
|
|
@@ -2082,7 +2012,6 @@ export declare enum EmbedEvent {
|
|
|
2082
2012
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2083
2013
|
/**
|
|
2084
2014
|
* Emitted when a Personalised view is saved.
|
|
2085
|
-
*
|
|
2086
2015
|
* @returns viewName: string
|
|
2087
2016
|
* @returns viewId: string
|
|
2088
2017
|
* @returns liveboardId: string
|
|
@@ -2092,7 +2021,6 @@ export declare enum EmbedEvent {
|
|
|
2092
2021
|
SavePersonalisedView = "savePersonalisedView",
|
|
2093
2022
|
/**
|
|
2094
2023
|
* Emitted when a Liveboard is reset.
|
|
2095
|
-
*
|
|
2096
2024
|
* @returns viewName: string
|
|
2097
2025
|
* @returns viewId: string
|
|
2098
2026
|
* @returns liveboardId: string
|
|
@@ -2102,7 +2030,6 @@ export declare enum EmbedEvent {
|
|
|
2102
2030
|
ResetLiveboard = "resetLiveboard",
|
|
2103
2031
|
/**
|
|
2104
2032
|
* Emitted when a PersonalisedView is deleted.
|
|
2105
|
-
*
|
|
2106
2033
|
* @returns views: string[]
|
|
2107
2034
|
* @returns liveboardId: string
|
|
2108
2035
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -2110,13 +2037,11 @@ export declare enum EmbedEvent {
|
|
|
2110
2037
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
2111
2038
|
/**
|
|
2112
2039
|
* Emitted when a user creates a new worksheet
|
|
2113
|
-
*
|
|
2114
2040
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2115
2041
|
*/
|
|
2116
2042
|
CreateWorksheet = "createWorksheet",
|
|
2117
2043
|
/**
|
|
2118
2044
|
* Emitted when Ask Sage is initialized.
|
|
2119
|
-
*
|
|
2120
2045
|
* @returns viewName: string
|
|
2121
2046
|
* @returns viewId: string
|
|
2122
2047
|
* @returns liveboardId: string
|
|
@@ -2126,10 +2051,32 @@ export declare enum EmbedEvent {
|
|
|
2126
2051
|
AskSageInit = "AskSageInit",
|
|
2127
2052
|
/**
|
|
2128
2053
|
* Emitted when a LB/viz is renamed
|
|
2129
|
-
*
|
|
2130
2054
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
2131
2055
|
*/
|
|
2132
|
-
Rename = "rename"
|
|
2056
|
+
Rename = "rename",
|
|
2057
|
+
/**
|
|
2058
|
+
* Emitted when user wants to intercept the search execution
|
|
2059
|
+
*
|
|
2060
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
2061
|
+
* event
|
|
2062
|
+
*
|
|
2063
|
+
*```js
|
|
2064
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
2065
|
+
* responder({
|
|
2066
|
+
* data: {
|
|
2067
|
+
* execute: true,
|
|
2068
|
+
* error: {errorText: "My own customised error"}
|
|
2069
|
+
* }})
|
|
2070
|
+
* })
|
|
2071
|
+
*```
|
|
2072
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
2073
|
+
*/
|
|
2074
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
2075
|
+
/**
|
|
2076
|
+
* Emitted when runtime parameters changes
|
|
2077
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
2078
|
+
*/
|
|
2079
|
+
ParameterChanged = "ParameterChanged"
|
|
2133
2080
|
}
|
|
2134
2081
|
/**
|
|
2135
2082
|
* Event types that can be triggered by the host application
|
|
@@ -2138,7 +2085,6 @@ export declare enum EmbedEvent {
|
|
|
2138
2085
|
* To trigger an event use the corresponding
|
|
2139
2086
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
2140
2087
|
* SearchEmbed.trigger} method.
|
|
2141
|
-
*
|
|
2142
2088
|
* @example
|
|
2143
2089
|
* ```js
|
|
2144
2090
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2159,7 +2105,6 @@ export declare enum HostEvent {
|
|
|
2159
2105
|
* the search query string.
|
|
2160
2106
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2161
2107
|
* Includes the following properties:
|
|
2162
|
-
*
|
|
2163
2108
|
* @param - `searchQuery` - query string with search tokens
|
|
2164
2109
|
* @param - `dataSources` - Data source GUID to Search on
|
|
2165
2110
|
* - Although an array, only a single source
|
|
@@ -2178,7 +2123,6 @@ export declare enum HostEvent {
|
|
|
2178
2123
|
/**
|
|
2179
2124
|
* Triggers a drill on certain points of the specified column
|
|
2180
2125
|
* Includes the following properties:
|
|
2181
|
-
*
|
|
2182
2126
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2183
2127
|
* to drill to. For example, { selectedPoints: []}
|
|
2184
2128
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2228,19 +2172,16 @@ export declare enum HostEvent {
|
|
|
2228
2172
|
DrillDown = "triggerDrillDown",
|
|
2229
2173
|
/**
|
|
2230
2174
|
* Apply filters
|
|
2231
|
-
*
|
|
2232
2175
|
* @hidden
|
|
2233
2176
|
*/
|
|
2234
2177
|
Filter = "filter",
|
|
2235
2178
|
/**
|
|
2236
2179
|
* Reload the answer or visualization
|
|
2237
|
-
*
|
|
2238
2180
|
* @hidden
|
|
2239
2181
|
*/
|
|
2240
2182
|
Reload = "reload",
|
|
2241
2183
|
/**
|
|
2242
2184
|
* Display specific visualizations on a Liveboard.
|
|
2243
|
-
*
|
|
2244
2185
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2245
2186
|
* in this parameter will be hidden.
|
|
2246
2187
|
* @example
|
|
@@ -2254,7 +2195,6 @@ export declare enum HostEvent {
|
|
|
2254
2195
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2255
2196
|
/**
|
|
2256
2197
|
* Set a Liveboard tab as an active tab.
|
|
2257
|
-
*
|
|
2258
2198
|
* @param - tabId - string of id of Tab to show
|
|
2259
2199
|
* @example
|
|
2260
2200
|
* ```js
|
|
@@ -2270,18 +2210,21 @@ export declare enum HostEvent {
|
|
|
2270
2210
|
* runtime filters passed here are appended to the existing runtime
|
|
2271
2211
|
* filters.
|
|
2272
2212
|
* Pass an array of runtime filters with the following attributes:
|
|
2213
|
+
*
|
|
2273
2214
|
* `columnName`
|
|
2274
2215
|
* _String_. The name of the column to filter on.
|
|
2216
|
+
*
|
|
2275
2217
|
* `operator`
|
|
2276
2218
|
* Runtime filter operator to apply. For information,
|
|
2277
|
-
* see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
|
|
2219
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
2220
|
+
*
|
|
2278
2221
|
* `values`
|
|
2279
|
-
*
|
|
2280
|
-
*
|
|
2281
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2282
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2283
|
-
* embedding (SageEmbed).
|
|
2222
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2223
|
+
* operators such as BW and IN accept multiple operands.
|
|
2284
2224
|
*
|
|
2225
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2226
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2227
|
+
* embedding (SageEmbed).
|
|
2285
2228
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2286
2229
|
* @example
|
|
2287
2230
|
* ```js
|
|
@@ -2297,7 +2240,6 @@ export declare enum HostEvent {
|
|
|
2297
2240
|
/**
|
|
2298
2241
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2299
2242
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2300
|
-
*
|
|
2301
2243
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
2302
2244
|
* be a number; for example, `1`, `-1`.
|
|
2303
2245
|
* @example
|
|
@@ -2310,7 +2252,6 @@ export declare enum HostEvent {
|
|
|
2310
2252
|
/**
|
|
2311
2253
|
* Open the filter panel for a particular column.
|
|
2312
2254
|
* Works with Search and Liveboard embed.
|
|
2313
|
-
*
|
|
2314
2255
|
* @param - { columnId: string,
|
|
2315
2256
|
* name: string,
|
|
2316
2257
|
* type: INT64/CHAR/DATE,
|
|
@@ -2327,7 +2268,6 @@ export declare enum HostEvent {
|
|
|
2327
2268
|
OpenFilter = "openFilter",
|
|
2328
2269
|
/**
|
|
2329
2270
|
* Add columns to the current search query.
|
|
2330
|
-
*
|
|
2331
2271
|
* @param - { columnIds: string[] }
|
|
2332
2272
|
* @example
|
|
2333
2273
|
* ```js
|
|
@@ -2338,7 +2278,6 @@ export declare enum HostEvent {
|
|
|
2338
2278
|
AddColumns = "addColumns",
|
|
2339
2279
|
/**
|
|
2340
2280
|
* Remove a column from the current search query.
|
|
2341
|
-
*
|
|
2342
2281
|
* @param - { columnId: string }
|
|
2343
2282
|
* @example
|
|
2344
2283
|
* ```js
|
|
@@ -2353,10 +2292,9 @@ export declare enum HostEvent {
|
|
|
2353
2292
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
2354
2293
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
2355
2294
|
* sorting, toggling of legends, and data drill down.
|
|
2356
|
-
*
|
|
2357
2295
|
* @example
|
|
2358
2296
|
* ```js
|
|
2359
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
2297
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
2360
2298
|
* data=>console.log(data))
|
|
2361
2299
|
* ```
|
|
2362
2300
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -2364,7 +2302,6 @@ export declare enum HostEvent {
|
|
|
2364
2302
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2365
2303
|
/**
|
|
2366
2304
|
* Trigger the **Pin** action on an embedded object
|
|
2367
|
-
*
|
|
2368
2305
|
* @param - Liveboard embed takes the `vizId` as a
|
|
2369
2306
|
* key. Can be left undefined when embedding Search, full app, or
|
|
2370
2307
|
* a visualization.
|
|
@@ -2381,7 +2318,6 @@ export declare enum HostEvent {
|
|
|
2381
2318
|
/**
|
|
2382
2319
|
* Trigger the **Show Liveboard details** action
|
|
2383
2320
|
* on an embedded Liveboard.
|
|
2384
|
-
*
|
|
2385
2321
|
* @example
|
|
2386
2322
|
*```js
|
|
2387
2323
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -2391,7 +2327,6 @@ export declare enum HostEvent {
|
|
|
2391
2327
|
LiveboardInfo = "pinboardInfo",
|
|
2392
2328
|
/**
|
|
2393
2329
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2394
|
-
*
|
|
2395
2330
|
* @example
|
|
2396
2331
|
* ```js
|
|
2397
2332
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -2401,7 +2336,6 @@ export declare enum HostEvent {
|
|
|
2401
2336
|
Schedule = "subscription",
|
|
2402
2337
|
/**
|
|
2403
2338
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2404
|
-
*
|
|
2405
2339
|
* @example
|
|
2406
2340
|
* ```js
|
|
2407
2341
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -2410,17 +2344,21 @@ export declare enum HostEvent {
|
|
|
2410
2344
|
*/
|
|
2411
2345
|
SchedulesList = "schedule-list",
|
|
2412
2346
|
/**
|
|
2413
|
-
* Trigger the **Export TML** action on an embedded Liveboard
|
|
2347
|
+
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
2348
|
+
* Answer.
|
|
2414
2349
|
*
|
|
2415
2350
|
* @example
|
|
2416
2351
|
* ```js
|
|
2417
2352
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
2418
2353
|
* ```
|
|
2354
|
+
*
|
|
2419
2355
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2420
2356
|
*/
|
|
2421
2357
|
ExportTML = "exportTSL",
|
|
2422
2358
|
/**
|
|
2423
|
-
* Trigger the **Edit TML** action on an embedded Liveboard
|
|
2359
|
+
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
2360
|
+
* saved Answers in the full application embedding.
|
|
2361
|
+
*
|
|
2424
2362
|
*
|
|
2425
2363
|
* @example
|
|
2426
2364
|
* ```js
|
|
@@ -2431,7 +2369,6 @@ export declare enum HostEvent {
|
|
|
2431
2369
|
EditTML = "editTSL",
|
|
2432
2370
|
/**
|
|
2433
2371
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
2434
|
-
*
|
|
2435
2372
|
* @example
|
|
2436
2373
|
* ```js
|
|
2437
2374
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -2440,7 +2377,11 @@ export declare enum HostEvent {
|
|
|
2440
2377
|
*/
|
|
2441
2378
|
UpdateTML = "updateTSL",
|
|
2442
2379
|
/**
|
|
2443
|
-
* Trigger the **Download PDF** action on an embedded Liveboard
|
|
2380
|
+
* Trigger the **Download PDF** action on an embedded Liveboard,
|
|
2381
|
+
* visualization or Answer.
|
|
2382
|
+
*
|
|
2383
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
2384
|
+
* visualizations and Answers if the data is in tabular format.
|
|
2444
2385
|
*
|
|
2445
2386
|
* @example
|
|
2446
2387
|
* ```js
|
|
@@ -2452,7 +2393,6 @@ export declare enum HostEvent {
|
|
|
2452
2393
|
/**
|
|
2453
2394
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
2454
2395
|
* visualization page.
|
|
2455
|
-
*
|
|
2456
2396
|
* @example
|
|
2457
2397
|
* ```js
|
|
2458
2398
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -2468,7 +2408,6 @@ export declare enum HostEvent {
|
|
|
2468
2408
|
MakeACopy = "makeACopy",
|
|
2469
2409
|
/**
|
|
2470
2410
|
* Trigger the **Delete** action for a Liveboard.
|
|
2471
|
-
*
|
|
2472
2411
|
* @example
|
|
2473
2412
|
* ```js
|
|
2474
2413
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -2478,7 +2417,6 @@ export declare enum HostEvent {
|
|
|
2478
2417
|
Remove = "delete",
|
|
2479
2418
|
/**
|
|
2480
2419
|
* Trigger the **Explore** action on a visualization.
|
|
2481
|
-
*
|
|
2482
2420
|
* @param - an object with `vizId` as a key
|
|
2483
2421
|
* @example
|
|
2484
2422
|
* ```js
|
|
@@ -2489,7 +2427,6 @@ export declare enum HostEvent {
|
|
|
2489
2427
|
Explore = "explore",
|
|
2490
2428
|
/**
|
|
2491
2429
|
* Trigger the **Create alert** action on a visualization
|
|
2492
|
-
*
|
|
2493
2430
|
* @param - an object with `vizId` as a key
|
|
2494
2431
|
* @example
|
|
2495
2432
|
* ```js
|
|
@@ -2502,7 +2439,6 @@ export declare enum HostEvent {
|
|
|
2502
2439
|
CreateMonitor = "createMonitor",
|
|
2503
2440
|
/**
|
|
2504
2441
|
* Trigger the **Manage alerts** action on a visualization
|
|
2505
|
-
*
|
|
2506
2442
|
* @param - an object with `vizId` as a key
|
|
2507
2443
|
* @example
|
|
2508
2444
|
* ```js
|
|
@@ -2514,29 +2450,28 @@ export declare enum HostEvent {
|
|
|
2514
2450
|
*/
|
|
2515
2451
|
ManageMonitor = "manageMonitor",
|
|
2516
2452
|
/**
|
|
2517
|
-
* Trigger the **Edit** action on a Liveboard or visualization
|
|
2453
|
+
* Trigger the **Edit** action on a Liveboard or a visualization
|
|
2454
|
+
* on a Liveboard.
|
|
2455
|
+
*
|
|
2456
|
+
* This event is not supported in visualization embed and search embed.
|
|
2518
2457
|
*
|
|
2519
2458
|
* @param - object - To trigger the action for a specific visualization
|
|
2520
2459
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
2521
|
-
*
|
|
2522
|
-
* a visualization.
|
|
2460
|
+
*
|
|
2523
2461
|
* @example
|
|
2524
2462
|
* ```js
|
|
2525
2463
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
2526
2464
|
* ```
|
|
2465
|
+
* @example
|
|
2527
2466
|
* ```js
|
|
2528
2467
|
* liveboardEmbed.trigger(HostEvent.Edit, {vizId:
|
|
2529
2468
|
* '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2530
2469
|
* ```
|
|
2531
|
-
* ```js
|
|
2532
|
-
* vizEmbed.trigger((HostEvent.Edit)
|
|
2533
|
-
* ```
|
|
2534
2470
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2535
2471
|
*/
|
|
2536
2472
|
Edit = "edit",
|
|
2537
2473
|
/**
|
|
2538
2474
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
2539
|
-
*
|
|
2540
2475
|
* @param - object - to trigger the action for a
|
|
2541
2476
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
2542
2477
|
* @example
|
|
@@ -2554,7 +2489,6 @@ export declare enum HostEvent {
|
|
|
2554
2489
|
CopyLink = "embedDocument",
|
|
2555
2490
|
/**
|
|
2556
2491
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
2557
|
-
*
|
|
2558
2492
|
* @param - object - to trigger the action for a specific visualization
|
|
2559
2493
|
* in Liveboard embed, pass in `vizId` as a key
|
|
2560
2494
|
* @example
|
|
@@ -2572,12 +2506,11 @@ export declare enum HostEvent {
|
|
|
2572
2506
|
Present = "present",
|
|
2573
2507
|
/**
|
|
2574
2508
|
* Get TML for the current search.
|
|
2575
|
-
*
|
|
2576
2509
|
* @example
|
|
2577
2510
|
* ```js
|
|
2578
2511
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
2579
2512
|
* console.log(
|
|
2580
|
-
* tml.search_query // TML representation of the search query
|
|
2513
|
+
* tml.answer.search_query // TML representation of the search query
|
|
2581
2514
|
* );
|
|
2582
2515
|
* })
|
|
2583
2516
|
* ```
|
|
@@ -2587,7 +2520,6 @@ export declare enum HostEvent {
|
|
|
2587
2520
|
GetTML = "getTML",
|
|
2588
2521
|
/**
|
|
2589
2522
|
* Trigger the **Show underlying data** action on visualization or search
|
|
2590
|
-
*
|
|
2591
2523
|
* @param - an object with vizId as a key
|
|
2592
2524
|
* @example
|
|
2593
2525
|
* ```js
|
|
@@ -2607,7 +2539,6 @@ export declare enum HostEvent {
|
|
|
2607
2539
|
* Trigger the **Delete** action for a visualization
|
|
2608
2540
|
* in an embedded Liveboard, or a chart or table
|
|
2609
2541
|
* generated from Search.
|
|
2610
|
-
*
|
|
2611
2542
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
2612
2543
|
* Can be left empty if embedding Search or visualization.
|
|
2613
2544
|
* @example
|
|
@@ -2624,7 +2555,6 @@ export declare enum HostEvent {
|
|
|
2624
2555
|
/**
|
|
2625
2556
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
2626
2557
|
* or search.
|
|
2627
|
-
*
|
|
2628
2558
|
* @param - Liveboard embed takes `vizId` as a
|
|
2629
2559
|
* key. Can be left undefined when embedding Search or
|
|
2630
2560
|
* visualization.
|
|
@@ -2645,7 +2575,6 @@ export declare enum HostEvent {
|
|
|
2645
2575
|
/**
|
|
2646
2576
|
* Trigger the **Download** action on charts in
|
|
2647
2577
|
* the embedded view.
|
|
2648
|
-
*
|
|
2649
2578
|
* @example
|
|
2650
2579
|
* ```js
|
|
2651
2580
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -2662,7 +2591,6 @@ export declare enum HostEvent {
|
|
|
2662
2591
|
/**
|
|
2663
2592
|
* Trigger the **Download** > **PNG** action on
|
|
2664
2593
|
* charts in the embedded view.
|
|
2665
|
-
*
|
|
2666
2594
|
* @example
|
|
2667
2595
|
* ```js
|
|
2668
2596
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2678,7 +2606,6 @@ export declare enum HostEvent {
|
|
|
2678
2606
|
/**
|
|
2679
2607
|
* Trigger the **Download** > **CSV** action on tables in
|
|
2680
2608
|
* the embedded view.
|
|
2681
|
-
*
|
|
2682
2609
|
* @example
|
|
2683
2610
|
* ```js
|
|
2684
2611
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -2696,7 +2623,6 @@ export declare enum HostEvent {
|
|
|
2696
2623
|
/**
|
|
2697
2624
|
* Trigger the **Download** > **XLSX** action on tables
|
|
2698
2625
|
* in the embedded view.
|
|
2699
|
-
*
|
|
2700
2626
|
* @example
|
|
2701
2627
|
* ```js
|
|
2702
2628
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2714,7 +2640,6 @@ export declare enum HostEvent {
|
|
|
2714
2640
|
/**
|
|
2715
2641
|
* Trigger the **Share** action on an embedded
|
|
2716
2642
|
* Liveboard or Answer.
|
|
2717
|
-
*
|
|
2718
2643
|
* @example
|
|
2719
2644
|
* ```js
|
|
2720
2645
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -2728,7 +2653,6 @@ export declare enum HostEvent {
|
|
|
2728
2653
|
/**
|
|
2729
2654
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
2730
2655
|
* Saves the changes.
|
|
2731
|
-
*
|
|
2732
2656
|
* @example
|
|
2733
2657
|
* ```js
|
|
2734
2658
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2742,7 +2666,6 @@ export declare enum HostEvent {
|
|
|
2742
2666
|
/**
|
|
2743
2667
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2744
2668
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2745
|
-
*
|
|
2746
2669
|
* @param - an object with `vizId` as a key
|
|
2747
2670
|
* @example
|
|
2748
2671
|
* ```js
|
|
@@ -2759,7 +2682,6 @@ export declare enum HostEvent {
|
|
|
2759
2682
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2760
2683
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2761
2684
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2762
|
-
*
|
|
2763
2685
|
* @param - an object with vizId as a key
|
|
2764
2686
|
* @example
|
|
2765
2687
|
* ```js
|
|
@@ -2776,7 +2698,6 @@ export declare enum HostEvent {
|
|
|
2776
2698
|
* Trigger the **Manage pipelines** action on an embedded
|
|
2777
2699
|
* visualization or Answer.
|
|
2778
2700
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2779
|
-
*
|
|
2780
2701
|
* @param - an object with `vizId` as a key
|
|
2781
2702
|
* @example
|
|
2782
2703
|
* ```js
|
|
@@ -2791,7 +2712,6 @@ export declare enum HostEvent {
|
|
|
2791
2712
|
ManagePipelines = "manage-pipeline",
|
|
2792
2713
|
/**
|
|
2793
2714
|
* Reset search operation on the Search or Answer page.
|
|
2794
|
-
*
|
|
2795
2715
|
* @example
|
|
2796
2716
|
* ```js
|
|
2797
2717
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -2803,32 +2723,73 @@ export declare enum HostEvent {
|
|
|
2803
2723
|
*/
|
|
2804
2724
|
ResetSearch = "resetSearch",
|
|
2805
2725
|
/**
|
|
2806
|
-
*
|
|
2807
|
-
*
|
|
2726
|
+
* Get details of filters applied on the Liveboard.
|
|
2727
|
+
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
2808
2728
|
*
|
|
2809
2729
|
* @example
|
|
2810
|
-
*
|
|
2730
|
+
* ```js
|
|
2731
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
2732
|
+
* console.log('data', data);
|
|
2733
|
+
* ```
|
|
2811
2734
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2812
2735
|
*/
|
|
2813
2736
|
GetFilters = "getFilters",
|
|
2814
2737
|
/**
|
|
2738
|
+
* Update one or several filters applied on a Liveboard.
|
|
2739
|
+
* @param - `filter`: a single filter object containing column name,
|
|
2740
|
+
* filter operator, and values.
|
|
2741
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
2742
|
+
* and values for each.
|
|
2743
|
+
*
|
|
2744
|
+
* Each filter object must include the following attributes:
|
|
2745
|
+
*
|
|
2746
|
+
* `column` - Name of the column to filter on.
|
|
2815
2747
|
*
|
|
2816
|
-
*
|
|
2748
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
2749
|
+
* For information about the supported filter operators,
|
|
2750
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
|
|
2751
|
+
*
|
|
2752
|
+
* `values` - An array of one or several values. The value definition on the
|
|
2753
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
2754
|
+
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
2755
|
+
*
|
|
2756
|
+
* @example
|
|
2757
|
+
* ```js
|
|
2817
2758
|
*
|
|
2818
|
-
*
|
|
2759
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2760
|
+
* filter: {
|
|
2761
|
+
* column: "item type",
|
|
2762
|
+
* oper: "IN",
|
|
2763
|
+
* values: ["bags","shirts"],
|
|
2764
|
+
* }
|
|
2765
|
+
* });
|
|
2766
|
+
* ```
|
|
2819
2767
|
* @example
|
|
2820
2768
|
*
|
|
2821
2769
|
* ```js
|
|
2822
2770
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2823
|
-
*
|
|
2824
|
-
*
|
|
2771
|
+
* filters: [{
|
|
2772
|
+
* column: "Item Type",
|
|
2773
|
+
* oper: 'IN',
|
|
2774
|
+
* values: ["bags","shirts"]
|
|
2775
|
+
* },
|
|
2776
|
+
* {
|
|
2777
|
+
* column: "Region",
|
|
2778
|
+
* oper: 'IN',
|
|
2779
|
+
* values: ["West","Midwest"]
|
|
2780
|
+
* },
|
|
2781
|
+
* {
|
|
2782
|
+
* column: "Date",
|
|
2783
|
+
* oper: 'EQ',
|
|
2784
|
+
* values: ["1656680400"]
|
|
2785
|
+
* }]
|
|
2786
|
+
* });
|
|
2825
2787
|
* ```
|
|
2826
2788
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2827
2789
|
*/
|
|
2828
2790
|
UpdateFilters = "updateFilters",
|
|
2829
2791
|
/**
|
|
2830
2792
|
* Get tab details for the current Liveboard.
|
|
2831
|
-
*
|
|
2832
2793
|
* @example
|
|
2833
2794
|
* ```js
|
|
2834
2795
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -2842,7 +2803,6 @@ export declare enum HostEvent {
|
|
|
2842
2803
|
GetTabs = "getTabs",
|
|
2843
2804
|
/**
|
|
2844
2805
|
* Set the visible tabs on a Liveboard.
|
|
2845
|
-
*
|
|
2846
2806
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
2847
2807
|
* will be hidden.
|
|
2848
2808
|
* @example
|
|
@@ -2856,7 +2816,6 @@ export declare enum HostEvent {
|
|
|
2856
2816
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2857
2817
|
/**
|
|
2858
2818
|
* Set the hidden tabs on a Liveboard.
|
|
2859
|
-
*
|
|
2860
2819
|
* @param - an array of the IDs of the tabs to hide.
|
|
2861
2820
|
* The IDs not passed will be shown.
|
|
2862
2821
|
* @example
|
|
@@ -2870,7 +2829,6 @@ export declare enum HostEvent {
|
|
|
2870
2829
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
2871
2830
|
/**
|
|
2872
2831
|
* Updates the search query string for Natural Language Search operations.
|
|
2873
|
-
*
|
|
2874
2832
|
* @param - `queryString`: Text string in Natural Language format
|
|
2875
2833
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
2876
2834
|
* @example
|
|
@@ -2885,7 +2843,6 @@ export declare enum HostEvent {
|
|
|
2885
2843
|
UpdateSageQuery = "updateSageQuery",
|
|
2886
2844
|
/**
|
|
2887
2845
|
* Get the answer session for a Search / Visualization.
|
|
2888
|
-
*
|
|
2889
2846
|
* @example
|
|
2890
2847
|
* ```js
|
|
2891
2848
|
* const {session} = await embed.trigger(
|
|
@@ -2898,7 +2855,6 @@ export declare enum HostEvent {
|
|
|
2898
2855
|
GetAnswerSession = "getAnswerSession",
|
|
2899
2856
|
/**
|
|
2900
2857
|
* Trigger Ask Sage for viz
|
|
2901
|
-
*
|
|
2902
2858
|
* @example
|
|
2903
2859
|
* ```js
|
|
2904
2860
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -2909,7 +2865,6 @@ export declare enum HostEvent {
|
|
|
2909
2865
|
AskSage = "AskSage",
|
|
2910
2866
|
/**
|
|
2911
2867
|
* Trigger UpdateCrossFilter for Liveboard
|
|
2912
|
-
*
|
|
2913
2868
|
* @example
|
|
2914
2869
|
* ```js
|
|
2915
2870
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -2925,14 +2880,42 @@ export declare enum HostEvent {
|
|
|
2925
2880
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
2926
2881
|
/**
|
|
2927
2882
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
2928
|
-
*
|
|
2929
2883
|
* @example
|
|
2930
2884
|
* ```js
|
|
2931
2885
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
2932
2886
|
* ```
|
|
2933
2887
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2934
2888
|
*/
|
|
2935
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
2889
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
2890
|
+
/**
|
|
2891
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
2892
|
+
* @example
|
|
2893
|
+
* ```js
|
|
2894
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
2895
|
+
*
|
|
2896
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2897
|
+
*/
|
|
2898
|
+
CreateLiveboard = "CreateLiveboard",
|
|
2899
|
+
/**
|
|
2900
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
2901
|
+
* @example
|
|
2902
|
+
* ```js
|
|
2903
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
2904
|
+
* name: "Color",
|
|
2905
|
+
* value: "almond"
|
|
2906
|
+
* }])
|
|
2907
|
+
*
|
|
2908
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2909
|
+
*/
|
|
2910
|
+
UpdateParameters = "UpdateParameters",
|
|
2911
|
+
/**
|
|
2912
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
2913
|
+
* ```js
|
|
2914
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters);
|
|
2915
|
+
*
|
|
2916
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2917
|
+
*/
|
|
2918
|
+
GetParameters = "GetParameters"
|
|
2936
2919
|
}
|
|
2937
2920
|
/**
|
|
2938
2921
|
* The different visual modes that the data sources panel within
|
|
@@ -3029,7 +3012,15 @@ export declare enum Param {
|
|
|
3029
3012
|
ClientLogLevel = "clientLogLevel",
|
|
3030
3013
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
3031
3014
|
enableAskSage = "enableAskSage",
|
|
3032
|
-
CollapseSearchBarInitially = "collapseSearchBarInitially"
|
|
3015
|
+
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
3016
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
3017
|
+
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
3018
|
+
DateFormatLocale = "dateFormatLocale",
|
|
3019
|
+
NumberFormatLocale = "numberFormatLocale",
|
|
3020
|
+
CurrencyFormat = "currencyFormat",
|
|
3021
|
+
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
3022
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
3023
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
3033
3024
|
}
|
|
3034
3025
|
/**
|
|
3035
3026
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3038,7 +3029,6 @@ export declare enum Param {
|
|
|
3038
3029
|
* specific actions in the embedded view, define the Action
|
|
3039
3030
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3040
3031
|
* or `hiddenActions` array.
|
|
3041
|
-
*
|
|
3042
3032
|
* @example
|
|
3043
3033
|
* ```js
|
|
3044
3034
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3062,10 +3052,9 @@ export declare enum Action {
|
|
|
3062
3052
|
/**
|
|
3063
3053
|
* The **Save** action on an Answer or Liveboard.
|
|
3064
3054
|
* Allows users to save the changes.
|
|
3065
|
-
*
|
|
3066
3055
|
* @example
|
|
3067
3056
|
* ```js
|
|
3068
|
-
* disabledActions: [Action.
|
|
3057
|
+
* disabledActions: [Action.Save]
|
|
3069
3058
|
* ```
|
|
3070
3059
|
*/
|
|
3071
3060
|
Save = "save",
|
|
@@ -3079,7 +3068,8 @@ export declare enum Action {
|
|
|
3079
3068
|
SaveUntitled = "saveUntitled",
|
|
3080
3069
|
/**
|
|
3081
3070
|
* The **Save as View** action on the Answer
|
|
3082
|
-
* page. Saves an Answer as a View object
|
|
3071
|
+
* page. Saves an Answer as a View object in the full
|
|
3072
|
+
* application embedding mode.
|
|
3083
3073
|
*
|
|
3084
3074
|
* @example
|
|
3085
3075
|
* ```js
|
|
@@ -3094,7 +3084,6 @@ export declare enum Action {
|
|
|
3094
3084
|
* visualizations in the embedded Liveboard view.
|
|
3095
3085
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
3096
3086
|
* Liveboards and visualizations.
|
|
3097
|
-
*
|
|
3098
3087
|
* @example
|
|
3099
3088
|
* ```js
|
|
3100
3089
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -3104,7 +3093,6 @@ export declare enum Action {
|
|
|
3104
3093
|
/**
|
|
3105
3094
|
* The **Copy and Edit** action on a Liveboard.
|
|
3106
3095
|
* This action is now replaced with `Action.MakeACopy`.
|
|
3107
|
-
*
|
|
3108
3096
|
* @example
|
|
3109
3097
|
* ```js
|
|
3110
3098
|
* disabledActions: [Action.EditACopy]
|
|
@@ -3114,7 +3102,6 @@ export declare enum Action {
|
|
|
3114
3102
|
/**
|
|
3115
3103
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
3116
3104
|
* Copies the visualization URL
|
|
3117
|
-
*
|
|
3118
3105
|
* @example
|
|
3119
3106
|
* ```js
|
|
3120
3107
|
* disabledActions: [Action.CopyLink]
|
|
@@ -3128,7 +3115,6 @@ export declare enum Action {
|
|
|
3128
3115
|
/**
|
|
3129
3116
|
* The **Schedule** menu action on a Liveboard.
|
|
3130
3117
|
* Allows scheduling a Liveboard notification.
|
|
3131
|
-
*
|
|
3132
3118
|
* @example
|
|
3133
3119
|
* ```js
|
|
3134
3120
|
* disabledActions: [Action.Schedule]
|
|
@@ -3138,7 +3124,6 @@ export declare enum Action {
|
|
|
3138
3124
|
/**
|
|
3139
3125
|
* The **Manage schedules** menu action on a Liveboard.
|
|
3140
3126
|
* Allows users to manage scheduled Liveboard jobs.
|
|
3141
|
-
*
|
|
3142
3127
|
* @example
|
|
3143
3128
|
* ```js
|
|
3144
3129
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -3148,7 +3133,6 @@ export declare enum Action {
|
|
|
3148
3133
|
/**
|
|
3149
3134
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3150
3135
|
* Allows users to share an object with other users and groups.
|
|
3151
|
-
*
|
|
3152
3136
|
* @example
|
|
3153
3137
|
* ```js
|
|
3154
3138
|
* disabledActions: [Action.Share]
|
|
@@ -3158,7 +3142,6 @@ export declare enum Action {
|
|
|
3158
3142
|
/**
|
|
3159
3143
|
* The **Add filter** action on a Liveboard and Search page.
|
|
3160
3144
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3161
|
-
*
|
|
3162
3145
|
* @example
|
|
3163
3146
|
* ```js
|
|
3164
3147
|
* disabledActions: [Action.AddFilter]
|
|
@@ -3169,7 +3152,6 @@ export declare enum Action {
|
|
|
3169
3152
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
3170
3153
|
* Allows to show action menu to add different objects (like
|
|
3171
3154
|
* formulas, parameters) in data panel v2.
|
|
3172
|
-
*
|
|
3173
3155
|
* @example
|
|
3174
3156
|
* ```js
|
|
3175
3157
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -3181,7 +3163,6 @@ export declare enum Action {
|
|
|
3181
3163
|
* Filter configuration options on a Liveboard and Search page.
|
|
3182
3164
|
* Allows configuring filter options when adding filters to a
|
|
3183
3165
|
* Liveboard or Answer.
|
|
3184
|
-
*
|
|
3185
3166
|
* @example
|
|
3186
3167
|
* ```js
|
|
3187
3168
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -3192,7 +3173,6 @@ export declare enum Action {
|
|
|
3192
3173
|
/**
|
|
3193
3174
|
* The **Choose sources** button on Search page.
|
|
3194
3175
|
* Allows selecting data sources for search queries.
|
|
3195
|
-
*
|
|
3196
3176
|
* @example
|
|
3197
3177
|
* ```js
|
|
3198
3178
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -3202,7 +3182,6 @@ export declare enum Action {
|
|
|
3202
3182
|
/**
|
|
3203
3183
|
* The **Create formula** action on a Search or Answer page.
|
|
3204
3184
|
* Allows adding formulas to an Answer.
|
|
3205
|
-
*
|
|
3206
3185
|
* @example
|
|
3207
3186
|
* ```js
|
|
3208
3187
|
* disabledActions: [Action.AddFormula]
|
|
@@ -3212,7 +3191,6 @@ export declare enum Action {
|
|
|
3212
3191
|
/**
|
|
3213
3192
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
3214
3193
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
3215
|
-
*
|
|
3216
3194
|
* @example
|
|
3217
3195
|
* ```js
|
|
3218
3196
|
* disabledActions: [Action.AddParameter]
|
|
@@ -3222,7 +3200,6 @@ export declare enum Action {
|
|
|
3222
3200
|
/**
|
|
3223
3201
|
* The **Add Column Set** action on a Answer.
|
|
3224
3202
|
* Allows adding column sets to a Answer.
|
|
3225
|
-
*
|
|
3226
3203
|
* @example
|
|
3227
3204
|
* ```js
|
|
3228
3205
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -3233,7 +3210,6 @@ export declare enum Action {
|
|
|
3233
3210
|
/**
|
|
3234
3211
|
* The **Add Query Set** action on a Answer.
|
|
3235
3212
|
* Allows adding query sets to a Answer.
|
|
3236
|
-
*
|
|
3237
3213
|
* @example
|
|
3238
3214
|
* ```js
|
|
3239
3215
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -3248,7 +3224,6 @@ export declare enum Action {
|
|
|
3248
3224
|
/**
|
|
3249
3225
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
3250
3226
|
* Answer page.
|
|
3251
|
-
*
|
|
3252
3227
|
* @example
|
|
3253
3228
|
* ```js
|
|
3254
3229
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -3271,7 +3246,6 @@ export declare enum Action {
|
|
|
3271
3246
|
/**
|
|
3272
3247
|
* The **Show underlying data** menu action on a visualization or
|
|
3273
3248
|
* Answer page.
|
|
3274
|
-
*
|
|
3275
3249
|
* @example
|
|
3276
3250
|
* ```js
|
|
3277
3251
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -3282,7 +3256,6 @@ export declare enum Action {
|
|
|
3282
3256
|
* The **Download** menu action on Liveboard visualizations
|
|
3283
3257
|
* and Answers.
|
|
3284
3258
|
* Allows downloading a visualization or Answer.
|
|
3285
|
-
*
|
|
3286
3259
|
* @example
|
|
3287
3260
|
* ```js
|
|
3288
3261
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -3293,7 +3266,6 @@ export declare enum Action {
|
|
|
3293
3266
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3294
3267
|
* or Answer page.
|
|
3295
3268
|
* Downloads a visualization or Answer as a PNG file.
|
|
3296
|
-
*
|
|
3297
3269
|
* @example
|
|
3298
3270
|
* ```js
|
|
3299
3271
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -3301,9 +3273,16 @@ export declare enum Action {
|
|
|
3301
3273
|
*/
|
|
3302
3274
|
DownloadAsPng = "downloadAsPng",
|
|
3303
3275
|
/**
|
|
3304
|
-
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3305
|
-
* Downloads a visualization or Answer as a PDF file.
|
|
3306
3276
|
*
|
|
3277
|
+
* The **Download PDF** action that downloads a Liveboard,
|
|
3278
|
+
* visualization, or Answer as a PDF file.
|
|
3279
|
+
*
|
|
3280
|
+
*
|
|
3281
|
+
* **NOTE**: The **Download** > **PDF** action is available on
|
|
3282
|
+
* visualizations and Answers if the data is in tabular format.
|
|
3283
|
+
*
|
|
3284
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
3285
|
+
*visualizations and Answers if the data is in tabular format.
|
|
3307
3286
|
* @example
|
|
3308
3287
|
* ```js
|
|
3309
3288
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -3314,7 +3293,6 @@ export declare enum Action {
|
|
|
3314
3293
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3315
3294
|
* or Answer page.
|
|
3316
3295
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3317
|
-
*
|
|
3318
3296
|
* @example
|
|
3319
3297
|
* ```js
|
|
3320
3298
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -3325,7 +3303,6 @@ export declare enum Action {
|
|
|
3325
3303
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3326
3304
|
* or Answer page.
|
|
3327
3305
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3328
|
-
*
|
|
3329
3306
|
* @example
|
|
3330
3307
|
* ```js
|
|
3331
3308
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -3340,7 +3317,6 @@ export declare enum Action {
|
|
|
3340
3317
|
* The **Export TML** menu action on Liveboard, Answers
|
|
3341
3318
|
* Worksheets and Data Connections page.
|
|
3342
3319
|
* Exports an object as a TML file.
|
|
3343
|
-
*
|
|
3344
3320
|
* @example
|
|
3345
3321
|
* ```js
|
|
3346
3322
|
* disabledActions: [Action.ExportTML]
|
|
@@ -3350,7 +3326,6 @@ export declare enum Action {
|
|
|
3350
3326
|
/**
|
|
3351
3327
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
3352
3328
|
* Imports TML representation of ThoughtSpot objects.
|
|
3353
|
-
*
|
|
3354
3329
|
* @example
|
|
3355
3330
|
* ```js
|
|
3356
3331
|
* disabledActions: [Action.ImportTML]
|
|
@@ -3360,7 +3335,6 @@ export declare enum Action {
|
|
|
3360
3335
|
/**
|
|
3361
3336
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3362
3337
|
* Update TML representation of ThoughtSpot objects.
|
|
3363
|
-
*
|
|
3364
3338
|
* @example
|
|
3365
3339
|
* ```js
|
|
3366
3340
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3370,7 +3344,6 @@ export declare enum Action {
|
|
|
3370
3344
|
/**
|
|
3371
3345
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3372
3346
|
* Opens the TML editor.
|
|
3373
|
-
*
|
|
3374
3347
|
* @example
|
|
3375
3348
|
* ```js
|
|
3376
3349
|
* disabledActions: [Action.EditTML]
|
|
@@ -3381,7 +3354,6 @@ export declare enum Action {
|
|
|
3381
3354
|
* The **Present** menu action for Liveboards and Answers.
|
|
3382
3355
|
* Allows presenting a Liveboard or visualization in
|
|
3383
3356
|
* slideshow mode.
|
|
3384
|
-
*
|
|
3385
3357
|
* @example
|
|
3386
3358
|
* ```js
|
|
3387
3359
|
* disabledActions: [Action.Present]
|
|
@@ -3391,7 +3363,6 @@ export declare enum Action {
|
|
|
3391
3363
|
/**
|
|
3392
3364
|
* The tile resize options in the visualization menu.
|
|
3393
3365
|
* Allows switching between different preset layouts.
|
|
3394
|
-
*
|
|
3395
3366
|
* @example
|
|
3396
3367
|
* ```js
|
|
3397
3368
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -3402,7 +3373,6 @@ export declare enum Action {
|
|
|
3402
3373
|
* The *Edit* action on the Liveboard page and in the
|
|
3403
3374
|
* visualization menu.
|
|
3404
3375
|
* Opens a Liveboard or visualization in edit mode.
|
|
3405
|
-
*
|
|
3406
3376
|
* @example
|
|
3407
3377
|
* ```js
|
|
3408
3378
|
* disabledActions: [Action.Edit]
|
|
@@ -3411,7 +3381,6 @@ export declare enum Action {
|
|
|
3411
3381
|
Edit = "edit",
|
|
3412
3382
|
/**
|
|
3413
3383
|
* The text edit option for Liveboard and visualization titles.
|
|
3414
|
-
*
|
|
3415
3384
|
* @example
|
|
3416
3385
|
* ```js
|
|
3417
3386
|
* disabledActions: [Action.EditTitle]
|
|
@@ -3421,7 +3390,6 @@ export declare enum Action {
|
|
|
3421
3390
|
/**
|
|
3422
3391
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
3423
3392
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3424
|
-
*
|
|
3425
3393
|
* @example
|
|
3426
3394
|
* ```js
|
|
3427
3395
|
* disabledActions: [Action.Remove]
|
|
@@ -3453,7 +3421,6 @@ export declare enum Action {
|
|
|
3453
3421
|
* Displays details such as the name, description, and
|
|
3454
3422
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3455
3423
|
* and update.
|
|
3456
|
-
*
|
|
3457
3424
|
* @example
|
|
3458
3425
|
* ```js
|
|
3459
3426
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -3471,7 +3438,6 @@ export declare enum Action {
|
|
|
3471
3438
|
/**
|
|
3472
3439
|
* The **Pin** menu action on an Answer or
|
|
3473
3440
|
* Search results page.
|
|
3474
|
-
*
|
|
3475
3441
|
* @example
|
|
3476
3442
|
* ```js
|
|
3477
3443
|
* disabledActions: [Action.Pin]
|
|
@@ -3484,7 +3450,6 @@ export declare enum Action {
|
|
|
3484
3450
|
AnalysisInfo = "analysisInfo",
|
|
3485
3451
|
/**
|
|
3486
3452
|
* The **Schedule** menu action on a Liveboard.
|
|
3487
|
-
*
|
|
3488
3453
|
* @example
|
|
3489
3454
|
* ```js
|
|
3490
3455
|
* disabledActions: [Action.Subscription]
|
|
@@ -3493,7 +3458,6 @@ export declare enum Action {
|
|
|
3493
3458
|
Subscription = "subscription",
|
|
3494
3459
|
/**
|
|
3495
3460
|
* The **Explore** action on Liveboard visualizations
|
|
3496
|
-
*
|
|
3497
3461
|
* @example
|
|
3498
3462
|
* ```js
|
|
3499
3463
|
* disabledActions: [Action.Explore]
|
|
@@ -3503,7 +3467,6 @@ export declare enum Action {
|
|
|
3503
3467
|
/**
|
|
3504
3468
|
* The action to include data points on a drilled-down Answer
|
|
3505
3469
|
* or visualization
|
|
3506
|
-
*
|
|
3507
3470
|
* @example
|
|
3508
3471
|
* ```js
|
|
3509
3472
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3513,7 +3476,6 @@ export declare enum Action {
|
|
|
3513
3476
|
/**
|
|
3514
3477
|
* The action to exclude data points on a drilled-down Answer
|
|
3515
3478
|
* or visualization
|
|
3516
|
-
*
|
|
3517
3479
|
* @example
|
|
3518
3480
|
* ```js
|
|
3519
3481
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3524,7 +3486,6 @@ export declare enum Action {
|
|
|
3524
3486
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3525
3487
|
* or Liveboard.
|
|
3526
3488
|
* Copies the selected data point.
|
|
3527
|
-
*
|
|
3528
3489
|
* @example
|
|
3529
3490
|
* ```js
|
|
3530
3491
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3542,7 +3503,6 @@ export declare enum Action {
|
|
|
3542
3503
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3543
3504
|
* visualizations.
|
|
3544
3505
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3545
|
-
*
|
|
3546
3506
|
* @example
|
|
3547
3507
|
* ```js
|
|
3548
3508
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3552,7 +3512,6 @@ export declare enum Action {
|
|
|
3552
3512
|
/**
|
|
3553
3513
|
* The request access action on Liveboards.
|
|
3554
3514
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3555
|
-
*
|
|
3556
3515
|
* @example
|
|
3557
3516
|
* ```js
|
|
3558
3517
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3562,7 +3521,6 @@ export declare enum Action {
|
|
|
3562
3521
|
/**
|
|
3563
3522
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3564
3523
|
* of the Answer page
|
|
3565
|
-
*
|
|
3566
3524
|
* @example
|
|
3567
3525
|
* ```js
|
|
3568
3526
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3570,7 +3528,8 @@ export declare enum Action {
|
|
|
3570
3528
|
*/
|
|
3571
3529
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
3572
3530
|
/**
|
|
3573
|
-
* The **Delete** action for Answers
|
|
3531
|
+
* The **Delete** action for Answers in the full application
|
|
3532
|
+
* embedding mode.
|
|
3574
3533
|
*
|
|
3575
3534
|
* @example
|
|
3576
3535
|
* ```js
|
|
@@ -3581,7 +3540,6 @@ export declare enum Action {
|
|
|
3581
3540
|
AnswerDelete = "onDeleteAnswer",
|
|
3582
3541
|
/**
|
|
3583
3542
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3584
|
-
*
|
|
3585
3543
|
* @example
|
|
3586
3544
|
* ```js
|
|
3587
3545
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3591,7 +3549,6 @@ export declare enum Action {
|
|
|
3591
3549
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3592
3550
|
/**
|
|
3593
3551
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3594
|
-
*
|
|
3595
3552
|
* @example
|
|
3596
3553
|
* ```js
|
|
3597
3554
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3601,7 +3558,6 @@ export declare enum Action {
|
|
|
3601
3558
|
AddToFavorites = "addToFavorites",
|
|
3602
3559
|
/**
|
|
3603
3560
|
* The edit icon on Liveboards (Classic experience).
|
|
3604
|
-
*
|
|
3605
3561
|
* @example
|
|
3606
3562
|
* ```js
|
|
3607
3563
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3611,7 +3567,6 @@ export declare enum Action {
|
|
|
3611
3567
|
EditDetails = "editDetails",
|
|
3612
3568
|
/**
|
|
3613
3569
|
* The Create alert action on KPI charts.
|
|
3614
|
-
*
|
|
3615
3570
|
* @example
|
|
3616
3571
|
* ```js
|
|
3617
3572
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3630,7 +3585,6 @@ export declare enum Action {
|
|
|
3630
3585
|
/**
|
|
3631
3586
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3632
3587
|
* Allows sending data to a Google Sheet.
|
|
3633
|
-
*
|
|
3634
3588
|
* @example
|
|
3635
3589
|
* ```js
|
|
3636
3590
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3642,7 +3596,6 @@ export declare enum Action {
|
|
|
3642
3596
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3643
3597
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3644
3598
|
* Microsoft Teams, and so on.
|
|
3645
|
-
*
|
|
3646
3599
|
* @example
|
|
3647
3600
|
* ```js
|
|
3648
3601
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3653,7 +3606,6 @@ export declare enum Action {
|
|
|
3653
3606
|
/**
|
|
3654
3607
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3655
3608
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3656
|
-
*
|
|
3657
3609
|
* @example
|
|
3658
3610
|
* ```js
|
|
3659
3611
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3664,7 +3616,6 @@ export declare enum Action {
|
|
|
3664
3616
|
/**
|
|
3665
3617
|
* The **Filter** action on Liveboard visualizations.
|
|
3666
3618
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3667
|
-
*
|
|
3668
3619
|
* @example
|
|
3669
3620
|
* ```js
|
|
3670
3621
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3675,7 +3626,6 @@ export declare enum Action {
|
|
|
3675
3626
|
/**
|
|
3676
3627
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
3677
3628
|
* Allows sending data to third-party apps Slack
|
|
3678
|
-
*
|
|
3679
3629
|
* @example
|
|
3680
3630
|
* ```js
|
|
3681
3631
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -3686,7 +3636,6 @@ export declare enum Action {
|
|
|
3686
3636
|
/**
|
|
3687
3637
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
3688
3638
|
* Allows sending data to third-party apps Team
|
|
3689
|
-
*
|
|
3690
3639
|
* @example
|
|
3691
3640
|
* ```js
|
|
3692
3641
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -3698,7 +3647,6 @@ export declare enum Action {
|
|
|
3698
3647
|
* The **Remove** action that appears when cross filters are applied
|
|
3699
3648
|
* on a Liveboard.
|
|
3700
3649
|
* Removes filters applied o a visualization.
|
|
3701
|
-
*
|
|
3702
3650
|
* @example
|
|
3703
3651
|
* ```js
|
|
3704
3652
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3710,7 +3658,6 @@ export declare enum Action {
|
|
|
3710
3658
|
* The **Aggregate** option in the chart axis or the
|
|
3711
3659
|
* table column customization menu.
|
|
3712
3660
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3713
|
-
*
|
|
3714
3661
|
* @example
|
|
3715
3662
|
* ```js
|
|
3716
3663
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3722,7 +3669,6 @@ export declare enum Action {
|
|
|
3722
3669
|
* The **Time bucket** option in the chart axis or table column
|
|
3723
3670
|
* customization menu.
|
|
3724
3671
|
* Allows defining time metric for date comparison.
|
|
3725
|
-
*
|
|
3726
3672
|
* @example
|
|
3727
3673
|
* ```js
|
|
3728
3674
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3733,7 +3679,6 @@ export declare enum Action {
|
|
|
3733
3679
|
/**
|
|
3734
3680
|
* The **Filter** action in the chart axis or table column
|
|
3735
3681
|
* customization menu.
|
|
3736
|
-
*
|
|
3737
3682
|
* @example
|
|
3738
3683
|
* ```js
|
|
3739
3684
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3745,7 +3690,6 @@ export declare enum Action {
|
|
|
3745
3690
|
* The **Conditional formatting** action on chart or table.
|
|
3746
3691
|
* Allows adding rules for conditional formatting of data
|
|
3747
3692
|
* points on a chart or table.
|
|
3748
|
-
*
|
|
3749
3693
|
* @example
|
|
3750
3694
|
* ```js
|
|
3751
3695
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3757,7 +3701,6 @@ export declare enum Action {
|
|
|
3757
3701
|
* The **Sort** menu action on a table or chart axis
|
|
3758
3702
|
* Sorts data in ascending or descending order.
|
|
3759
3703
|
* Allows adding, editing, or removing filters.
|
|
3760
|
-
*
|
|
3761
3704
|
* @example
|
|
3762
3705
|
* ```js
|
|
3763
3706
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3770,7 +3713,6 @@ export declare enum Action {
|
|
|
3770
3713
|
* customization menu.
|
|
3771
3714
|
* Allows grouping data points if the axes use the same
|
|
3772
3715
|
* unit of measurement and a similar scale.
|
|
3773
|
-
*
|
|
3774
3716
|
* @example
|
|
3775
3717
|
* ```js
|
|
3776
3718
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3782,7 +3724,6 @@ export declare enum Action {
|
|
|
3782
3724
|
* The **Position** option in the axis customization menu.
|
|
3783
3725
|
* Allows changing the position of the axis to the
|
|
3784
3726
|
* left or right side of the chart.
|
|
3785
|
-
*
|
|
3786
3727
|
* @example
|
|
3787
3728
|
* ```js
|
|
3788
3729
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3793,7 +3734,6 @@ export declare enum Action {
|
|
|
3793
3734
|
/**
|
|
3794
3735
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3795
3736
|
* Renames the axis label on a chart or the column header on a table.
|
|
3796
|
-
*
|
|
3797
3737
|
* @example
|
|
3798
3738
|
* ```js
|
|
3799
3739
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3805,7 +3745,6 @@ export declare enum Action {
|
|
|
3805
3745
|
* The **Edit** action in the axis customization menu.
|
|
3806
3746
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3807
3747
|
* and format of a column.
|
|
3808
|
-
*
|
|
3809
3748
|
* @example
|
|
3810
3749
|
* ```js
|
|
3811
3750
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3816,7 +3755,6 @@ export declare enum Action {
|
|
|
3816
3755
|
/**
|
|
3817
3756
|
* The **Number format** action to customize the format of
|
|
3818
3757
|
* the data labels on a chart or table.
|
|
3819
|
-
*
|
|
3820
3758
|
* @example
|
|
3821
3759
|
* ```js
|
|
3822
3760
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3827,7 +3765,6 @@ export declare enum Action {
|
|
|
3827
3765
|
/**
|
|
3828
3766
|
* The **Text wrapping** action on a table.
|
|
3829
3767
|
* Wraps or clips column text on a table.
|
|
3830
|
-
*
|
|
3831
3768
|
* @example
|
|
3832
3769
|
* ```js
|
|
3833
3770
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3840,7 +3777,6 @@ export declare enum Action {
|
|
|
3840
3777
|
* customization menu.
|
|
3841
3778
|
* Removes the data labels from a chart or the column of a
|
|
3842
3779
|
* table visualization.
|
|
3843
|
-
*
|
|
3844
3780
|
* @example
|
|
3845
3781
|
* ```js
|
|
3846
3782
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3855,7 +3791,6 @@ export declare enum Action {
|
|
|
3855
3791
|
/**
|
|
3856
3792
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3857
3793
|
* Allows renaming a Liveboard or visualization.
|
|
3858
|
-
*
|
|
3859
3794
|
* @example
|
|
3860
3795
|
* ```js
|
|
3861
3796
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3899,7 +3834,6 @@ export declare enum Action {
|
|
|
3899
3834
|
/**
|
|
3900
3835
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
3901
3836
|
* Allows moving a visualization to a different tab.
|
|
3902
|
-
*
|
|
3903
3837
|
* @example
|
|
3904
3838
|
* ```js
|
|
3905
3839
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -3908,7 +3842,6 @@ export declare enum Action {
|
|
|
3908
3842
|
MoveToTab = "onContainerMove",
|
|
3909
3843
|
/**
|
|
3910
3844
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
3911
|
-
*
|
|
3912
3845
|
* @example
|
|
3913
3846
|
* ```js
|
|
3914
3847
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -3917,7 +3850,6 @@ export declare enum Action {
|
|
|
3917
3850
|
ManageMonitor = "ManageMonitor",
|
|
3918
3851
|
/**
|
|
3919
3852
|
* Action ID for Liveboard Personalised Views dropdown
|
|
3920
|
-
*
|
|
3921
3853
|
* @example
|
|
3922
3854
|
* ```js
|
|
3923
3855
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -3927,7 +3859,6 @@ export declare enum Action {
|
|
|
3927
3859
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
3928
3860
|
/**
|
|
3929
3861
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
3930
|
-
*
|
|
3931
3862
|
* @example
|
|
3932
3863
|
* ```js
|
|
3933
3864
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -3939,7 +3870,6 @@ export declare enum Action {
|
|
|
3939
3870
|
* Action ID for the Parent TML action
|
|
3940
3871
|
* The parent action **TML** must be included to access TML-related options
|
|
3941
3872
|
* within the cascading menu (specific to the answer page)
|
|
3942
|
-
*
|
|
3943
3873
|
* @example
|
|
3944
3874
|
* ```js
|
|
3945
3875
|
* // to include specific TML actions
|
|
@@ -3951,13 +3881,11 @@ export declare enum Action {
|
|
|
3951
3881
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
3952
3882
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
3953
3883
|
* ```
|
|
3954
|
-
*
|
|
3955
|
-
* @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
|
|
3884
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
3956
3885
|
*/
|
|
3957
3886
|
TML = "tml",
|
|
3958
3887
|
/**
|
|
3959
3888
|
* Action ID for to hide Verified Liveboard Banner
|
|
3960
|
-
*
|
|
3961
3889
|
* @example
|
|
3962
3890
|
* ```js
|
|
3963
3891
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -3967,7 +3895,6 @@ export declare enum Action {
|
|
|
3967
3895
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
3968
3896
|
/**
|
|
3969
3897
|
* Action ID for ask sage button
|
|
3970
|
-
*
|
|
3971
3898
|
* @example
|
|
3972
3899
|
* ```js
|
|
3973
3900
|
* hiddenAction: [Action.AskAi]
|
|
@@ -3977,7 +3904,6 @@ export declare enum Action {
|
|
|
3977
3904
|
AskAi = "AskAi",
|
|
3978
3905
|
/**
|
|
3979
3906
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
3980
|
-
*
|
|
3981
3907
|
* @example
|
|
3982
3908
|
* ```js
|
|
3983
3909
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -3987,7 +3913,6 @@ export declare enum Action {
|
|
|
3987
3913
|
AddToWatchlist = "addToWatchlist",
|
|
3988
3914
|
/**
|
|
3989
3915
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
3990
|
-
*
|
|
3991
3916
|
* @example
|
|
3992
3917
|
* ```js
|
|
3993
3918
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -3995,19 +3920,8 @@ export declare enum Action {
|
|
|
3995
3920
|
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
3996
3921
|
*/
|
|
3997
3922
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
3998
|
-
/**
|
|
3999
|
-
* The **Copy KPI Link** menu action on KPI watchlist.
|
|
4000
|
-
*
|
|
4001
|
-
* @example
|
|
4002
|
-
* ```js
|
|
4003
|
-
* disabledActions: [Action.CopyKpiLink]
|
|
4004
|
-
* ```
|
|
4005
|
-
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
4006
|
-
*/
|
|
4007
|
-
CopyKpiLink = "copyKpiLink",
|
|
4008
3923
|
/**
|
|
4009
3924
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
4010
|
-
*
|
|
4011
3925
|
* @example
|
|
4012
3926
|
* ```js
|
|
4013
3927
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -4017,7 +3931,6 @@ export declare enum Action {
|
|
|
4017
3931
|
OrganiseFavourites = "organiseFavourites",
|
|
4018
3932
|
/**
|
|
4019
3933
|
* Action ID for AI Highlights button
|
|
4020
|
-
*
|
|
4021
3934
|
* @example
|
|
4022
3935
|
* ```js
|
|
4023
3936
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -4086,7 +3999,6 @@ export interface CustomActionPayload {
|
|
|
4086
3999
|
export declare enum LogLevel {
|
|
4087
4000
|
/**
|
|
4088
4001
|
* No logs will be logged in the console.
|
|
4089
|
-
*
|
|
4090
4002
|
* @example
|
|
4091
4003
|
* ```js
|
|
4092
4004
|
* init({
|
|
@@ -4099,7 +4011,6 @@ export declare enum LogLevel {
|
|
|
4099
4011
|
SILENT = "SILENT",
|
|
4100
4012
|
/**
|
|
4101
4013
|
* Only ERROR logs will be logged in the console.
|
|
4102
|
-
*
|
|
4103
4014
|
* @example
|
|
4104
4015
|
* ```js
|
|
4105
4016
|
* init({
|
|
@@ -4112,7 +4023,6 @@ export declare enum LogLevel {
|
|
|
4112
4023
|
ERROR = "ERROR",
|
|
4113
4024
|
/**
|
|
4114
4025
|
* Only WARN and ERROR logs will be logged in the console.
|
|
4115
|
-
*
|
|
4116
4026
|
* @example
|
|
4117
4027
|
* ```js
|
|
4118
4028
|
* init({
|
|
@@ -4125,7 +4035,6 @@ export declare enum LogLevel {
|
|
|
4125
4035
|
WARN = "WARN",
|
|
4126
4036
|
/**
|
|
4127
4037
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
4128
|
-
*
|
|
4129
4038
|
* @example
|
|
4130
4039
|
* ```js
|
|
4131
4040
|
* init({
|
|
@@ -4138,7 +4047,6 @@ export declare enum LogLevel {
|
|
|
4138
4047
|
INFO = "INFO",
|
|
4139
4048
|
/**
|
|
4140
4049
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
4141
|
-
*
|
|
4142
4050
|
* @example
|
|
4143
4051
|
* ```js
|
|
4144
4052
|
* init({
|
|
@@ -4151,7 +4059,6 @@ export declare enum LogLevel {
|
|
|
4151
4059
|
DEBUG = "DEBUG",
|
|
4152
4060
|
/**
|
|
4153
4061
|
* All logs will be logged in the console.
|
|
4154
|
-
*
|
|
4155
4062
|
* @example
|
|
4156
4063
|
* ```js
|
|
4157
4064
|
* init({
|