@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/src/types.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
|
*/
|
|
@@ -13,7 +12,6 @@ import type { SessionInterface } from './utils/graphql/answerService/answerServi
|
|
|
13
12
|
/**
|
|
14
13
|
* The authentication mechanism for allowing access to the
|
|
15
14
|
* the embedded app
|
|
16
|
-
*
|
|
17
15
|
* @group Authentication / Init
|
|
18
16
|
*/
|
|
19
17
|
// eslint-disable-next-line no-shadow
|
|
@@ -21,7 +19,6 @@ export enum AuthType {
|
|
|
21
19
|
/**
|
|
22
20
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
23
21
|
* `Passthrough`.
|
|
24
|
-
*
|
|
25
22
|
* @example
|
|
26
23
|
* ```js
|
|
27
24
|
* init({
|
|
@@ -39,7 +36,6 @@ export enum AuthType {
|
|
|
39
36
|
* To use this:
|
|
40
37
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
41
38
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
42
|
-
*
|
|
43
39
|
* @example
|
|
44
40
|
* ```js
|
|
45
41
|
* init({
|
|
@@ -52,14 +48,12 @@ export enum AuthType {
|
|
|
52
48
|
EmbeddedSSO = 'EmbeddedSSO',
|
|
53
49
|
/**
|
|
54
50
|
* SSO using SAML
|
|
55
|
-
*
|
|
56
51
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
57
52
|
* @hidden
|
|
58
53
|
*/
|
|
59
54
|
SSO = 'SSO_SAML',
|
|
60
55
|
/**
|
|
61
56
|
* SSO using SAML
|
|
62
|
-
*
|
|
63
57
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
64
58
|
* @hidden
|
|
65
59
|
*/
|
|
@@ -71,7 +65,6 @@ export enum AuthType {
|
|
|
71
65
|
*
|
|
72
66
|
* This redirects the host application to the SAML IdP. The host application
|
|
73
67
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
74
|
-
*
|
|
75
68
|
* @example
|
|
76
69
|
* ```js
|
|
77
70
|
* init({
|
|
@@ -112,7 +105,6 @@ export enum AuthType {
|
|
|
112
105
|
SAMLRedirect = 'SSO_SAML',
|
|
113
106
|
/**
|
|
114
107
|
* SSO using OIDC
|
|
115
|
-
*
|
|
116
108
|
* @hidden
|
|
117
109
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
118
110
|
*/
|
|
@@ -125,7 +117,6 @@ export enum AuthType {
|
|
|
125
117
|
OIDCRedirect = 'SSO_OIDC',
|
|
126
118
|
/**
|
|
127
119
|
* Trusted authentication server
|
|
128
|
-
*
|
|
129
120
|
* @hidden
|
|
130
121
|
* @deprecated Use {@link TrustedAuth} instead
|
|
131
122
|
*/
|
|
@@ -134,7 +125,6 @@ export enum AuthType {
|
|
|
134
125
|
* Trusted authentication server. Use your own authentication server
|
|
135
126
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
136
127
|
* from ThoughtSpot.
|
|
137
|
-
*
|
|
138
128
|
* @example
|
|
139
129
|
* ```js
|
|
140
130
|
* init({
|
|
@@ -146,6 +136,7 @@ export enum AuthType {
|
|
|
146
136
|
* .then((data) => data.token);
|
|
147
137
|
* }
|
|
148
138
|
* });
|
|
139
|
+
* });
|
|
149
140
|
* ```
|
|
150
141
|
*/
|
|
151
142
|
TrustedAuthToken = 'AuthServer',
|
|
@@ -155,7 +146,6 @@ export enum AuthType {
|
|
|
155
146
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
156
147
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
157
148
|
* implemented by some browsers.
|
|
158
|
-
*
|
|
159
149
|
* @example
|
|
160
150
|
* ```js
|
|
161
151
|
* init({
|
|
@@ -230,7 +220,6 @@ export interface customCssInterface {
|
|
|
230
220
|
/**
|
|
231
221
|
* Can be used to define a custom font face
|
|
232
222
|
* like:
|
|
233
|
-
*
|
|
234
223
|
* @example
|
|
235
224
|
* ```js
|
|
236
225
|
* rules_UNSTABLE?: {
|
|
@@ -272,7 +261,6 @@ export interface CustomStyles {
|
|
|
272
261
|
* Thoughtspot components.
|
|
273
262
|
* You can customize styles, text strings, and icons.
|
|
274
263
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
275
|
-
*
|
|
276
264
|
* @example
|
|
277
265
|
* ```js
|
|
278
266
|
* init({
|
|
@@ -316,7 +304,6 @@ export interface CustomisationsInterface {
|
|
|
316
304
|
* It includes the ThoughtSpot hostname or IP address,
|
|
317
305
|
* the type of authentication, and the authentication endpoint
|
|
318
306
|
* if a trusted authentication server is used.
|
|
319
|
-
*
|
|
320
307
|
* @group Authentication / Init
|
|
321
308
|
*/
|
|
322
309
|
export interface EmbedConfig {
|
|
@@ -366,7 +353,6 @@ export interface EmbedConfig {
|
|
|
366
353
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
367
354
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
368
355
|
* place.
|
|
369
|
-
*
|
|
370
356
|
* @default false
|
|
371
357
|
* @deprecated
|
|
372
358
|
*/
|
|
@@ -378,7 +364,6 @@ export interface EmbedConfig {
|
|
|
378
364
|
*
|
|
379
365
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
380
366
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
381
|
-
*
|
|
382
367
|
* @default false
|
|
383
368
|
* @version SDK: 1.18.0
|
|
384
369
|
*/
|
|
@@ -390,7 +375,6 @@ export interface EmbedConfig {
|
|
|
390
375
|
* terminated.
|
|
391
376
|
*
|
|
392
377
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
393
|
-
*
|
|
394
378
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
395
379
|
*/
|
|
396
380
|
redirectPath?: string;
|
|
@@ -402,7 +386,6 @@ export interface EmbedConfig {
|
|
|
402
386
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
403
387
|
* should be encoded in base64. This provides additional security to
|
|
404
388
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
405
|
-
*
|
|
406
389
|
* @default false
|
|
407
390
|
*/
|
|
408
391
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -413,7 +396,6 @@ export interface EmbedConfig {
|
|
|
413
396
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
414
397
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
415
398
|
* in this case.
|
|
416
|
-
*
|
|
417
399
|
* @default false
|
|
418
400
|
*/
|
|
419
401
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -422,7 +404,6 @@ export interface EmbedConfig {
|
|
|
422
404
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
423
405
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
424
406
|
* persists even in the case of a non-logged-in user.
|
|
425
|
-
*
|
|
426
407
|
* @default false
|
|
427
408
|
*/
|
|
428
409
|
ignoreNoCookieAccess?: boolean;
|
|
@@ -430,7 +411,6 @@ export interface EmbedConfig {
|
|
|
430
411
|
/**
|
|
431
412
|
* Re-login a user with the previous login options
|
|
432
413
|
* when a user session expires.
|
|
433
|
-
*
|
|
434
414
|
* @default false
|
|
435
415
|
*/
|
|
436
416
|
autoLogin?: boolean;
|
|
@@ -440,7 +420,6 @@ export interface EmbedConfig {
|
|
|
440
420
|
* This flag is typically used alongside the combination of authentication modes such
|
|
441
421
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
442
422
|
* EmbedConfig.autoLogin}
|
|
443
|
-
*
|
|
444
423
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
445
424
|
* @default false
|
|
446
425
|
*/
|
|
@@ -448,14 +427,12 @@ export interface EmbedConfig {
|
|
|
448
427
|
|
|
449
428
|
/**
|
|
450
429
|
* This message is displayed in the embedded view when a user login fails.
|
|
451
|
-
*
|
|
452
430
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
453
431
|
*/
|
|
454
432
|
loginFailedMessage?: string;
|
|
455
433
|
|
|
456
434
|
/**
|
|
457
435
|
* Calls the prefetch method internally when set to `true`
|
|
458
|
-
*
|
|
459
436
|
* @default false
|
|
460
437
|
*/
|
|
461
438
|
callPrefetch?: boolean;
|
|
@@ -464,7 +441,6 @@ export interface EmbedConfig {
|
|
|
464
441
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
465
442
|
* to start after the previous embed's render is complete. This helps improve
|
|
466
443
|
* performance by decreasing the load on the browser.
|
|
467
|
-
*
|
|
468
444
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
469
445
|
* @default false
|
|
470
446
|
*/
|
|
@@ -473,7 +449,6 @@ export interface EmbedConfig {
|
|
|
473
449
|
/**
|
|
474
450
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
475
451
|
* You would also need to set `style-src` in the CSP settings.
|
|
476
|
-
*
|
|
477
452
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
478
453
|
* @default ''
|
|
479
454
|
*/
|
|
@@ -485,16 +460,15 @@ export interface EmbedConfig {
|
|
|
485
460
|
*
|
|
486
461
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
487
462
|
* involves an extra network call.
|
|
488
|
-
*
|
|
489
463
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
490
464
|
*/
|
|
491
465
|
detectCookieAccessSlow?: boolean;
|
|
492
466
|
/**
|
|
493
467
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
494
|
-
*
|
|
495
468
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
496
469
|
*/
|
|
497
470
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
471
|
+
|
|
498
472
|
/**
|
|
499
473
|
* Hide `beta` alert warning message for SageEmbed.
|
|
500
474
|
*
|
|
@@ -502,7 +476,6 @@ export interface EmbedConfig {
|
|
|
502
476
|
suppressSageEmbedBetaWarning?: boolean;
|
|
503
477
|
/**
|
|
504
478
|
* Custom style params for embed Config.
|
|
505
|
-
*
|
|
506
479
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
507
480
|
*/
|
|
508
481
|
customizations?: CustomisationsInterface;
|
|
@@ -510,7 +483,6 @@ export interface EmbedConfig {
|
|
|
510
483
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
511
484
|
* button that the user can click to trigger the flow.
|
|
512
485
|
* This attribute sets a containing element for that button.
|
|
513
|
-
*
|
|
514
486
|
* @example
|
|
515
487
|
* ```js
|
|
516
488
|
* init({
|
|
@@ -532,7 +504,6 @@ export interface EmbedConfig {
|
|
|
532
504
|
/**
|
|
533
505
|
* Text to show in the button which triggers the popup auth flow.
|
|
534
506
|
* Default: `Authorize`.
|
|
535
|
-
*
|
|
536
507
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
537
508
|
*/
|
|
538
509
|
authTriggerText?: string;
|
|
@@ -540,7 +511,6 @@ export interface EmbedConfig {
|
|
|
540
511
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
541
512
|
* access to the embedded application users
|
|
542
513
|
* outside of the iframe.
|
|
543
|
-
*
|
|
544
514
|
* @default true
|
|
545
515
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
546
516
|
*/
|
|
@@ -548,7 +518,6 @@ export interface EmbedConfig {
|
|
|
548
518
|
|
|
549
519
|
/**
|
|
550
520
|
* Host config in case embedded app is inside TS app itself
|
|
551
|
-
*
|
|
552
521
|
* @hidden
|
|
553
522
|
*/
|
|
554
523
|
hostConfig?: {
|
|
@@ -560,21 +529,18 @@ export interface EmbedConfig {
|
|
|
560
529
|
/**
|
|
561
530
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
562
531
|
* 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).
|
|
563
|
-
*
|
|
564
532
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
565
533
|
*/
|
|
566
534
|
pendoTrackingKey?: string;
|
|
567
535
|
|
|
568
536
|
/**
|
|
569
537
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
570
|
-
*
|
|
571
538
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
572
539
|
*/
|
|
573
540
|
suppressErrorAlerts?: boolean;
|
|
574
541
|
|
|
575
542
|
/**
|
|
576
543
|
* Log level for the SDK.
|
|
577
|
-
*
|
|
578
544
|
* @default LogLevel.ERROR
|
|
579
545
|
* @example
|
|
580
546
|
* ```js
|
|
@@ -588,10 +554,39 @@ export interface EmbedConfig {
|
|
|
588
554
|
logLevel?: LogLevel;
|
|
589
555
|
/**
|
|
590
556
|
* Disables the Mixpanel tracking from the SDK.
|
|
591
|
-
*
|
|
592
557
|
* @version SDK: 1.27.9
|
|
593
558
|
*/
|
|
594
559
|
disableSDKTracking?: boolean;
|
|
560
|
+
/**
|
|
561
|
+
* Overrides default/user preffered locale for date formatting
|
|
562
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
563
|
+
*/
|
|
564
|
+
dateFormatLocale?: string;
|
|
565
|
+
/**
|
|
566
|
+
* Overrides default/user preffered locale for number formatting
|
|
567
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
568
|
+
*/
|
|
569
|
+
numberFormatLocale?: string;
|
|
570
|
+
/**
|
|
571
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
572
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
573
|
+
*/
|
|
574
|
+
currencyFormat?: string;
|
|
575
|
+
|
|
576
|
+
/**
|
|
577
|
+
* This flag is used to disable the token verification in the SDK.
|
|
578
|
+
* Enabling this flag will also disable the caching of the token.
|
|
579
|
+
* @hidden
|
|
580
|
+
* @example
|
|
581
|
+
* ```js
|
|
582
|
+
* init({
|
|
583
|
+
* ...embedConfig,
|
|
584
|
+
* disableTokenVerification : true
|
|
585
|
+
* })
|
|
586
|
+
* ```
|
|
587
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
588
|
+
*/
|
|
589
|
+
disableTokenVerification?: boolean;
|
|
595
590
|
}
|
|
596
591
|
|
|
597
592
|
// eslint-disable-next-line @typescript-eslint/no-empty-interface
|
|
@@ -599,7 +594,6 @@ export interface LayoutConfig {}
|
|
|
599
594
|
|
|
600
595
|
/**
|
|
601
596
|
* Embedded iframe configuration
|
|
602
|
-
*
|
|
603
597
|
* @group Embed components
|
|
604
598
|
*/
|
|
605
599
|
export interface FrameParams {
|
|
@@ -635,9 +629,7 @@ export interface ViewConfig {
|
|
|
635
629
|
/**
|
|
636
630
|
* The width and height dimensions to render an embedded
|
|
637
631
|
* object inside your app. Specify the values in pixels or percentage.
|
|
638
|
-
*
|
|
639
632
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
640
|
-
*
|
|
641
633
|
* @example
|
|
642
634
|
* ```js
|
|
643
635
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -664,7 +656,6 @@ export interface ViewConfig {
|
|
|
664
656
|
* (...), and the contextual menu. These actions will be disabled
|
|
665
657
|
* for the user.
|
|
666
658
|
* Use this to disable actions.
|
|
667
|
-
*
|
|
668
659
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
669
660
|
* @example
|
|
670
661
|
* ```js
|
|
@@ -692,9 +683,7 @@ export interface ViewConfig {
|
|
|
692
683
|
* The list of actions to hide from the embedded.
|
|
693
684
|
* This actions will be hidden from the user.
|
|
694
685
|
* Use this to hide an action.
|
|
695
|
-
*
|
|
696
686
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
697
|
-
*
|
|
698
687
|
* @example
|
|
699
688
|
* ```js
|
|
700
689
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -712,10 +701,8 @@ export interface ViewConfig {
|
|
|
712
701
|
* Use this to hide all actions except the ones you want to show.
|
|
713
702
|
*
|
|
714
703
|
* Use either this or hiddenActions.
|
|
715
|
-
*
|
|
716
704
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
717
705
|
* @important
|
|
718
|
-
*
|
|
719
706
|
* @example
|
|
720
707
|
* ```js
|
|
721
708
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -727,9 +714,7 @@ export interface ViewConfig {
|
|
|
727
714
|
visibleActions?: Action[];
|
|
728
715
|
/**
|
|
729
716
|
* Show alert messages and toast messages in the embedded view.
|
|
730
|
-
*
|
|
731
717
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
732
|
-
*
|
|
733
718
|
* @example
|
|
734
719
|
* ```js
|
|
735
720
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -742,9 +727,7 @@ export interface ViewConfig {
|
|
|
742
727
|
/**
|
|
743
728
|
* The list of runtime filters to apply to a search answer,
|
|
744
729
|
* visualization, or Liveboard.
|
|
745
|
-
*
|
|
746
730
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
747
|
-
*
|
|
748
731
|
* @example
|
|
749
732
|
* ```js
|
|
750
733
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -763,9 +746,7 @@ export interface ViewConfig {
|
|
|
763
746
|
/**
|
|
764
747
|
* The list of parameter override to apply to a search answer,
|
|
765
748
|
* visualization, or Liveboard.
|
|
766
|
-
*
|
|
767
749
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
768
|
-
*
|
|
769
750
|
* @example
|
|
770
751
|
* ```js
|
|
771
752
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -782,7 +763,6 @@ export interface ViewConfig {
|
|
|
782
763
|
runtimeParameters?: RuntimeParameter[];
|
|
783
764
|
/**
|
|
784
765
|
* The locale/language to use for the embedded view.
|
|
785
|
-
*
|
|
786
766
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
787
767
|
* @example
|
|
788
768
|
* ```js
|
|
@@ -816,7 +796,6 @@ export interface ViewConfig {
|
|
|
816
796
|
/**
|
|
817
797
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
818
798
|
* You would also need to set `style-src` in the CSP settings.
|
|
819
|
-
*
|
|
820
799
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
821
800
|
* @default ''
|
|
822
801
|
*/
|
|
@@ -824,9 +803,7 @@ export interface ViewConfig {
|
|
|
824
803
|
/**
|
|
825
804
|
* Insert as a sibling of the target container, instead of appending to a
|
|
826
805
|
* child inside it.
|
|
827
|
-
*
|
|
828
806
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
829
|
-
*
|
|
830
807
|
* @example
|
|
831
808
|
* ```js
|
|
832
809
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -838,7 +815,6 @@ export interface ViewConfig {
|
|
|
838
815
|
insertAsSibling?: boolean;
|
|
839
816
|
/**
|
|
840
817
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
841
|
-
*
|
|
842
818
|
* @example
|
|
843
819
|
* ```js
|
|
844
820
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -851,7 +827,6 @@ export interface ViewConfig {
|
|
|
851
827
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
852
828
|
/**
|
|
853
829
|
* Flag to override openNew tab context menu link
|
|
854
|
-
*
|
|
855
830
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
856
831
|
* @example
|
|
857
832
|
* ```js
|
|
@@ -864,7 +839,6 @@ export interface ViewConfig {
|
|
|
864
839
|
linkOverride?: boolean;
|
|
865
840
|
/**
|
|
866
841
|
* flag to enable insert into slides action
|
|
867
|
-
*
|
|
868
842
|
* @hidden
|
|
869
843
|
* @private
|
|
870
844
|
*/
|
|
@@ -872,7 +846,6 @@ export interface ViewConfig {
|
|
|
872
846
|
/**
|
|
873
847
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
874
848
|
* if available and matches the configuration.
|
|
875
|
-
*
|
|
876
849
|
* @version SDK: 1.22.0
|
|
877
850
|
* @hidden
|
|
878
851
|
*
|
|
@@ -886,7 +859,6 @@ export interface ViewConfig {
|
|
|
886
859
|
*
|
|
887
860
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
888
861
|
* embedded view.
|
|
889
|
-
*
|
|
890
862
|
* @default false
|
|
891
863
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
892
864
|
*/
|
|
@@ -895,7 +867,6 @@ export interface ViewConfig {
|
|
|
895
867
|
* The list of tab IDs to hide from the embedded.
|
|
896
868
|
* This Tabs will be hidden from their respective LBs.
|
|
897
869
|
* Use this to hide an tabID.
|
|
898
|
-
*
|
|
899
870
|
* @example
|
|
900
871
|
* ```js
|
|
901
872
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -912,10 +883,11 @@ export interface ViewConfig {
|
|
|
912
883
|
* Hide the home page modules
|
|
913
884
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
914
885
|
*
|
|
886
|
+
*
|
|
887
|
+
*
|
|
915
888
|
* **Note**: This option does not apply to the classic homepage.
|
|
916
889
|
* To access the updated modular homepage, set
|
|
917
890
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
918
|
-
*
|
|
919
891
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
920
892
|
* @example
|
|
921
893
|
* ```js
|
|
@@ -924,19 +896,17 @@ export interface ViewConfig {
|
|
|
924
896
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
925
897
|
* })
|
|
926
898
|
* ```
|
|
927
|
-
*
|
|
928
899
|
*/
|
|
929
900
|
hiddenHomepageModules?: HomepageModule[];
|
|
930
901
|
/**
|
|
931
902
|
* reordering the home page modules
|
|
932
903
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
933
904
|
*
|
|
905
|
+
*
|
|
934
906
|
* **Note**: This option does not apply to the classic homepage.
|
|
935
907
|
* To access the updated modular homepage, set
|
|
936
908
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
937
|
-
*
|
|
938
909
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
939
|
-
*
|
|
940
910
|
* @example
|
|
941
911
|
* ```js
|
|
942
912
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -951,9 +921,7 @@ export interface ViewConfig {
|
|
|
951
921
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
952
922
|
*
|
|
953
923
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
954
|
-
*
|
|
955
924
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
956
|
-
*
|
|
957
925
|
* @example
|
|
958
926
|
* ```js
|
|
959
927
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -970,8 +938,7 @@ export interface ViewConfig {
|
|
|
970
938
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
971
939
|
* There are 8 eight home navigation list items.
|
|
972
940
|
* To hide these items, specify the string in the array.
|
|
973
|
-
*
|
|
974
|
-
* * @example
|
|
941
|
+
* @example
|
|
975
942
|
* ```js
|
|
976
943
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
977
944
|
* ... // other options
|
|
@@ -979,10 +946,11 @@ export interface ViewConfig {
|
|
|
979
946
|
* })
|
|
980
947
|
* ```
|
|
981
948
|
*
|
|
949
|
+
*
|
|
950
|
+
*
|
|
982
951
|
* **Note**: This option does not apply to the classic homepage.
|
|
983
952
|
* To access the updated modular homepage, set
|
|
984
953
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
985
|
-
*
|
|
986
954
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
987
955
|
*/
|
|
988
956
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -990,7 +958,6 @@ export interface ViewConfig {
|
|
|
990
958
|
* PreRender id to be used for PreRendering the embed.
|
|
991
959
|
* Use PreRender to render the embed in the background and then
|
|
992
960
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
993
|
-
*
|
|
994
961
|
* @example
|
|
995
962
|
* ```js
|
|
996
963
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1008,11 +975,9 @@ export interface ViewConfig {
|
|
|
1008
975
|
* of its embedding element and adjust its own size accordingly.
|
|
1009
976
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
1010
977
|
* its dimensions based on changes to the size of the embedding element.
|
|
1011
|
-
*
|
|
1012
978
|
* @type {boolean}
|
|
1013
979
|
* @default false
|
|
1014
980
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
1015
|
-
*
|
|
1016
981
|
* @example
|
|
1017
982
|
* ```js
|
|
1018
983
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -1027,15 +992,23 @@ export interface ViewConfig {
|
|
|
1027
992
|
doNotTrackPreRenderSize?: boolean;
|
|
1028
993
|
/**
|
|
1029
994
|
* For internal tracking of the embed component type.
|
|
1030
|
-
*
|
|
1031
995
|
* @hidden
|
|
1032
996
|
*/
|
|
1033
997
|
embedComponentType?: string;
|
|
998
|
+
/**
|
|
999
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
1000
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
1001
|
+
*
|
|
1002
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
1003
|
+
* embedded view.
|
|
1004
|
+
* @default false
|
|
1005
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1006
|
+
*/
|
|
1007
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
1034
1008
|
}
|
|
1035
1009
|
|
|
1036
1010
|
/**
|
|
1037
1011
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
1038
|
-
*
|
|
1039
1012
|
* @group Events
|
|
1040
1013
|
*/
|
|
1041
1014
|
export type MessagePayload = {
|
|
@@ -1049,7 +1022,6 @@ export type MessagePayload = {
|
|
|
1049
1022
|
/**
|
|
1050
1023
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
1051
1024
|
* option
|
|
1052
|
-
*
|
|
1053
1025
|
* @group Events
|
|
1054
1026
|
*/
|
|
1055
1027
|
export type MessageOptions = {
|
|
@@ -1061,7 +1033,6 @@ export type MessageOptions = {
|
|
|
1061
1033
|
};
|
|
1062
1034
|
/**
|
|
1063
1035
|
* MessageCallback: Embed event message callback
|
|
1064
|
-
*
|
|
1065
1036
|
* @group Events
|
|
1066
1037
|
*/
|
|
1067
1038
|
export type MessageCallback = (
|
|
@@ -1160,7 +1131,6 @@ export enum RuntimeFilterOp {
|
|
|
1160
1131
|
* **Note**: This option does not apply to the classic homepage.
|
|
1161
1132
|
* To access the updated modular homepage, set
|
|
1162
1133
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1163
|
-
*
|
|
1164
1134
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1165
1135
|
*/
|
|
1166
1136
|
// eslint-disable-next-line no-shadow
|
|
@@ -1209,7 +1179,7 @@ export interface RuntimeFilter {
|
|
|
1209
1179
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
1210
1180
|
* operands.
|
|
1211
1181
|
*/
|
|
1212
|
-
values: (number | boolean | string)[];
|
|
1182
|
+
values: (number | boolean | string | bigint)[];
|
|
1213
1183
|
}
|
|
1214
1184
|
/**
|
|
1215
1185
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -1231,7 +1201,6 @@ export interface RuntimeParameter {
|
|
|
1231
1201
|
*
|
|
1232
1202
|
* To add an event listener use the corresponding
|
|
1233
1203
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
1234
|
-
*
|
|
1235
1204
|
* @example
|
|
1236
1205
|
* ```js
|
|
1237
1206
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1250,7 +1219,6 @@ export interface RuntimeParameter {
|
|
|
1250
1219
|
export enum EmbedEvent {
|
|
1251
1220
|
/**
|
|
1252
1221
|
* Rendering has initialized.
|
|
1253
|
-
*
|
|
1254
1222
|
* @example
|
|
1255
1223
|
*```js
|
|
1256
1224
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -1264,7 +1232,7 @@ export enum EmbedEvent {
|
|
|
1264
1232
|
Init = 'init',
|
|
1265
1233
|
/**
|
|
1266
1234
|
* Authentication has either succeeded or failed.
|
|
1267
|
-
*
|
|
1235
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1268
1236
|
* @example
|
|
1269
1237
|
*```js
|
|
1270
1238
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -1276,8 +1244,8 @@ export enum EmbedEvent {
|
|
|
1276
1244
|
AuthInit = 'authInit',
|
|
1277
1245
|
/**
|
|
1278
1246
|
* The embed object container has loaded.
|
|
1279
|
-
*
|
|
1280
1247
|
* @returns timestamp - The timestamp when the event was generated.
|
|
1248
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1281
1249
|
* @example
|
|
1282
1250
|
*```js
|
|
1283
1251
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -1290,8 +1258,8 @@ export enum EmbedEvent {
|
|
|
1290
1258
|
Load = 'load',
|
|
1291
1259
|
/**
|
|
1292
1260
|
* Data pertaining to answer or Liveboard is received
|
|
1293
|
-
*
|
|
1294
1261
|
* @return data - The answer or Liveboard data
|
|
1262
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1295
1263
|
* @example
|
|
1296
1264
|
*```js
|
|
1297
1265
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -1303,13 +1271,12 @@ export enum EmbedEvent {
|
|
|
1303
1271
|
Data = 'data',
|
|
1304
1272
|
/**
|
|
1305
1273
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
1306
|
-
*
|
|
1307
1274
|
* @hidden
|
|
1308
1275
|
*/
|
|
1309
1276
|
FiltersChanged = 'filtersChanged',
|
|
1310
1277
|
/**
|
|
1311
1278
|
* Search query has been updated by the user.
|
|
1312
|
-
*
|
|
1279
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1313
1280
|
* @example
|
|
1314
1281
|
*```js
|
|
1315
1282
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -1318,13 +1285,13 @@ export enum EmbedEvent {
|
|
|
1318
1285
|
QueryChanged = 'queryChanged',
|
|
1319
1286
|
/**
|
|
1320
1287
|
* A drill-down operation has been performed.
|
|
1321
|
-
*
|
|
1288
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1322
1289
|
* @returns additionalFilters - Any additional filters applied
|
|
1323
1290
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
1324
1291
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
1325
1292
|
* @example
|
|
1326
1293
|
*```js
|
|
1327
|
-
* searchEmbed.
|
|
1294
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
1328
1295
|
* points: {
|
|
1329
1296
|
* clickedPoint,
|
|
1330
1297
|
* selectedPoints: selectedPoint
|
|
@@ -1355,8 +1322,8 @@ export enum EmbedEvent {
|
|
|
1355
1322
|
Drilldown = 'drillDown',
|
|
1356
1323
|
/**
|
|
1357
1324
|
* One or more data sources have been selected.
|
|
1358
|
-
*
|
|
1359
1325
|
* @returns dataSourceIds - the list of data sources
|
|
1326
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1360
1327
|
* @example
|
|
1361
1328
|
* ```js
|
|
1362
1329
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -1367,7 +1334,6 @@ export enum EmbedEvent {
|
|
|
1367
1334
|
DataSourceSelected = 'dataSourceSelected',
|
|
1368
1335
|
/**
|
|
1369
1336
|
* One or more data columns have been selected.
|
|
1370
|
-
*
|
|
1371
1337
|
* @returns columnIds - the list of columns
|
|
1372
1338
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1373
1339
|
* @example
|
|
@@ -1380,10 +1346,10 @@ export enum EmbedEvent {
|
|
|
1380
1346
|
AddRemoveColumns = 'addRemoveColumns',
|
|
1381
1347
|
/**
|
|
1382
1348
|
* A custom action has been triggered.
|
|
1383
|
-
*
|
|
1384
1349
|
* @returns actionId - ID of the custom action
|
|
1385
1350
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
1386
1351
|
* Answer or Liveboard data
|
|
1352
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1387
1353
|
* @example
|
|
1388
1354
|
* ```js
|
|
1389
1355
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -1397,7 +1363,6 @@ export enum EmbedEvent {
|
|
|
1397
1363
|
CustomAction = 'customAction',
|
|
1398
1364
|
/**
|
|
1399
1365
|
* Listen to double click actions on a visualization.
|
|
1400
|
-
*
|
|
1401
1366
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
1402
1367
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1403
1368
|
* @example
|
|
@@ -1410,7 +1375,6 @@ export enum EmbedEvent {
|
|
|
1410
1375
|
VizPointDoubleClick = 'vizPointDoubleClick',
|
|
1411
1376
|
/**
|
|
1412
1377
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
1413
|
-
*
|
|
1414
1378
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
1415
1379
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1416
1380
|
* @important
|
|
@@ -1431,21 +1395,22 @@ export enum EmbedEvent {
|
|
|
1431
1395
|
/**
|
|
1432
1396
|
* An error has occurred. This event is fired for the following error types:
|
|
1433
1397
|
*
|
|
1434
|
-
*
|
|
1398
|
+
* `API`: API call failure error.
|
|
1435
1399
|
*
|
|
1436
|
-
*
|
|
1400
|
+
* `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
|
|
1401
|
+
* mode.
|
|
1437
1402
|
*
|
|
1438
|
-
*
|
|
1403
|
+
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
1439
1404
|
*
|
|
1440
|
-
*
|
|
1405
|
+
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
1441
1406
|
*
|
|
1442
|
-
*
|
|
1407
|
+
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
1443
1408
|
*
|
|
1444
|
-
*
|
|
1445
|
-
*
|
|
1446
|
-
* For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
|
|
1409
|
+
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
1447
1410
|
*
|
|
1411
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
1448
1412
|
* @returns error - An error object or message
|
|
1413
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1449
1414
|
* @example
|
|
1450
1415
|
* ```js
|
|
1451
1416
|
* // API error
|
|
@@ -1469,8 +1434,8 @@ export enum EmbedEvent {
|
|
|
1469
1434
|
Error = 'Error',
|
|
1470
1435
|
/**
|
|
1471
1436
|
* The embedded object has sent an alert.
|
|
1472
|
-
*
|
|
1473
1437
|
* @returns alert - An alert object
|
|
1438
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
1474
1439
|
* @example
|
|
1475
1440
|
* ```js
|
|
1476
1441
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -1479,7 +1444,7 @@ export enum EmbedEvent {
|
|
|
1479
1444
|
Alert = 'alert',
|
|
1480
1445
|
/**
|
|
1481
1446
|
* The ThoughtSpot auth session has expired.
|
|
1482
|
-
*
|
|
1447
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
1483
1448
|
* @example
|
|
1484
1449
|
*```js
|
|
1485
1450
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -1492,26 +1457,22 @@ export enum EmbedEvent {
|
|
|
1492
1457
|
AuthExpire = 'ThoughtspotAuthExpired',
|
|
1493
1458
|
/**
|
|
1494
1459
|
* ThoughtSpot failed to validate the auth session.
|
|
1495
|
-
*
|
|
1496
1460
|
* @hidden
|
|
1497
1461
|
*/
|
|
1498
1462
|
AuthFailure = 'ThoughtspotAuthFailure',
|
|
1499
1463
|
/**
|
|
1500
1464
|
* ThoughtSpot failed to validate the auth session.
|
|
1501
|
-
*
|
|
1502
1465
|
* @hidden
|
|
1503
1466
|
*/
|
|
1504
1467
|
AuthLogout = 'ThoughtspotAuthLogout',
|
|
1505
1468
|
/**
|
|
1506
1469
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
1507
|
-
*
|
|
1508
1470
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
1509
1471
|
* @hidden
|
|
1510
1472
|
*/
|
|
1511
1473
|
EmbedHeight = 'EMBED_HEIGHT',
|
|
1512
1474
|
/**
|
|
1513
1475
|
* The center of visible iframe viewport is calculated.
|
|
1514
|
-
*
|
|
1515
1476
|
* @returns data - The center of the visible Iframe viewport.
|
|
1516
1477
|
* @hidden
|
|
1517
1478
|
*/
|
|
@@ -1519,7 +1480,6 @@ export enum EmbedEvent {
|
|
|
1519
1480
|
/**
|
|
1520
1481
|
* Emitted when the **Get Data** action is initiated.
|
|
1521
1482
|
* Applicable to `SearchBarEmbed` only.
|
|
1522
|
-
*
|
|
1523
1483
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
1524
1484
|
* @example
|
|
1525
1485
|
*```js
|
|
@@ -1532,7 +1492,7 @@ export enum EmbedEvent {
|
|
|
1532
1492
|
GetDataClick = 'getDataClick',
|
|
1533
1493
|
/**
|
|
1534
1494
|
* Detects the route change.
|
|
1535
|
-
*
|
|
1495
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
1536
1496
|
* @example
|
|
1537
1497
|
*```js
|
|
1538
1498
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -1542,15 +1502,13 @@ export enum EmbedEvent {
|
|
|
1542
1502
|
RouteChange = 'ROUTE_CHANGE',
|
|
1543
1503
|
/**
|
|
1544
1504
|
* The v1 event type for Data
|
|
1545
|
-
*
|
|
1546
1505
|
* @hidden
|
|
1547
1506
|
*/
|
|
1548
1507
|
V1Data = 'exportVizDataToParent',
|
|
1549
1508
|
/**
|
|
1550
1509
|
* Emitted when the embed does not have cookie access. This happens
|
|
1551
1510
|
* when Safari and other Web browsers block third-party cookies
|
|
1552
|
-
* are blocked by default.
|
|
1553
|
-
*
|
|
1511
|
+
* are blocked by default.
|
|
1554
1512
|
* @example
|
|
1555
1513
|
*```js
|
|
1556
1514
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -1560,14 +1518,12 @@ export enum EmbedEvent {
|
|
|
1560
1518
|
NoCookieAccess = 'noCookieAccess',
|
|
1561
1519
|
/**
|
|
1562
1520
|
* Emitted when SAML is complete
|
|
1563
|
-
*
|
|
1564
1521
|
* @private
|
|
1565
1522
|
* @hidden
|
|
1566
1523
|
*/
|
|
1567
1524
|
SAMLComplete = 'samlComplete',
|
|
1568
1525
|
/**
|
|
1569
1526
|
* Emitted when any modal is opened in the app
|
|
1570
|
-
*
|
|
1571
1527
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1572
1528
|
* @example
|
|
1573
1529
|
*```js
|
|
@@ -1579,7 +1535,6 @@ export enum EmbedEvent {
|
|
|
1579
1535
|
DialogOpen = 'dialog-open',
|
|
1580
1536
|
/**
|
|
1581
1537
|
* Emitted when any modal is closed in the app
|
|
1582
|
-
*
|
|
1583
1538
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1584
1539
|
* @example
|
|
1585
1540
|
*```js
|
|
@@ -1592,8 +1547,7 @@ export enum EmbedEvent {
|
|
|
1592
1547
|
/**
|
|
1593
1548
|
* Emitted when the Liveboard shell loads.
|
|
1594
1549
|
* You can use this event as a hook to trigger
|
|
1595
|
-
*
|
|
1596
|
-
*
|
|
1550
|
+
* actions on the rendered Liveboard.
|
|
1597
1551
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1598
1552
|
* @example
|
|
1599
1553
|
*```js
|
|
@@ -1613,9 +1567,7 @@ export enum EmbedEvent {
|
|
|
1613
1567
|
*/
|
|
1614
1568
|
LiveboardRendered = 'PinboardRendered',
|
|
1615
1569
|
/**
|
|
1616
|
-
*
|
|
1617
|
-
* is triggered on all events.
|
|
1618
|
-
*
|
|
1570
|
+
* Emits all events.
|
|
1619
1571
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1620
1572
|
* @example
|
|
1621
1573
|
*```js
|
|
@@ -1627,17 +1579,16 @@ export enum EmbedEvent {
|
|
|
1627
1579
|
ALL = '*',
|
|
1628
1580
|
/**
|
|
1629
1581
|
* Emitted when an Answer is saved in the app
|
|
1630
|
-
*
|
|
1631
1582
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1632
1583
|
* @example
|
|
1633
1584
|
*```js
|
|
1634
|
-
* //
|
|
1585
|
+
* //Emit when action starts
|
|
1635
1586
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1636
1587
|
* console.log('Save', payload)
|
|
1637
1588
|
* }, {
|
|
1638
1589
|
* start: true
|
|
1639
1590
|
* })
|
|
1640
|
-
* //
|
|
1591
|
+
* //emit when action ends
|
|
1641
1592
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
1642
1593
|
* console.log('Save', payload)
|
|
1643
1594
|
* })
|
|
@@ -1647,15 +1598,14 @@ export enum EmbedEvent {
|
|
|
1647
1598
|
/**
|
|
1648
1599
|
* Emitted when the download action is triggered on an answer
|
|
1649
1600
|
*
|
|
1650
|
-
* **Note**:
|
|
1601
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
1651
1602
|
* To fire an event when a download action is initiated on a chart or table,
|
|
1652
1603
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
1653
1604
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
1654
|
-
*
|
|
1655
1605
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1656
1606
|
* @example
|
|
1657
1607
|
*```js
|
|
1658
|
-
* liveboardEmbed.
|
|
1608
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
1659
1609
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
1660
1610
|
* })
|
|
1661
1611
|
*```
|
|
@@ -1663,14 +1613,13 @@ export enum EmbedEvent {
|
|
|
1663
1613
|
Download = 'download',
|
|
1664
1614
|
/**
|
|
1665
1615
|
* Emitted when the download action is triggered on an answer
|
|
1666
|
-
*
|
|
1667
1616
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
1668
1617
|
* @example
|
|
1669
1618
|
*```js
|
|
1670
|
-
* //
|
|
1619
|
+
* //emit when action starts
|
|
1671
1620
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1672
1621
|
* console.log('download PNG', payload)}, {start: true })
|
|
1673
|
-
* //
|
|
1622
|
+
* //emit when action ends
|
|
1674
1623
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
1675
1624
|
* console.log('download PNG', payload)})
|
|
1676
1625
|
*```
|
|
@@ -1678,14 +1627,13 @@ export enum EmbedEvent {
|
|
|
1678
1627
|
DownloadAsPng = 'downloadAsPng',
|
|
1679
1628
|
/**
|
|
1680
1629
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
1681
|
-
*
|
|
1682
1630
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1683
1631
|
* @example
|
|
1684
1632
|
*```js
|
|
1685
|
-
* //
|
|
1633
|
+
* //emit when action starts
|
|
1686
1634
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1687
1635
|
* console.log('download PDF', payload)}, {start: true })
|
|
1688
|
-
* //
|
|
1636
|
+
* //emit when action ends
|
|
1689
1637
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
1690
1638
|
* console.log('download PDF', payload)})
|
|
1691
1639
|
*```
|
|
@@ -1693,14 +1641,13 @@ export enum EmbedEvent {
|
|
|
1693
1641
|
DownloadAsPdf = 'downloadAsPdf',
|
|
1694
1642
|
/**
|
|
1695
1643
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
1696
|
-
*
|
|
1697
1644
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1698
1645
|
* @example
|
|
1699
1646
|
*```js
|
|
1700
|
-
* //
|
|
1647
|
+
* //emit when action starts
|
|
1701
1648
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1702
1649
|
* console.log('download CSV', payload)}, {start: true })
|
|
1703
|
-
* //
|
|
1650
|
+
* //emit when action ends
|
|
1704
1651
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
1705
1652
|
* console.log('download CSV', payload)})
|
|
1706
1653
|
*```
|
|
@@ -1708,14 +1655,13 @@ export enum EmbedEvent {
|
|
|
1708
1655
|
DownloadAsCsv = 'downloadAsCsv',
|
|
1709
1656
|
/**
|
|
1710
1657
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
1711
|
-
*
|
|
1712
1658
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1713
1659
|
* @example
|
|
1714
1660
|
*```js
|
|
1715
|
-
* //
|
|
1661
|
+
* //emit when action starts
|
|
1716
1662
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1717
1663
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
1718
|
-
* //
|
|
1664
|
+
* //emit when action ends
|
|
1719
1665
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
1720
1666
|
* console.log('download Xlsx', payload)})
|
|
1721
1667
|
*```
|
|
@@ -1723,14 +1669,13 @@ export enum EmbedEvent {
|
|
|
1723
1669
|
DownloadAsXlsx = 'downloadAsXlsx',
|
|
1724
1670
|
/**
|
|
1725
1671
|
* Emitted when an Answer is deleted in the app
|
|
1726
|
-
*
|
|
1727
1672
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1728
1673
|
* @example
|
|
1729
1674
|
*```js
|
|
1730
|
-
* //
|
|
1675
|
+
* //emit when action starts
|
|
1731
1676
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1732
1677
|
* console.log('delete answer', payload)}, {start: true })
|
|
1733
|
-
* //
|
|
1678
|
+
* //emit when action is completed
|
|
1734
1679
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
1735
1680
|
* console.log('delete answer', payload)})
|
|
1736
1681
|
*```
|
|
@@ -1738,17 +1683,16 @@ export enum EmbedEvent {
|
|
|
1738
1683
|
AnswerDelete = 'answerDelete',
|
|
1739
1684
|
/**
|
|
1740
1685
|
* Emitted when an answer is pinned to a Liveboard
|
|
1741
|
-
*
|
|
1742
1686
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1743
1687
|
* @example
|
|
1744
1688
|
*```js
|
|
1745
|
-
* //
|
|
1689
|
+
* //emit when action starts
|
|
1746
1690
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1747
1691
|
* console.log('pin', payload)
|
|
1748
1692
|
* }, {
|
|
1749
1693
|
* start: true
|
|
1750
1694
|
* })
|
|
1751
|
-
* //
|
|
1695
|
+
* //emit when action ends
|
|
1752
1696
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
1753
1697
|
* console.log('pin', payload)
|
|
1754
1698
|
* })
|
|
@@ -1757,17 +1701,16 @@ export enum EmbedEvent {
|
|
|
1757
1701
|
Pin = 'pin',
|
|
1758
1702
|
/**
|
|
1759
1703
|
* Emitted when SpotIQ analysis is triggered
|
|
1760
|
-
*
|
|
1761
1704
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1762
1705
|
* @example
|
|
1763
1706
|
*```js
|
|
1764
|
-
* //
|
|
1707
|
+
* //emit when action starts
|
|
1765
1708
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1766
1709
|
* console.log('SpotIQAnalyze', payload)
|
|
1767
1710
|
* }, {
|
|
1768
1711
|
* start: true
|
|
1769
1712
|
* })
|
|
1770
|
-
* //
|
|
1713
|
+
* //emit when action ends
|
|
1771
1714
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
1772
1715
|
* console.log('SpotIQ analyze', payload)
|
|
1773
1716
|
* })
|
|
@@ -1776,17 +1719,16 @@ export enum EmbedEvent {
|
|
|
1776
1719
|
SpotIQAnalyze = 'spotIQAnalyze',
|
|
1777
1720
|
/**
|
|
1778
1721
|
* Emitted when a user shares an object with another user or group
|
|
1779
|
-
*
|
|
1780
1722
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1781
1723
|
* @example
|
|
1782
1724
|
*```js
|
|
1783
|
-
* //
|
|
1725
|
+
* //emit when action starts
|
|
1784
1726
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1785
1727
|
* console.log('Share', payload)
|
|
1786
1728
|
* }, {
|
|
1787
1729
|
* start: true
|
|
1788
1730
|
* })
|
|
1789
|
-
* //
|
|
1731
|
+
* //emit when action ends
|
|
1790
1732
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
1791
1733
|
* console.log('Share', payload)
|
|
1792
1734
|
* })
|
|
@@ -1796,7 +1738,6 @@ export enum EmbedEvent {
|
|
|
1796
1738
|
/**
|
|
1797
1739
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
1798
1740
|
* data on a chart or table.
|
|
1799
|
-
*
|
|
1800
1741
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1801
1742
|
* @example
|
|
1802
1743
|
*```js
|
|
@@ -1809,7 +1750,6 @@ export enum EmbedEvent {
|
|
|
1809
1750
|
/**
|
|
1810
1751
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
1811
1752
|
* data on a chart or table
|
|
1812
|
-
*
|
|
1813
1753
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1814
1754
|
* @example
|
|
1815
1755
|
*```js
|
|
@@ -1821,7 +1761,6 @@ export enum EmbedEvent {
|
|
|
1821
1761
|
DrillExclude = 'context-menu-item-exclude',
|
|
1822
1762
|
/**
|
|
1823
1763
|
* Emitted when a column value is copied in the embedded app.
|
|
1824
|
-
*
|
|
1825
1764
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1826
1765
|
* @example
|
|
1827
1766
|
*```js
|
|
@@ -1833,7 +1772,6 @@ export enum EmbedEvent {
|
|
|
1833
1772
|
CopyToClipboard = 'context-menu-item-copy-to-clipboard',
|
|
1834
1773
|
/**
|
|
1835
1774
|
* Emitted when a user clicks the **Update TML** action
|
|
1836
|
-
*
|
|
1837
1775
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1838
1776
|
* @example
|
|
1839
1777
|
*```js
|
|
@@ -1844,7 +1782,6 @@ export enum EmbedEvent {
|
|
|
1844
1782
|
UpdateTML = 'updateTSL',
|
|
1845
1783
|
/**
|
|
1846
1784
|
* Emitted when a user clicks the **Edit TML** action
|
|
1847
|
-
*
|
|
1848
1785
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1849
1786
|
* @example
|
|
1850
1787
|
*```js
|
|
@@ -1857,14 +1794,13 @@ export enum EmbedEvent {
|
|
|
1857
1794
|
/**
|
|
1858
1795
|
* Emitted when the **Export TML** action is triggered on an
|
|
1859
1796
|
* an embedded object in the app
|
|
1860
|
-
*
|
|
1861
1797
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1862
1798
|
* @example
|
|
1863
1799
|
*```js
|
|
1864
|
-
* //
|
|
1800
|
+
* //emit when action starts
|
|
1865
1801
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1866
1802
|
* console.log('Export TML', payload)}, { start: true })
|
|
1867
|
-
* //
|
|
1803
|
+
* //emit when action ends
|
|
1868
1804
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
1869
1805
|
* console.log('Export TML', payload)})
|
|
1870
1806
|
*```
|
|
@@ -1872,7 +1808,6 @@ export enum EmbedEvent {
|
|
|
1872
1808
|
ExportTML = 'exportTSL',
|
|
1873
1809
|
/**
|
|
1874
1810
|
* Emitted when an Answer is saved as a View.
|
|
1875
|
-
*
|
|
1876
1811
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1877
1812
|
* @example
|
|
1878
1813
|
*```js
|
|
@@ -1884,14 +1819,13 @@ export enum EmbedEvent {
|
|
|
1884
1819
|
SaveAsView = 'saveAsView',
|
|
1885
1820
|
/**
|
|
1886
1821
|
* Emitted when the user creates a copy of an Answer
|
|
1887
|
-
*
|
|
1888
1822
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1889
1823
|
* @example
|
|
1890
1824
|
*```js
|
|
1891
|
-
* //
|
|
1825
|
+
* //emit when action starts
|
|
1892
1826
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1893
1827
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
1894
|
-
* //
|
|
1828
|
+
* //emit when action ends
|
|
1895
1829
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
1896
1830
|
* console.log('Copy and edit', payload)})
|
|
1897
1831
|
*```
|
|
@@ -1899,7 +1833,6 @@ export enum EmbedEvent {
|
|
|
1899
1833
|
CopyAEdit = 'copyAEdit',
|
|
1900
1834
|
/**
|
|
1901
1835
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
1902
|
-
*
|
|
1903
1836
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1904
1837
|
* @example
|
|
1905
1838
|
*```js
|
|
@@ -1911,7 +1844,6 @@ export enum EmbedEvent {
|
|
|
1911
1844
|
ShowUnderlyingData = 'showUnderlyingData',
|
|
1912
1845
|
/**
|
|
1913
1846
|
* Emitted when an answer is switched to a chart or table view.
|
|
1914
|
-
*
|
|
1915
1847
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
1916
1848
|
* @example
|
|
1917
1849
|
*```js
|
|
@@ -1923,13 +1855,11 @@ export enum EmbedEvent {
|
|
|
1923
1855
|
AnswerChartSwitcher = 'answerChartSwitcher',
|
|
1924
1856
|
/**
|
|
1925
1857
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
1926
|
-
*
|
|
1927
1858
|
* @hidden
|
|
1928
1859
|
*/
|
|
1929
1860
|
APP_INIT = 'appInit',
|
|
1930
1861
|
/**
|
|
1931
1862
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
1932
|
-
*
|
|
1933
1863
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1934
1864
|
* @example
|
|
1935
1865
|
*```js
|
|
@@ -1941,7 +1871,6 @@ export enum EmbedEvent {
|
|
|
1941
1871
|
LiveboardInfo = 'pinboardInfo',
|
|
1942
1872
|
/**
|
|
1943
1873
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
1944
|
-
*
|
|
1945
1874
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1946
1875
|
* @example
|
|
1947
1876
|
*```js
|
|
@@ -1953,7 +1882,6 @@ export enum EmbedEvent {
|
|
|
1953
1882
|
AddToFavorites = 'addToFavorites',
|
|
1954
1883
|
/**
|
|
1955
1884
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
1956
|
-
*
|
|
1957
1885
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1958
1886
|
* @example
|
|
1959
1887
|
*```js
|
|
@@ -1965,7 +1893,6 @@ export enum EmbedEvent {
|
|
|
1965
1893
|
Schedule = 'subscription',
|
|
1966
1894
|
/**
|
|
1967
1895
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
1968
|
-
*
|
|
1969
1896
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1970
1897
|
* @example
|
|
1971
1898
|
*```js
|
|
@@ -1977,7 +1904,6 @@ export enum EmbedEvent {
|
|
|
1977
1904
|
Edit = 'edit',
|
|
1978
1905
|
/**
|
|
1979
1906
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
1980
|
-
*
|
|
1981
1907
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1982
1908
|
* @example
|
|
1983
1909
|
*```js
|
|
@@ -1989,11 +1915,10 @@ export enum EmbedEvent {
|
|
|
1989
1915
|
MakeACopy = 'makeACopy',
|
|
1990
1916
|
/**
|
|
1991
1917
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
1992
|
-
*
|
|
1993
1918
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
1994
1919
|
* @example
|
|
1995
1920
|
*```js
|
|
1996
|
-
* liveboardEmbed.
|
|
1921
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
1997
1922
|
*```
|
|
1998
1923
|
* @example
|
|
1999
1924
|
*```js
|
|
@@ -2005,71 +1930,64 @@ export enum EmbedEvent {
|
|
|
2005
1930
|
Present = 'present',
|
|
2006
1931
|
/**
|
|
2007
1932
|
* Emitted when a user clicks **Delete** on a visualization
|
|
2008
|
-
*
|
|
2009
1933
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2010
1934
|
* @example
|
|
2011
1935
|
*```js
|
|
2012
|
-
* liveboardEmbed.
|
|
1936
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
2013
1937
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2014
1938
|
*```
|
|
2015
1939
|
*/
|
|
2016
1940
|
Delete = 'delete',
|
|
2017
1941
|
/**
|
|
2018
1942
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
2019
|
-
*
|
|
2020
1943
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2021
1944
|
* @example
|
|
2022
1945
|
*```js
|
|
2023
|
-
* liveboardEmbed.
|
|
1946
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
2024
1947
|
*```
|
|
2025
1948
|
*/
|
|
2026
1949
|
SchedulesList = 'schedule-list',
|
|
2027
1950
|
/**
|
|
2028
1951
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
2029
|
-
*
|
|
2030
1952
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2031
1953
|
* @example
|
|
2032
1954
|
*```js
|
|
2033
|
-
* liveboardEmbed.
|
|
1955
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
2034
1956
|
*```
|
|
2035
1957
|
*/
|
|
2036
1958
|
Cancel = 'cancel',
|
|
2037
1959
|
/**
|
|
2038
1960
|
* Emitted when a user clicks **Explore** on a visualization
|
|
2039
|
-
*
|
|
2040
1961
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2041
1962
|
* @example
|
|
2042
1963
|
*```js
|
|
2043
|
-
* liveboardEmbed.
|
|
1964
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
2044
1965
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2045
1966
|
*```
|
|
2046
1967
|
*/
|
|
2047
1968
|
Explore = 'explore',
|
|
2048
1969
|
/**
|
|
2049
1970
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
2050
|
-
*
|
|
2051
1971
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
2052
1972
|
* @example
|
|
2053
1973
|
*```js
|
|
2054
|
-
* liveboardEmbed.
|
|
1974
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
2055
1975
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2056
1976
|
*```
|
|
2057
1977
|
*/
|
|
2058
1978
|
CopyLink = 'embedDocument',
|
|
2059
1979
|
/**
|
|
2060
1980
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
2061
|
-
*
|
|
2062
1981
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2063
1982
|
* @example
|
|
2064
1983
|
*```js
|
|
2065
|
-
* liveboardEmbed.
|
|
1984
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
2066
1985
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
2067
1986
|
*```
|
|
2068
1987
|
*/
|
|
2069
1988
|
CrossFilterChanged = 'cross-filter-changed',
|
|
2070
1989
|
/**
|
|
2071
1990
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
2072
|
-
*
|
|
2073
1991
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2074
1992
|
* @example
|
|
2075
1993
|
*```js
|
|
@@ -2081,44 +1999,53 @@ export enum EmbedEvent {
|
|
|
2081
1999
|
VizPointRightClick = 'vizPointRightClick',
|
|
2082
2000
|
/**
|
|
2083
2001
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
2084
|
-
*
|
|
2085
2002
|
* @hidden
|
|
2086
2003
|
*/
|
|
2087
2004
|
InsertIntoSlide = 'insertInToSlide',
|
|
2088
2005
|
/**
|
|
2089
|
-
* @hidden
|
|
2090
2006
|
* Emitted when a user changes any filter on a Liveboard.
|
|
2007
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
2008
|
+
* filter details.
|
|
2009
|
+
* @example
|
|
2010
|
+
*
|
|
2011
|
+
*```js
|
|
2012
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
2013
|
+
* console.log('payload', payload);
|
|
2014
|
+
* })
|
|
2015
|
+
*
|
|
2091
2016
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
2017
|
+
* @example
|
|
2018
|
+
*
|
|
2019
|
+
*```js
|
|
2020
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
2021
|
+
* console.log('payload', payload);
|
|
2022
|
+
* })
|
|
2023
|
+
*```
|
|
2092
2024
|
*/
|
|
2093
2025
|
FilterChanged = 'filterChanged',
|
|
2094
2026
|
/**
|
|
2095
2027
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
2096
|
-
*
|
|
2097
2028
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2098
2029
|
*/
|
|
2099
2030
|
SageEmbedQuery = 'sageEmbedQuery',
|
|
2100
2031
|
/**
|
|
2101
2032
|
* Emitted when a user selects a data source.
|
|
2102
|
-
*
|
|
2103
2033
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
2104
2034
|
*/
|
|
2105
2035
|
SageWorksheetUpdated = 'sageWorksheetUpdated',
|
|
2106
2036
|
/**
|
|
2107
2037
|
* Emitted when a user updates a connection on the **Data** page
|
|
2108
|
-
*
|
|
2109
2038
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2110
2039
|
*/
|
|
2111
2040
|
UpdateConnection = 'updateConnection',
|
|
2112
2041
|
/**
|
|
2113
2042
|
* Emitted when a user updates a connection on the **Data** page
|
|
2114
|
-
*
|
|
2115
2043
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
2116
2044
|
*/
|
|
2117
2045
|
CreateConnection = 'createConnection',
|
|
2118
2046
|
/**
|
|
2119
2047
|
* Emitted when name, status (private or public) or filter values of a
|
|
2120
2048
|
* Personalised view is updated.
|
|
2121
|
-
*
|
|
2122
2049
|
* @returns viewName: string
|
|
2123
2050
|
* @returns viewId: string
|
|
2124
2051
|
* @returns liveboardId: string
|
|
@@ -2128,7 +2055,6 @@ export enum EmbedEvent {
|
|
|
2128
2055
|
UpdatePersonalisedView = 'updatePersonalisedView',
|
|
2129
2056
|
/**
|
|
2130
2057
|
* Emitted when a Personalised view is saved.
|
|
2131
|
-
*
|
|
2132
2058
|
* @returns viewName: string
|
|
2133
2059
|
* @returns viewId: string
|
|
2134
2060
|
* @returns liveboardId: string
|
|
@@ -2138,7 +2064,6 @@ export enum EmbedEvent {
|
|
|
2138
2064
|
SavePersonalisedView = 'savePersonalisedView',
|
|
2139
2065
|
/**
|
|
2140
2066
|
* Emitted when a Liveboard is reset.
|
|
2141
|
-
*
|
|
2142
2067
|
* @returns viewName: string
|
|
2143
2068
|
* @returns viewId: string
|
|
2144
2069
|
* @returns liveboardId: string
|
|
@@ -2148,7 +2073,6 @@ export enum EmbedEvent {
|
|
|
2148
2073
|
ResetLiveboard = 'resetLiveboard',
|
|
2149
2074
|
/**
|
|
2150
2075
|
* Emitted when a PersonalisedView is deleted.
|
|
2151
|
-
*
|
|
2152
2076
|
* @returns views: string[]
|
|
2153
2077
|
* @returns liveboardId: string
|
|
2154
2078
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -2156,13 +2080,11 @@ export enum EmbedEvent {
|
|
|
2156
2080
|
DeletePersonalisedView = 'deletePersonalisedView',
|
|
2157
2081
|
/**
|
|
2158
2082
|
* Emitted when a user creates a new worksheet
|
|
2159
|
-
*
|
|
2160
2083
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2161
2084
|
*/
|
|
2162
2085
|
CreateWorksheet = 'createWorksheet',
|
|
2163
2086
|
/**
|
|
2164
2087
|
* Emitted when Ask Sage is initialized.
|
|
2165
|
-
*
|
|
2166
2088
|
* @returns viewName: string
|
|
2167
2089
|
* @returns viewId: string
|
|
2168
2090
|
* @returns liveboardId: string
|
|
@@ -2172,10 +2094,32 @@ export enum EmbedEvent {
|
|
|
2172
2094
|
AskSageInit = 'AskSageInit',
|
|
2173
2095
|
/**
|
|
2174
2096
|
* Emitted when a LB/viz is renamed
|
|
2175
|
-
*
|
|
2176
2097
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
2177
2098
|
*/
|
|
2178
2099
|
Rename = 'rename',
|
|
2100
|
+
/**
|
|
2101
|
+
* Emitted when user wants to intercept the search execution
|
|
2102
|
+
*
|
|
2103
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
2104
|
+
* event
|
|
2105
|
+
*
|
|
2106
|
+
*```js
|
|
2107
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
2108
|
+
* responder({
|
|
2109
|
+
* data: {
|
|
2110
|
+
* execute: true,
|
|
2111
|
+
* error: {errorText: "My own customised error"}
|
|
2112
|
+
* }})
|
|
2113
|
+
* })
|
|
2114
|
+
*```
|
|
2115
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
2116
|
+
*/
|
|
2117
|
+
OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
|
|
2118
|
+
/**
|
|
2119
|
+
* Emitted when runtime parameters changes
|
|
2120
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
2121
|
+
*/
|
|
2122
|
+
ParameterChanged = 'ParameterChanged',
|
|
2179
2123
|
}
|
|
2180
2124
|
|
|
2181
2125
|
/**
|
|
@@ -2185,7 +2129,6 @@ export enum EmbedEvent {
|
|
|
2185
2129
|
* To trigger an event use the corresponding
|
|
2186
2130
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
2187
2131
|
* SearchEmbed.trigger} method.
|
|
2188
|
-
*
|
|
2189
2132
|
* @example
|
|
2190
2133
|
* ```js
|
|
2191
2134
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2207,7 +2150,6 @@ export enum HostEvent {
|
|
|
2207
2150
|
* the search query string.
|
|
2208
2151
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
2209
2152
|
* Includes the following properties:
|
|
2210
|
-
*
|
|
2211
2153
|
* @param - `searchQuery` - query string with search tokens
|
|
2212
2154
|
* @param - `dataSources` - Data source GUID to Search on
|
|
2213
2155
|
* - Although an array, only a single source
|
|
@@ -2226,7 +2168,6 @@ export enum HostEvent {
|
|
|
2226
2168
|
/**
|
|
2227
2169
|
* Triggers a drill on certain points of the specified column
|
|
2228
2170
|
* Includes the following properties:
|
|
2229
|
-
*
|
|
2230
2171
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
2231
2172
|
* to drill to. For example, { selectedPoints: []}
|
|
2232
2173
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -2276,19 +2217,16 @@ export enum HostEvent {
|
|
|
2276
2217
|
DrillDown = 'triggerDrillDown',
|
|
2277
2218
|
/**
|
|
2278
2219
|
* Apply filters
|
|
2279
|
-
*
|
|
2280
2220
|
* @hidden
|
|
2281
2221
|
*/
|
|
2282
2222
|
Filter = 'filter',
|
|
2283
2223
|
/**
|
|
2284
2224
|
* Reload the answer or visualization
|
|
2285
|
-
*
|
|
2286
2225
|
* @hidden
|
|
2287
2226
|
*/
|
|
2288
2227
|
Reload = 'reload',
|
|
2289
2228
|
/**
|
|
2290
2229
|
* Display specific visualizations on a Liveboard.
|
|
2291
|
-
*
|
|
2292
2230
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
2293
2231
|
* in this parameter will be hidden.
|
|
2294
2232
|
* @example
|
|
@@ -2302,7 +2240,6 @@ export enum HostEvent {
|
|
|
2302
2240
|
SetVisibleVizs = 'SetPinboardVisibleVizs',
|
|
2303
2241
|
/**
|
|
2304
2242
|
* Set a Liveboard tab as an active tab.
|
|
2305
|
-
*
|
|
2306
2243
|
* @param - tabId - string of id of Tab to show
|
|
2307
2244
|
* @example
|
|
2308
2245
|
* ```js
|
|
@@ -2318,18 +2255,21 @@ export enum HostEvent {
|
|
|
2318
2255
|
* runtime filters passed here are appended to the existing runtime
|
|
2319
2256
|
* filters.
|
|
2320
2257
|
* Pass an array of runtime filters with the following attributes:
|
|
2258
|
+
*
|
|
2321
2259
|
* `columnName`
|
|
2322
2260
|
* _String_. The name of the column to filter on.
|
|
2261
|
+
*
|
|
2323
2262
|
* `operator`
|
|
2324
|
-
*
|
|
2325
|
-
*
|
|
2263
|
+
* Runtime filter operator to apply. For information,
|
|
2264
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
2265
|
+
*
|
|
2326
2266
|
* `values`
|
|
2327
|
-
*
|
|
2328
|
-
*
|
|
2329
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2330
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2331
|
-
* embedding (SageEmbed).
|
|
2267
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
2268
|
+
* operators such as BW and IN accept multiple operands.
|
|
2332
2269
|
*
|
|
2270
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
2271
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
2272
|
+
* embedding (SageEmbed).
|
|
2333
2273
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
2334
2274
|
* @example
|
|
2335
2275
|
* ```js
|
|
@@ -2345,7 +2285,6 @@ export enum HostEvent {
|
|
|
2345
2285
|
/**
|
|
2346
2286
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
2347
2287
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
2348
|
-
*
|
|
2349
2288
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
2350
2289
|
* be a number; for example, `1`, `-1`.
|
|
2351
2290
|
* @example
|
|
@@ -2358,7 +2297,6 @@ export enum HostEvent {
|
|
|
2358
2297
|
/**
|
|
2359
2298
|
* Open the filter panel for a particular column.
|
|
2360
2299
|
* Works with Search and Liveboard embed.
|
|
2361
|
-
*
|
|
2362
2300
|
* @param - { columnId: string,
|
|
2363
2301
|
* name: string,
|
|
2364
2302
|
* type: INT64/CHAR/DATE,
|
|
@@ -2375,7 +2313,6 @@ export enum HostEvent {
|
|
|
2375
2313
|
OpenFilter = 'openFilter',
|
|
2376
2314
|
/**
|
|
2377
2315
|
* Add columns to the current search query.
|
|
2378
|
-
*
|
|
2379
2316
|
* @param - { columnIds: string[] }
|
|
2380
2317
|
* @example
|
|
2381
2318
|
* ```js
|
|
@@ -2386,7 +2323,6 @@ export enum HostEvent {
|
|
|
2386
2323
|
AddColumns = 'addColumns',
|
|
2387
2324
|
/**
|
|
2388
2325
|
* Remove a column from the current search query.
|
|
2389
|
-
*
|
|
2390
2326
|
* @param - { columnId: string }
|
|
2391
2327
|
* @example
|
|
2392
2328
|
* ```js
|
|
@@ -2401,10 +2337,9 @@ export enum HostEvent {
|
|
|
2401
2337
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
2402
2338
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
2403
2339
|
* sorting, toggling of legends, and data drill down.
|
|
2404
|
-
*
|
|
2405
2340
|
* @example
|
|
2406
2341
|
* ```js
|
|
2407
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
2342
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
2408
2343
|
* data=>console.log(data))
|
|
2409
2344
|
* ```
|
|
2410
2345
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -2412,7 +2347,6 @@ export enum HostEvent {
|
|
|
2412
2347
|
getExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
|
|
2413
2348
|
/**
|
|
2414
2349
|
* Trigger the **Pin** action on an embedded object
|
|
2415
|
-
*
|
|
2416
2350
|
* @param - Liveboard embed takes the `vizId` as a
|
|
2417
2351
|
* key. Can be left undefined when embedding Search, full app, or
|
|
2418
2352
|
* a visualization.
|
|
@@ -2429,7 +2363,6 @@ export enum HostEvent {
|
|
|
2429
2363
|
/**
|
|
2430
2364
|
* Trigger the **Show Liveboard details** action
|
|
2431
2365
|
* on an embedded Liveboard.
|
|
2432
|
-
*
|
|
2433
2366
|
* @example
|
|
2434
2367
|
*```js
|
|
2435
2368
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -2439,7 +2372,6 @@ export enum HostEvent {
|
|
|
2439
2372
|
LiveboardInfo = 'pinboardInfo',
|
|
2440
2373
|
/**
|
|
2441
2374
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
2442
|
-
*
|
|
2443
2375
|
* @example
|
|
2444
2376
|
* ```js
|
|
2445
2377
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -2449,7 +2381,6 @@ export enum HostEvent {
|
|
|
2449
2381
|
Schedule = 'subscription',
|
|
2450
2382
|
/**
|
|
2451
2383
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
2452
|
-
*
|
|
2453
2384
|
* @example
|
|
2454
2385
|
* ```js
|
|
2455
2386
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -2459,7 +2390,6 @@ export enum HostEvent {
|
|
|
2459
2390
|
SchedulesList = 'schedule-list',
|
|
2460
2391
|
/**
|
|
2461
2392
|
* Trigger the **Export TML** action on an embedded Liveboard.
|
|
2462
|
-
*
|
|
2463
2393
|
* @example
|
|
2464
2394
|
* ```js
|
|
2465
2395
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
@@ -2469,7 +2399,6 @@ export enum HostEvent {
|
|
|
2469
2399
|
ExportTML = 'exportTSL',
|
|
2470
2400
|
/**
|
|
2471
2401
|
* Trigger the **Edit TML** action on an embedded Liveboard.
|
|
2472
|
-
*
|
|
2473
2402
|
* @example
|
|
2474
2403
|
* ```js
|
|
2475
2404
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -2479,7 +2408,6 @@ export enum HostEvent {
|
|
|
2479
2408
|
EditTML = 'editTSL',
|
|
2480
2409
|
/**
|
|
2481
2410
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
2482
|
-
*
|
|
2483
2411
|
* @example
|
|
2484
2412
|
* ```js
|
|
2485
2413
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -2489,7 +2417,6 @@ export enum HostEvent {
|
|
|
2489
2417
|
UpdateTML = 'updateTSL',
|
|
2490
2418
|
/**
|
|
2491
2419
|
* Trigger the **Download PDF** action on an embedded Liveboard.
|
|
2492
|
-
*
|
|
2493
2420
|
* @example
|
|
2494
2421
|
* ```js
|
|
2495
2422
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -2500,7 +2427,6 @@ export enum HostEvent {
|
|
|
2500
2427
|
/**
|
|
2501
2428
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
2502
2429
|
* visualization page.
|
|
2503
|
-
*
|
|
2504
2430
|
* @example
|
|
2505
2431
|
* ```js
|
|
2506
2432
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -2516,7 +2442,6 @@ export enum HostEvent {
|
|
|
2516
2442
|
MakeACopy = 'makeACopy',
|
|
2517
2443
|
/**
|
|
2518
2444
|
* Trigger the **Delete** action for a Liveboard.
|
|
2519
|
-
*
|
|
2520
2445
|
* @example
|
|
2521
2446
|
* ```js
|
|
2522
2447
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -2526,7 +2451,6 @@ export enum HostEvent {
|
|
|
2526
2451
|
Remove = 'delete',
|
|
2527
2452
|
/**
|
|
2528
2453
|
* Trigger the **Explore** action on a visualization.
|
|
2529
|
-
*
|
|
2530
2454
|
* @param - an object with `vizId` as a key
|
|
2531
2455
|
* @example
|
|
2532
2456
|
* ```js
|
|
@@ -2537,7 +2461,6 @@ export enum HostEvent {
|
|
|
2537
2461
|
Explore = 'explore',
|
|
2538
2462
|
/**
|
|
2539
2463
|
* Trigger the **Create alert** action on a visualization
|
|
2540
|
-
*
|
|
2541
2464
|
* @param - an object with `vizId` as a key
|
|
2542
2465
|
* @example
|
|
2543
2466
|
* ```js
|
|
@@ -2550,7 +2473,6 @@ export enum HostEvent {
|
|
|
2550
2473
|
CreateMonitor = 'createMonitor',
|
|
2551
2474
|
/**
|
|
2552
2475
|
* Trigger the **Manage alerts** action on a visualization
|
|
2553
|
-
*
|
|
2554
2476
|
* @param - an object with `vizId` as a key
|
|
2555
2477
|
* @example
|
|
2556
2478
|
* ```js
|
|
@@ -2563,7 +2485,6 @@ export enum HostEvent {
|
|
|
2563
2485
|
ManageMonitor = 'manageMonitor',
|
|
2564
2486
|
/**
|
|
2565
2487
|
* Trigger the **Edit** action on a Liveboard or visualization
|
|
2566
|
-
*
|
|
2567
2488
|
* @param - object - To trigger the action for a specific visualization
|
|
2568
2489
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
2569
2490
|
* Can be left undefined when embedding Search, full app, or
|
|
@@ -2584,7 +2505,6 @@ export enum HostEvent {
|
|
|
2584
2505
|
Edit = 'edit',
|
|
2585
2506
|
/**
|
|
2586
2507
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
2587
|
-
*
|
|
2588
2508
|
* @param - object - to trigger the action for a
|
|
2589
2509
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
2590
2510
|
* @example
|
|
@@ -2602,7 +2522,6 @@ export enum HostEvent {
|
|
|
2602
2522
|
CopyLink = 'embedDocument',
|
|
2603
2523
|
/**
|
|
2604
2524
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
2605
|
-
*
|
|
2606
2525
|
* @param - object - to trigger the action for a specific visualization
|
|
2607
2526
|
* in Liveboard embed, pass in `vizId` as a key
|
|
2608
2527
|
* @example
|
|
@@ -2620,12 +2539,11 @@ export enum HostEvent {
|
|
|
2620
2539
|
Present = 'present',
|
|
2621
2540
|
/**
|
|
2622
2541
|
* Get TML for the current search.
|
|
2623
|
-
*
|
|
2624
2542
|
* @example
|
|
2625
2543
|
* ```js
|
|
2626
2544
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
2627
2545
|
* console.log(
|
|
2628
|
-
* tml.search_query // TML representation of the search query
|
|
2546
|
+
* tml.answer.search_query // TML representation of the search query
|
|
2629
2547
|
* );
|
|
2630
2548
|
* })
|
|
2631
2549
|
* ```
|
|
@@ -2635,7 +2553,6 @@ export enum HostEvent {
|
|
|
2635
2553
|
GetTML = 'getTML',
|
|
2636
2554
|
/**
|
|
2637
2555
|
* Trigger the **Show underlying data** action on visualization or search
|
|
2638
|
-
*
|
|
2639
2556
|
* @param - an object with vizId as a key
|
|
2640
2557
|
* @example
|
|
2641
2558
|
* ```js
|
|
@@ -2655,7 +2572,6 @@ export enum HostEvent {
|
|
|
2655
2572
|
* Trigger the **Delete** action for a visualization
|
|
2656
2573
|
* in an embedded Liveboard, or a chart or table
|
|
2657
2574
|
* generated from Search.
|
|
2658
|
-
*
|
|
2659
2575
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
2660
2576
|
* Can be left empty if embedding Search or visualization.
|
|
2661
2577
|
* @example
|
|
@@ -2672,7 +2588,6 @@ export enum HostEvent {
|
|
|
2672
2588
|
/**
|
|
2673
2589
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
2674
2590
|
* or search.
|
|
2675
|
-
*
|
|
2676
2591
|
* @param - Liveboard embed takes `vizId` as a
|
|
2677
2592
|
* key. Can be left undefined when embedding Search or
|
|
2678
2593
|
* visualization.
|
|
@@ -2693,7 +2608,6 @@ export enum HostEvent {
|
|
|
2693
2608
|
/**
|
|
2694
2609
|
* Trigger the **Download** action on charts in
|
|
2695
2610
|
* the embedded view.
|
|
2696
|
-
*
|
|
2697
2611
|
* @example
|
|
2698
2612
|
* ```js
|
|
2699
2613
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -2710,7 +2624,6 @@ export enum HostEvent {
|
|
|
2710
2624
|
/**
|
|
2711
2625
|
* Trigger the **Download** > **PNG** action on
|
|
2712
2626
|
* charts in the embedded view.
|
|
2713
|
-
*
|
|
2714
2627
|
* @example
|
|
2715
2628
|
* ```js
|
|
2716
2629
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -2726,7 +2639,6 @@ export enum HostEvent {
|
|
|
2726
2639
|
/**
|
|
2727
2640
|
* Trigger the **Download** > **CSV** action on tables in
|
|
2728
2641
|
* the embedded view.
|
|
2729
|
-
*
|
|
2730
2642
|
* @example
|
|
2731
2643
|
* ```js
|
|
2732
2644
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -2744,7 +2656,6 @@ export enum HostEvent {
|
|
|
2744
2656
|
/**
|
|
2745
2657
|
* Trigger the **Download** > **XLSX** action on tables
|
|
2746
2658
|
* in the embedded view.
|
|
2747
|
-
*
|
|
2748
2659
|
* @example
|
|
2749
2660
|
* ```js
|
|
2750
2661
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -2762,7 +2673,6 @@ export enum HostEvent {
|
|
|
2762
2673
|
/**
|
|
2763
2674
|
* Trigger the **Share** action on an embedded
|
|
2764
2675
|
* Liveboard or Answer.
|
|
2765
|
-
*
|
|
2766
2676
|
* @example
|
|
2767
2677
|
* ```js
|
|
2768
2678
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -2776,7 +2686,6 @@ export enum HostEvent {
|
|
|
2776
2686
|
/**
|
|
2777
2687
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
2778
2688
|
* Saves the changes.
|
|
2779
|
-
*
|
|
2780
2689
|
* @example
|
|
2781
2690
|
* ```js
|
|
2782
2691
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -2790,7 +2699,6 @@ export enum HostEvent {
|
|
|
2790
2699
|
/**
|
|
2791
2700
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
2792
2701
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
2793
|
-
*
|
|
2794
2702
|
* @param - an object with `vizId` as a key
|
|
2795
2703
|
* @example
|
|
2796
2704
|
* ```js
|
|
@@ -2807,7 +2715,6 @@ export enum HostEvent {
|
|
|
2807
2715
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
2808
2716
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
2809
2717
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
2810
|
-
*
|
|
2811
2718
|
* @param - an object with vizId as a key
|
|
2812
2719
|
* @example
|
|
2813
2720
|
* ```js
|
|
@@ -2824,7 +2731,6 @@ export enum HostEvent {
|
|
|
2824
2731
|
* Trigger the **Manage pipelines** action on an embedded
|
|
2825
2732
|
* visualization or Answer.
|
|
2826
2733
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
2827
|
-
*
|
|
2828
2734
|
* @param - an object with `vizId` as a key
|
|
2829
2735
|
* @example
|
|
2830
2736
|
* ```js
|
|
@@ -2839,7 +2745,6 @@ export enum HostEvent {
|
|
|
2839
2745
|
ManagePipelines = 'manage-pipeline',
|
|
2840
2746
|
/**
|
|
2841
2747
|
* Reset search operation on the Search or Answer page.
|
|
2842
|
-
*
|
|
2843
2748
|
* @example
|
|
2844
2749
|
* ```js
|
|
2845
2750
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -2851,32 +2756,70 @@ export enum HostEvent {
|
|
|
2851
2756
|
*/
|
|
2852
2757
|
ResetSearch = 'resetSearch',
|
|
2853
2758
|
/**
|
|
2854
|
-
*
|
|
2855
|
-
* Get the currents visible and runtime filters applied on a Liveboard
|
|
2856
|
-
*
|
|
2759
|
+
* Get details of the visible and runtime filters applied on Liveboard.
|
|
2857
2760
|
* @example
|
|
2858
|
-
*
|
|
2761
|
+
* ```js
|
|
2762
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
2763
|
+
* console.log('data', data);
|
|
2764
|
+
* ```
|
|
2859
2765
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2860
2766
|
*/
|
|
2861
2767
|
GetFilters = 'getFilters',
|
|
2862
2768
|
/**
|
|
2769
|
+
* Update one or several filters applied on a Liveboard.
|
|
2770
|
+
* @param - `filter`: a single filter object containing column name,
|
|
2771
|
+
* filter operator, and values.
|
|
2772
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
2773
|
+
* and values for each.
|
|
2863
2774
|
*
|
|
2864
|
-
*
|
|
2775
|
+
* Each filter object must include the following attributes:
|
|
2865
2776
|
*
|
|
2866
|
-
*
|
|
2777
|
+
* `column` - Name of the column to filter on.
|
|
2778
|
+
*
|
|
2779
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
2780
|
+
* For information about the supported filter operators,
|
|
2781
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
|
|
2782
|
+
*
|
|
2783
|
+
* `values` - An array of one or several values. The value definition on the
|
|
2784
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
2785
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
|
|
2786
|
+
* @example
|
|
2787
|
+
* ```js
|
|
2788
|
+
*
|
|
2789
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2790
|
+
* filter: {
|
|
2791
|
+
* column: "item type",
|
|
2792
|
+
* oper: "IN",
|
|
2793
|
+
* values: ["bags","shirts"],
|
|
2794
|
+
* }
|
|
2795
|
+
* });
|
|
2796
|
+
* ```
|
|
2867
2797
|
* @example
|
|
2868
2798
|
*
|
|
2869
2799
|
* ```js
|
|
2870
2800
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
2871
|
-
*
|
|
2872
|
-
*
|
|
2801
|
+
* filters: [{
|
|
2802
|
+
* column: "Item Type",
|
|
2803
|
+
* oper: 'IN',
|
|
2804
|
+
* values: ["bags","shirts"]
|
|
2805
|
+
* },
|
|
2806
|
+
* {
|
|
2807
|
+
* column: "Region",
|
|
2808
|
+
* oper: 'IN',
|
|
2809
|
+
* values: ["West","Midwest"]
|
|
2810
|
+
* },
|
|
2811
|
+
* {
|
|
2812
|
+
* column: "Date",
|
|
2813
|
+
* oper: 'EQ',
|
|
2814
|
+
* values: ["1656680400"]
|
|
2815
|
+
* }]
|
|
2816
|
+
* });
|
|
2873
2817
|
* ```
|
|
2874
2818
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2875
2819
|
*/
|
|
2876
2820
|
UpdateFilters = 'updateFilters',
|
|
2877
2821
|
/**
|
|
2878
2822
|
* Get tab details for the current Liveboard.
|
|
2879
|
-
*
|
|
2880
2823
|
* @example
|
|
2881
2824
|
* ```js
|
|
2882
2825
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -2890,7 +2833,6 @@ export enum HostEvent {
|
|
|
2890
2833
|
GetTabs = 'getTabs',
|
|
2891
2834
|
/**
|
|
2892
2835
|
* Set the visible tabs on a Liveboard.
|
|
2893
|
-
*
|
|
2894
2836
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
2895
2837
|
* will be hidden.
|
|
2896
2838
|
* @example
|
|
@@ -2904,7 +2846,6 @@ export enum HostEvent {
|
|
|
2904
2846
|
SetVisibleTabs = 'SetPinboardVisibleTabs',
|
|
2905
2847
|
/**
|
|
2906
2848
|
* Set the hidden tabs on a Liveboard.
|
|
2907
|
-
*
|
|
2908
2849
|
* @param - an array of the IDs of the tabs to hide.
|
|
2909
2850
|
* The IDs not passed will be shown.
|
|
2910
2851
|
* @example
|
|
@@ -2918,7 +2859,6 @@ export enum HostEvent {
|
|
|
2918
2859
|
SetHiddenTabs = 'SetPinboardHiddenTabs',
|
|
2919
2860
|
/**
|
|
2920
2861
|
* Updates the search query string for Natural Language Search operations.
|
|
2921
|
-
*
|
|
2922
2862
|
* @param - `queryString`: Text string in Natural Language format
|
|
2923
2863
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
2924
2864
|
* @example
|
|
@@ -2933,7 +2873,6 @@ export enum HostEvent {
|
|
|
2933
2873
|
UpdateSageQuery = 'updateSageQuery',
|
|
2934
2874
|
/**
|
|
2935
2875
|
* Get the answer session for a Search / Visualization.
|
|
2936
|
-
*
|
|
2937
2876
|
* @example
|
|
2938
2877
|
* ```js
|
|
2939
2878
|
* const {session} = await embed.trigger(
|
|
@@ -2946,7 +2885,6 @@ export enum HostEvent {
|
|
|
2946
2885
|
GetAnswerSession = 'getAnswerSession',
|
|
2947
2886
|
/**
|
|
2948
2887
|
* Trigger Ask Sage for viz
|
|
2949
|
-
*
|
|
2950
2888
|
* @example
|
|
2951
2889
|
* ```js
|
|
2952
2890
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -2957,7 +2895,6 @@ export enum HostEvent {
|
|
|
2957
2895
|
AskSage = 'AskSage',
|
|
2958
2896
|
/**
|
|
2959
2897
|
* Trigger UpdateCrossFilter for Liveboard
|
|
2960
|
-
*
|
|
2961
2898
|
* @example
|
|
2962
2899
|
* ```js
|
|
2963
2900
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -2973,7 +2910,6 @@ export enum HostEvent {
|
|
|
2973
2910
|
UpdateCrossFilter = 'UpdateCrossFilter',
|
|
2974
2911
|
/**
|
|
2975
2912
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
2976
|
-
*
|
|
2977
2913
|
* @example
|
|
2978
2914
|
* ```js
|
|
2979
2915
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
@@ -2981,6 +2917,35 @@ export enum HostEvent {
|
|
|
2981
2917
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2982
2918
|
*/
|
|
2983
2919
|
ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
|
|
2920
|
+
/**
|
|
2921
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
2922
|
+
* @example
|
|
2923
|
+
* ```js
|
|
2924
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
2925
|
+
*
|
|
2926
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2927
|
+
*/
|
|
2928
|
+
CreateLiveboard = 'CreateLiveboard',
|
|
2929
|
+
/**
|
|
2930
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
2931
|
+
* @example
|
|
2932
|
+
* ```js
|
|
2933
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
2934
|
+
* name: "Color",
|
|
2935
|
+
* value: "almond"
|
|
2936
|
+
* }])
|
|
2937
|
+
*
|
|
2938
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2939
|
+
*/
|
|
2940
|
+
UpdateParameters = 'UpdateParameters',
|
|
2941
|
+
/**
|
|
2942
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
2943
|
+
* ```js
|
|
2944
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters);
|
|
2945
|
+
*
|
|
2946
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
2947
|
+
*/
|
|
2948
|
+
GetParameters = 'GetParameters',
|
|
2984
2949
|
}
|
|
2985
2950
|
|
|
2986
2951
|
/**
|
|
@@ -3082,7 +3047,15 @@ export enum Param {
|
|
|
3082
3047
|
ClientLogLevel = 'clientLogLevel',
|
|
3083
3048
|
OverrideNativeConsole = 'overrideConsoleLogs',
|
|
3084
3049
|
enableAskSage = 'enableAskSage',
|
|
3085
|
-
CollapseSearchBarInitially= 'collapseSearchBarInitially',
|
|
3050
|
+
CollapseSearchBarInitially = 'collapseSearchBarInitially',
|
|
3051
|
+
DataPanelCustomGroupsAccordionInitialState = 'dataPanelCustomGroupsAccordionInitialState',
|
|
3052
|
+
EnableCustomColumnGroups = 'enableCustomColumnGroups',
|
|
3053
|
+
DateFormatLocale = 'dateFormatLocale',
|
|
3054
|
+
NumberFormatLocale = 'numberFormatLocale',
|
|
3055
|
+
CurrencyFormat = 'currencyFormat',
|
|
3056
|
+
Enable2ColumnLayout = 'enable2ColumnLayout',
|
|
3057
|
+
IsFullAppEmbed = 'isFullAppEmbed',
|
|
3058
|
+
IsOnBeforeGetVizDataInterceptEnabled = 'isOnBeforeGetVizDataInterceptEnabled',
|
|
3086
3059
|
}
|
|
3087
3060
|
|
|
3088
3061
|
/**
|
|
@@ -3092,7 +3065,6 @@ export enum Param {
|
|
|
3092
3065
|
* specific actions in the embedded view, define the Action
|
|
3093
3066
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
3094
3067
|
* or `hiddenActions` array.
|
|
3095
|
-
*
|
|
3096
3068
|
* @example
|
|
3097
3069
|
* ```js
|
|
3098
3070
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -3117,10 +3089,9 @@ export enum Action {
|
|
|
3117
3089
|
/**
|
|
3118
3090
|
* The **Save** action on an Answer or Liveboard.
|
|
3119
3091
|
* Allows users to save the changes.
|
|
3120
|
-
*
|
|
3121
3092
|
* @example
|
|
3122
3093
|
* ```js
|
|
3123
|
-
* disabledActions: [Action.
|
|
3094
|
+
* disabledActions: [Action.Save]
|
|
3124
3095
|
* ```
|
|
3125
3096
|
*/
|
|
3126
3097
|
Save = 'save',
|
|
@@ -3135,7 +3106,6 @@ export enum Action {
|
|
|
3135
3106
|
/**
|
|
3136
3107
|
* The **Save as View** action on the Answer
|
|
3137
3108
|
* page. Saves an Answer as a View object.
|
|
3138
|
-
*
|
|
3139
3109
|
* @example
|
|
3140
3110
|
* ```js
|
|
3141
3111
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -3149,7 +3119,6 @@ export enum Action {
|
|
|
3149
3119
|
* visualizations in the embedded Liveboard view.
|
|
3150
3120
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
3151
3121
|
* Liveboards and visualizations.
|
|
3152
|
-
*
|
|
3153
3122
|
* @example
|
|
3154
3123
|
* ```js
|
|
3155
3124
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -3159,7 +3128,6 @@ export enum Action {
|
|
|
3159
3128
|
/**
|
|
3160
3129
|
* The **Copy and Edit** action on a Liveboard.
|
|
3161
3130
|
* This action is now replaced with `Action.MakeACopy`.
|
|
3162
|
-
*
|
|
3163
3131
|
* @example
|
|
3164
3132
|
* ```js
|
|
3165
3133
|
* disabledActions: [Action.EditACopy]
|
|
@@ -3169,7 +3137,6 @@ export enum Action {
|
|
|
3169
3137
|
/**
|
|
3170
3138
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
3171
3139
|
* Copies the visualization URL
|
|
3172
|
-
*
|
|
3173
3140
|
* @example
|
|
3174
3141
|
* ```js
|
|
3175
3142
|
* disabledActions: [Action.CopyLink]
|
|
@@ -3183,7 +3150,6 @@ export enum Action {
|
|
|
3183
3150
|
/**
|
|
3184
3151
|
* The **Schedule** menu action on a Liveboard.
|
|
3185
3152
|
* Allows scheduling a Liveboard notification.
|
|
3186
|
-
*
|
|
3187
3153
|
* @example
|
|
3188
3154
|
* ```js
|
|
3189
3155
|
* disabledActions: [Action.Schedule]
|
|
@@ -3193,7 +3159,6 @@ export enum Action {
|
|
|
3193
3159
|
/**
|
|
3194
3160
|
* The **Manage schedules** menu action on a Liveboard.
|
|
3195
3161
|
* Allows users to manage scheduled Liveboard jobs.
|
|
3196
|
-
*
|
|
3197
3162
|
* @example
|
|
3198
3163
|
* ```js
|
|
3199
3164
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -3203,7 +3168,6 @@ export enum Action {
|
|
|
3203
3168
|
/**
|
|
3204
3169
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
3205
3170
|
* Allows users to share an object with other users and groups.
|
|
3206
|
-
*
|
|
3207
3171
|
* @example
|
|
3208
3172
|
* ```js
|
|
3209
3173
|
* disabledActions: [Action.Share]
|
|
@@ -3213,7 +3177,6 @@ export enum Action {
|
|
|
3213
3177
|
/**
|
|
3214
3178
|
* The **Add filter** action on a Liveboard and Search page.
|
|
3215
3179
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
3216
|
-
*
|
|
3217
3180
|
* @example
|
|
3218
3181
|
* ```js
|
|
3219
3182
|
* disabledActions: [Action.AddFilter]
|
|
@@ -3224,7 +3187,6 @@ export enum Action {
|
|
|
3224
3187
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
3225
3188
|
* Allows to show action menu to add different objects (like
|
|
3226
3189
|
* formulas, parameters) in data panel v2.
|
|
3227
|
-
*
|
|
3228
3190
|
* @example
|
|
3229
3191
|
* ```js
|
|
3230
3192
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -3236,7 +3198,6 @@ export enum Action {
|
|
|
3236
3198
|
* Filter configuration options on a Liveboard and Search page.
|
|
3237
3199
|
* Allows configuring filter options when adding filters to a
|
|
3238
3200
|
* Liveboard or Answer.
|
|
3239
|
-
*
|
|
3240
3201
|
* @example
|
|
3241
3202
|
* ```js
|
|
3242
3203
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -3247,7 +3208,6 @@ export enum Action {
|
|
|
3247
3208
|
/**
|
|
3248
3209
|
* The **Choose sources** button on Search page.
|
|
3249
3210
|
* Allows selecting data sources for search queries.
|
|
3250
|
-
*
|
|
3251
3211
|
* @example
|
|
3252
3212
|
* ```js
|
|
3253
3213
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -3257,7 +3217,6 @@ export enum Action {
|
|
|
3257
3217
|
/**
|
|
3258
3218
|
* The **Create formula** action on a Search or Answer page.
|
|
3259
3219
|
* Allows adding formulas to an Answer.
|
|
3260
|
-
*
|
|
3261
3220
|
* @example
|
|
3262
3221
|
* ```js
|
|
3263
3222
|
* disabledActions: [Action.AddFormula]
|
|
@@ -3267,7 +3226,6 @@ export enum Action {
|
|
|
3267
3226
|
/**
|
|
3268
3227
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
3269
3228
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
3270
|
-
*
|
|
3271
3229
|
* @example
|
|
3272
3230
|
* ```js
|
|
3273
3231
|
* disabledActions: [Action.AddParameter]
|
|
@@ -3277,7 +3235,6 @@ export enum Action {
|
|
|
3277
3235
|
/**
|
|
3278
3236
|
* The **Add Column Set** action on a Answer.
|
|
3279
3237
|
* Allows adding column sets to a Answer.
|
|
3280
|
-
*
|
|
3281
3238
|
* @example
|
|
3282
3239
|
* ```js
|
|
3283
3240
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -3288,7 +3245,6 @@ export enum Action {
|
|
|
3288
3245
|
/**
|
|
3289
3246
|
* The **Add Query Set** action on a Answer.
|
|
3290
3247
|
* Allows adding query sets to a Answer.
|
|
3291
|
-
*
|
|
3292
3248
|
* @example
|
|
3293
3249
|
* ```js
|
|
3294
3250
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -3303,7 +3259,6 @@ export enum Action {
|
|
|
3303
3259
|
/**
|
|
3304
3260
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
3305
3261
|
* Answer page.
|
|
3306
|
-
*
|
|
3307
3262
|
* @example
|
|
3308
3263
|
* ```js
|
|
3309
3264
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -3326,7 +3281,6 @@ export enum Action {
|
|
|
3326
3281
|
/**
|
|
3327
3282
|
* The **Show underlying data** menu action on a visualization or
|
|
3328
3283
|
* Answer page.
|
|
3329
|
-
*
|
|
3330
3284
|
* @example
|
|
3331
3285
|
* ```js
|
|
3332
3286
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -3337,7 +3291,6 @@ export enum Action {
|
|
|
3337
3291
|
* The **Download** menu action on Liveboard visualizations
|
|
3338
3292
|
* and Answers.
|
|
3339
3293
|
* Allows downloading a visualization or Answer.
|
|
3340
|
-
*
|
|
3341
3294
|
* @example
|
|
3342
3295
|
* ```js
|
|
3343
3296
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -3348,7 +3301,6 @@ export enum Action {
|
|
|
3348
3301
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
3349
3302
|
* or Answer page.
|
|
3350
3303
|
* Downloads a visualization or Answer as a PNG file.
|
|
3351
|
-
*
|
|
3352
3304
|
* @example
|
|
3353
3305
|
* ```js
|
|
3354
3306
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -3356,9 +3308,12 @@ export enum Action {
|
|
|
3356
3308
|
*/
|
|
3357
3309
|
DownloadAsPng = 'downloadAsPng',
|
|
3358
3310
|
/**
|
|
3359
|
-
* The **Download** > **PDF** menu action on a Liveboard.
|
|
3360
|
-
* Downloads a visualization or Answer as a PDF file.
|
|
3361
3311
|
*
|
|
3312
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
3313
|
+
*visualization, or Answer as a PDF file.
|
|
3314
|
+
*
|
|
3315
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
3316
|
+
*visualizations and Answers if the data is in tabular format.
|
|
3362
3317
|
* @example
|
|
3363
3318
|
* ```js
|
|
3364
3319
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -3369,7 +3324,6 @@ export enum Action {
|
|
|
3369
3324
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
3370
3325
|
* or Answer page.
|
|
3371
3326
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3372
|
-
*
|
|
3373
3327
|
* @example
|
|
3374
3328
|
* ```js
|
|
3375
3329
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -3380,7 +3334,6 @@ export enum Action {
|
|
|
3380
3334
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
3381
3335
|
* or Answer page.
|
|
3382
3336
|
* Downloads a visualization or Answer in the XLSX format.
|
|
3383
|
-
*
|
|
3384
3337
|
* @example
|
|
3385
3338
|
* ```js
|
|
3386
3339
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -3395,7 +3348,6 @@ export enum Action {
|
|
|
3395
3348
|
* The **Export TML** menu action on Liveboard, Answers
|
|
3396
3349
|
* Worksheets and Data Connections page.
|
|
3397
3350
|
* Exports an object as a TML file.
|
|
3398
|
-
*
|
|
3399
3351
|
* @example
|
|
3400
3352
|
* ```js
|
|
3401
3353
|
* disabledActions: [Action.ExportTML]
|
|
@@ -3405,7 +3357,6 @@ export enum Action {
|
|
|
3405
3357
|
/**
|
|
3406
3358
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
3407
3359
|
* Imports TML representation of ThoughtSpot objects.
|
|
3408
|
-
*
|
|
3409
3360
|
* @example
|
|
3410
3361
|
* ```js
|
|
3411
3362
|
* disabledActions: [Action.ImportTML]
|
|
@@ -3415,7 +3366,6 @@ export enum Action {
|
|
|
3415
3366
|
/**
|
|
3416
3367
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
3417
3368
|
* Update TML representation of ThoughtSpot objects.
|
|
3418
|
-
*
|
|
3419
3369
|
* @example
|
|
3420
3370
|
* ```js
|
|
3421
3371
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -3425,7 +3375,6 @@ export enum Action {
|
|
|
3425
3375
|
/**
|
|
3426
3376
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
3427
3377
|
* Opens the TML editor.
|
|
3428
|
-
*
|
|
3429
3378
|
* @example
|
|
3430
3379
|
* ```js
|
|
3431
3380
|
* disabledActions: [Action.EditTML]
|
|
@@ -3436,7 +3385,6 @@ export enum Action {
|
|
|
3436
3385
|
* The **Present** menu action for Liveboards and Answers.
|
|
3437
3386
|
* Allows presenting a Liveboard or visualization in
|
|
3438
3387
|
* slideshow mode.
|
|
3439
|
-
*
|
|
3440
3388
|
* @example
|
|
3441
3389
|
* ```js
|
|
3442
3390
|
* disabledActions: [Action.Present]
|
|
@@ -3446,7 +3394,6 @@ export enum Action {
|
|
|
3446
3394
|
/**
|
|
3447
3395
|
* The tile resize options in the visualization menu.
|
|
3448
3396
|
* Allows switching between different preset layouts.
|
|
3449
|
-
*
|
|
3450
3397
|
* @example
|
|
3451
3398
|
* ```js
|
|
3452
3399
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -3457,7 +3404,6 @@ export enum Action {
|
|
|
3457
3404
|
* The *Edit* action on the Liveboard page and in the
|
|
3458
3405
|
* visualization menu.
|
|
3459
3406
|
* Opens a Liveboard or visualization in edit mode.
|
|
3460
|
-
*
|
|
3461
3407
|
* @example
|
|
3462
3408
|
* ```js
|
|
3463
3409
|
* disabledActions: [Action.Edit]
|
|
@@ -3466,7 +3412,6 @@ export enum Action {
|
|
|
3466
3412
|
Edit = 'edit',
|
|
3467
3413
|
/**
|
|
3468
3414
|
* The text edit option for Liveboard and visualization titles.
|
|
3469
|
-
*
|
|
3470
3415
|
* @example
|
|
3471
3416
|
* ```js
|
|
3472
3417
|
* disabledActions: [Action.EditTitle]
|
|
@@ -3476,7 +3421,6 @@ export enum Action {
|
|
|
3476
3421
|
/**
|
|
3477
3422
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
3478
3423
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
3479
|
-
*
|
|
3480
3424
|
* @example
|
|
3481
3425
|
* ```js
|
|
3482
3426
|
* disabledActions: [Action.Remove]
|
|
@@ -3508,7 +3452,6 @@ export enum Action {
|
|
|
3508
3452
|
* Displays details such as the name, description, and
|
|
3509
3453
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
3510
3454
|
* and update.
|
|
3511
|
-
*
|
|
3512
3455
|
* @example
|
|
3513
3456
|
* ```js
|
|
3514
3457
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -3526,7 +3469,6 @@ export enum Action {
|
|
|
3526
3469
|
/**
|
|
3527
3470
|
* The **Pin** menu action on an Answer or
|
|
3528
3471
|
* Search results page.
|
|
3529
|
-
*
|
|
3530
3472
|
* @example
|
|
3531
3473
|
* ```js
|
|
3532
3474
|
* disabledActions: [Action.Pin]
|
|
@@ -3539,7 +3481,6 @@ export enum Action {
|
|
|
3539
3481
|
AnalysisInfo = 'analysisInfo',
|
|
3540
3482
|
/**
|
|
3541
3483
|
* The **Schedule** menu action on a Liveboard.
|
|
3542
|
-
*
|
|
3543
3484
|
* @example
|
|
3544
3485
|
* ```js
|
|
3545
3486
|
* disabledActions: [Action.Subscription]
|
|
@@ -3548,7 +3489,6 @@ export enum Action {
|
|
|
3548
3489
|
Subscription = 'subscription',
|
|
3549
3490
|
/**
|
|
3550
3491
|
* The **Explore** action on Liveboard visualizations
|
|
3551
|
-
*
|
|
3552
3492
|
* @example
|
|
3553
3493
|
* ```js
|
|
3554
3494
|
* disabledActions: [Action.Explore]
|
|
@@ -3558,7 +3498,6 @@ export enum Action {
|
|
|
3558
3498
|
/**
|
|
3559
3499
|
* The action to include data points on a drilled-down Answer
|
|
3560
3500
|
* or visualization
|
|
3561
|
-
*
|
|
3562
3501
|
* @example
|
|
3563
3502
|
* ```js
|
|
3564
3503
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3569,7 +3508,6 @@ export enum Action {
|
|
|
3569
3508
|
/**
|
|
3570
3509
|
* The action to exclude data points on a drilled-down Answer
|
|
3571
3510
|
* or visualization
|
|
3572
|
-
*
|
|
3573
3511
|
* @example
|
|
3574
3512
|
* ```js
|
|
3575
3513
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -3580,7 +3518,6 @@ export enum Action {
|
|
|
3580
3518
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
3581
3519
|
* or Liveboard.
|
|
3582
3520
|
* Copies the selected data point.
|
|
3583
|
-
*
|
|
3584
3521
|
* @example
|
|
3585
3522
|
* ```js
|
|
3586
3523
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -3598,7 +3535,6 @@ export enum Action {
|
|
|
3598
3535
|
* The **Drill down** menu action on Answers and Liveboard
|
|
3599
3536
|
* visualizations.
|
|
3600
3537
|
* Allows drilling down to a specific data point on a chart or table.
|
|
3601
|
-
*
|
|
3602
3538
|
* @example
|
|
3603
3539
|
* ```js
|
|
3604
3540
|
* disabledActions: [Action.DrillDown]
|
|
@@ -3608,7 +3544,6 @@ export enum Action {
|
|
|
3608
3544
|
/**
|
|
3609
3545
|
* The request access action on Liveboards.
|
|
3610
3546
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
3611
|
-
*
|
|
3612
3547
|
* @example
|
|
3613
3548
|
* ```js
|
|
3614
3549
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -3618,7 +3553,6 @@ export enum Action {
|
|
|
3618
3553
|
/**
|
|
3619
3554
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
3620
3555
|
* of the Answer page
|
|
3621
|
-
*
|
|
3622
3556
|
* @example
|
|
3623
3557
|
* ```js
|
|
3624
3558
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -3627,7 +3561,6 @@ export enum Action {
|
|
|
3627
3561
|
QueryDetailsButtons = 'queryDetailsButtons',
|
|
3628
3562
|
/**
|
|
3629
3563
|
* The **Delete** action for Answers.
|
|
3630
|
-
*
|
|
3631
3564
|
* @example
|
|
3632
3565
|
* ```js
|
|
3633
3566
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -3637,7 +3570,6 @@ export enum Action {
|
|
|
3637
3570
|
AnswerDelete = 'onDeleteAnswer',
|
|
3638
3571
|
/**
|
|
3639
3572
|
* The Chart switcher icon on Answer and visualization pages.
|
|
3640
|
-
*
|
|
3641
3573
|
* @example
|
|
3642
3574
|
* ```js
|
|
3643
3575
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -3647,7 +3579,6 @@ export enum Action {
|
|
|
3647
3579
|
AnswerChartSwitcher = 'answerChartSwitcher',
|
|
3648
3580
|
/**
|
|
3649
3581
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
3650
|
-
*
|
|
3651
3582
|
* @example
|
|
3652
3583
|
* ```js
|
|
3653
3584
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -3657,7 +3588,6 @@ export enum Action {
|
|
|
3657
3588
|
AddToFavorites = 'addToFavorites',
|
|
3658
3589
|
/**
|
|
3659
3590
|
* The edit icon on Liveboards (Classic experience).
|
|
3660
|
-
*
|
|
3661
3591
|
* @example
|
|
3662
3592
|
* ```js
|
|
3663
3593
|
* disabledActions: [Action.EditDetails]
|
|
@@ -3667,7 +3597,6 @@ export enum Action {
|
|
|
3667
3597
|
EditDetails = 'editDetails',
|
|
3668
3598
|
/**
|
|
3669
3599
|
* The Create alert action on KPI charts.
|
|
3670
|
-
*
|
|
3671
3600
|
* @example
|
|
3672
3601
|
* ```js
|
|
3673
3602
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -3686,7 +3615,6 @@ export enum Action {
|
|
|
3686
3615
|
/**
|
|
3687
3616
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
3688
3617
|
* Allows sending data to a Google Sheet.
|
|
3689
|
-
*
|
|
3690
3618
|
* @example
|
|
3691
3619
|
* ```js
|
|
3692
3620
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -3698,7 +3626,6 @@ export enum Action {
|
|
|
3698
3626
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
3699
3627
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
3700
3628
|
* Microsoft Teams, and so on.
|
|
3701
|
-
*
|
|
3702
3629
|
* @example
|
|
3703
3630
|
* ```js
|
|
3704
3631
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3709,7 +3636,6 @@ export enum Action {
|
|
|
3709
3636
|
/**
|
|
3710
3637
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
3711
3638
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
3712
|
-
*
|
|
3713
3639
|
* @example
|
|
3714
3640
|
* ```js
|
|
3715
3641
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -3720,7 +3646,6 @@ export enum Action {
|
|
|
3720
3646
|
/**
|
|
3721
3647
|
* The **Filter** action on Liveboard visualizations.
|
|
3722
3648
|
* Allows users to apply cross-filters on a Liveboard.
|
|
3723
|
-
*
|
|
3724
3649
|
* @example
|
|
3725
3650
|
* ```js
|
|
3726
3651
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -3731,7 +3656,6 @@ export enum Action {
|
|
|
3731
3656
|
/**
|
|
3732
3657
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
3733
3658
|
* Allows sending data to third-party apps Slack
|
|
3734
|
-
*
|
|
3735
3659
|
* @example
|
|
3736
3660
|
* ```js
|
|
3737
3661
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -3742,7 +3666,6 @@ export enum Action {
|
|
|
3742
3666
|
/**
|
|
3743
3667
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
3744
3668
|
* Allows sending data to third-party apps Team
|
|
3745
|
-
*
|
|
3746
3669
|
* @example
|
|
3747
3670
|
* ```js
|
|
3748
3671
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -3754,7 +3677,6 @@ export enum Action {
|
|
|
3754
3677
|
* The **Remove** action that appears when cross filters are applied
|
|
3755
3678
|
* on a Liveboard.
|
|
3756
3679
|
* Removes filters applied o a visualization.
|
|
3757
|
-
*
|
|
3758
3680
|
* @example
|
|
3759
3681
|
* ```js
|
|
3760
3682
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -3766,7 +3688,6 @@ export enum Action {
|
|
|
3766
3688
|
* The **Aggregate** option in the chart axis or the
|
|
3767
3689
|
* table column customization menu.
|
|
3768
3690
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
3769
|
-
*
|
|
3770
3691
|
* @example
|
|
3771
3692
|
* ```js
|
|
3772
3693
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -3778,7 +3699,6 @@ export enum Action {
|
|
|
3778
3699
|
* The **Time bucket** option in the chart axis or table column
|
|
3779
3700
|
* customization menu.
|
|
3780
3701
|
* Allows defining time metric for date comparison.
|
|
3781
|
-
*
|
|
3782
3702
|
* @example
|
|
3783
3703
|
* ```js
|
|
3784
3704
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -3789,7 +3709,6 @@ export enum Action {
|
|
|
3789
3709
|
/**
|
|
3790
3710
|
* The **Filter** action in the chart axis or table column
|
|
3791
3711
|
* customization menu.
|
|
3792
|
-
*
|
|
3793
3712
|
* @example
|
|
3794
3713
|
* ```js
|
|
3795
3714
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -3801,7 +3720,6 @@ export enum Action {
|
|
|
3801
3720
|
* The **Conditional formatting** action on chart or table.
|
|
3802
3721
|
* Allows adding rules for conditional formatting of data
|
|
3803
3722
|
* points on a chart or table.
|
|
3804
|
-
*
|
|
3805
3723
|
* @example
|
|
3806
3724
|
* ```js
|
|
3807
3725
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3813,7 +3731,6 @@ export enum Action {
|
|
|
3813
3731
|
* The **Sort** menu action on a table or chart axis
|
|
3814
3732
|
* Sorts data in ascending or descending order.
|
|
3815
3733
|
* Allows adding, editing, or removing filters.
|
|
3816
|
-
*
|
|
3817
3734
|
* @example
|
|
3818
3735
|
* ```js
|
|
3819
3736
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -3826,7 +3743,6 @@ export enum Action {
|
|
|
3826
3743
|
* customization menu.
|
|
3827
3744
|
* Allows grouping data points if the axes use the same
|
|
3828
3745
|
* unit of measurement and a similar scale.
|
|
3829
|
-
*
|
|
3830
3746
|
* @example
|
|
3831
3747
|
* ```js
|
|
3832
3748
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -3838,7 +3754,6 @@ export enum Action {
|
|
|
3838
3754
|
* The **Position** option in the axis customization menu.
|
|
3839
3755
|
* Allows changing the position of the axis to the
|
|
3840
3756
|
* left or right side of the chart.
|
|
3841
|
-
*
|
|
3842
3757
|
* @example
|
|
3843
3758
|
* ```js
|
|
3844
3759
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -3849,7 +3764,6 @@ export enum Action {
|
|
|
3849
3764
|
/**
|
|
3850
3765
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
3851
3766
|
* Renames the axis label on a chart or the column header on a table.
|
|
3852
|
-
*
|
|
3853
3767
|
* @example
|
|
3854
3768
|
* ```js
|
|
3855
3769
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -3861,7 +3775,6 @@ export enum Action {
|
|
|
3861
3775
|
* The **Edit** action in the axis customization menu.
|
|
3862
3776
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
3863
3777
|
* and format of a column.
|
|
3864
|
-
*
|
|
3865
3778
|
* @example
|
|
3866
3779
|
* ```js
|
|
3867
3780
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -3872,7 +3785,6 @@ export enum Action {
|
|
|
3872
3785
|
/**
|
|
3873
3786
|
* The **Number format** action to customize the format of
|
|
3874
3787
|
* the data labels on a chart or table.
|
|
3875
|
-
*
|
|
3876
3788
|
* @example
|
|
3877
3789
|
* ```js
|
|
3878
3790
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -3883,7 +3795,6 @@ export enum Action {
|
|
|
3883
3795
|
/**
|
|
3884
3796
|
* The **Text wrapping** action on a table.
|
|
3885
3797
|
* Wraps or clips column text on a table.
|
|
3886
|
-
*
|
|
3887
3798
|
* @example
|
|
3888
3799
|
* ```js
|
|
3889
3800
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -3896,7 +3807,6 @@ export enum Action {
|
|
|
3896
3807
|
* customization menu.
|
|
3897
3808
|
* Removes the data labels from a chart or the column of a
|
|
3898
3809
|
* table visualization.
|
|
3899
|
-
*
|
|
3900
3810
|
* @example
|
|
3901
3811
|
* ```js
|
|
3902
3812
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -3911,7 +3821,6 @@ export enum Action {
|
|
|
3911
3821
|
/**
|
|
3912
3822
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
3913
3823
|
* Allows renaming a Liveboard or visualization.
|
|
3914
|
-
*
|
|
3915
3824
|
* @example
|
|
3916
3825
|
* ```js
|
|
3917
3826
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -3955,7 +3864,6 @@ export enum Action {
|
|
|
3955
3864
|
/**
|
|
3956
3865
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
3957
3866
|
* Allows moving a visualization to a different tab.
|
|
3958
|
-
*
|
|
3959
3867
|
* @example
|
|
3960
3868
|
* ```js
|
|
3961
3869
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -3964,7 +3872,6 @@ export enum Action {
|
|
|
3964
3872
|
MoveToTab = 'onContainerMove',
|
|
3965
3873
|
/**
|
|
3966
3874
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
3967
|
-
*
|
|
3968
3875
|
* @example
|
|
3969
3876
|
* ```js
|
|
3970
3877
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -3973,7 +3880,6 @@ export enum Action {
|
|
|
3973
3880
|
ManageMonitor = 'ManageMonitor',
|
|
3974
3881
|
/**
|
|
3975
3882
|
* Action ID for Liveboard Personalised Views dropdown
|
|
3976
|
-
*
|
|
3977
3883
|
* @example
|
|
3978
3884
|
* ```js
|
|
3979
3885
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -3983,7 +3889,6 @@ export enum Action {
|
|
|
3983
3889
|
PersonalisedViewsDropdown = 'personalisedViewsDropdown',
|
|
3984
3890
|
/**
|
|
3985
3891
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
3986
|
-
*
|
|
3987
3892
|
* @example
|
|
3988
3893
|
* ```js
|
|
3989
3894
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -3996,7 +3901,6 @@ export enum Action {
|
|
|
3996
3901
|
* Action ID for the Parent TML action
|
|
3997
3902
|
* The parent action **TML** must be included to access TML-related options
|
|
3998
3903
|
* within the cascading menu (specific to the answer page)
|
|
3999
|
-
*
|
|
4000
3904
|
* @example
|
|
4001
3905
|
* ```js
|
|
4002
3906
|
* // to include specific TML actions
|
|
@@ -4008,14 +3912,12 @@ export enum Action {
|
|
|
4008
3912
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
4009
3913
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
4010
3914
|
* ```
|
|
4011
|
-
*
|
|
4012
|
-
* @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
|
|
3915
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
4013
3916
|
*/
|
|
4014
3917
|
TML = 'tml',
|
|
4015
3918
|
|
|
4016
3919
|
/**
|
|
4017
3920
|
* Action ID for to hide Verified Liveboard Banner
|
|
4018
|
-
*
|
|
4019
3921
|
* @example
|
|
4020
3922
|
* ```js
|
|
4021
3923
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -4026,7 +3928,6 @@ export enum Action {
|
|
|
4026
3928
|
|
|
4027
3929
|
/**
|
|
4028
3930
|
* Action ID for ask sage button
|
|
4029
|
-
*
|
|
4030
3931
|
* @example
|
|
4031
3932
|
* ```js
|
|
4032
3933
|
* hiddenAction: [Action.AskAi]
|
|
@@ -4037,7 +3938,6 @@ export enum Action {
|
|
|
4037
3938
|
|
|
4038
3939
|
/**
|
|
4039
3940
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
4040
|
-
*
|
|
4041
3941
|
* @example
|
|
4042
3942
|
* ```js
|
|
4043
3943
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -4048,7 +3948,6 @@ export enum Action {
|
|
|
4048
3948
|
|
|
4049
3949
|
/**
|
|
4050
3950
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
4051
|
-
*
|
|
4052
3951
|
* @example
|
|
4053
3952
|
* ```js
|
|
4054
3953
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -4057,20 +3956,8 @@ export enum Action {
|
|
|
4057
3956
|
*/
|
|
4058
3957
|
RemoveFromWatchlist = 'removeFromWatchlist',
|
|
4059
3958
|
|
|
4060
|
-
/**
|
|
4061
|
-
* The **Copy KPI Link** menu action on KPI watchlist.
|
|
4062
|
-
*
|
|
4063
|
-
* @example
|
|
4064
|
-
* ```js
|
|
4065
|
-
* disabledActions: [Action.CopyKpiLink]
|
|
4066
|
-
* ```
|
|
4067
|
-
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
4068
|
-
*/
|
|
4069
|
-
CopyKpiLink = 'copyKpiLink',
|
|
4070
|
-
|
|
4071
3959
|
/**
|
|
4072
3960
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
4073
|
-
*
|
|
4074
3961
|
* @example
|
|
4075
3962
|
* ```js
|
|
4076
3963
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -4081,7 +3968,6 @@ export enum Action {
|
|
|
4081
3968
|
|
|
4082
3969
|
/**
|
|
4083
3970
|
* Action ID for AI Highlights button
|
|
4084
|
-
*
|
|
4085
3971
|
* @example
|
|
4086
3972
|
* ```js
|
|
4087
3973
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -4161,7 +4047,6 @@ export interface CustomActionPayload {
|
|
|
4161
4047
|
export enum LogLevel {
|
|
4162
4048
|
/**
|
|
4163
4049
|
* No logs will be logged in the console.
|
|
4164
|
-
*
|
|
4165
4050
|
* @example
|
|
4166
4051
|
* ```js
|
|
4167
4052
|
* init({
|
|
@@ -4174,7 +4059,6 @@ export enum LogLevel {
|
|
|
4174
4059
|
SILENT = 'SILENT',
|
|
4175
4060
|
/**
|
|
4176
4061
|
* Only ERROR logs will be logged in the console.
|
|
4177
|
-
*
|
|
4178
4062
|
* @example
|
|
4179
4063
|
* ```js
|
|
4180
4064
|
* init({
|
|
@@ -4187,7 +4071,6 @@ export enum LogLevel {
|
|
|
4187
4071
|
ERROR = 'ERROR',
|
|
4188
4072
|
/**
|
|
4189
4073
|
* Only WARN and ERROR logs will be logged in the console.
|
|
4190
|
-
*
|
|
4191
4074
|
* @example
|
|
4192
4075
|
* ```js
|
|
4193
4076
|
* init({
|
|
@@ -4200,7 +4083,6 @@ export enum LogLevel {
|
|
|
4200
4083
|
WARN = 'WARN',
|
|
4201
4084
|
/**
|
|
4202
4085
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
4203
|
-
*
|
|
4204
4086
|
* @example
|
|
4205
4087
|
* ```js
|
|
4206
4088
|
* init({
|
|
@@ -4214,7 +4096,6 @@ export enum LogLevel {
|
|
|
4214
4096
|
|
|
4215
4097
|
/**
|
|
4216
4098
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
4217
|
-
*
|
|
4218
4099
|
* @example
|
|
4219
4100
|
* ```js
|
|
4220
4101
|
* init({
|
|
@@ -4227,7 +4108,6 @@ export enum LogLevel {
|
|
|
4227
4108
|
DEBUG = 'DEBUG',
|
|
4228
4109
|
/**
|
|
4229
4110
|
* All logs will be logged in the console.
|
|
4230
|
-
*
|
|
4231
4111
|
* @example
|
|
4232
4112
|
* ```js
|
|
4233
4113
|
* init({
|