@thoughtspot/visual-embed-sdk 1.29.1-alpha.1 → 1.29.1
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 +246 -367
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +197 -297
- 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 +2 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +57 -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 +246 -367
- 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 +2 -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 +6902 -7009
- package/dist/tsembed-react.js +6896 -7000
- package/dist/tsembed.es.js +3832 -4141
- package/dist/tsembed.js +15218 -15519
- package/dist/visual-embed-sdk-react-full.d.ts +450 -646
- package/dist/visual-embed-sdk-react.d.ts +450 -646
- package/dist/visual-embed-sdk.d.ts +449 -634
- 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 +246 -367
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +197 -297
- 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 +2 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +56 -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 +456 -645
- 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 +246 -366
- 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 +58 -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/lib/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?: {
|
|
@@ -536,19 +504,16 @@ export interface EmbedConfig {
|
|
|
536
504
|
/**
|
|
537
505
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
538
506
|
* is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
|
|
539
|
-
*
|
|
540
507
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
541
508
|
*/
|
|
542
509
|
pendoTrackingKey?: string;
|
|
543
510
|
/**
|
|
544
511
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
545
|
-
*
|
|
546
512
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
547
513
|
*/
|
|
548
514
|
suppressErrorAlerts?: boolean;
|
|
549
515
|
/**
|
|
550
516
|
* Log level for the SDK.
|
|
551
|
-
*
|
|
552
517
|
* @default LogLevel.ERROR
|
|
553
518
|
* @example
|
|
554
519
|
* ```js
|
|
@@ -562,16 +527,43 @@ export interface EmbedConfig {
|
|
|
562
527
|
logLevel?: LogLevel;
|
|
563
528
|
/**
|
|
564
529
|
* Disables the Mixpanel tracking from the SDK.
|
|
565
|
-
*
|
|
566
530
|
* @version SDK: 1.27.9
|
|
567
531
|
*/
|
|
568
532
|
disableSDKTracking?: boolean;
|
|
533
|
+
/**
|
|
534
|
+
* Overrides default/user preffered locale for date formatting
|
|
535
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
536
|
+
*/
|
|
537
|
+
dateFormatLocale?: string;
|
|
538
|
+
/**
|
|
539
|
+
* Overrides default/user preffered locale for number formatting
|
|
540
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
541
|
+
*/
|
|
542
|
+
numberFormatLocale?: string;
|
|
543
|
+
/**
|
|
544
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
545
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
546
|
+
*/
|
|
547
|
+
currencyFormat?: string;
|
|
548
|
+
/**
|
|
549
|
+
* This flag is used to disable the token verification in the SDK.
|
|
550
|
+
* Enabling this flag will also disable the caching of the token.
|
|
551
|
+
* @hidden
|
|
552
|
+
* @example
|
|
553
|
+
* ```js
|
|
554
|
+
* init({
|
|
555
|
+
* ...embedConfig,
|
|
556
|
+
* disableTokenVerification : true
|
|
557
|
+
* })
|
|
558
|
+
* ```
|
|
559
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
560
|
+
*/
|
|
561
|
+
disableTokenVerification?: boolean;
|
|
569
562
|
}
|
|
570
563
|
export interface LayoutConfig {
|
|
571
564
|
}
|
|
572
565
|
/**
|
|
573
566
|
* Embedded iframe configuration
|
|
574
|
-
*
|
|
575
567
|
* @group Embed components
|
|
576
568
|
*/
|
|
577
569
|
export interface FrameParams {
|
|
@@ -606,9 +598,7 @@ export interface ViewConfig {
|
|
|
606
598
|
/**
|
|
607
599
|
* The width and height dimensions to render an embedded
|
|
608
600
|
* object inside your app. Specify the values in pixels or percentage.
|
|
609
|
-
*
|
|
610
601
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
611
|
-
*
|
|
612
602
|
* @example
|
|
613
603
|
* ```js
|
|
614
604
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -634,7 +624,6 @@ export interface ViewConfig {
|
|
|
634
624
|
* (...), and the contextual menu. These actions will be disabled
|
|
635
625
|
* for the user.
|
|
636
626
|
* Use this to disable actions.
|
|
637
|
-
*
|
|
638
627
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
639
628
|
* @example
|
|
640
629
|
* ```js
|
|
@@ -662,9 +651,7 @@ export interface ViewConfig {
|
|
|
662
651
|
* The list of actions to hide from the embedded.
|
|
663
652
|
* This actions will be hidden from the user.
|
|
664
653
|
* Use this to hide an action.
|
|
665
|
-
*
|
|
666
654
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
667
|
-
*
|
|
668
655
|
* @example
|
|
669
656
|
* ```js
|
|
670
657
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -682,10 +669,8 @@ export interface ViewConfig {
|
|
|
682
669
|
* Use this to hide all actions except the ones you want to show.
|
|
683
670
|
*
|
|
684
671
|
* Use either this or hiddenActions.
|
|
685
|
-
*
|
|
686
672
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
687
673
|
* @important
|
|
688
|
-
*
|
|
689
674
|
* @example
|
|
690
675
|
* ```js
|
|
691
676
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -697,9 +682,7 @@ export interface ViewConfig {
|
|
|
697
682
|
visibleActions?: Action[];
|
|
698
683
|
/**
|
|
699
684
|
* Show alert messages and toast messages in the embedded view.
|
|
700
|
-
*
|
|
701
685
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
702
|
-
*
|
|
703
686
|
* @example
|
|
704
687
|
* ```js
|
|
705
688
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -712,9 +695,7 @@ export interface ViewConfig {
|
|
|
712
695
|
/**
|
|
713
696
|
* The list of runtime filters to apply to a search answer,
|
|
714
697
|
* visualization, or Liveboard.
|
|
715
|
-
*
|
|
716
698
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
717
|
-
*
|
|
718
699
|
* @example
|
|
719
700
|
* ```js
|
|
720
701
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -733,9 +714,7 @@ export interface ViewConfig {
|
|
|
733
714
|
/**
|
|
734
715
|
* The list of parameter override to apply to a search answer,
|
|
735
716
|
* visualization, or Liveboard.
|
|
736
|
-
*
|
|
737
717
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
738
|
-
*
|
|
739
718
|
* @example
|
|
740
719
|
* ```js
|
|
741
720
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -752,7 +731,6 @@ export interface ViewConfig {
|
|
|
752
731
|
runtimeParameters?: RuntimeParameter[];
|
|
753
732
|
/**
|
|
754
733
|
* The locale/language to use for the embedded view.
|
|
755
|
-
*
|
|
756
734
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
757
735
|
* @example
|
|
758
736
|
* ```js
|
|
@@ -788,7 +766,6 @@ export interface ViewConfig {
|
|
|
788
766
|
/**
|
|
789
767
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
790
768
|
* You would also need to set `style-src` in the CSP settings.
|
|
791
|
-
*
|
|
792
769
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
793
770
|
* @default ''
|
|
794
771
|
*/
|
|
@@ -796,9 +773,7 @@ export interface ViewConfig {
|
|
|
796
773
|
/**
|
|
797
774
|
* Insert as a sibling of the target container, instead of appending to a
|
|
798
775
|
* child inside it.
|
|
799
|
-
*
|
|
800
776
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
801
|
-
*
|
|
802
777
|
* @example
|
|
803
778
|
* ```js
|
|
804
779
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -810,7 +785,6 @@ export interface ViewConfig {
|
|
|
810
785
|
insertAsSibling?: boolean;
|
|
811
786
|
/**
|
|
812
787
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
813
|
-
*
|
|
814
788
|
* @example
|
|
815
789
|
* ```js
|
|
816
790
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -823,7 +797,6 @@ export interface ViewConfig {
|
|
|
823
797
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
824
798
|
/**
|
|
825
799
|
* Flag to override openNew tab context menu link
|
|
826
|
-
*
|
|
827
800
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
828
801
|
* @example
|
|
829
802
|
* ```js
|
|
@@ -836,7 +809,6 @@ export interface ViewConfig {
|
|
|
836
809
|
linkOverride?: boolean;
|
|
837
810
|
/**
|
|
838
811
|
* flag to enable insert into slides action
|
|
839
|
-
*
|
|
840
812
|
* @hidden
|
|
841
813
|
* @private
|
|
842
814
|
*/
|
|
@@ -844,7 +816,6 @@ export interface ViewConfig {
|
|
|
844
816
|
/**
|
|
845
817
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
846
818
|
* if available and matches the configuration.
|
|
847
|
-
*
|
|
848
819
|
* @version SDK: 1.22.0
|
|
849
820
|
* @hidden
|
|
850
821
|
*
|
|
@@ -858,7 +829,6 @@ export interface ViewConfig {
|
|
|
858
829
|
*
|
|
859
830
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
860
831
|
* embedded view.
|
|
861
|
-
*
|
|
862
832
|
* @default false
|
|
863
833
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
864
834
|
*/
|
|
@@ -867,7 +837,6 @@ export interface ViewConfig {
|
|
|
867
837
|
* The list of tab IDs to hide from the embedded.
|
|
868
838
|
* This Tabs will be hidden from their respective LBs.
|
|
869
839
|
* Use this to hide an tabID.
|
|
870
|
-
*
|
|
871
840
|
* @example
|
|
872
841
|
* ```js
|
|
873
842
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -884,10 +853,11 @@ export interface ViewConfig {
|
|
|
884
853
|
* Hide the home page modules
|
|
885
854
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
886
855
|
*
|
|
856
|
+
*
|
|
857
|
+
*
|
|
887
858
|
* **Note**: This option does not apply to the classic homepage.
|
|
888
859
|
* To access the updated modular homepage, set
|
|
889
860
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
890
|
-
*
|
|
891
861
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
892
862
|
* @example
|
|
893
863
|
* ```js
|
|
@@ -896,19 +866,17 @@ export interface ViewConfig {
|
|
|
896
866
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
897
867
|
* })
|
|
898
868
|
* ```
|
|
899
|
-
*
|
|
900
869
|
*/
|
|
901
870
|
hiddenHomepageModules?: HomepageModule[];
|
|
902
871
|
/**
|
|
903
872
|
* reordering the home page modules
|
|
904
873
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
905
874
|
*
|
|
875
|
+
*
|
|
906
876
|
* **Note**: This option does not apply to the classic homepage.
|
|
907
877
|
* To access the updated modular homepage, set
|
|
908
878
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
909
|
-
*
|
|
910
879
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
911
|
-
*
|
|
912
880
|
* @example
|
|
913
881
|
* ```js
|
|
914
882
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -923,9 +891,7 @@ export interface ViewConfig {
|
|
|
923
891
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
924
892
|
*
|
|
925
893
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
926
|
-
*
|
|
927
894
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
928
|
-
*
|
|
929
895
|
* @example
|
|
930
896
|
* ```js
|
|
931
897
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -942,8 +908,7 @@ export interface ViewConfig {
|
|
|
942
908
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
943
909
|
* There are 8 eight home navigation list items.
|
|
944
910
|
* To hide these items, specify the string in the array.
|
|
945
|
-
*
|
|
946
|
-
* * @example
|
|
911
|
+
* @example
|
|
947
912
|
* ```js
|
|
948
913
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
949
914
|
* ... // other options
|
|
@@ -951,10 +916,11 @@ export interface ViewConfig {
|
|
|
951
916
|
* })
|
|
952
917
|
* ```
|
|
953
918
|
*
|
|
919
|
+
*
|
|
920
|
+
*
|
|
954
921
|
* **Note**: This option does not apply to the classic homepage.
|
|
955
922
|
* To access the updated modular homepage, set
|
|
956
923
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
957
|
-
*
|
|
958
924
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
959
925
|
*/
|
|
960
926
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -962,7 +928,6 @@ export interface ViewConfig {
|
|
|
962
928
|
* PreRender id to be used for PreRendering the embed.
|
|
963
929
|
* Use PreRender to render the embed in the background and then
|
|
964
930
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
965
|
-
*
|
|
966
931
|
* @example
|
|
967
932
|
* ```js
|
|
968
933
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -979,11 +944,9 @@ export interface ViewConfig {
|
|
|
979
944
|
* of its embedding element and adjust its own size accordingly.
|
|
980
945
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
981
946
|
* its dimensions based on changes to the size of the embedding element.
|
|
982
|
-
*
|
|
983
947
|
* @type {boolean}
|
|
984
948
|
* @default false
|
|
985
949
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
986
|
-
*
|
|
987
950
|
* @example
|
|
988
951
|
* ```js
|
|
989
952
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -998,14 +961,22 @@ export interface ViewConfig {
|
|
|
998
961
|
doNotTrackPreRenderSize?: boolean;
|
|
999
962
|
/**
|
|
1000
963
|
* For internal tracking of the embed component type.
|
|
1001
|
-
*
|
|
1002
964
|
* @hidden
|
|
1003
965
|
*/
|
|
1004
966
|
embedComponentType?: string;
|
|
967
|
+
/**
|
|
968
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
969
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
970
|
+
*
|
|
971
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
972
|
+
* embedded view.
|
|
973
|
+
* @default false
|
|
974
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
975
|
+
*/
|
|
976
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
1005
977
|
}
|
|
1006
978
|
/**
|
|
1007
979
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
1008
|
-
*
|
|
1009
980
|
* @group Events
|
|
1010
981
|
*/
|
|
1011
982
|
export type MessagePayload = {
|
|
@@ -1016,7 +987,6 @@ export type MessagePayload = {
|
|
|
1016
987
|
/**
|
|
1017
988
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
1018
989
|
* option
|
|
1019
|
-
*
|
|
1020
990
|
* @group Events
|
|
1021
991
|
*/
|
|
1022
992
|
export type MessageOptions = {
|
|
@@ -1028,7 +998,6 @@ export type MessageOptions = {
|
|
|
1028
998
|
};
|
|
1029
999
|
/**
|
|
1030
1000
|
* MessageCallback: Embed event message callback
|
|
1031
|
-
*
|
|
1032
1001
|
* @group Events
|
|
1033
1002
|
*/
|
|
1034
1003
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -1118,7 +1087,6 @@ export declare enum RuntimeFilterOp {
|
|
|
1118
1087
|
* **Note**: This option does not apply to the classic homepage.
|
|
1119
1088
|
* To access the updated modular homepage, set
|
|
1120
1089
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1121
|
-
*
|
|
1122
1090
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1123
1091
|
*/
|
|
1124
1092
|
export declare enum HomepageModule {
|
|
@@ -1165,7 +1133,7 @@ export interface RuntimeFilter {
|
|
|
1165
1133
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
1166
1134
|
* operands.
|
|
1167
1135
|
*/
|
|
1168
|
-
values: (number | boolean | string)[];
|
|
1136
|
+
values: (number | boolean | string | bigint)[];
|
|
1169
1137
|
}
|
|
1170
1138
|
/**
|
|
1171
1139
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -1186,7 +1154,6 @@ export interface RuntimeParameter {
|
|
|
1186
1154
|
*
|
|
1187
1155
|
* To add an event listener use the corresponding
|
|
1188
1156
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
1189
|
-
*
|
|
1190
1157
|
* @example
|
|
1191
1158
|
* ```js
|
|
1192
1159
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1204,7 +1171,6 @@ export interface RuntimeParameter {
|
|
|
1204
1171
|
export declare enum EmbedEvent {
|
|
1205
1172
|
/**
|
|
1206
1173
|
* Rendering has initialized.
|
|
1207
|
-
*
|
|
1208
1174
|
* @example
|
|
1209
1175
|
*```js
|
|
1210
1176
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -1218,7 +1184,7 @@ export declare enum EmbedEvent {
|
|
|
1218
1184
|
Init = "init",
|
|
1219
1185
|
/**
|
|
1220
1186
|
* Authentication has either succeeded or failed.
|
|
1221
|
-
*
|
|
1187
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1222
1188
|
* @example
|
|
1223
1189
|
*```js
|
|
1224
1190
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -1230,8 +1196,8 @@ export declare enum EmbedEvent {
|
|
|
1230
1196
|
AuthInit = "authInit",
|
|
1231
1197
|
/**
|
|
1232
1198
|
* The embed object container has loaded.
|
|
1233
|
-
*
|
|
1234
1199
|
* @returns timestamp - The timestamp when the event was generated.
|
|
1200
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1235
1201
|
* @example
|
|
1236
1202
|
*```js
|
|
1237
1203
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -1244,8 +1210,8 @@ export declare enum EmbedEvent {
|
|
|
1244
1210
|
Load = "load",
|
|
1245
1211
|
/**
|
|
1246
1212
|
* Data pertaining to answer or Liveboard is received
|
|
1247
|
-
*
|
|
1248
1213
|
* @return data - The answer or Liveboard data
|
|
1214
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1249
1215
|
* @example
|
|
1250
1216
|
*```js
|
|
1251
1217
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -1257,13 +1223,12 @@ export declare enum EmbedEvent {
|
|
|
1257
1223
|
Data = "data",
|
|
1258
1224
|
/**
|
|
1259
1225
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
1260
|
-
*
|
|
1261
1226
|
* @hidden
|
|
1262
1227
|
*/
|
|
1263
1228
|
FiltersChanged = "filtersChanged",
|
|
1264
1229
|
/**
|
|
1265
1230
|
* Search query has been updated by the user.
|
|
1266
|
-
*
|
|
1231
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1267
1232
|
* @example
|
|
1268
1233
|
*```js
|
|
1269
1234
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -1272,13 +1237,13 @@ export declare enum EmbedEvent {
|
|
|
1272
1237
|
QueryChanged = "queryChanged",
|
|
1273
1238
|
/**
|
|
1274
1239
|
* A drill-down operation has been performed.
|
|
1275
|
-
*
|
|
1240
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1276
1241
|
* @returns additionalFilters - Any additional filters applied
|
|
1277
1242
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
1278
1243
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
1279
1244
|
* @example
|
|
1280
1245
|
*```js
|
|
1281
|
-
* searchEmbed.
|
|
1246
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
1282
1247
|
* points: {
|
|
1283
1248
|
* clickedPoint,
|
|
1284
1249
|
* selectedPoints: selectedPoint
|
|
@@ -1309,8 +1274,8 @@ export declare enum EmbedEvent {
|
|
|
1309
1274
|
Drilldown = "drillDown",
|
|
1310
1275
|
/**
|
|
1311
1276
|
* One or more data sources have been selected.
|
|
1312
|
-
*
|
|
1313
1277
|
* @returns dataSourceIds - the list of data sources
|
|
1278
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1314
1279
|
* @example
|
|
1315
1280
|
* ```js
|
|
1316
1281
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -1321,7 +1286,6 @@ export declare enum EmbedEvent {
|
|
|
1321
1286
|
DataSourceSelected = "dataSourceSelected",
|
|
1322
1287
|
/**
|
|
1323
1288
|
* One or more data columns have been selected.
|
|
1324
|
-
*
|
|
1325
1289
|
* @returns columnIds - the list of columns
|
|
1326
1290
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1327
1291
|
* @example
|
|
@@ -1334,10 +1298,10 @@ export declare enum EmbedEvent {
|
|
|
1334
1298
|
AddRemoveColumns = "addRemoveColumns",
|
|
1335
1299
|
/**
|
|
1336
1300
|
* A custom action has been triggered.
|
|
1337
|
-
*
|
|
1338
1301
|
* @returns actionId - ID of the custom action
|
|
1339
1302
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
1340
1303
|
* Answer or Liveboard data
|
|
1304
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1341
1305
|
* @example
|
|
1342
1306
|
* ```js
|
|
1343
1307
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -1351,7 +1315,6 @@ export declare enum EmbedEvent {
|
|
|
1351
1315
|
CustomAction = "customAction",
|
|
1352
1316
|
/**
|
|
1353
1317
|
* Listen to double click actions on a visualization.
|
|
1354
|
-
*
|
|
1355
1318
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
1356
1319
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1357
1320
|
* @example
|
|
@@ -1364,7 +1327,6 @@ export declare enum EmbedEvent {
|
|
|
1364
1327
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
1365
1328
|
/**
|
|
1366
1329
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
1367
|
-
*
|
|
1368
1330
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
1369
1331
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1370
1332
|
* @important
|
|
@@ -1385,21 +1347,22 @@ export declare enum EmbedEvent {
|
|
|
1385
1347
|
/**
|
|
1386
1348
|
* An error has occurred. This event is fired for the following error types:
|
|
1387
1349
|
*
|
|
1388
|
-
*
|
|
1389
|
-
*
|
|
1390
|
-
* FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
|
|
1350
|
+
* `API`: API call failure error.
|
|
1391
1351
|
*
|
|
1392
|
-
*
|
|
1352
|
+
* `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
|
|
1353
|
+
* mode.
|
|
1393
1354
|
*
|
|
1394
|
-
*
|
|
1355
|
+
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
1395
1356
|
*
|
|
1396
|
-
*
|
|
1357
|
+
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
1397
1358
|
*
|
|
1398
|
-
*
|
|
1359
|
+
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
1399
1360
|
*
|
|
1400
|
-
*
|
|
1361
|
+
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
1401
1362
|
*
|
|
1363
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
1402
1364
|
* @returns error - An error object or message
|
|
1365
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1403
1366
|
* @example
|
|
1404
1367
|
* ```js
|
|
1405
1368
|
* // API error
|
|
@@ -1423,8 +1386,8 @@ export declare enum EmbedEvent {
|
|
|
1423
1386
|
Error = "Error",
|
|
1424
1387
|
/**
|
|
1425
1388
|
* The embedded object has sent an alert.
|
|
1426
|
-
*
|
|
1427
1389
|
* @returns alert - An alert object
|
|
1390
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1428
1391
|
* @example
|
|
1429
1392
|
* ```js
|
|
1430
1393
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -1433,7 +1396,7 @@ export declare enum EmbedEvent {
|
|
|
1433
1396
|
Alert = "alert",
|
|
1434
1397
|
/**
|
|
1435
1398
|
* The ThoughtSpot auth session has expired.
|
|
1436
|
-
*
|
|
1399
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1437
1400
|
* @example
|
|
1438
1401
|
*```js
|
|
1439
1402
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -1446,26 +1409,22 @@ export declare enum EmbedEvent {
|
|
|
1446
1409
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
1447
1410
|
/**
|
|
1448
1411
|
* ThoughtSpot failed to validate the auth session.
|
|
1449
|
-
*
|
|
1450
1412
|
* @hidden
|
|
1451
1413
|
*/
|
|
1452
1414
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
1453
1415
|
/**
|
|
1454
1416
|
* ThoughtSpot failed to validate the auth session.
|
|
1455
|
-
*
|
|
1456
1417
|
* @hidden
|
|
1457
1418
|
*/
|
|
1458
1419
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
1459
1420
|
/**
|
|
1460
1421
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
1461
|
-
*
|
|
1462
1422
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
1463
1423
|
* @hidden
|
|
1464
1424
|
*/
|
|
1465
1425
|
EmbedHeight = "EMBED_HEIGHT",
|
|
1466
1426
|
/**
|
|
1467
1427
|
* The center of visible iframe viewport is calculated.
|
|
1468
|
-
*
|
|
1469
1428
|
* @returns data - The center of the visible Iframe viewport.
|
|
1470
1429
|
* @hidden
|
|
1471
1430
|
*/
|
|
@@ -1473,7 +1432,6 @@ export declare enum EmbedEvent {
|
|
|
1473
1432
|
/**
|
|
1474
1433
|
* Emitted when the **Get Data** action is initiated.
|
|
1475
1434
|
* Applicable to `SearchBarEmbed` only.
|
|
1476
|
-
*
|
|
1477
1435
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1478
1436
|
* @example
|
|
1479
1437
|
*```js
|
|
@@ -1486,7 +1444,7 @@ export declare enum EmbedEvent {
|
|
|
1486
1444
|
GetDataClick = "getDataClick",
|
|
1487
1445
|
/**
|
|
1488
1446
|
* Detects the route change.
|
|
1489
|
-
*
|
|
1447
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
1490
1448
|
* @example
|
|
1491
1449
|
*```js
|
|
1492
1450
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -1496,15 +1454,13 @@ export declare enum EmbedEvent {
|
|
|
1496
1454
|
RouteChange = "ROUTE_CHANGE",
|
|
1497
1455
|
/**
|
|
1498
1456
|
* The v1 event type for Data
|
|
1499
|
-
*
|
|
1500
1457
|
* @hidden
|
|
1501
1458
|
*/
|
|
1502
1459
|
V1Data = "exportVizDataToParent",
|
|
1503
1460
|
/**
|
|
1504
1461
|
* Emitted when the embed does not have cookie access. This happens
|
|
1505
1462
|
* when Safari and other Web browsers block third-party cookies
|
|
1506
|
-
* are blocked by default.
|
|
1507
|
-
*
|
|
1463
|
+
* are blocked by default.
|
|
1508
1464
|
* @example
|
|
1509
1465
|
*```js
|
|
1510
1466
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -1514,14 +1470,12 @@ export declare enum EmbedEvent {
|
|
|
1514
1470
|
NoCookieAccess = "noCookieAccess",
|
|
1515
1471
|
/**
|
|
1516
1472
|
* Emitted when SAML is complete
|
|
1517
|
-
*
|
|
1518
1473
|
* @private
|
|
1519
1474
|
* @hidden
|
|
1520
1475
|
*/
|
|
1521
1476
|
SAMLComplete = "samlComplete",
|
|
1522
1477
|
/**
|
|
1523
1478
|
* Emitted when any modal is opened in the app
|
|
1524
|
-
*
|
|
1525
1479
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1526
1480
|
* @example
|
|
1527
1481
|
*```js
|
|
@@ -1533,7 +1487,6 @@ export declare enum EmbedEvent {
|
|
|
1533
1487
|
DialogOpen = "dialog-open",
|
|
1534
1488
|
/**
|
|
1535
1489
|
* Emitted when any modal is closed in the app
|
|
1536
|
-
*
|
|
1537
1490
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1538
1491
|
* @example
|
|
1539
1492
|
*```js
|
|
@@ -1546,8 +1499,7 @@ export declare enum EmbedEvent {
|
|
|
1546
1499
|
/**
|
|
1547
1500
|
* Emitted when the Liveboard shell loads.
|
|
1548
1501
|
* You can use this event as a hook to trigger
|
|
1549
|
-
*
|
|
1550
|
-
*
|
|
1502
|
+
* actions on the rendered Liveboard.
|
|
1551
1503
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1552
1504
|
* @example
|
|
1553
1505
|
*```js
|
|
@@ -1567,9 +1519,7 @@ export declare enum EmbedEvent {
|
|
|
1567
1519
|
*/
|
|
1568
1520
|
LiveboardRendered = "PinboardRendered",
|
|
1569
1521
|
/**
|
|
1570
|
-
*
|
|
1571
|
-
* is triggered on all events.
|
|
1572
|
-
*
|
|
1522
|
+
* Emits all events.
|
|
1573
1523
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1574
1524
|
* @example
|
|
1575
1525
|
*```js
|
|
@@ -1581,17 +1531,16 @@ export declare enum EmbedEvent {
|
|
|
1581
1531
|
ALL = "*",
|
|
1582
1532
|
/**
|
|
1583
1533
|
* Emitted when an Answer is saved in the app
|
|
1584
|
-
*
|
|
1585
1534
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1586
1535
|
* @example
|
|
1587
1536
|
*```js
|
|
1588
|
-
* //
|
|
1537
|
+
* //Emit when action starts
|
|
1589
1538
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1590
1539
|
* console.log('Save', payload)
|
|
1591
1540
|
* }, {
|
|
1592
1541
|
* start: true
|
|
1593
1542
|
* })
|
|
1594
|
-
* //
|
|
1543
|
+
* //emit when action ends
|
|
1595
1544
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1596
1545
|
* console.log('Save', payload)
|
|
1597
1546
|
* })
|
|
@@ -1601,15 +1550,14 @@ export declare enum EmbedEvent {
|
|
|
1601
1550
|
/**
|
|
1602
1551
|
* Emitted when the download action is triggered on an answer
|
|
1603
1552
|
*
|
|
1604
|
-
* **Note**:
|
|
1553
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
1605
1554
|
* To fire an event when a download action is initiated on a chart or table,
|
|
1606
1555
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
1607
1556
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
1608
|
-
*
|
|
1609
1557
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1610
1558
|
* @example
|
|
1611
1559
|
*```js
|
|
1612
|
-
* liveboardEmbed.
|
|
1560
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
1613
1561
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1614
1562
|
* })
|
|
1615
1563
|
*```
|
|
@@ -1617,14 +1565,13 @@ export declare enum EmbedEvent {
|
|
|
1617
1565
|
Download = "download",
|
|
1618
1566
|
/**
|
|
1619
1567
|
* Emitted when the download action is triggered on an answer
|
|
1620
|
-
*
|
|
1621
1568
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1622
1569
|
* @example
|
|
1623
1570
|
*```js
|
|
1624
|
-
* //
|
|
1571
|
+
* //emit when action starts
|
|
1625
1572
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1626
1573
|
* console.log('download PNG', payload)}, {start: true })
|
|
1627
|
-
* //
|
|
1574
|
+
* //emit when action ends
|
|
1628
1575
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1629
1576
|
* console.log('download PNG', payload)})
|
|
1630
1577
|
*```
|
|
@@ -1632,14 +1579,13 @@ export declare enum EmbedEvent {
|
|
|
1632
1579
|
DownloadAsPng = "downloadAsPng",
|
|
1633
1580
|
/**
|
|
1634
1581
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
1635
|
-
*
|
|
1636
1582
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1637
1583
|
* @example
|
|
1638
1584
|
*```js
|
|
1639
|
-
* //
|
|
1585
|
+
* //emit when action starts
|
|
1640
1586
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1641
1587
|
* console.log('download PDF', payload)}, {start: true })
|
|
1642
|
-
* //
|
|
1588
|
+
* //emit when action ends
|
|
1643
1589
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1644
1590
|
* console.log('download PDF', payload)})
|
|
1645
1591
|
*```
|
|
@@ -1647,14 +1593,13 @@ export declare enum EmbedEvent {
|
|
|
1647
1593
|
DownloadAsPdf = "downloadAsPdf",
|
|
1648
1594
|
/**
|
|
1649
1595
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
1650
|
-
*
|
|
1651
1596
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1652
1597
|
* @example
|
|
1653
1598
|
*```js
|
|
1654
|
-
* //
|
|
1599
|
+
* //emit when action starts
|
|
1655
1600
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1656
1601
|
* console.log('download CSV', payload)}, {start: true })
|
|
1657
|
-
* //
|
|
1602
|
+
* //emit when action ends
|
|
1658
1603
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1659
1604
|
* console.log('download CSV', payload)})
|
|
1660
1605
|
*```
|
|
@@ -1662,14 +1607,13 @@ export declare enum EmbedEvent {
|
|
|
1662
1607
|
DownloadAsCsv = "downloadAsCsv",
|
|
1663
1608
|
/**
|
|
1664
1609
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1665
|
-
*
|
|
1666
1610
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1667
1611
|
* @example
|
|
1668
1612
|
*```js
|
|
1669
|
-
* //
|
|
1613
|
+
* //emit when action starts
|
|
1670
1614
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1671
1615
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
1672
|
-
* //
|
|
1616
|
+
* //emit when action ends
|
|
1673
1617
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1674
1618
|
* console.log('download Xlsx', payload)})
|
|
1675
1619
|
*```
|
|
@@ -1677,14 +1621,13 @@ export declare enum EmbedEvent {
|
|
|
1677
1621
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
1678
1622
|
/**
|
|
1679
1623
|
* Emitted when an Answer is deleted in the app
|
|
1680
|
-
*
|
|
1681
1624
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1682
1625
|
* @example
|
|
1683
1626
|
*```js
|
|
1684
|
-
* //
|
|
1627
|
+
* //emit when action starts
|
|
1685
1628
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1686
1629
|
* console.log('delete answer', payload)}, {start: true })
|
|
1687
|
-
* //
|
|
1630
|
+
* //emit when action is completed
|
|
1688
1631
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1689
1632
|
* console.log('delete answer', payload)})
|
|
1690
1633
|
*```
|
|
@@ -1692,17 +1635,16 @@ export declare enum EmbedEvent {
|
|
|
1692
1635
|
AnswerDelete = "answerDelete",
|
|
1693
1636
|
/**
|
|
1694
1637
|
* Emitted when an answer is pinned to a Liveboard
|
|
1695
|
-
*
|
|
1696
1638
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1697
1639
|
* @example
|
|
1698
1640
|
*```js
|
|
1699
|
-
* //
|
|
1641
|
+
* //emit when action starts
|
|
1700
1642
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1701
1643
|
* console.log('pin', payload)
|
|
1702
1644
|
* }, {
|
|
1703
1645
|
* start: true
|
|
1704
1646
|
* })
|
|
1705
|
-
* //
|
|
1647
|
+
* //emit when action ends
|
|
1706
1648
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1707
1649
|
* console.log('pin', payload)
|
|
1708
1650
|
* })
|
|
@@ -1711,17 +1653,16 @@ export declare enum EmbedEvent {
|
|
|
1711
1653
|
Pin = "pin",
|
|
1712
1654
|
/**
|
|
1713
1655
|
* Emitted when SpotIQ analysis is triggered
|
|
1714
|
-
*
|
|
1715
1656
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1716
1657
|
* @example
|
|
1717
1658
|
*```js
|
|
1718
|
-
* //
|
|
1659
|
+
* //emit when action starts
|
|
1719
1660
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1720
1661
|
* console.log('SpotIQAnalyze', payload)
|
|
1721
1662
|
* }, {
|
|
1722
1663
|
* start: true
|
|
1723
1664
|
* })
|
|
1724
|
-
* //
|
|
1665
|
+
* //emit when action ends
|
|
1725
1666
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1726
1667
|
* console.log('SpotIQ analyze', payload)
|
|
1727
1668
|
* })
|
|
@@ -1730,17 +1671,16 @@ export declare enum EmbedEvent {
|
|
|
1730
1671
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
1731
1672
|
/**
|
|
1732
1673
|
* Emitted when a user shares an object with another user or group
|
|
1733
|
-
*
|
|
1734
1674
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1735
1675
|
* @example
|
|
1736
1676
|
*```js
|
|
1737
|
-
* //
|
|
1677
|
+
* //emit when action starts
|
|
1738
1678
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1739
1679
|
* console.log('Share', payload)
|
|
1740
1680
|
* }, {
|
|
1741
1681
|
* start: true
|
|
1742
1682
|
* })
|
|
1743
|
-
* //
|
|
1683
|
+
* //emit when action ends
|
|
1744
1684
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1745
1685
|
* console.log('Share', payload)
|
|
1746
1686
|
* })
|
|
@@ -1750,7 +1690,6 @@ export declare enum EmbedEvent {
|
|
|
1750
1690
|
/**
|
|
1751
1691
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
1752
1692
|
* data on a chart or table.
|
|
1753
|
-
*
|
|
1754
1693
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1755
1694
|
* @example
|
|
1756
1695
|
*```js
|
|
@@ -1763,7 +1702,6 @@ export declare enum EmbedEvent {
|
|
|
1763
1702
|
/**
|
|
1764
1703
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
1765
1704
|
* data on a chart or table
|
|
1766
|
-
*
|
|
1767
1705
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1768
1706
|
* @example
|
|
1769
1707
|
*```js
|
|
@@ -1775,7 +1713,6 @@ export declare enum EmbedEvent {
|
|
|
1775
1713
|
DrillExclude = "context-menu-item-exclude",
|
|
1776
1714
|
/**
|
|
1777
1715
|
* Emitted when a column value is copied in the embedded app.
|
|
1778
|
-
*
|
|
1779
1716
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1780
1717
|
* @example
|
|
1781
1718
|
*```js
|
|
@@ -1787,7 +1724,6 @@ export declare enum EmbedEvent {
|
|
|
1787
1724
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
1788
1725
|
/**
|
|
1789
1726
|
* Emitted when a user clicks the **Update TML** action
|
|
1790
|
-
*
|
|
1791
1727
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1792
1728
|
* @example
|
|
1793
1729
|
*```js
|
|
@@ -1798,7 +1734,6 @@ export declare enum EmbedEvent {
|
|
|
1798
1734
|
UpdateTML = "updateTSL",
|
|
1799
1735
|
/**
|
|
1800
1736
|
* Emitted when a user clicks the **Edit TML** action
|
|
1801
|
-
*
|
|
1802
1737
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1803
1738
|
* @example
|
|
1804
1739
|
*```js
|
|
@@ -1811,14 +1746,13 @@ export declare enum EmbedEvent {
|
|
|
1811
1746
|
/**
|
|
1812
1747
|
* Emitted when the **Export TML** action is triggered on an
|
|
1813
1748
|
* an embedded object in the app
|
|
1814
|
-
*
|
|
1815
1749
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1816
1750
|
* @example
|
|
1817
1751
|
*```js
|
|
1818
|
-
* //
|
|
1752
|
+
* //emit when action starts
|
|
1819
1753
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1820
1754
|
* console.log('Export TML', payload)}, { start: true })
|
|
1821
|
-
* //
|
|
1755
|
+
* //emit when action ends
|
|
1822
1756
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1823
1757
|
* console.log('Export TML', payload)})
|
|
1824
1758
|
*```
|
|
@@ -1826,7 +1760,6 @@ export declare enum EmbedEvent {
|
|
|
1826
1760
|
ExportTML = "exportTSL",
|
|
1827
1761
|
/**
|
|
1828
1762
|
* Emitted when an Answer is saved as a View.
|
|
1829
|
-
*
|
|
1830
1763
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1831
1764
|
* @example
|
|
1832
1765
|
*```js
|
|
@@ -1838,14 +1771,13 @@ export declare enum EmbedEvent {
|
|
|
1838
1771
|
SaveAsView = "saveAsView",
|
|
1839
1772
|
/**
|
|
1840
1773
|
* Emitted when the user creates a copy of an Answer
|
|
1841
|
-
*
|
|
1842
1774
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1843
1775
|
* @example
|
|
1844
1776
|
*```js
|
|
1845
|
-
* //
|
|
1777
|
+
* //emit when action starts
|
|
1846
1778
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1847
1779
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1848
|
-
* //
|
|
1780
|
+
* //emit when action ends
|
|
1849
1781
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1850
1782
|
* console.log('Copy and edit', payload)})
|
|
1851
1783
|
*```
|
|
@@ -1853,7 +1785,6 @@ export declare enum EmbedEvent {
|
|
|
1853
1785
|
CopyAEdit = "copyAEdit",
|
|
1854
1786
|
/**
|
|
1855
1787
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
1856
|
-
*
|
|
1857
1788
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1858
1789
|
* @example
|
|
1859
1790
|
*```js
|
|
@@ -1865,7 +1796,6 @@ export declare enum EmbedEvent {
|
|
|
1865
1796
|
ShowUnderlyingData = "showUnderlyingData",
|
|
1866
1797
|
/**
|
|
1867
1798
|
* Emitted when an answer is switched to a chart or table view.
|
|
1868
|
-
*
|
|
1869
1799
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1870
1800
|
* @example
|
|
1871
1801
|
*```js
|
|
@@ -1877,13 +1807,11 @@ export declare enum EmbedEvent {
|
|
|
1877
1807
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
1878
1808
|
/**
|
|
1879
1809
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
1880
|
-
*
|
|
1881
1810
|
* @hidden
|
|
1882
1811
|
*/
|
|
1883
1812
|
APP_INIT = "appInit",
|
|
1884
1813
|
/**
|
|
1885
1814
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1886
|
-
*
|
|
1887
1815
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1888
1816
|
* @example
|
|
1889
1817
|
*```js
|
|
@@ -1895,7 +1823,6 @@ export declare enum EmbedEvent {
|
|
|
1895
1823
|
LiveboardInfo = "pinboardInfo",
|
|
1896
1824
|
/**
|
|
1897
1825
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1898
|
-
*
|
|
1899
1826
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1900
1827
|
* @example
|
|
1901
1828
|
*```js
|
|
@@ -1907,7 +1834,6 @@ export declare enum EmbedEvent {
|
|
|
1907
1834
|
AddToFavorites = "addToFavorites",
|
|
1908
1835
|
/**
|
|
1909
1836
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1910
|
-
*
|
|
1911
1837
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1912
1838
|
* @example
|
|
1913
1839
|
*```js
|
|
@@ -1919,7 +1845,6 @@ export declare enum EmbedEvent {
|
|
|
1919
1845
|
Schedule = "subscription",
|
|
1920
1846
|
/**
|
|
1921
1847
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1922
|
-
*
|
|
1923
1848
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1924
1849
|
* @example
|
|
1925
1850
|
*```js
|
|
@@ -1931,7 +1856,6 @@ export declare enum EmbedEvent {
|
|
|
1931
1856
|
Edit = "edit",
|
|
1932
1857
|
/**
|
|
1933
1858
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1934
|
-
*
|
|
1935
1859
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1936
1860
|
* @example
|
|
1937
1861
|
*```js
|
|
@@ -1943,11 +1867,10 @@ export declare enum EmbedEvent {
|
|
|
1943
1867
|
MakeACopy = "makeACopy",
|
|
1944
1868
|
/**
|
|
1945
1869
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1946
|
-
*
|
|
1947
1870
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1948
1871
|
* @example
|
|
1949
1872
|
*```js
|
|
1950
|
-
* liveboardEmbed.
|
|
1873
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1951
1874
|
*```
|
|
1952
1875
|
* @example
|
|
1953
1876
|
*```js
|
|
@@ -1959,71 +1882,64 @@ export declare enum EmbedEvent {
|
|
|
1959
1882
|
Present = "present",
|
|
1960
1883
|
/**
|
|
1961
1884
|
* Emitted when a user clicks **Delete** on a visualization
|
|
1962
|
-
*
|
|
1963
1885
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1964
1886
|
* @example
|
|
1965
1887
|
*```js
|
|
1966
|
-
* liveboardEmbed.
|
|
1888
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
1967
1889
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1968
1890
|
*```
|
|
1969
1891
|
*/
|
|
1970
1892
|
Delete = "delete",
|
|
1971
1893
|
/**
|
|
1972
1894
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
1973
|
-
*
|
|
1974
1895
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1975
1896
|
* @example
|
|
1976
1897
|
*```js
|
|
1977
|
-
* liveboardEmbed.
|
|
1898
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
1978
1899
|
*```
|
|
1979
1900
|
*/
|
|
1980
1901
|
SchedulesList = "schedule-list",
|
|
1981
1902
|
/**
|
|
1982
1903
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
1983
|
-
*
|
|
1984
1904
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1985
1905
|
* @example
|
|
1986
1906
|
*```js
|
|
1987
|
-
* liveboardEmbed.
|
|
1907
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
1988
1908
|
*```
|
|
1989
1909
|
*/
|
|
1990
1910
|
Cancel = "cancel",
|
|
1991
1911
|
/**
|
|
1992
1912
|
* Emitted when a user clicks **Explore** on a visualization
|
|
1993
|
-
*
|
|
1994
1913
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1995
1914
|
* @example
|
|
1996
1915
|
*```js
|
|
1997
|
-
* liveboardEmbed.
|
|
1916
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
1998
1917
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
1999
1918
|
*```
|
|
2000
1919
|
*/
|
|
2001
1920
|
Explore = "explore",
|
|
2002
1921
|
/**
|
|
2003
1922
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2004
|
-
*
|
|
2005
1923
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2006
1924
|
* @example
|
|
2007
1925
|
*```js
|
|
2008
|
-
* liveboardEmbed.
|
|
1926
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
2009
1927
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2010
1928
|
*```
|
|
2011
1929
|
*/
|
|
2012
1930
|
CopyLink = "embedDocument",
|
|
2013
1931
|
/**
|
|
2014
1932
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
2015
|
-
*
|
|
2016
1933
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2017
1934
|
* @example
|
|
2018
1935
|
*```js
|
|
2019
|
-
* liveboardEmbed.
|
|
1936
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
2020
1937
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2021
1938
|
*```
|
|
2022
1939
|
*/
|
|
2023
1940
|
CrossFilterChanged = "cross-filter-changed",
|
|
2024
1941
|
/**
|
|
2025
1942
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2026
|
-
*
|
|
2027
1943
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2028
1944
|
* @example
|
|
2029
1945
|
*```js
|
|
@@ -2035,44 +1951,53 @@ export declare enum EmbedEvent {
|
|
|
2035
1951
|
VizPointRightClick = "vizPointRightClick",
|
|
2036
1952
|
/**
|
|
2037
1953
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2038
|
-
*
|
|
2039
1954
|
* @hidden
|
|
2040
1955
|
*/
|
|
2041
1956
|
InsertIntoSlide = "insertInToSlide",
|
|
2042
1957
|
/**
|
|
2043
|
-
* @hidden
|
|
2044
1958
|
* Emitted when a user changes any filter on a Liveboard.
|
|
1959
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
1960
|
+
* filter details.
|
|
1961
|
+
* @example
|
|
1962
|
+
*
|
|
1963
|
+
*```js
|
|
1964
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1965
|
+
* console.log('payload', payload);
|
|
1966
|
+
* })
|
|
1967
|
+
*
|
|
2045
1968
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
1969
|
+
* @example
|
|
1970
|
+
*
|
|
1971
|
+
*```js
|
|
1972
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
1973
|
+
* console.log('payload', payload);
|
|
1974
|
+
* })
|
|
1975
|
+
*```
|
|
2046
1976
|
*/
|
|
2047
1977
|
FilterChanged = "filterChanged",
|
|
2048
1978
|
/**
|
|
2049
1979
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
2050
|
-
*
|
|
2051
1980
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2052
1981
|
*/
|
|
2053
1982
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2054
1983
|
/**
|
|
2055
1984
|
* Emitted when a user selects a data source.
|
|
2056
|
-
*
|
|
2057
1985
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2058
1986
|
*/
|
|
2059
1987
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2060
1988
|
/**
|
|
2061
1989
|
* Emitted when a user updates a connection on the **Data** page
|
|
2062
|
-
*
|
|
2063
1990
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2064
1991
|
*/
|
|
2065
1992
|
UpdateConnection = "updateConnection",
|
|
2066
1993
|
/**
|
|
2067
1994
|
* Emitted when a user updates a connection on the **Data** page
|
|
2068
|
-
*
|
|
2069
1995
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2070
1996
|
*/
|
|
2071
1997
|
CreateConnection = "createConnection",
|
|
2072
1998
|
/**
|
|
2073
1999
|
* Emitted when name, status (private or public) or filter values of a
|
|
2074
2000
|
* Personalised view is updated.
|
|
2075
|
-
*
|
|
2076
2001
|
* @returns viewName: string
|
|
2077
2002
|
* @returns viewId: string
|
|
2078
2003
|
* @returns liveboardId: string
|
|
@@ -2082,7 +2007,6 @@ export declare enum EmbedEvent {
|
|
|
2082
2007
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2083
2008
|
/**
|
|
2084
2009
|
* Emitted when a Personalised view is saved.
|
|
2085
|
-
*
|
|
2086
2010
|
* @returns viewName: string
|
|
2087
2011
|
* @returns viewId: string
|
|
2088
2012
|
* @returns liveboardId: string
|
|
@@ -2092,7 +2016,6 @@ export declare enum EmbedEvent {
|
|
|
2092
2016
|
SavePersonalisedView = "savePersonalisedView",
|
|
2093
2017
|
/**
|
|
2094
2018
|
* Emitted when a Liveboard is reset.
|
|
2095
|
-
*
|
|
2096
2019
|
* @returns viewName: string
|
|
2097
2020
|
* @returns viewId: string
|
|
2098
2021
|
* @returns liveboardId: string
|
|
@@ -2102,7 +2025,6 @@ export declare enum EmbedEvent {
|
|
|
2102
2025
|
ResetLiveboard = "resetLiveboard",
|
|
2103
2026
|
/**
|
|
2104
2027
|
* Emitted when a PersonalisedView is deleted.
|
|
2105
|
-
*
|
|
2106
2028
|
* @returns views: string[]
|
|
2107
2029
|
* @returns liveboardId: string
|
|
2108
2030
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -2110,13 +2032,11 @@ export declare enum EmbedEvent {
|
|
|
2110
2032
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
2111
2033
|
/**
|
|
2112
2034
|
* Emitted when a user creates a new worksheet
|
|
2113
|
-
*
|
|
2114
2035
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2115
2036
|
*/
|
|
2116
2037
|
CreateWorksheet = "createWorksheet",
|
|
2117
2038
|
/**
|
|
2118
2039
|
* Emitted when Ask Sage is initialized.
|
|
2119
|
-
*
|
|
2120
2040
|
* @returns viewName: string
|
|
2121
2041
|
* @returns viewId: string
|
|
2122
2042
|
* @returns liveboardId: string
|
|
@@ -2126,10 +2046,32 @@ export declare enum EmbedEvent {
|
|
|
2126
2046
|
AskSageInit = "AskSageInit",
|
|
2127
2047
|
/**
|
|
2128
2048
|
* Emitted when a LB/viz is renamed
|
|
2129
|
-
*
|
|
2130
2049
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
2131
2050
|
*/
|
|
2132
|
-
Rename = "rename"
|
|
2051
|
+
Rename = "rename",
|
|
2052
|
+
/**
|
|
2053
|
+
* Emitted when user wants to intercept the search execution
|
|
2054
|
+
*
|
|
2055
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
2056
|
+
* event
|
|
2057
|
+
*
|
|
2058
|
+
*```js
|
|
2059
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
2060
|
+
* responder({
|
|
2061
|
+
* data: {
|
|
2062
|
+
* execute: true,
|
|
2063
|
+
* error: {errorText: "My own customised error"}
|
|
2064
|
+
* }})
|
|
2065
|
+
* })
|
|
2066
|
+
*```
|
|
2067
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
2068
|
+
*/
|
|
2069
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
2070
|
+
/**
|
|
2071
|
+
* Emitted when runtime parameters changes
|
|
2072
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
2073
|
+
*/
|
|
2074
|
+
ParameterChanged = "ParameterChanged"
|
|
2133
2075
|
}
|
|
2134
2076
|
/**
|
|
2135
2077
|
* Event types that can be triggered by the host application
|
|
@@ -2138,7 +2080,6 @@ export declare enum EmbedEvent {
|
|
|
2138
2080
|
* To trigger an event use the corresponding
|
|
2139
2081
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
2140
2082
|
* SearchEmbed.trigger} method.
|
|
2141
|
-
*
|
|
2142
2083
|
* @example
|
|
2143
2084
|
* ```js
|
|
2144
2085
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2159,7 +2100,6 @@ export declare enum HostEvent {
|
|
|
2159
2100
|
* the search query string.
|
|
2160
2101
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2161
2102
|
* Includes the following properties:
|
|
2162
|
-
*
|
|
2163
2103
|
* @param - `searchQuery` - query string with search tokens
|
|
2164
2104
|
* @param - `dataSources` - Data source GUID to Search on
|
|
2165
2105
|
* - Although an array, only a single source
|
|
@@ -2178,7 +2118,6 @@ export declare enum HostEvent {
|
|
|
2178
2118
|
/**
|
|
2179
2119
|
* Triggers a drill on certain points of the specified column
|
|
2180
2120
|
* Includes the following properties:
|
|
2181
|
-
*
|
|
2182
2121
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2183
2122
|
* to drill to. For example, { selectedPoints: []}
|
|
2184
2123
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2228,19 +2167,16 @@ export declare enum HostEvent {
|
|
|
2228
2167
|
DrillDown = "triggerDrillDown",
|
|
2229
2168
|
/**
|
|
2230
2169
|
* Apply filters
|
|
2231
|
-
*
|
|
2232
2170
|
* @hidden
|
|
2233
2171
|
*/
|
|
2234
2172
|
Filter = "filter",
|
|
2235
2173
|
/**
|
|
2236
2174
|
* Reload the answer or visualization
|
|
2237
|
-
*
|
|
2238
2175
|
* @hidden
|
|
2239
2176
|
*/
|
|
2240
2177
|
Reload = "reload",
|
|
2241
2178
|
/**
|
|
2242
2179
|
* Display specific visualizations on a Liveboard.
|
|
2243
|
-
*
|
|
2244
2180
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2245
2181
|
* in this parameter will be hidden.
|
|
2246
2182
|
* @example
|
|
@@ -2254,7 +2190,6 @@ export declare enum HostEvent {
|
|
|
2254
2190
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
2255
2191
|
/**
|
|
2256
2192
|
* Set a Liveboard tab as an active tab.
|
|
2257
|
-
*
|
|
2258
2193
|
* @param - tabId - string of id of Tab to show
|
|
2259
2194
|
* @example
|
|
2260
2195
|
* ```js
|
|
@@ -2270,18 +2205,21 @@ export declare enum HostEvent {
|
|
|
2270
2205
|
* runtime filters passed here are appended to the existing runtime
|
|
2271
2206
|
* filters.
|
|
2272
2207
|
* Pass an array of runtime filters with the following attributes:
|
|
2208
|
+
*
|
|
2273
2209
|
* `columnName`
|
|
2274
2210
|
* _String_. The name of the column to filter on.
|
|
2211
|
+
*
|
|
2275
2212
|
* `operator`
|
|
2276
|
-
*
|
|
2277
|
-
*
|
|
2213
|
+
* Runtime filter operator to apply. For information,
|
|
2214
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2215
|
+
*
|
|
2278
2216
|
* `values`
|
|
2279
|
-
*
|
|
2280
|
-
*
|
|
2281
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2282
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2283
|
-
* embedding (SageEmbed).
|
|
2217
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2218
|
+
* operators such as BW and IN accept multiple operands.
|
|
2284
2219
|
*
|
|
2220
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2221
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2222
|
+
* embedding (SageEmbed).
|
|
2285
2223
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2286
2224
|
* @example
|
|
2287
2225
|
* ```js
|
|
@@ -2297,7 +2235,6 @@ export declare enum HostEvent {
|
|
|
2297
2235
|
/**
|
|
2298
2236
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2299
2237
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2300
|
-
*
|
|
2301
2238
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
2302
2239
|
* be a number; for example, `1`, `-1`.
|
|
2303
2240
|
* @example
|
|
@@ -2310,7 +2247,6 @@ export declare enum HostEvent {
|
|
|
2310
2247
|
/**
|
|
2311
2248
|
* Open the filter panel for a particular column.
|
|
2312
2249
|
* Works with Search and Liveboard embed.
|
|
2313
|
-
*
|
|
2314
2250
|
* @param - { columnId: string,
|
|
2315
2251
|
* name: string,
|
|
2316
2252
|
* type: INT64/CHAR/DATE,
|
|
@@ -2327,7 +2263,6 @@ export declare enum HostEvent {
|
|
|
2327
2263
|
OpenFilter = "openFilter",
|
|
2328
2264
|
/**
|
|
2329
2265
|
* Add columns to the current search query.
|
|
2330
|
-
*
|
|
2331
2266
|
* @param - { columnIds: string[] }
|
|
2332
2267
|
* @example
|
|
2333
2268
|
* ```js
|
|
@@ -2338,7 +2273,6 @@ export declare enum HostEvent {
|
|
|
2338
2273
|
AddColumns = "addColumns",
|
|
2339
2274
|
/**
|
|
2340
2275
|
* Remove a column from the current search query.
|
|
2341
|
-
*
|
|
2342
2276
|
* @param - { columnId: string }
|
|
2343
2277
|
* @example
|
|
2344
2278
|
* ```js
|
|
@@ -2353,10 +2287,9 @@ export declare enum HostEvent {
|
|
|
2353
2287
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
2354
2288
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
2355
2289
|
* sorting, toggling of legends, and data drill down.
|
|
2356
|
-
*
|
|
2357
2290
|
* @example
|
|
2358
2291
|
* ```js
|
|
2359
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
2292
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
2360
2293
|
* data=>console.log(data))
|
|
2361
2294
|
* ```
|
|
2362
2295
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -2364,7 +2297,6 @@ export declare enum HostEvent {
|
|
|
2364
2297
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
2365
2298
|
/**
|
|
2366
2299
|
* Trigger the **Pin** action on an embedded object
|
|
2367
|
-
*
|
|
2368
2300
|
* @param - Liveboard embed takes the `vizId` as a
|
|
2369
2301
|
* key. Can be left undefined when embedding Search, full app, or
|
|
2370
2302
|
* a visualization.
|
|
@@ -2381,7 +2313,6 @@ export declare enum HostEvent {
|
|
|
2381
2313
|
/**
|
|
2382
2314
|
* Trigger the **Show Liveboard details** action
|
|
2383
2315
|
* on an embedded Liveboard.
|
|
2384
|
-
*
|
|
2385
2316
|
* @example
|
|
2386
2317
|
*```js
|
|
2387
2318
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -2391,7 +2322,6 @@ export declare enum HostEvent {
|
|
|
2391
2322
|
LiveboardInfo = "pinboardInfo",
|
|
2392
2323
|
/**
|
|
2393
2324
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2394
|
-
*
|
|
2395
2325
|
* @example
|
|
2396
2326
|
* ```js
|
|
2397
2327
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -2401,7 +2331,6 @@ export declare enum HostEvent {
|
|
|
2401
2331
|
Schedule = "subscription",
|
|
2402
2332
|
/**
|
|
2403
2333
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2404
|
-
*
|
|
2405
2334
|
* @example
|
|
2406
2335
|
* ```js
|
|
2407
2336
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -2411,7 +2340,6 @@ export declare enum HostEvent {
|
|
|
2411
2340
|
SchedulesList = "schedule-list",
|
|
2412
2341
|
/**
|
|
2413
2342
|
* Trigger the **Export TML** action on an embedded Liveboard.
|
|
2414
|
-
*
|
|
2415
2343
|
* @example
|
|
2416
2344
|
* ```js
|
|
2417
2345
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
@@ -2421,7 +2349,6 @@ export declare enum HostEvent {
|
|
|
2421
2349
|
ExportTML = "exportTSL",
|
|
2422
2350
|
/**
|
|
2423
2351
|
* Trigger the **Edit TML** action on an embedded Liveboard.
|
|
2424
|
-
*
|
|
2425
2352
|
* @example
|
|
2426
2353
|
* ```js
|
|
2427
2354
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -2431,7 +2358,6 @@ export declare enum HostEvent {
|
|
|
2431
2358
|
EditTML = "editTSL",
|
|
2432
2359
|
/**
|
|
2433
2360
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
2434
|
-
*
|
|
2435
2361
|
* @example
|
|
2436
2362
|
* ```js
|
|
2437
2363
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -2441,7 +2367,6 @@ export declare enum HostEvent {
|
|
|
2441
2367
|
UpdateTML = "updateTSL",
|
|
2442
2368
|
/**
|
|
2443
2369
|
* Trigger the **Download PDF** action on an embedded Liveboard.
|
|
2444
|
-
*
|
|
2445
2370
|
* @example
|
|
2446
2371
|
* ```js
|
|
2447
2372
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -2452,7 +2377,6 @@ export declare enum HostEvent {
|
|
|
2452
2377
|
/**
|
|
2453
2378
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
2454
2379
|
* visualization page.
|
|
2455
|
-
*
|
|
2456
2380
|
* @example
|
|
2457
2381
|
* ```js
|
|
2458
2382
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -2468,7 +2392,6 @@ export declare enum HostEvent {
|
|
|
2468
2392
|
MakeACopy = "makeACopy",
|
|
2469
2393
|
/**
|
|
2470
2394
|
* Trigger the **Delete** action for a Liveboard.
|
|
2471
|
-
*
|
|
2472
2395
|
* @example
|
|
2473
2396
|
* ```js
|
|
2474
2397
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -2478,7 +2401,6 @@ export declare enum HostEvent {
|
|
|
2478
2401
|
Remove = "delete",
|
|
2479
2402
|
/**
|
|
2480
2403
|
* Trigger the **Explore** action on a visualization.
|
|
2481
|
-
*
|
|
2482
2404
|
* @param - an object with `vizId` as a key
|
|
2483
2405
|
* @example
|
|
2484
2406
|
* ```js
|
|
@@ -2489,7 +2411,6 @@ export declare enum HostEvent {
|
|
|
2489
2411
|
Explore = "explore",
|
|
2490
2412
|
/**
|
|
2491
2413
|
* Trigger the **Create alert** action on a visualization
|
|
2492
|
-
*
|
|
2493
2414
|
* @param - an object with `vizId` as a key
|
|
2494
2415
|
* @example
|
|
2495
2416
|
* ```js
|
|
@@ -2502,7 +2423,6 @@ export declare enum HostEvent {
|
|
|
2502
2423
|
CreateMonitor = "createMonitor",
|
|
2503
2424
|
/**
|
|
2504
2425
|
* Trigger the **Manage alerts** action on a visualization
|
|
2505
|
-
*
|
|
2506
2426
|
* @param - an object with `vizId` as a key
|
|
2507
2427
|
* @example
|
|
2508
2428
|
* ```js
|
|
@@ -2515,7 +2435,6 @@ export declare enum HostEvent {
|
|
|
2515
2435
|
ManageMonitor = "manageMonitor",
|
|
2516
2436
|
/**
|
|
2517
2437
|
* Trigger the **Edit** action on a Liveboard or visualization
|
|
2518
|
-
*
|
|
2519
2438
|
* @param - object - To trigger the action for a specific visualization
|
|
2520
2439
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
2521
2440
|
* Can be left undefined when embedding Search, full app, or
|
|
@@ -2536,7 +2455,6 @@ export declare enum HostEvent {
|
|
|
2536
2455
|
Edit = "edit",
|
|
2537
2456
|
/**
|
|
2538
2457
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
2539
|
-
*
|
|
2540
2458
|
* @param - object - to trigger the action for a
|
|
2541
2459
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
2542
2460
|
* @example
|
|
@@ -2554,7 +2472,6 @@ export declare enum HostEvent {
|
|
|
2554
2472
|
CopyLink = "embedDocument",
|
|
2555
2473
|
/**
|
|
2556
2474
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
2557
|
-
*
|
|
2558
2475
|
* @param - object - to trigger the action for a specific visualization
|
|
2559
2476
|
* in Liveboard embed, pass in `vizId` as a key
|
|
2560
2477
|
* @example
|
|
@@ -2572,12 +2489,11 @@ export declare enum HostEvent {
|
|
|
2572
2489
|
Present = "present",
|
|
2573
2490
|
/**
|
|
2574
2491
|
* Get TML for the current search.
|
|
2575
|
-
*
|
|
2576
2492
|
* @example
|
|
2577
2493
|
* ```js
|
|
2578
2494
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
2579
2495
|
* console.log(
|
|
2580
|
-
* tml.search_query // TML representation of the search query
|
|
2496
|
+
* tml.answer.search_query // TML representation of the search query
|
|
2581
2497
|
* );
|
|
2582
2498
|
* })
|
|
2583
2499
|
* ```
|
|
@@ -2587,7 +2503,6 @@ export declare enum HostEvent {
|
|
|
2587
2503
|
GetTML = "getTML",
|
|
2588
2504
|
/**
|
|
2589
2505
|
* Trigger the **Show underlying data** action on visualization or search
|
|
2590
|
-
*
|
|
2591
2506
|
* @param - an object with vizId as a key
|
|
2592
2507
|
* @example
|
|
2593
2508
|
* ```js
|
|
@@ -2607,7 +2522,6 @@ export declare enum HostEvent {
|
|
|
2607
2522
|
* Trigger the **Delete** action for a visualization
|
|
2608
2523
|
* in an embedded Liveboard, or a chart or table
|
|
2609
2524
|
* generated from Search.
|
|
2610
|
-
*
|
|
2611
2525
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
2612
2526
|
* Can be left empty if embedding Search or visualization.
|
|
2613
2527
|
* @example
|
|
@@ -2624,7 +2538,6 @@ export declare enum HostEvent {
|
|
|
2624
2538
|
/**
|
|
2625
2539
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
2626
2540
|
* or search.
|
|
2627
|
-
*
|
|
2628
2541
|
* @param - Liveboard embed takes `vizId` as a
|
|
2629
2542
|
* key. Can be left undefined when embedding Search or
|
|
2630
2543
|
* visualization.
|
|
@@ -2645,7 +2558,6 @@ export declare enum HostEvent {
|
|
|
2645
2558
|
/**
|
|
2646
2559
|
* Trigger the **Download** action on charts in
|
|
2647
2560
|
* the embedded view.
|
|
2648
|
-
*
|
|
2649
2561
|
* @example
|
|
2650
2562
|
* ```js
|
|
2651
2563
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -2662,7 +2574,6 @@ export declare enum HostEvent {
|
|
|
2662
2574
|
/**
|
|
2663
2575
|
* Trigger the **Download** > **PNG** action on
|
|
2664
2576
|
* charts in the embedded view.
|
|
2665
|
-
*
|
|
2666
2577
|
* @example
|
|
2667
2578
|
* ```js
|
|
2668
2579
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2678,7 +2589,6 @@ export declare enum HostEvent {
|
|
|
2678
2589
|
/**
|
|
2679
2590
|
* Trigger the **Download** > **CSV** action on tables in
|
|
2680
2591
|
* the embedded view.
|
|
2681
|
-
*
|
|
2682
2592
|
* @example
|
|
2683
2593
|
* ```js
|
|
2684
2594
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -2696,7 +2606,6 @@ export declare enum HostEvent {
|
|
|
2696
2606
|
/**
|
|
2697
2607
|
* Trigger the **Download** > **XLSX** action on tables
|
|
2698
2608
|
* in the embedded view.
|
|
2699
|
-
*
|
|
2700
2609
|
* @example
|
|
2701
2610
|
* ```js
|
|
2702
2611
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2714,7 +2623,6 @@ export declare enum HostEvent {
|
|
|
2714
2623
|
/**
|
|
2715
2624
|
* Trigger the **Share** action on an embedded
|
|
2716
2625
|
* Liveboard or Answer.
|
|
2717
|
-
*
|
|
2718
2626
|
* @example
|
|
2719
2627
|
* ```js
|
|
2720
2628
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -2728,7 +2636,6 @@ export declare enum HostEvent {
|
|
|
2728
2636
|
/**
|
|
2729
2637
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
2730
2638
|
* Saves the changes.
|
|
2731
|
-
*
|
|
2732
2639
|
* @example
|
|
2733
2640
|
* ```js
|
|
2734
2641
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2742,7 +2649,6 @@ export declare enum HostEvent {
|
|
|
2742
2649
|
/**
|
|
2743
2650
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2744
2651
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2745
|
-
*
|
|
2746
2652
|
* @param - an object with `vizId` as a key
|
|
2747
2653
|
* @example
|
|
2748
2654
|
* ```js
|
|
@@ -2759,7 +2665,6 @@ export declare enum HostEvent {
|
|
|
2759
2665
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2760
2666
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2761
2667
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2762
|
-
*
|
|
2763
2668
|
* @param - an object with vizId as a key
|
|
2764
2669
|
* @example
|
|
2765
2670
|
* ```js
|
|
@@ -2776,7 +2681,6 @@ export declare enum HostEvent {
|
|
|
2776
2681
|
* Trigger the **Manage pipelines** action on an embedded
|
|
2777
2682
|
* visualization or Answer.
|
|
2778
2683
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2779
|
-
*
|
|
2780
2684
|
* @param - an object with `vizId` as a key
|
|
2781
2685
|
* @example
|
|
2782
2686
|
* ```js
|
|
@@ -2791,7 +2695,6 @@ export declare enum HostEvent {
|
|
|
2791
2695
|
ManagePipelines = "manage-pipeline",
|
|
2792
2696
|
/**
|
|
2793
2697
|
* Reset search operation on the Search or Answer page.
|
|
2794
|
-
*
|
|
2795
2698
|
* @example
|
|
2796
2699
|
* ```js
|
|
2797
2700
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -2803,32 +2706,70 @@ export declare enum HostEvent {
|
|
|
2803
2706
|
*/
|
|
2804
2707
|
ResetSearch = "resetSearch",
|
|
2805
2708
|
/**
|
|
2806
|
-
*
|
|
2807
|
-
* Get the currents visible and runtime filters applied on a Liveboard
|
|
2808
|
-
*
|
|
2709
|
+
* Get details of the visible and runtime filters applied on Liveboard.
|
|
2809
2710
|
* @example
|
|
2810
|
-
*
|
|
2711
|
+
* ```js
|
|
2712
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
2713
|
+
* console.log('data', data);
|
|
2714
|
+
* ```
|
|
2811
2715
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2812
2716
|
*/
|
|
2813
2717
|
GetFilters = "getFilters",
|
|
2814
2718
|
/**
|
|
2719
|
+
* Update one or several filters applied on a Liveboard.
|
|
2720
|
+
* @param - `filter`: a single filter object containing column name,
|
|
2721
|
+
* filter operator, and values.
|
|
2722
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
2723
|
+
* and values for each.
|
|
2815
2724
|
*
|
|
2816
|
-
*
|
|
2725
|
+
* Each filter object must include the following attributes:
|
|
2817
2726
|
*
|
|
2818
|
-
*
|
|
2727
|
+
* `column` - Name of the column to filter on.
|
|
2728
|
+
*
|
|
2729
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
2730
|
+
* For information about the supported filter operators,
|
|
2731
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
|
|
2732
|
+
*
|
|
2733
|
+
* `values` - An array of one or several values. The value definition on the
|
|
2734
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
2735
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
|
|
2736
|
+
* @example
|
|
2737
|
+
* ```js
|
|
2738
|
+
*
|
|
2739
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2740
|
+
* filter: {
|
|
2741
|
+
* column: "item type",
|
|
2742
|
+
* oper: "IN",
|
|
2743
|
+
* values: ["bags","shirts"],
|
|
2744
|
+
* }
|
|
2745
|
+
* });
|
|
2746
|
+
* ```
|
|
2819
2747
|
* @example
|
|
2820
2748
|
*
|
|
2821
2749
|
* ```js
|
|
2822
2750
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2823
|
-
*
|
|
2824
|
-
*
|
|
2751
|
+
* filters: [{
|
|
2752
|
+
* column: "Item Type",
|
|
2753
|
+
* oper: 'IN',
|
|
2754
|
+
* values: ["bags","shirts"]
|
|
2755
|
+
* },
|
|
2756
|
+
* {
|
|
2757
|
+
* column: "Region",
|
|
2758
|
+
* oper: 'IN',
|
|
2759
|
+
* values: ["West","Midwest"]
|
|
2760
|
+
* },
|
|
2761
|
+
* {
|
|
2762
|
+
* column: "Date",
|
|
2763
|
+
* oper: 'EQ',
|
|
2764
|
+
* values: ["1656680400"]
|
|
2765
|
+
* }]
|
|
2766
|
+
* });
|
|
2825
2767
|
* ```
|
|
2826
2768
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2827
2769
|
*/
|
|
2828
2770
|
UpdateFilters = "updateFilters",
|
|
2829
2771
|
/**
|
|
2830
2772
|
* Get tab details for the current Liveboard.
|
|
2831
|
-
*
|
|
2832
2773
|
* @example
|
|
2833
2774
|
* ```js
|
|
2834
2775
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -2842,7 +2783,6 @@ export declare enum HostEvent {
|
|
|
2842
2783
|
GetTabs = "getTabs",
|
|
2843
2784
|
/**
|
|
2844
2785
|
* Set the visible tabs on a Liveboard.
|
|
2845
|
-
*
|
|
2846
2786
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
2847
2787
|
* will be hidden.
|
|
2848
2788
|
* @example
|
|
@@ -2856,7 +2796,6 @@ export declare enum HostEvent {
|
|
|
2856
2796
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
2857
2797
|
/**
|
|
2858
2798
|
* Set the hidden tabs on a Liveboard.
|
|
2859
|
-
*
|
|
2860
2799
|
* @param - an array of the IDs of the tabs to hide.
|
|
2861
2800
|
* The IDs not passed will be shown.
|
|
2862
2801
|
* @example
|
|
@@ -2870,7 +2809,6 @@ export declare enum HostEvent {
|
|
|
2870
2809
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
2871
2810
|
/**
|
|
2872
2811
|
* Updates the search query string for Natural Language Search operations.
|
|
2873
|
-
*
|
|
2874
2812
|
* @param - `queryString`: Text string in Natural Language format
|
|
2875
2813
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
2876
2814
|
* @example
|
|
@@ -2885,7 +2823,6 @@ export declare enum HostEvent {
|
|
|
2885
2823
|
UpdateSageQuery = "updateSageQuery",
|
|
2886
2824
|
/**
|
|
2887
2825
|
* Get the answer session for a Search / Visualization.
|
|
2888
|
-
*
|
|
2889
2826
|
* @example
|
|
2890
2827
|
* ```js
|
|
2891
2828
|
* const {session} = await embed.trigger(
|
|
@@ -2898,7 +2835,6 @@ export declare enum HostEvent {
|
|
|
2898
2835
|
GetAnswerSession = "getAnswerSession",
|
|
2899
2836
|
/**
|
|
2900
2837
|
* Trigger Ask Sage for viz
|
|
2901
|
-
*
|
|
2902
2838
|
* @example
|
|
2903
2839
|
* ```js
|
|
2904
2840
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -2909,7 +2845,6 @@ export declare enum HostEvent {
|
|
|
2909
2845
|
AskSage = "AskSage",
|
|
2910
2846
|
/**
|
|
2911
2847
|
* Trigger UpdateCrossFilter for Liveboard
|
|
2912
|
-
*
|
|
2913
2848
|
* @example
|
|
2914
2849
|
* ```js
|
|
2915
2850
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -2925,14 +2860,42 @@ export declare enum HostEvent {
|
|
|
2925
2860
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
2926
2861
|
/**
|
|
2927
2862
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
2928
|
-
*
|
|
2929
2863
|
* @example
|
|
2930
2864
|
* ```js
|
|
2931
2865
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
2932
2866
|
* ```
|
|
2933
2867
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2934
2868
|
*/
|
|
2935
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
2869
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
2870
|
+
/**
|
|
2871
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
2872
|
+
* @example
|
|
2873
|
+
* ```js
|
|
2874
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
2875
|
+
*
|
|
2876
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2877
|
+
*/
|
|
2878
|
+
CreateLiveboard = "CreateLiveboard",
|
|
2879
|
+
/**
|
|
2880
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
2881
|
+
* @example
|
|
2882
|
+
* ```js
|
|
2883
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
2884
|
+
* name: "Color",
|
|
2885
|
+
* value: "almond"
|
|
2886
|
+
* }])
|
|
2887
|
+
*
|
|
2888
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2889
|
+
*/
|
|
2890
|
+
UpdateParameters = "UpdateParameters",
|
|
2891
|
+
/**
|
|
2892
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
2893
|
+
* ```js
|
|
2894
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters);
|
|
2895
|
+
*
|
|
2896
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2897
|
+
*/
|
|
2898
|
+
GetParameters = "GetParameters"
|
|
2936
2899
|
}
|
|
2937
2900
|
/**
|
|
2938
2901
|
* The different visual modes that the data sources panel within
|
|
@@ -3029,7 +2992,15 @@ export declare enum Param {
|
|
|
3029
2992
|
ClientLogLevel = "clientLogLevel",
|
|
3030
2993
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
3031
2994
|
enableAskSage = "enableAskSage",
|
|
3032
|
-
CollapseSearchBarInitially = "collapseSearchBarInitially"
|
|
2995
|
+
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
2996
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
2997
|
+
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
2998
|
+
DateFormatLocale = "dateFormatLocale",
|
|
2999
|
+
NumberFormatLocale = "numberFormatLocale",
|
|
3000
|
+
CurrencyFormat = "currencyFormat",
|
|
3001
|
+
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
3002
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
3003
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
3033
3004
|
}
|
|
3034
3005
|
/**
|
|
3035
3006
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -3038,7 +3009,6 @@ export declare enum Param {
|
|
|
3038
3009
|
* specific actions in the embedded view, define the Action
|
|
3039
3010
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3040
3011
|
* or `hiddenActions` array.
|
|
3041
|
-
*
|
|
3042
3012
|
* @example
|
|
3043
3013
|
* ```js
|
|
3044
3014
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3062,10 +3032,9 @@ export declare enum Action {
|
|
|
3062
3032
|
/**
|
|
3063
3033
|
* The **Save** action on an Answer or Liveboard.
|
|
3064
3034
|
* Allows users to save the changes.
|
|
3065
|
-
*
|
|
3066
3035
|
* @example
|
|
3067
3036
|
* ```js
|
|
3068
|
-
* disabledActions: [Action.
|
|
3037
|
+
* disabledActions: [Action.Save]
|
|
3069
3038
|
* ```
|
|
3070
3039
|
*/
|
|
3071
3040
|
Save = "save",
|
|
@@ -3080,7 +3049,6 @@ export declare enum Action {
|
|
|
3080
3049
|
/**
|
|
3081
3050
|
* The **Save as View** action on the Answer
|
|
3082
3051
|
* page. Saves an Answer as a View object.
|
|
3083
|
-
*
|
|
3084
3052
|
* @example
|
|
3085
3053
|
* ```js
|
|
3086
3054
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -3094,7 +3062,6 @@ export declare enum Action {
|
|
|
3094
3062
|
* visualizations in the embedded Liveboard view.
|
|
3095
3063
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
3096
3064
|
* Liveboards and visualizations.
|
|
3097
|
-
*
|
|
3098
3065
|
* @example
|
|
3099
3066
|
* ```js
|
|
3100
3067
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -3104,7 +3071,6 @@ export declare enum Action {
|
|
|
3104
3071
|
/**
|
|
3105
3072
|
* The **Copy and Edit** action on a Liveboard.
|
|
3106
3073
|
* This action is now replaced with `Action.MakeACopy`.
|
|
3107
|
-
*
|
|
3108
3074
|
* @example
|
|
3109
3075
|
* ```js
|
|
3110
3076
|
* disabledActions: [Action.EditACopy]
|
|
@@ -3114,7 +3080,6 @@ export declare enum Action {
|
|
|
3114
3080
|
/**
|
|
3115
3081
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
3116
3082
|
* Copies the visualization URL
|
|
3117
|
-
*
|
|
3118
3083
|
* @example
|
|
3119
3084
|
* ```js
|
|
3120
3085
|
* disabledActions: [Action.CopyLink]
|
|
@@ -3128,7 +3093,6 @@ export declare enum Action {
|
|
|
3128
3093
|
/**
|
|
3129
3094
|
* The **Schedule** menu action on a Liveboard.
|
|
3130
3095
|
* Allows scheduling a Liveboard notification.
|
|
3131
|
-
*
|
|
3132
3096
|
* @example
|
|
3133
3097
|
* ```js
|
|
3134
3098
|
* disabledActions: [Action.Schedule]
|
|
@@ -3138,7 +3102,6 @@ export declare enum Action {
|
|
|
3138
3102
|
/**
|
|
3139
3103
|
* The **Manage schedules** menu action on a Liveboard.
|
|
3140
3104
|
* Allows users to manage scheduled Liveboard jobs.
|
|
3141
|
-
*
|
|
3142
3105
|
* @example
|
|
3143
3106
|
* ```js
|
|
3144
3107
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -3148,7 +3111,6 @@ export declare enum Action {
|
|
|
3148
3111
|
/**
|
|
3149
3112
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3150
3113
|
* Allows users to share an object with other users and groups.
|
|
3151
|
-
*
|
|
3152
3114
|
* @example
|
|
3153
3115
|
* ```js
|
|
3154
3116
|
* disabledActions: [Action.Share]
|
|
@@ -3158,7 +3120,6 @@ export declare enum Action {
|
|
|
3158
3120
|
/**
|
|
3159
3121
|
* The **Add filter** action on a Liveboard and Search page.
|
|
3160
3122
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3161
|
-
*
|
|
3162
3123
|
* @example
|
|
3163
3124
|
* ```js
|
|
3164
3125
|
* disabledActions: [Action.AddFilter]
|
|
@@ -3169,7 +3130,6 @@ export declare enum Action {
|
|
|
3169
3130
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
3170
3131
|
* Allows to show action menu to add different objects (like
|
|
3171
3132
|
* formulas, parameters) in data panel v2.
|
|
3172
|
-
*
|
|
3173
3133
|
* @example
|
|
3174
3134
|
* ```js
|
|
3175
3135
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -3181,7 +3141,6 @@ export declare enum Action {
|
|
|
3181
3141
|
* Filter configuration options on a Liveboard and Search page.
|
|
3182
3142
|
* Allows configuring filter options when adding filters to a
|
|
3183
3143
|
* Liveboard or Answer.
|
|
3184
|
-
*
|
|
3185
3144
|
* @example
|
|
3186
3145
|
* ```js
|
|
3187
3146
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -3192,7 +3151,6 @@ export declare enum Action {
|
|
|
3192
3151
|
/**
|
|
3193
3152
|
* The **Choose sources** button on Search page.
|
|
3194
3153
|
* Allows selecting data sources for search queries.
|
|
3195
|
-
*
|
|
3196
3154
|
* @example
|
|
3197
3155
|
* ```js
|
|
3198
3156
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -3202,7 +3160,6 @@ export declare enum Action {
|
|
|
3202
3160
|
/**
|
|
3203
3161
|
* The **Create formula** action on a Search or Answer page.
|
|
3204
3162
|
* Allows adding formulas to an Answer.
|
|
3205
|
-
*
|
|
3206
3163
|
* @example
|
|
3207
3164
|
* ```js
|
|
3208
3165
|
* disabledActions: [Action.AddFormula]
|
|
@@ -3212,7 +3169,6 @@ export declare enum Action {
|
|
|
3212
3169
|
/**
|
|
3213
3170
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
3214
3171
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
3215
|
-
*
|
|
3216
3172
|
* @example
|
|
3217
3173
|
* ```js
|
|
3218
3174
|
* disabledActions: [Action.AddParameter]
|
|
@@ -3222,7 +3178,6 @@ export declare enum Action {
|
|
|
3222
3178
|
/**
|
|
3223
3179
|
* The **Add Column Set** action on a Answer.
|
|
3224
3180
|
* Allows adding column sets to a Answer.
|
|
3225
|
-
*
|
|
3226
3181
|
* @example
|
|
3227
3182
|
* ```js
|
|
3228
3183
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -3233,7 +3188,6 @@ export declare enum Action {
|
|
|
3233
3188
|
/**
|
|
3234
3189
|
* The **Add Query Set** action on a Answer.
|
|
3235
3190
|
* Allows adding query sets to a Answer.
|
|
3236
|
-
*
|
|
3237
3191
|
* @example
|
|
3238
3192
|
* ```js
|
|
3239
3193
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -3248,7 +3202,6 @@ export declare enum Action {
|
|
|
3248
3202
|
/**
|
|
3249
3203
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
3250
3204
|
* Answer page.
|
|
3251
|
-
*
|
|
3252
3205
|
* @example
|
|
3253
3206
|
* ```js
|
|
3254
3207
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -3271,7 +3224,6 @@ export declare enum Action {
|
|
|
3271
3224
|
/**
|
|
3272
3225
|
* The **Show underlying data** menu action on a visualization or
|
|
3273
3226
|
* Answer page.
|
|
3274
|
-
*
|
|
3275
3227
|
* @example
|
|
3276
3228
|
* ```js
|
|
3277
3229
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -3282,7 +3234,6 @@ export declare enum Action {
|
|
|
3282
3234
|
* The **Download** menu action on Liveboard visualizations
|
|
3283
3235
|
* and Answers.
|
|
3284
3236
|
* Allows downloading a visualization or Answer.
|
|
3285
|
-
*
|
|
3286
3237
|
* @example
|
|
3287
3238
|
* ```js
|
|
3288
3239
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -3293,7 +3244,6 @@ export declare enum Action {
|
|
|
3293
3244
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3294
3245
|
* or Answer page.
|
|
3295
3246
|
* Downloads a visualization or Answer as a PNG file.
|
|
3296
|
-
*
|
|
3297
3247
|
* @example
|
|
3298
3248
|
* ```js
|
|
3299
3249
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -3301,9 +3251,12 @@ export declare enum Action {
|
|
|
3301
3251
|
*/
|
|
3302
3252
|
DownloadAsPng = "downloadAsPng",
|
|
3303
3253
|
/**
|
|
3304
|
-
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3305
|
-
* Downloads a visualization or Answer as a PDF file.
|
|
3306
3254
|
*
|
|
3255
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
3256
|
+
*visualization, or Answer as a PDF file.
|
|
3257
|
+
*
|
|
3258
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
3259
|
+
*visualizations and Answers if the data is in tabular format.
|
|
3307
3260
|
* @example
|
|
3308
3261
|
* ```js
|
|
3309
3262
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -3314,7 +3267,6 @@ export declare enum Action {
|
|
|
3314
3267
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3315
3268
|
* or Answer page.
|
|
3316
3269
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3317
|
-
*
|
|
3318
3270
|
* @example
|
|
3319
3271
|
* ```js
|
|
3320
3272
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -3325,7 +3277,6 @@ export declare enum Action {
|
|
|
3325
3277
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3326
3278
|
* or Answer page.
|
|
3327
3279
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3328
|
-
*
|
|
3329
3280
|
* @example
|
|
3330
3281
|
* ```js
|
|
3331
3282
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -3340,7 +3291,6 @@ export declare enum Action {
|
|
|
3340
3291
|
* The **Export TML** menu action on Liveboard, Answers
|
|
3341
3292
|
* Worksheets and Data Connections page.
|
|
3342
3293
|
* Exports an object as a TML file.
|
|
3343
|
-
*
|
|
3344
3294
|
* @example
|
|
3345
3295
|
* ```js
|
|
3346
3296
|
* disabledActions: [Action.ExportTML]
|
|
@@ -3350,7 +3300,6 @@ export declare enum Action {
|
|
|
3350
3300
|
/**
|
|
3351
3301
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
3352
3302
|
* Imports TML representation of ThoughtSpot objects.
|
|
3353
|
-
*
|
|
3354
3303
|
* @example
|
|
3355
3304
|
* ```js
|
|
3356
3305
|
* disabledActions: [Action.ImportTML]
|
|
@@ -3360,7 +3309,6 @@ export declare enum Action {
|
|
|
3360
3309
|
/**
|
|
3361
3310
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3362
3311
|
* Update TML representation of ThoughtSpot objects.
|
|
3363
|
-
*
|
|
3364
3312
|
* @example
|
|
3365
3313
|
* ```js
|
|
3366
3314
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3370,7 +3318,6 @@ export declare enum Action {
|
|
|
3370
3318
|
/**
|
|
3371
3319
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3372
3320
|
* Opens the TML editor.
|
|
3373
|
-
*
|
|
3374
3321
|
* @example
|
|
3375
3322
|
* ```js
|
|
3376
3323
|
* disabledActions: [Action.EditTML]
|
|
@@ -3381,7 +3328,6 @@ export declare enum Action {
|
|
|
3381
3328
|
* The **Present** menu action for Liveboards and Answers.
|
|
3382
3329
|
* Allows presenting a Liveboard or visualization in
|
|
3383
3330
|
* slideshow mode.
|
|
3384
|
-
*
|
|
3385
3331
|
* @example
|
|
3386
3332
|
* ```js
|
|
3387
3333
|
* disabledActions: [Action.Present]
|
|
@@ -3391,7 +3337,6 @@ export declare enum Action {
|
|
|
3391
3337
|
/**
|
|
3392
3338
|
* The tile resize options in the visualization menu.
|
|
3393
3339
|
* Allows switching between different preset layouts.
|
|
3394
|
-
*
|
|
3395
3340
|
* @example
|
|
3396
3341
|
* ```js
|
|
3397
3342
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -3402,7 +3347,6 @@ export declare enum Action {
|
|
|
3402
3347
|
* The *Edit* action on the Liveboard page and in the
|
|
3403
3348
|
* visualization menu.
|
|
3404
3349
|
* Opens a Liveboard or visualization in edit mode.
|
|
3405
|
-
*
|
|
3406
3350
|
* @example
|
|
3407
3351
|
* ```js
|
|
3408
3352
|
* disabledActions: [Action.Edit]
|
|
@@ -3411,7 +3355,6 @@ export declare enum Action {
|
|
|
3411
3355
|
Edit = "edit",
|
|
3412
3356
|
/**
|
|
3413
3357
|
* The text edit option for Liveboard and visualization titles.
|
|
3414
|
-
*
|
|
3415
3358
|
* @example
|
|
3416
3359
|
* ```js
|
|
3417
3360
|
* disabledActions: [Action.EditTitle]
|
|
@@ -3421,7 +3364,6 @@ export declare enum Action {
|
|
|
3421
3364
|
/**
|
|
3422
3365
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
3423
3366
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3424
|
-
*
|
|
3425
3367
|
* @example
|
|
3426
3368
|
* ```js
|
|
3427
3369
|
* disabledActions: [Action.Remove]
|
|
@@ -3453,7 +3395,6 @@ export declare enum Action {
|
|
|
3453
3395
|
* Displays details such as the name, description, and
|
|
3454
3396
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3455
3397
|
* and update.
|
|
3456
|
-
*
|
|
3457
3398
|
* @example
|
|
3458
3399
|
* ```js
|
|
3459
3400
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -3471,7 +3412,6 @@ export declare enum Action {
|
|
|
3471
3412
|
/**
|
|
3472
3413
|
* The **Pin** menu action on an Answer or
|
|
3473
3414
|
* Search results page.
|
|
3474
|
-
*
|
|
3475
3415
|
* @example
|
|
3476
3416
|
* ```js
|
|
3477
3417
|
* disabledActions: [Action.Pin]
|
|
@@ -3484,7 +3424,6 @@ export declare enum Action {
|
|
|
3484
3424
|
AnalysisInfo = "analysisInfo",
|
|
3485
3425
|
/**
|
|
3486
3426
|
* The **Schedule** menu action on a Liveboard.
|
|
3487
|
-
*
|
|
3488
3427
|
* @example
|
|
3489
3428
|
* ```js
|
|
3490
3429
|
* disabledActions: [Action.Subscription]
|
|
@@ -3493,7 +3432,6 @@ export declare enum Action {
|
|
|
3493
3432
|
Subscription = "subscription",
|
|
3494
3433
|
/**
|
|
3495
3434
|
* The **Explore** action on Liveboard visualizations
|
|
3496
|
-
*
|
|
3497
3435
|
* @example
|
|
3498
3436
|
* ```js
|
|
3499
3437
|
* disabledActions: [Action.Explore]
|
|
@@ -3503,7 +3441,6 @@ export declare enum Action {
|
|
|
3503
3441
|
/**
|
|
3504
3442
|
* The action to include data points on a drilled-down Answer
|
|
3505
3443
|
* or visualization
|
|
3506
|
-
*
|
|
3507
3444
|
* @example
|
|
3508
3445
|
* ```js
|
|
3509
3446
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3513,7 +3450,6 @@ export declare enum Action {
|
|
|
3513
3450
|
/**
|
|
3514
3451
|
* The action to exclude data points on a drilled-down Answer
|
|
3515
3452
|
* or visualization
|
|
3516
|
-
*
|
|
3517
3453
|
* @example
|
|
3518
3454
|
* ```js
|
|
3519
3455
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3524,7 +3460,6 @@ export declare enum Action {
|
|
|
3524
3460
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3525
3461
|
* or Liveboard.
|
|
3526
3462
|
* Copies the selected data point.
|
|
3527
|
-
*
|
|
3528
3463
|
* @example
|
|
3529
3464
|
* ```js
|
|
3530
3465
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3542,7 +3477,6 @@ export declare enum Action {
|
|
|
3542
3477
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3543
3478
|
* visualizations.
|
|
3544
3479
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3545
|
-
*
|
|
3546
3480
|
* @example
|
|
3547
3481
|
* ```js
|
|
3548
3482
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3552,7 +3486,6 @@ export declare enum Action {
|
|
|
3552
3486
|
/**
|
|
3553
3487
|
* The request access action on Liveboards.
|
|
3554
3488
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3555
|
-
*
|
|
3556
3489
|
* @example
|
|
3557
3490
|
* ```js
|
|
3558
3491
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3562,7 +3495,6 @@ export declare enum Action {
|
|
|
3562
3495
|
/**
|
|
3563
3496
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3564
3497
|
* of the Answer page
|
|
3565
|
-
*
|
|
3566
3498
|
* @example
|
|
3567
3499
|
* ```js
|
|
3568
3500
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3571,7 +3503,6 @@ export declare enum Action {
|
|
|
3571
3503
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
3572
3504
|
/**
|
|
3573
3505
|
* The **Delete** action for Answers.
|
|
3574
|
-
*
|
|
3575
3506
|
* @example
|
|
3576
3507
|
* ```js
|
|
3577
3508
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3581,7 +3512,6 @@ export declare enum Action {
|
|
|
3581
3512
|
AnswerDelete = "onDeleteAnswer",
|
|
3582
3513
|
/**
|
|
3583
3514
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3584
|
-
*
|
|
3585
3515
|
* @example
|
|
3586
3516
|
* ```js
|
|
3587
3517
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3591,7 +3521,6 @@ export declare enum Action {
|
|
|
3591
3521
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3592
3522
|
/**
|
|
3593
3523
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3594
|
-
*
|
|
3595
3524
|
* @example
|
|
3596
3525
|
* ```js
|
|
3597
3526
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3601,7 +3530,6 @@ export declare enum Action {
|
|
|
3601
3530
|
AddToFavorites = "addToFavorites",
|
|
3602
3531
|
/**
|
|
3603
3532
|
* The edit icon on Liveboards (Classic experience).
|
|
3604
|
-
*
|
|
3605
3533
|
* @example
|
|
3606
3534
|
* ```js
|
|
3607
3535
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3611,7 +3539,6 @@ export declare enum Action {
|
|
|
3611
3539
|
EditDetails = "editDetails",
|
|
3612
3540
|
/**
|
|
3613
3541
|
* The Create alert action on KPI charts.
|
|
3614
|
-
*
|
|
3615
3542
|
* @example
|
|
3616
3543
|
* ```js
|
|
3617
3544
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3630,7 +3557,6 @@ export declare enum Action {
|
|
|
3630
3557
|
/**
|
|
3631
3558
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3632
3559
|
* Allows sending data to a Google Sheet.
|
|
3633
|
-
*
|
|
3634
3560
|
* @example
|
|
3635
3561
|
* ```js
|
|
3636
3562
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3642,7 +3568,6 @@ export declare enum Action {
|
|
|
3642
3568
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3643
3569
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3644
3570
|
* Microsoft Teams, and so on.
|
|
3645
|
-
*
|
|
3646
3571
|
* @example
|
|
3647
3572
|
* ```js
|
|
3648
3573
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3653,7 +3578,6 @@ export declare enum Action {
|
|
|
3653
3578
|
/**
|
|
3654
3579
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3655
3580
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3656
|
-
*
|
|
3657
3581
|
* @example
|
|
3658
3582
|
* ```js
|
|
3659
3583
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3664,7 +3588,6 @@ export declare enum Action {
|
|
|
3664
3588
|
/**
|
|
3665
3589
|
* The **Filter** action on Liveboard visualizations.
|
|
3666
3590
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3667
|
-
*
|
|
3668
3591
|
* @example
|
|
3669
3592
|
* ```js
|
|
3670
3593
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3675,7 +3598,6 @@ export declare enum Action {
|
|
|
3675
3598
|
/**
|
|
3676
3599
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
3677
3600
|
* Allows sending data to third-party apps Slack
|
|
3678
|
-
*
|
|
3679
3601
|
* @example
|
|
3680
3602
|
* ```js
|
|
3681
3603
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -3686,7 +3608,6 @@ export declare enum Action {
|
|
|
3686
3608
|
/**
|
|
3687
3609
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
3688
3610
|
* Allows sending data to third-party apps Team
|
|
3689
|
-
*
|
|
3690
3611
|
* @example
|
|
3691
3612
|
* ```js
|
|
3692
3613
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -3698,7 +3619,6 @@ export declare enum Action {
|
|
|
3698
3619
|
* The **Remove** action that appears when cross filters are applied
|
|
3699
3620
|
* on a Liveboard.
|
|
3700
3621
|
* Removes filters applied o a visualization.
|
|
3701
|
-
*
|
|
3702
3622
|
* @example
|
|
3703
3623
|
* ```js
|
|
3704
3624
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3710,7 +3630,6 @@ export declare enum Action {
|
|
|
3710
3630
|
* The **Aggregate** option in the chart axis or the
|
|
3711
3631
|
* table column customization menu.
|
|
3712
3632
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3713
|
-
*
|
|
3714
3633
|
* @example
|
|
3715
3634
|
* ```js
|
|
3716
3635
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3722,7 +3641,6 @@ export declare enum Action {
|
|
|
3722
3641
|
* The **Time bucket** option in the chart axis or table column
|
|
3723
3642
|
* customization menu.
|
|
3724
3643
|
* Allows defining time metric for date comparison.
|
|
3725
|
-
*
|
|
3726
3644
|
* @example
|
|
3727
3645
|
* ```js
|
|
3728
3646
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3733,7 +3651,6 @@ export declare enum Action {
|
|
|
3733
3651
|
/**
|
|
3734
3652
|
* The **Filter** action in the chart axis or table column
|
|
3735
3653
|
* customization menu.
|
|
3736
|
-
*
|
|
3737
3654
|
* @example
|
|
3738
3655
|
* ```js
|
|
3739
3656
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3745,7 +3662,6 @@ export declare enum Action {
|
|
|
3745
3662
|
* The **Conditional formatting** action on chart or table.
|
|
3746
3663
|
* Allows adding rules for conditional formatting of data
|
|
3747
3664
|
* points on a chart or table.
|
|
3748
|
-
*
|
|
3749
3665
|
* @example
|
|
3750
3666
|
* ```js
|
|
3751
3667
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3757,7 +3673,6 @@ export declare enum Action {
|
|
|
3757
3673
|
* The **Sort** menu action on a table or chart axis
|
|
3758
3674
|
* Sorts data in ascending or descending order.
|
|
3759
3675
|
* Allows adding, editing, or removing filters.
|
|
3760
|
-
*
|
|
3761
3676
|
* @example
|
|
3762
3677
|
* ```js
|
|
3763
3678
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3770,7 +3685,6 @@ export declare enum Action {
|
|
|
3770
3685
|
* customization menu.
|
|
3771
3686
|
* Allows grouping data points if the axes use the same
|
|
3772
3687
|
* unit of measurement and a similar scale.
|
|
3773
|
-
*
|
|
3774
3688
|
* @example
|
|
3775
3689
|
* ```js
|
|
3776
3690
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3782,7 +3696,6 @@ export declare enum Action {
|
|
|
3782
3696
|
* The **Position** option in the axis customization menu.
|
|
3783
3697
|
* Allows changing the position of the axis to the
|
|
3784
3698
|
* left or right side of the chart.
|
|
3785
|
-
*
|
|
3786
3699
|
* @example
|
|
3787
3700
|
* ```js
|
|
3788
3701
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3793,7 +3706,6 @@ export declare enum Action {
|
|
|
3793
3706
|
/**
|
|
3794
3707
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3795
3708
|
* Renames the axis label on a chart or the column header on a table.
|
|
3796
|
-
*
|
|
3797
3709
|
* @example
|
|
3798
3710
|
* ```js
|
|
3799
3711
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3805,7 +3717,6 @@ export declare enum Action {
|
|
|
3805
3717
|
* The **Edit** action in the axis customization menu.
|
|
3806
3718
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3807
3719
|
* and format of a column.
|
|
3808
|
-
*
|
|
3809
3720
|
* @example
|
|
3810
3721
|
* ```js
|
|
3811
3722
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3816,7 +3727,6 @@ export declare enum Action {
|
|
|
3816
3727
|
/**
|
|
3817
3728
|
* The **Number format** action to customize the format of
|
|
3818
3729
|
* the data labels on a chart or table.
|
|
3819
|
-
*
|
|
3820
3730
|
* @example
|
|
3821
3731
|
* ```js
|
|
3822
3732
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3827,7 +3737,6 @@ export declare enum Action {
|
|
|
3827
3737
|
/**
|
|
3828
3738
|
* The **Text wrapping** action on a table.
|
|
3829
3739
|
* Wraps or clips column text on a table.
|
|
3830
|
-
*
|
|
3831
3740
|
* @example
|
|
3832
3741
|
* ```js
|
|
3833
3742
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3840,7 +3749,6 @@ export declare enum Action {
|
|
|
3840
3749
|
* customization menu.
|
|
3841
3750
|
* Removes the data labels from a chart or the column of a
|
|
3842
3751
|
* table visualization.
|
|
3843
|
-
*
|
|
3844
3752
|
* @example
|
|
3845
3753
|
* ```js
|
|
3846
3754
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3855,7 +3763,6 @@ export declare enum Action {
|
|
|
3855
3763
|
/**
|
|
3856
3764
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3857
3765
|
* Allows renaming a Liveboard or visualization.
|
|
3858
|
-
*
|
|
3859
3766
|
* @example
|
|
3860
3767
|
* ```js
|
|
3861
3768
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3899,7 +3806,6 @@ export declare enum Action {
|
|
|
3899
3806
|
/**
|
|
3900
3807
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
3901
3808
|
* Allows moving a visualization to a different tab.
|
|
3902
|
-
*
|
|
3903
3809
|
* @example
|
|
3904
3810
|
* ```js
|
|
3905
3811
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -3908,7 +3814,6 @@ export declare enum Action {
|
|
|
3908
3814
|
MoveToTab = "onContainerMove",
|
|
3909
3815
|
/**
|
|
3910
3816
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
3911
|
-
*
|
|
3912
3817
|
* @example
|
|
3913
3818
|
* ```js
|
|
3914
3819
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -3917,7 +3822,6 @@ export declare enum Action {
|
|
|
3917
3822
|
ManageMonitor = "ManageMonitor",
|
|
3918
3823
|
/**
|
|
3919
3824
|
* Action ID for Liveboard Personalised Views dropdown
|
|
3920
|
-
*
|
|
3921
3825
|
* @example
|
|
3922
3826
|
* ```js
|
|
3923
3827
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -3927,7 +3831,6 @@ export declare enum Action {
|
|
|
3927
3831
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
3928
3832
|
/**
|
|
3929
3833
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
3930
|
-
*
|
|
3931
3834
|
* @example
|
|
3932
3835
|
* ```js
|
|
3933
3836
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -3939,7 +3842,6 @@ export declare enum Action {
|
|
|
3939
3842
|
* Action ID for the Parent TML action
|
|
3940
3843
|
* The parent action **TML** must be included to access TML-related options
|
|
3941
3844
|
* within the cascading menu (specific to the answer page)
|
|
3942
|
-
*
|
|
3943
3845
|
* @example
|
|
3944
3846
|
* ```js
|
|
3945
3847
|
* // to include specific TML actions
|
|
@@ -3951,13 +3853,11 @@ export declare enum Action {
|
|
|
3951
3853
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
3952
3854
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
3953
3855
|
* ```
|
|
3954
|
-
*
|
|
3955
|
-
* @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
|
|
3856
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
3956
3857
|
*/
|
|
3957
3858
|
TML = "tml",
|
|
3958
3859
|
/**
|
|
3959
3860
|
* Action ID for to hide Verified Liveboard Banner
|
|
3960
|
-
*
|
|
3961
3861
|
* @example
|
|
3962
3862
|
* ```js
|
|
3963
3863
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -3967,7 +3867,6 @@ export declare enum Action {
|
|
|
3967
3867
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
3968
3868
|
/**
|
|
3969
3869
|
* Action ID for ask sage button
|
|
3970
|
-
*
|
|
3971
3870
|
* @example
|
|
3972
3871
|
* ```js
|
|
3973
3872
|
* hiddenAction: [Action.AskAi]
|
|
@@ -3977,7 +3876,6 @@ export declare enum Action {
|
|
|
3977
3876
|
AskAi = "AskAi",
|
|
3978
3877
|
/**
|
|
3979
3878
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
3980
|
-
*
|
|
3981
3879
|
* @example
|
|
3982
3880
|
* ```js
|
|
3983
3881
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -3987,7 +3885,6 @@ export declare enum Action {
|
|
|
3987
3885
|
AddToWatchlist = "addToWatchlist",
|
|
3988
3886
|
/**
|
|
3989
3887
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
3990
|
-
*
|
|
3991
3888
|
* @example
|
|
3992
3889
|
* ```js
|
|
3993
3890
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -3995,19 +3892,8 @@ export declare enum Action {
|
|
|
3995
3892
|
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
3996
3893
|
*/
|
|
3997
3894
|
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
3895
|
/**
|
|
4009
3896
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
4010
|
-
*
|
|
4011
3897
|
* @example
|
|
4012
3898
|
* ```js
|
|
4013
3899
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -4017,7 +3903,6 @@ export declare enum Action {
|
|
|
4017
3903
|
OrganiseFavourites = "organiseFavourites",
|
|
4018
3904
|
/**
|
|
4019
3905
|
* Action ID for AI Highlights button
|
|
4020
|
-
*
|
|
4021
3906
|
* @example
|
|
4022
3907
|
* ```js
|
|
4023
3908
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -4086,7 +3971,6 @@ export interface CustomActionPayload {
|
|
|
4086
3971
|
export declare enum LogLevel {
|
|
4087
3972
|
/**
|
|
4088
3973
|
* No logs will be logged in the console.
|
|
4089
|
-
*
|
|
4090
3974
|
* @example
|
|
4091
3975
|
* ```js
|
|
4092
3976
|
* init({
|
|
@@ -4099,7 +3983,6 @@ export declare enum LogLevel {
|
|
|
4099
3983
|
SILENT = "SILENT",
|
|
4100
3984
|
/**
|
|
4101
3985
|
* Only ERROR logs will be logged in the console.
|
|
4102
|
-
*
|
|
4103
3986
|
* @example
|
|
4104
3987
|
* ```js
|
|
4105
3988
|
* init({
|
|
@@ -4112,7 +3995,6 @@ export declare enum LogLevel {
|
|
|
4112
3995
|
ERROR = "ERROR",
|
|
4113
3996
|
/**
|
|
4114
3997
|
* Only WARN and ERROR logs will be logged in the console.
|
|
4115
|
-
*
|
|
4116
3998
|
* @example
|
|
4117
3999
|
* ```js
|
|
4118
4000
|
* init({
|
|
@@ -4125,7 +4007,6 @@ export declare enum LogLevel {
|
|
|
4125
4007
|
WARN = "WARN",
|
|
4126
4008
|
/**
|
|
4127
4009
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
4128
|
-
*
|
|
4129
4010
|
* @example
|
|
4130
4011
|
* ```js
|
|
4131
4012
|
* init({
|
|
@@ -4138,7 +4019,6 @@ export declare enum LogLevel {
|
|
|
4138
4019
|
INFO = "INFO",
|
|
4139
4020
|
/**
|
|
4140
4021
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
4141
|
-
*
|
|
4142
4022
|
* @example
|
|
4143
4023
|
* ```js
|
|
4144
4024
|
* init({
|
|
@@ -4151,7 +4031,6 @@ export declare enum LogLevel {
|
|
|
4151
4031
|
DEBUG = "DEBUG",
|
|
4152
4032
|
/**
|
|
4153
4033
|
* All logs will be logged in the console.
|
|
4154
|
-
*
|
|
4155
4034
|
* @example
|
|
4156
4035
|
* ```js
|
|
4157
4036
|
* init({
|