@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
|
@@ -13,7 +13,6 @@ interface PreRenderProps {
|
|
|
13
13
|
* PreRender id to be used for PreRendering the embed.
|
|
14
14
|
* Use PreRender to render the embed in the background and then
|
|
15
15
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
16
|
-
*
|
|
17
16
|
* @example
|
|
18
17
|
* ```js
|
|
19
18
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -40,7 +39,6 @@ interface PreRenderProps {
|
|
|
40
39
|
}
|
|
41
40
|
/**
|
|
42
41
|
* React component for Search Embed.
|
|
43
|
-
*
|
|
44
42
|
* @example
|
|
45
43
|
* ```tsx
|
|
46
44
|
* function Search() {
|
|
@@ -57,7 +55,6 @@ interface AppProps extends EmbedProps, AppViewConfig {
|
|
|
57
55
|
}
|
|
58
56
|
/**
|
|
59
57
|
* React component for Full app Embed.
|
|
60
|
-
*
|
|
61
58
|
* @example
|
|
62
59
|
* ```tsx
|
|
63
60
|
* function Search() {
|
|
@@ -77,7 +74,6 @@ export const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttri
|
|
|
77
74
|
* default.
|
|
78
75
|
*
|
|
79
76
|
* AppEmbed with preRenderId passed will call showPreRender on the embed.
|
|
80
|
-
*
|
|
81
77
|
* @example
|
|
82
78
|
* ```tsx
|
|
83
79
|
* function LandingPageComponent() {
|
|
@@ -94,7 +90,6 @@ interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
|
|
|
94
90
|
}
|
|
95
91
|
/**
|
|
96
92
|
* React component for Liveboard embed.
|
|
97
|
-
*
|
|
98
93
|
* @example
|
|
99
94
|
* ```tsx
|
|
100
95
|
* function Liveboard() {
|
|
@@ -112,14 +107,13 @@ export const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & Rea
|
|
|
112
107
|
/**
|
|
113
108
|
* React component for PreRendered Liveboard embed.
|
|
114
109
|
*
|
|
115
|
-
*
|
|
110
|
+
* PreRenderedLiveboardEmbed will preRender the liveboard and will be hidden by default.
|
|
116
111
|
*
|
|
117
112
|
* LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
|
|
118
113
|
*
|
|
119
114
|
* If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
|
|
120
115
|
* tries to preRender the LiveboardEmbed, so it is recommended to use pass the
|
|
121
116
|
* liveboardId to both the components.
|
|
122
|
-
*
|
|
123
117
|
* @example
|
|
124
118
|
* ```tsx
|
|
125
119
|
* function LandingPageComponent() {
|
|
@@ -137,7 +131,6 @@ interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
|
|
|
137
131
|
}
|
|
138
132
|
/**
|
|
139
133
|
* React component for Search bar embed.
|
|
140
|
-
*
|
|
141
134
|
* @example
|
|
142
135
|
* ```tsx
|
|
143
136
|
* function SearchBar() {
|
|
@@ -156,7 +149,6 @@ export const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps
|
|
|
156
149
|
* default.
|
|
157
150
|
*
|
|
158
151
|
* SearchBarEmbed with preRenderId passed will call showPreRender on the embed.
|
|
159
|
-
*
|
|
160
152
|
* @example
|
|
161
153
|
* ```tsx
|
|
162
154
|
* function LandingPageComponent() {
|
|
@@ -173,7 +165,6 @@ interface SageEmbedProps extends EmbedProps, SageViewConfig {
|
|
|
173
165
|
}
|
|
174
166
|
/**
|
|
175
167
|
* React component for LLM based search Sage embed.
|
|
176
|
-
*
|
|
177
168
|
* @example
|
|
178
169
|
* ```tsx
|
|
179
170
|
* function Sage() {
|
|
@@ -192,7 +183,6 @@ export const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.R
|
|
|
192
183
|
* default.
|
|
193
184
|
*
|
|
194
185
|
* SageEmbed with preRenderId passed will call showPreRender on the embed.
|
|
195
|
-
*
|
|
196
186
|
* @example
|
|
197
187
|
* ```tsx
|
|
198
188
|
* function LandingPageComponent() {
|
|
@@ -208,7 +198,6 @@ export const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProp
|
|
|
208
198
|
type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed;
|
|
209
199
|
/**
|
|
210
200
|
* Get a reference to the embed component to trigger events on the component.
|
|
211
|
-
*
|
|
212
201
|
* @example
|
|
213
202
|
* ```
|
|
214
203
|
* function Component() {
|
|
@@ -230,7 +219,6 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
|
|
|
230
219
|
*
|
|
231
220
|
* ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
|
|
232
221
|
* in other web applications.
|
|
233
|
-
*
|
|
234
222
|
* @summary ThoughtSpot Visual Embed SDK
|
|
235
223
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
236
224
|
*/
|
|
@@ -243,11 +231,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
243
231
|
/**
|
|
244
232
|
* The array of data source GUIDs to set on load.
|
|
245
233
|
* Only a single data source is supported currently.
|
|
246
|
-
*
|
|
247
234
|
* @deprecated Use `dataSource` instead
|
|
248
|
-
*
|
|
249
235
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
250
|
-
*
|
|
251
236
|
* @example
|
|
252
237
|
* ```js
|
|
253
238
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -259,9 +244,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
259
244
|
dataSources?: string[];
|
|
260
245
|
/**
|
|
261
246
|
* Pass the ID of the source to be selected.
|
|
262
|
-
*
|
|
263
247
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
264
|
-
*
|
|
265
248
|
* @example
|
|
266
249
|
* ```js
|
|
267
250
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -273,9 +256,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
273
256
|
dataSource?: string;
|
|
274
257
|
/**
|
|
275
258
|
* Boolean to define if the last selected data source should be used
|
|
276
|
-
*
|
|
277
259
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
278
|
-
*
|
|
279
260
|
* @example
|
|
280
261
|
* ```js
|
|
281
262
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -295,9 +276,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
295
276
|
* If it is executed, the focus is placed on the results.
|
|
296
277
|
* If it’s not executed, the focus is placed at the end of
|
|
297
278
|
* the token string in the search bar.
|
|
298
|
-
*
|
|
299
279
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
300
|
-
*
|
|
301
280
|
* @example
|
|
302
281
|
* ```js
|
|
303
282
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -313,7 +292,6 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
313
292
|
}
|
|
314
293
|
/**
|
|
315
294
|
* Embed ThoughtSpot search bar
|
|
316
|
-
*
|
|
317
295
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
318
296
|
* @group Embed components
|
|
319
297
|
*/
|
|
@@ -334,7 +312,6 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
334
312
|
* Copyright (c) 2023
|
|
335
313
|
*
|
|
336
314
|
* Embed ThoughtSpot Sage
|
|
337
|
-
*
|
|
338
315
|
* @summary TS Sage embed
|
|
339
316
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
340
317
|
*/
|
|
@@ -357,7 +334,6 @@ export interface SearchOptions {
|
|
|
357
334
|
/**
|
|
358
335
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
359
336
|
* GPT and LLM.
|
|
360
|
-
*
|
|
361
337
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
362
338
|
* @group Embed components
|
|
363
339
|
*/
|
|
@@ -366,7 +342,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
366
342
|
* If set to true, a list of Liveboard and Answers related
|
|
367
343
|
* to the natural language search will be shown below the
|
|
368
344
|
* AI generated answer.
|
|
369
|
-
*
|
|
370
345
|
* @deprecated Currently Liveboard and Answers related
|
|
371
346
|
* to the natural language search will not be shown for sage
|
|
372
347
|
* embed
|
|
@@ -374,49 +349,43 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
374
349
|
showObjectResults?: boolean;
|
|
375
350
|
/**
|
|
376
351
|
* flag used by the TS product tour page to show the blue search bar
|
|
377
|
-
* even after the search is completed. This is different from
|
|
378
|
-
* experience where it mimics closer to the non-embed case.
|
|
352
|
+
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
353
|
+
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
379
354
|
* The Sample questions container is collapsed when this value is set after
|
|
380
355
|
* does a search.
|
|
381
|
-
*
|
|
382
356
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
383
357
|
* @hidden
|
|
384
358
|
*/
|
|
385
359
|
isProductTour?: boolean;
|
|
386
360
|
/**
|
|
387
361
|
* Show or hide the search bar title.
|
|
388
|
-
*
|
|
389
|
-
* @
|
|
362
|
+
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
363
|
+
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
390
364
|
*/
|
|
391
365
|
hideSearchBarTitle?: boolean;
|
|
392
366
|
/**
|
|
393
367
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
394
368
|
* at the top of the Answer page.
|
|
395
|
-
*
|
|
396
369
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
397
370
|
*/
|
|
398
371
|
hideSageAnswerHeader?: boolean;
|
|
399
372
|
/**
|
|
400
373
|
* Disable the worksheet selection option.
|
|
401
|
-
*
|
|
402
374
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
403
375
|
*/
|
|
404
376
|
disableWorksheetChange?: boolean;
|
|
405
377
|
/**
|
|
406
378
|
* Hide the worksheet selection panel.
|
|
407
|
-
*
|
|
408
379
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
409
380
|
*/
|
|
410
381
|
hideWorksheetSelector?: boolean;
|
|
411
382
|
/**
|
|
412
383
|
* Show or hide autocomplete suggestions for the search query string.
|
|
413
|
-
*
|
|
414
384
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
415
385
|
*/
|
|
416
386
|
hideAutocompleteSuggestions?: boolean;
|
|
417
387
|
/**
|
|
418
388
|
* Show or hide autocomplete suggestions for the search query string.
|
|
419
|
-
*
|
|
420
389
|
* @deprecated
|
|
421
390
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
422
391
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -426,7 +395,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
426
395
|
* Show or hide sample questions.
|
|
427
396
|
* The sample questions are autogenerated based on the worksheet
|
|
428
397
|
* selected for the search operation.
|
|
429
|
-
*
|
|
430
398
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
431
399
|
*/
|
|
432
400
|
hideSampleQuestions?: boolean;
|
|
@@ -444,7 +412,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
444
412
|
* If it is executed, the focus is placed on the results.
|
|
445
413
|
* If it’s not executed, the focus is placed at the end of
|
|
446
414
|
* the token string in the search bar.
|
|
447
|
-
*
|
|
448
415
|
* @example
|
|
449
416
|
* ```js
|
|
450
417
|
* searchOptions: {
|
|
@@ -456,10 +423,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
456
423
|
*/
|
|
457
424
|
searchOptions?: SearchOptions;
|
|
458
425
|
}
|
|
459
|
-
export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
|
|
460
426
|
/**
|
|
461
427
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
462
|
-
*
|
|
463
428
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
464
429
|
* @group Embed components
|
|
465
430
|
*/
|
|
@@ -473,20 +438,17 @@ export declare class SageEmbed extends V1Embed {
|
|
|
473
438
|
/**
|
|
474
439
|
* Constructs a map of parameters to be passed on to the
|
|
475
440
|
* embedded Eureka or Sage search page.
|
|
476
|
-
*
|
|
477
441
|
* @returns {string} query string
|
|
478
442
|
*/
|
|
479
443
|
protected getEmbedParams(): string;
|
|
480
444
|
/**
|
|
481
445
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
482
446
|
* loaded in the iframe
|
|
483
|
-
*
|
|
484
447
|
* @returns {string} iframe url
|
|
485
448
|
*/
|
|
486
449
|
getIFrameSrc(): string;
|
|
487
450
|
/**
|
|
488
451
|
* Render the embedded ThoughtSpot Sage
|
|
489
|
-
*
|
|
490
452
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
491
453
|
*/
|
|
492
454
|
render(): Promise<SageEmbed>;
|
|
@@ -496,7 +458,6 @@ export declare class SageEmbed extends V1Embed {
|
|
|
496
458
|
* Copyright (c) 2022
|
|
497
459
|
*
|
|
498
460
|
* Embed ThoughtSpot search or a saved answer
|
|
499
|
-
*
|
|
500
461
|
* @summary Search embed
|
|
501
462
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
502
463
|
*/
|
|
@@ -517,18 +478,33 @@ export interface SearchOptions {
|
|
|
517
478
|
*/
|
|
518
479
|
executeSearch?: boolean;
|
|
519
480
|
}
|
|
481
|
+
/**
|
|
482
|
+
* Define the initial state os column custom group accordions
|
|
483
|
+
* in data panel v2.
|
|
484
|
+
*/
|
|
485
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
486
|
+
/**
|
|
487
|
+
* Expand all the accordion initially in data panel v2.
|
|
488
|
+
*/
|
|
489
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
490
|
+
/**
|
|
491
|
+
* Collapse all the accordions initially in data panel v2.
|
|
492
|
+
*/
|
|
493
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
494
|
+
/**
|
|
495
|
+
* Expand the first accordion and collapse the rest.
|
|
496
|
+
*/
|
|
497
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
498
|
+
}
|
|
520
499
|
/**
|
|
521
500
|
* The configuration attributes for the embedded search view.
|
|
522
|
-
*
|
|
523
501
|
* @group Embed components
|
|
524
502
|
*/
|
|
525
503
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
526
504
|
/**
|
|
527
505
|
* If set to true, the data sources panel is collapsed on load,
|
|
528
506
|
* but can be expanded manually.
|
|
529
|
-
*
|
|
530
507
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
531
|
-
*
|
|
532
508
|
* @example
|
|
533
509
|
* ```js
|
|
534
510
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -540,9 +516,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
540
516
|
collapseDataSources?: boolean;
|
|
541
517
|
/**
|
|
542
518
|
* Show or hide the data sources panel.
|
|
543
|
-
*
|
|
544
519
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
545
|
-
*
|
|
546
520
|
* @example
|
|
547
521
|
* ```js
|
|
548
522
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -556,9 +530,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
556
530
|
* Show or hide the charts and tables in search answers.
|
|
557
531
|
* This attribute can be used to create a custom visualization
|
|
558
532
|
* using raw answer data.
|
|
559
|
-
*
|
|
560
533
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
561
|
-
*
|
|
562
534
|
* @example
|
|
563
535
|
* ```js
|
|
564
536
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -568,11 +540,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
568
540
|
* ```
|
|
569
541
|
*/
|
|
570
542
|
hideResults?: boolean;
|
|
543
|
+
/**
|
|
544
|
+
* If set to true, expands all the data sources panel.
|
|
545
|
+
*/
|
|
546
|
+
expandAllDataSource?: boolean;
|
|
571
547
|
/**
|
|
572
548
|
* If set to true, the Search Assist feature is enabled.
|
|
573
|
-
*
|
|
574
549
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
575
|
-
*
|
|
576
550
|
* @example
|
|
577
551
|
* ```js
|
|
578
552
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -585,9 +559,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
585
559
|
/**
|
|
586
560
|
* If set to true, the tabular view is set as the default
|
|
587
561
|
* format for presenting search data.
|
|
588
|
-
*
|
|
589
562
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
590
|
-
*
|
|
591
563
|
* @example
|
|
592
564
|
* ```js
|
|
593
565
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -599,9 +571,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
599
571
|
/**
|
|
600
572
|
* The array of data source GUIDs to set on load.
|
|
601
573
|
* Only a single data source is supported currently.
|
|
602
|
-
*
|
|
603
574
|
* @deprecated Use `dataSource` instead.
|
|
604
|
-
*
|
|
605
575
|
* @example
|
|
606
576
|
* ```js
|
|
607
577
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -613,9 +583,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
613
583
|
dataSources?: string[];
|
|
614
584
|
/**
|
|
615
585
|
* The array of data source GUIDs to set on load.
|
|
616
|
-
*
|
|
617
586
|
* @version: SDK: 1.19.0
|
|
618
|
-
*
|
|
619
587
|
* @example
|
|
620
588
|
* ```js
|
|
621
589
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -627,7 +595,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
627
595
|
dataSource?: string;
|
|
628
596
|
/**
|
|
629
597
|
* The initial search query to load the answer with.
|
|
630
|
-
*
|
|
631
598
|
* @deprecated
|
|
632
599
|
*
|
|
633
600
|
* Use {@link searchOptions} instead.
|
|
@@ -643,7 +610,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
643
610
|
* If it is executed, the focus is placed on the results.
|
|
644
611
|
* If it’s not executed, the focus is placed at the end of
|
|
645
612
|
* the token string in the search bar.
|
|
646
|
-
*
|
|
647
613
|
* @example
|
|
648
614
|
* ```js
|
|
649
615
|
* searchOptions: {
|
|
@@ -655,9 +621,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
655
621
|
searchOptions?: SearchOptions;
|
|
656
622
|
/**
|
|
657
623
|
* The GUID of a saved answer to load initially.
|
|
658
|
-
*
|
|
659
624
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
660
|
-
*
|
|
661
625
|
* @example
|
|
662
626
|
* ```js
|
|
663
627
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -670,9 +634,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
670
634
|
/**
|
|
671
635
|
* If set to true, the search page will render without the Search Bar
|
|
672
636
|
* The chart/table should still be visible.
|
|
673
|
-
*
|
|
674
637
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
675
|
-
*
|
|
676
638
|
* @example
|
|
677
639
|
* ```js
|
|
678
640
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -684,10 +646,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
684
646
|
hideSearchBar?: boolean;
|
|
685
647
|
/**
|
|
686
648
|
* Flag to control Data panel experience
|
|
687
|
-
*
|
|
688
649
|
* @default false
|
|
689
650
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
690
|
-
*
|
|
691
651
|
* @example
|
|
692
652
|
* ```js
|
|
693
653
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -699,22 +659,56 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
699
659
|
dataPanelV2?: boolean;
|
|
700
660
|
/**
|
|
701
661
|
* Flag to set if last selected dataSource should be used
|
|
702
|
-
*
|
|
703
662
|
* @version: SDK: 1.24.0
|
|
704
663
|
*/
|
|
705
664
|
useLastSelectedSources?: boolean;
|
|
706
665
|
/**
|
|
707
666
|
* To set the initial state of the search bar in case of saved-answers.
|
|
708
|
-
*
|
|
709
667
|
* @default false
|
|
710
668
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
711
669
|
*/
|
|
712
670
|
collapseSearchBarInitially?: boolean;
|
|
671
|
+
/**
|
|
672
|
+
* To enable custom column groups in data panel v2
|
|
673
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
674
|
+
* @default false
|
|
675
|
+
* @example
|
|
676
|
+
* ```js
|
|
677
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
678
|
+
* ... // other options
|
|
679
|
+
* enableCustomColumnGroups: true,
|
|
680
|
+
* });
|
|
681
|
+
* ```
|
|
682
|
+
*/
|
|
683
|
+
enableCustomColumnGroups?: boolean;
|
|
684
|
+
/**
|
|
685
|
+
* Flag to enable onBeforeSearchExecute Embed Event
|
|
686
|
+
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
687
|
+
*/
|
|
688
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
689
|
+
/**
|
|
690
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
691
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
692
|
+
* List of different enum values:-
|
|
693
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
694
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
695
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
696
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
697
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
698
|
+
* @example
|
|
699
|
+
* ```js
|
|
700
|
+
* const embed = new SearchEmbed('#tsEmbed', {
|
|
701
|
+
* ... // other options
|
|
702
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
703
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
704
|
+
* });
|
|
705
|
+
* ```
|
|
706
|
+
*/
|
|
707
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
713
708
|
}
|
|
714
709
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
715
710
|
/**
|
|
716
711
|
* Embed ThoughtSpot search
|
|
717
|
-
*
|
|
718
712
|
* @group Embed components
|
|
719
713
|
*/
|
|
720
714
|
export declare class SearchEmbed extends TsEmbed {
|
|
@@ -727,7 +721,6 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
727
721
|
/**
|
|
728
722
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
729
723
|
* loaded in the iframe
|
|
730
|
-
*
|
|
731
724
|
* @param answerId The GUID of a saved answer
|
|
732
725
|
* @param dataSources A list of data source GUIDs
|
|
733
726
|
*/
|
|
@@ -743,7 +736,6 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
743
736
|
*
|
|
744
737
|
* Full application embedding
|
|
745
738
|
* https://developers.thoughtspot.com/docs/?pageid=full-embed
|
|
746
|
-
*
|
|
747
739
|
* @summary Full app embed
|
|
748
740
|
* @module
|
|
749
741
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
@@ -781,9 +773,26 @@ export declare enum Page {
|
|
|
781
773
|
*/
|
|
782
774
|
SpotIQ = "insights"
|
|
783
775
|
}
|
|
776
|
+
/**
|
|
777
|
+
* Define the initial state os column custom group accordions
|
|
778
|
+
* in data panel v2.
|
|
779
|
+
*/
|
|
780
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
781
|
+
/**
|
|
782
|
+
* Expand all the accordion initially in data panel v2.
|
|
783
|
+
*/
|
|
784
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
785
|
+
/**
|
|
786
|
+
* Collapse all the accordions initially in data panel v2.
|
|
787
|
+
*/
|
|
788
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
789
|
+
/**
|
|
790
|
+
* Expand the first accordion and collapse the rest.
|
|
791
|
+
*/
|
|
792
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
793
|
+
}
|
|
784
794
|
/**
|
|
785
795
|
* The view configuration for full app embedding.
|
|
786
|
-
*
|
|
787
796
|
* @group Embed components
|
|
788
797
|
*/
|
|
789
798
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
@@ -791,10 +800,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
791
800
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
792
801
|
* is displayed. By default, the navigation bar is hidden.
|
|
793
802
|
* This flag also controls the homepage left navigation bar.
|
|
794
|
-
*
|
|
795
803
|
* @default true
|
|
796
804
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
797
|
-
*
|
|
798
805
|
* @example
|
|
799
806
|
* ```js
|
|
800
807
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -810,13 +817,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
810
817
|
* nav-bars are visible, this flag will only hide the homepage left nav-bar.
|
|
811
818
|
* The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
|
|
812
819
|
*
|
|
820
|
+
*
|
|
813
821
|
* **Note**: This option does not apply to the classic homepage.
|
|
814
822
|
* To access the updated modular homepage, set
|
|
815
823
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
816
|
-
*
|
|
817
824
|
* @default false
|
|
818
825
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
819
|
-
*
|
|
820
826
|
* @example
|
|
821
827
|
* ```js
|
|
822
828
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -831,7 +837,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
831
837
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
832
838
|
* @default false
|
|
833
839
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
834
|
-
*
|
|
835
840
|
* @example
|
|
836
841
|
* ```js
|
|
837
842
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -845,13 +850,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
845
850
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
846
851
|
* By default, the application switcher is shown.
|
|
847
852
|
*
|
|
853
|
+
*
|
|
848
854
|
* **Note**: This option does not apply to the classic homepage.
|
|
849
855
|
* To access the updated modular homepage, set
|
|
850
856
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
851
|
-
*
|
|
852
857
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
853
858
|
* @default false
|
|
854
|
-
*
|
|
855
859
|
* @example
|
|
856
860
|
* ```js
|
|
857
861
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -865,13 +869,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
865
869
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
866
870
|
* By default, the Org switcher button is shown.
|
|
867
871
|
*
|
|
872
|
+
*
|
|
868
873
|
* **Note**: This option does not apply to the classic homepage.
|
|
869
874
|
* To access the updated modular homepage, set
|
|
870
875
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
871
|
-
*
|
|
872
876
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
873
877
|
* @default true
|
|
874
|
-
*
|
|
875
878
|
* @example
|
|
876
879
|
* ```js
|
|
877
880
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -889,9 +892,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
889
892
|
*
|
|
890
893
|
* For eg, if you want the component to open to a specific Liveboard
|
|
891
894
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
892
|
-
*
|
|
893
895
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
894
|
-
*
|
|
895
896
|
* @example
|
|
896
897
|
* ```js
|
|
897
898
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -907,9 +908,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
907
908
|
*
|
|
908
909
|
* Use this to open to particular page in the app. To open to a specific
|
|
909
910
|
* path within the app, use the `path` attribute which is more flexible.
|
|
910
|
-
*
|
|
911
911
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
912
|
-
*
|
|
913
912
|
* @example
|
|
914
913
|
* ```js
|
|
915
914
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -923,7 +922,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
923
922
|
* This puts a filter tag on the application. All metadata lists in the
|
|
924
923
|
* application, such as Liveboards and answers, would be filtered by this
|
|
925
924
|
* tag.
|
|
926
|
-
*
|
|
927
925
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
928
926
|
* @example
|
|
929
927
|
* ```js
|
|
@@ -936,9 +934,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
936
934
|
tag?: string;
|
|
937
935
|
/**
|
|
938
936
|
* The array of GUIDs to be hidden
|
|
939
|
-
*
|
|
940
937
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
941
|
-
*
|
|
942
938
|
* @example
|
|
943
939
|
* ```js
|
|
944
940
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -954,7 +950,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
954
950
|
/**
|
|
955
951
|
* Render liveboards using the new v2 rendering mode
|
|
956
952
|
* This is a transient flag which is primarily meant for internal use
|
|
957
|
-
*
|
|
958
953
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
959
954
|
* @hidden
|
|
960
955
|
*/
|
|
@@ -962,9 +957,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
962
957
|
/**
|
|
963
958
|
* If set to true, the Search Assist feature is enabled.
|
|
964
959
|
* @default true
|
|
965
|
-
*
|
|
966
960
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
967
|
-
*
|
|
968
961
|
* @example
|
|
969
962
|
* ```js
|
|
970
963
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -977,9 +970,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
977
970
|
/**
|
|
978
971
|
* If set to true, the embedded object container dynamically resizes
|
|
979
972
|
* according to the height of the pages which support fullHeight mode.
|
|
980
|
-
*
|
|
981
973
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
982
|
-
*
|
|
983
974
|
* @example
|
|
984
975
|
* ```js
|
|
985
976
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -991,7 +982,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
991
982
|
fullHeight?: boolean;
|
|
992
983
|
/**
|
|
993
984
|
* Flag to control Data panel experience
|
|
994
|
-
*
|
|
995
985
|
* @default false
|
|
996
986
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
997
987
|
* @hidden
|
|
@@ -999,10 +989,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
999
989
|
dataPanelV2?: boolean;
|
|
1000
990
|
/**
|
|
1001
991
|
* Show or hide Liveboard header
|
|
1002
|
-
*
|
|
1003
992
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1004
993
|
* @default false
|
|
1005
|
-
*
|
|
1006
994
|
* @example
|
|
1007
995
|
* ```js
|
|
1008
996
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1014,10 +1002,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1014
1002
|
hideLiveboardHeader?: boolean;
|
|
1015
1003
|
/**
|
|
1016
1004
|
* Show or hide Liveboard title
|
|
1017
|
-
*
|
|
1018
1005
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1019
1006
|
* @default false
|
|
1020
|
-
*
|
|
1021
1007
|
* @example
|
|
1022
1008
|
* ```js
|
|
1023
1009
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1029,10 +1015,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1029
1015
|
showLiveboardTitle?: boolean;
|
|
1030
1016
|
/**
|
|
1031
1017
|
* Show or hide Liveboard description
|
|
1032
|
-
*
|
|
1033
1018
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1034
1019
|
* @default false
|
|
1035
|
-
*
|
|
1036
1020
|
* @example
|
|
1037
1021
|
* ```js
|
|
1038
1022
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1044,10 +1028,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1044
1028
|
showLiveboardDescription?: boolean;
|
|
1045
1029
|
/**
|
|
1046
1030
|
* Flag to control new Modular Home experience.
|
|
1047
|
-
*
|
|
1048
1031
|
* @default false
|
|
1049
1032
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
1050
|
-
*
|
|
1051
1033
|
* @example
|
|
1052
1034
|
* ```js
|
|
1053
1035
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1059,7 +1041,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1059
1041
|
modularHomeExperience?: boolean;
|
|
1060
1042
|
/**
|
|
1061
1043
|
* Boolean to control if Liveboard header is sticky or not.
|
|
1062
|
-
*
|
|
1063
1044
|
* @example
|
|
1064
1045
|
* ```js
|
|
1065
1046
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -1072,22 +1053,70 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
1072
1053
|
isLiveboardHeaderSticky?: boolean;
|
|
1073
1054
|
/**
|
|
1074
1055
|
* enable or disable ask sage
|
|
1075
|
-
*
|
|
1076
1056
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1077
1057
|
* @default false
|
|
1078
1058
|
*/
|
|
1079
1059
|
enableAskSage?: boolean;
|
|
1080
1060
|
/**
|
|
1081
1061
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1082
|
-
*
|
|
1083
1062
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1084
1063
|
* @default false
|
|
1085
1064
|
*/
|
|
1086
1065
|
collapseSearchBarInitially?: boolean;
|
|
1066
|
+
/**
|
|
1067
|
+
* To enable custom column groups in data panel v2.
|
|
1068
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1069
|
+
* @default false
|
|
1070
|
+
* @example
|
|
1071
|
+
* ```js
|
|
1072
|
+
* const embed = new AppEmbed('#embed', {
|
|
1073
|
+
* ... // other app view config
|
|
1074
|
+
* enableCustomColumnGroups: true,
|
|
1075
|
+
* });
|
|
1076
|
+
* ```
|
|
1077
|
+
*/
|
|
1078
|
+
enableCustomColumnGroups?: boolean;
|
|
1079
|
+
/**
|
|
1080
|
+
* This controls the initial behaviour of custom column groups accordion.
|
|
1081
|
+
* It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
|
|
1082
|
+
* List of different enum values:-
|
|
1083
|
+
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1084
|
+
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1085
|
+
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1086
|
+
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1087
|
+
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1088
|
+
* @example
|
|
1089
|
+
* ```js
|
|
1090
|
+
* const embed = new AppEmbed('#embed', {
|
|
1091
|
+
* ... // other app view config
|
|
1092
|
+
* dataPanelCustomGroupsAccordionInitialState:
|
|
1093
|
+
* DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
|
|
1094
|
+
* });
|
|
1095
|
+
* ```
|
|
1096
|
+
*/
|
|
1097
|
+
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1098
|
+
/**
|
|
1099
|
+
* This flag is used to enable the 2 column layout in liveboard
|
|
1100
|
+
* @type {boolean}
|
|
1101
|
+
* @default false
|
|
1102
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1103
|
+
* @example
|
|
1104
|
+
* ```js
|
|
1105
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1106
|
+
* ... // other options
|
|
1107
|
+
* enable2ColumnLayout: true,
|
|
1108
|
+
* })
|
|
1109
|
+
* ```
|
|
1110
|
+
*/
|
|
1111
|
+
enable2ColumnLayout?: boolean;
|
|
1112
|
+
/**
|
|
1113
|
+
* Flag to use OnBeforeSearchExecute embed event
|
|
1114
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
1115
|
+
*/
|
|
1116
|
+
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1087
1117
|
}
|
|
1088
1118
|
/**
|
|
1089
1119
|
* Embeds full ThoughtSpot experience in a host application.
|
|
1090
|
-
*
|
|
1091
1120
|
* @group Embed components
|
|
1092
1121
|
*/
|
|
1093
1122
|
export declare class AppEmbed extends V1Embed {
|
|
@@ -1100,14 +1129,12 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1100
1129
|
protected getEmbedParams(): string;
|
|
1101
1130
|
/**
|
|
1102
1131
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
1103
|
-
*
|
|
1104
1132
|
* @param pageId The ID of the page to be embedded.
|
|
1105
1133
|
*/
|
|
1106
1134
|
getIFrameSrc(): string;
|
|
1107
1135
|
/**
|
|
1108
1136
|
* Set the iframe height as per the computed height received
|
|
1109
1137
|
* from the ThoughtSpot app.
|
|
1110
|
-
*
|
|
1111
1138
|
* @param data The event payload
|
|
1112
1139
|
*/
|
|
1113
1140
|
protected updateIFrameHeight: (data: MessagePayload) => void;
|
|
@@ -1115,7 +1142,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1115
1142
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
1116
1143
|
* This is used for embedding answers, pinboards, visualizations and full application
|
|
1117
1144
|
* only.
|
|
1118
|
-
*
|
|
1119
1145
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
1120
1146
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
1121
1147
|
* When used with `noReload` (default: true) this can also be a number
|
|
@@ -1126,7 +1152,6 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1126
1152
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
1127
1153
|
/**
|
|
1128
1154
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
1129
|
-
*
|
|
1130
1155
|
* @param renderOptions An object containing the page ID
|
|
1131
1156
|
* to be embedded.
|
|
1132
1157
|
*/
|
|
@@ -1139,13 +1164,11 @@ export declare class AppEmbed extends V1Embed {
|
|
|
1139
1164
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
1140
1165
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
1141
1166
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
1142
|
-
*
|
|
1143
1167
|
* @summary Liveboard & visualization embed
|
|
1144
1168
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1145
1169
|
*/
|
|
1146
1170
|
/**
|
|
1147
1171
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
1148
|
-
*
|
|
1149
1172
|
* @group Embed components
|
|
1150
1173
|
*/
|
|
1151
1174
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -1158,9 +1181,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1158
1181
|
* visualizations to display on the screen.
|
|
1159
1182
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
1160
1183
|
* incrementally as users scroll the page to view the charts and tables.
|
|
1161
|
-
*
|
|
1162
1184
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
1163
|
-
*
|
|
1164
1185
|
* @example
|
|
1165
1186
|
* ```js
|
|
1166
1187
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1174,7 +1195,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1174
1195
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
1175
1196
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
1176
1197
|
* other screens navigable from a Liveboard.
|
|
1177
|
-
*
|
|
1178
1198
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1179
1199
|
* @default 500
|
|
1180
1200
|
* @example
|
|
@@ -1189,7 +1209,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1189
1209
|
defaultHeight?: number;
|
|
1190
1210
|
/**
|
|
1191
1211
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
1192
|
-
*
|
|
1193
1212
|
* @example
|
|
1194
1213
|
* ```js
|
|
1195
1214
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1197,14 +1216,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1197
1216
|
* enableVizTransformations:true,
|
|
1198
1217
|
* })
|
|
1199
1218
|
* ```
|
|
1200
|
-
*
|
|
1201
1219
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1202
1220
|
*/
|
|
1203
1221
|
enableVizTransformations?: boolean;
|
|
1204
1222
|
/**
|
|
1205
1223
|
* The Liveboard to display in the embedded view.
|
|
1206
1224
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
1207
|
-
*
|
|
1208
1225
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
1209
1226
|
* @example
|
|
1210
1227
|
* ```js
|
|
@@ -1216,15 +1233,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1216
1233
|
liveboardId?: string;
|
|
1217
1234
|
/**
|
|
1218
1235
|
* To support backward compatibility
|
|
1219
|
-
*
|
|
1220
1236
|
* @hidden
|
|
1221
1237
|
*/
|
|
1222
1238
|
pinboardId?: string;
|
|
1223
1239
|
/**
|
|
1224
1240
|
* The visualization within the Liveboard to display.
|
|
1225
|
-
*
|
|
1226
1241
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1227
|
-
*
|
|
1228
1242
|
* @example
|
|
1229
1243
|
* ```js
|
|
1230
1244
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1237,7 +1251,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1237
1251
|
/**
|
|
1238
1252
|
* If set to true, all filter chips from a
|
|
1239
1253
|
* Liveboard page will be read-only (no X buttons)
|
|
1240
|
-
*
|
|
1241
1254
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
1242
1255
|
* @example
|
|
1243
1256
|
* ```js
|
|
@@ -1252,9 +1265,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1252
1265
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
1253
1266
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
1254
1267
|
* event.
|
|
1255
|
-
*
|
|
1256
1268
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
1257
|
-
*
|
|
1258
1269
|
* @example
|
|
1259
1270
|
* ```js
|
|
1260
1271
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1268,14 +1279,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1268
1279
|
visibleVizs?: string[];
|
|
1269
1280
|
/**
|
|
1270
1281
|
* To support backward compatibility
|
|
1271
|
-
*
|
|
1272
1282
|
* @hidden
|
|
1273
1283
|
*/
|
|
1274
1284
|
preventPinboardFilterRemoval?: boolean;
|
|
1275
1285
|
/**
|
|
1276
1286
|
* Render embedded Liveboards and visualizations in the
|
|
1277
1287
|
* new Liveboard experience mode.
|
|
1278
|
-
*
|
|
1279
1288
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
1280
1289
|
* @example
|
|
1281
1290
|
* ```js
|
|
@@ -1289,7 +1298,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1289
1298
|
/**
|
|
1290
1299
|
* Set a Liveboard tab as an active tab.
|
|
1291
1300
|
* Specify the tab ID.
|
|
1292
|
-
*
|
|
1293
1301
|
* @example
|
|
1294
1302
|
* ```js
|
|
1295
1303
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -1302,9 +1310,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1302
1310
|
activeTabId?: string;
|
|
1303
1311
|
/**
|
|
1304
1312
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1305
|
-
*
|
|
1306
1313
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
1307
|
-
*
|
|
1308
1314
|
* @example
|
|
1309
1315
|
* ```js
|
|
1310
1316
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1316,7 +1322,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1316
1322
|
hideTabPanel?: boolean;
|
|
1317
1323
|
/**
|
|
1318
1324
|
* Show or hide the Liveboard header.
|
|
1319
|
-
*
|
|
1320
1325
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1321
1326
|
* @default false
|
|
1322
1327
|
* @example
|
|
@@ -1332,7 +1337,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1332
1337
|
* Show or hide the Liveboard title.
|
|
1333
1338
|
* @default false
|
|
1334
1339
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1335
|
-
*
|
|
1336
1340
|
* @example
|
|
1337
1341
|
* ```js
|
|
1338
1342
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1346,7 +1350,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1346
1350
|
* Show or hide the Liveboard description.
|
|
1347
1351
|
* @default false
|
|
1348
1352
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
1349
|
-
*
|
|
1350
1353
|
* @example
|
|
1351
1354
|
* ```js
|
|
1352
1355
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -1360,7 +1363,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1360
1363
|
* Control the position and visibility of
|
|
1361
1364
|
* the Liveboard header as the users scroll down the
|
|
1362
1365
|
* embedded Liveboard page.
|
|
1363
|
-
*
|
|
1364
1366
|
* @example
|
|
1365
1367
|
* ```js
|
|
1366
1368
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -1373,7 +1375,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1373
1375
|
isLiveboardHeaderSticky?: boolean;
|
|
1374
1376
|
/**
|
|
1375
1377
|
* enable or disable ask sage
|
|
1376
|
-
*
|
|
1377
1378
|
* @default false
|
|
1378
1379
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
1379
1380
|
* @example
|
|
@@ -1385,12 +1386,25 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
1385
1386
|
* ```
|
|
1386
1387
|
*/
|
|
1387
1388
|
enableAskSage?: boolean;
|
|
1389
|
+
/**
|
|
1390
|
+
* This flag is used to enable the 2 column layout in liveboard
|
|
1391
|
+
* @type {boolean}
|
|
1392
|
+
* @default false
|
|
1393
|
+
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
1394
|
+
* @example
|
|
1395
|
+
* ```js
|
|
1396
|
+
* const embed = new LiveboardEmbed('#embed-container', {
|
|
1397
|
+
* ... // other options
|
|
1398
|
+
* enable2ColumnLayout: true,
|
|
1399
|
+
* })
|
|
1400
|
+
* ```
|
|
1401
|
+
*/
|
|
1402
|
+
enable2ColumnLayout?: boolean;
|
|
1388
1403
|
}
|
|
1389
1404
|
/**
|
|
1390
1405
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
1391
1406
|
* waits for the authentication to complete, so you need not wait for
|
|
1392
1407
|
* `AuthStatus.SUCCESS`.
|
|
1393
|
-
*
|
|
1394
1408
|
* @example
|
|
1395
1409
|
* ```js
|
|
1396
1410
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -1414,14 +1428,12 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
1414
1428
|
protected handleRenderForPrerender(): void;
|
|
1415
1429
|
/**
|
|
1416
1430
|
* Triggers an event to the embedded app
|
|
1417
|
-
*
|
|
1418
1431
|
* @param messageType The event type
|
|
1419
1432
|
* @param data The payload to send with the message
|
|
1420
1433
|
*/
|
|
1421
1434
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
1422
1435
|
/**
|
|
1423
1436
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
1424
|
-
*
|
|
1425
1437
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
1426
1438
|
* visualization ID and the runtime filters.
|
|
1427
1439
|
*/
|
|
@@ -1477,7 +1489,6 @@ export declare const handleAuth: () => Promise<boolean>;
|
|
|
1477
1489
|
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
1478
1490
|
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
1479
1491
|
* to your app.
|
|
1480
|
-
*
|
|
1481
1492
|
* @param url The URL provided for prefetch
|
|
1482
1493
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
1483
1494
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -1489,7 +1500,6 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
|
|
|
1489
1500
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
1490
1501
|
* component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
|
|
1491
1502
|
* to actually embed. That is handled internally.
|
|
1492
|
-
*
|
|
1493
1503
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
1494
1504
|
* authentication mechanism and so on.
|
|
1495
1505
|
* @example
|
|
@@ -1516,7 +1526,6 @@ export declare function disableAutoLogin(): void;
|
|
|
1516
1526
|
*
|
|
1517
1527
|
* You can call the `init` method again to re login, if autoLogin is set to
|
|
1518
1528
|
* true in this second call it will be honored.
|
|
1519
|
-
*
|
|
1520
1529
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
1521
1530
|
* @returns Promise which resolves when logout completes.
|
|
1522
1531
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
@@ -1526,13 +1535,11 @@ export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolea
|
|
|
1526
1535
|
/**
|
|
1527
1536
|
* Renders functions in a queue, resolves to next function only after the callback next
|
|
1528
1537
|
* is called
|
|
1529
|
-
*
|
|
1530
1538
|
* @param fn The function being registered
|
|
1531
1539
|
*/
|
|
1532
1540
|
export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
1533
1541
|
/**
|
|
1534
1542
|
* Imports TML representation of the metadata objects into ThoughtSpot.
|
|
1535
|
-
*
|
|
1536
1543
|
* @param data
|
|
1537
1544
|
* @example
|
|
1538
1545
|
* ```js
|
|
@@ -1557,7 +1564,6 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
1557
1564
|
/**
|
|
1558
1565
|
* Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
|
|
1559
1566
|
* format.
|
|
1560
|
-
*
|
|
1561
1567
|
* @param data
|
|
1562
1568
|
* @example
|
|
1563
1569
|
* ```js
|
|
@@ -1594,10 +1600,15 @@ export declare let loggedInStatus: boolean;
|
|
|
1594
1600
|
export declare let samlAuthWindow: Window;
|
|
1595
1601
|
export declare let samlCompletionPromise: Promise<void>;
|
|
1596
1602
|
export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
|
|
1603
|
+
interface sessionInfoInterface {
|
|
1604
|
+
userGUID: any;
|
|
1605
|
+
isPublicUser: any;
|
|
1606
|
+
mixpanelToken: any;
|
|
1607
|
+
[key: string]: any;
|
|
1608
|
+
}
|
|
1597
1609
|
/**
|
|
1598
1610
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
1599
1611
|
* of {@link AuthStatus.FAILURE}.
|
|
1600
|
-
*
|
|
1601
1612
|
* @group Authentication / Init
|
|
1602
1613
|
*/
|
|
1603
1614
|
export declare enum AuthFailureType {
|
|
@@ -1608,7 +1619,6 @@ export declare enum AuthFailureType {
|
|
|
1608
1619
|
}
|
|
1609
1620
|
/**
|
|
1610
1621
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
1611
|
-
*
|
|
1612
1622
|
* @group Authentication / Init
|
|
1613
1623
|
*/
|
|
1614
1624
|
export declare enum AuthStatus {
|
|
@@ -1632,27 +1642,23 @@ export declare enum AuthStatus {
|
|
|
1632
1642
|
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
1633
1643
|
* popup is waiting to be triggered either programmatically
|
|
1634
1644
|
* or by the trigger button.
|
|
1635
|
-
*
|
|
1636
1645
|
* @version SDK: 1.19.0
|
|
1637
1646
|
*/
|
|
1638
1647
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
1639
1648
|
}
|
|
1640
1649
|
/**
|
|
1641
1650
|
* Event emitter returned from {@link init}.
|
|
1642
|
-
*
|
|
1643
1651
|
* @group Authentication / Init
|
|
1644
1652
|
*/
|
|
1645
1653
|
export interface AuthEventEmitter {
|
|
1646
1654
|
/**
|
|
1647
1655
|
* Register a listener on Auth failure.
|
|
1648
|
-
*
|
|
1649
1656
|
* @param event
|
|
1650
1657
|
* @param listener
|
|
1651
1658
|
*/
|
|
1652
1659
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
1653
1660
|
/**
|
|
1654
1661
|
* Register a listener on Auth SDK success.
|
|
1655
|
-
*
|
|
1656
1662
|
* @param event
|
|
1657
1663
|
* @param listener
|
|
1658
1664
|
*/
|
|
@@ -1663,13 +1669,11 @@ export interface AuthEventEmitter {
|
|
|
1663
1669
|
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
1664
1670
|
/**
|
|
1665
1671
|
* Trigger an event on the emitter returned from init.
|
|
1666
|
-
*
|
|
1667
1672
|
* @param {@link AuthEvent}
|
|
1668
1673
|
*/
|
|
1669
1674
|
emit(event: AuthEvent, ...args: any[]): boolean;
|
|
1670
1675
|
/**
|
|
1671
1676
|
* Remove listener from the emitter returned from init.
|
|
1672
|
-
*
|
|
1673
1677
|
* @param event
|
|
1674
1678
|
* @param listener
|
|
1675
1679
|
* @param context
|
|
@@ -1678,14 +1682,12 @@ export interface AuthEventEmitter {
|
|
|
1678
1682
|
off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
|
|
1679
1683
|
/**
|
|
1680
1684
|
* Remove all the event listeners
|
|
1681
|
-
*
|
|
1682
1685
|
* @param event
|
|
1683
1686
|
*/
|
|
1684
1687
|
removeAllListeners(event: AuthStatus): this;
|
|
1685
1688
|
}
|
|
1686
1689
|
/**
|
|
1687
1690
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
1688
|
-
*
|
|
1689
1691
|
* @group Authentication / Init
|
|
1690
1692
|
*/
|
|
1691
1693
|
export declare enum AuthEvent {
|
|
@@ -1711,7 +1713,7 @@ export declare function notifyAuthSDKSuccess(): void;
|
|
|
1711
1713
|
/**
|
|
1712
1714
|
*
|
|
1713
1715
|
*/
|
|
1714
|
-
export declare function notifyAuthSuccess():
|
|
1716
|
+
export declare function notifyAuthSuccess(): void;
|
|
1715
1717
|
/**
|
|
1716
1718
|
*
|
|
1717
1719
|
* @param failureType
|
|
@@ -1721,32 +1723,25 @@ export declare function notifyAuthFailure(failureType: AuthFailureType): void;
|
|
|
1721
1723
|
*
|
|
1722
1724
|
*/
|
|
1723
1725
|
export declare function notifyLogout(): void;
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
* This should be called after the cookie is set for cookie auth or
|
|
1727
|
-
* after the token is set for cookieless.
|
|
1728
|
-
*
|
|
1729
|
-
* @return {Promise<void>}
|
|
1730
|
-
* @example
|
|
1731
|
-
* ```js
|
|
1732
|
-
* await postLoginService();
|
|
1733
|
-
* ```
|
|
1734
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1735
|
-
*/
|
|
1736
|
-
export declare function postLoginService(): Promise<void>;
|
|
1726
|
+
export declare const initSession: (sessionDetails: sessionInfoInterface) => void;
|
|
1727
|
+
export declare const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
|
|
1737
1728
|
/**
|
|
1738
1729
|
* Return releaseVersion if available
|
|
1739
1730
|
*/
|
|
1740
1731
|
export declare function getReleaseVersion(): string;
|
|
1732
|
+
/**
|
|
1733
|
+
* Return a promise that resolves with the session information when
|
|
1734
|
+
* authentication is successful. And info is available.
|
|
1735
|
+
* @group Global methods
|
|
1736
|
+
*/
|
|
1737
|
+
export declare function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
1741
1738
|
/**
|
|
1742
1739
|
* Perform token based authentication
|
|
1743
|
-
*
|
|
1744
1740
|
* @param embedConfig The embed configuration
|
|
1745
1741
|
*/
|
|
1746
1742
|
export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1747
1743
|
/**
|
|
1748
1744
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
1749
|
-
*
|
|
1750
1745
|
* @param embedConfig The embed configuration
|
|
1751
1746
|
*/
|
|
1752
1747
|
export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1756,7 +1751,6 @@ export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promis
|
|
|
1756
1751
|
*
|
|
1757
1752
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1758
1753
|
* strongly advised not to use this authentication method in production.
|
|
1759
|
-
*
|
|
1760
1754
|
* @param embedConfig The embed configuration
|
|
1761
1755
|
*/
|
|
1762
1756
|
export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1765,7 +1759,6 @@ export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
1765
1759
|
export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1766
1760
|
/**
|
|
1767
1761
|
* Perform authentication on the ThoughtSpot cluster
|
|
1768
|
-
*
|
|
1769
1762
|
* @param embedConfig The embed configuration
|
|
1770
1763
|
*/
|
|
1771
1764
|
export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1773,92 +1766,24 @@ export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean
|
|
|
1773
1766
|
* Check if we are authenticated to the ThoughtSpot cluster
|
|
1774
1767
|
*/
|
|
1775
1768
|
export declare const isAuthenticated: () => boolean;
|
|
1776
|
-
|
|
1777
|
-
export type SessionInfo = {
|
|
1778
|
-
releaseVersion: string;
|
|
1779
|
-
userGUID: string;
|
|
1780
|
-
currentOrgId: number;
|
|
1781
|
-
privileges: string[];
|
|
1782
|
-
mixpanelToken: string;
|
|
1783
|
-
isPublicUser: boolean;
|
|
1784
|
-
clusterId: string;
|
|
1785
|
-
clusterName: string;
|
|
1786
|
-
[key: string]: any;
|
|
1787
|
-
};
|
|
1788
|
-
/**
|
|
1789
|
-
* Returns the session info object and caches it for future use.
|
|
1790
|
-
* Once fetched the session info object is cached and returned from the cache on
|
|
1791
|
-
* subsequent calls.
|
|
1792
|
-
*
|
|
1793
|
-
* @example ```js
|
|
1794
|
-
* const sessionInfo = await getSessionInfo();
|
|
1795
|
-
* console.log(sessionInfo);
|
|
1796
|
-
* ```
|
|
1797
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1798
|
-
* @returns {Promise<SessionInfo>} The session info object.
|
|
1799
|
-
*/
|
|
1800
|
-
export declare function getSessionInfo(): Promise<SessionInfo>;
|
|
1801
|
-
/**
|
|
1802
|
-
* Returns the cached session info object. If the client is not authenticated the
|
|
1803
|
-
* function will return null.
|
|
1804
|
-
*
|
|
1805
|
-
* @example ```js
|
|
1806
|
-
* const sessionInfo = getCachedSessionInfo();
|
|
1807
|
-
* if (sessionInfo) {
|
|
1808
|
-
* console.log(sessionInfo);
|
|
1809
|
-
* } else {
|
|
1810
|
-
* console.log('Not authenticated');
|
|
1811
|
-
* }
|
|
1812
|
-
* ```
|
|
1813
|
-
* @returns {SessionInfo | null} The session info object.
|
|
1814
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1815
|
-
*/
|
|
1816
|
-
export declare function getCachedSessionInfo(): SessionInfo | null;
|
|
1817
|
-
/**
|
|
1818
|
-
* Processes the session info response and returns the session info object.
|
|
1819
|
-
*
|
|
1820
|
-
* @param sessionInfoResp {any} Response from the session info API.
|
|
1821
|
-
* @returns {SessionInfo} The session info object.
|
|
1822
|
-
* @example ```js
|
|
1823
|
-
* const sessionInfoResp = await fetch(sessionInfoPath);
|
|
1824
|
-
* const sessionInfo = getSessionDetails(sessionInfoResp);
|
|
1825
|
-
* console.log(sessionInfo);
|
|
1826
|
-
* ```
|
|
1827
|
-
* @version SDK: 1.28.3 | ThoughtSpot: *
|
|
1828
|
-
*/
|
|
1829
|
-
export declare const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
|
|
1830
|
-
/**
|
|
1831
|
-
* Resets the cached session info object and forces a new fetch on the next call.
|
|
1832
|
-
*
|
|
1833
|
-
* @example ```js
|
|
1834
|
-
* resetCachedSessionInfo();
|
|
1835
|
-
* const sessionInfo = await getSessionInfo();
|
|
1836
|
-
* console.log(sessionInfo);
|
|
1837
|
-
* ```
|
|
1838
|
-
* @version SDK: 1.28.3 | ThoughtSpot ts7.april.cl, 7.2.1
|
|
1839
|
-
* @returns {void}
|
|
1840
|
-
*/
|
|
1841
|
-
export declare function resetCachedSessionInfo(): void;
|
|
1769
|
+
export {};
|
|
1842
1770
|
|
|
1843
1771
|
/**
|
|
1844
1772
|
* Copyright (c) 2023
|
|
1845
1773
|
*
|
|
1846
1774
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
1847
|
-
*
|
|
1848
1775
|
* @summary Type definitions for Embed SDK
|
|
1849
1776
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1850
1777
|
*/
|
|
1851
1778
|
/**
|
|
1852
1779
|
* The authentication mechanism for allowing access to the
|
|
1853
1780
|
* the embedded app
|
|
1854
|
-
*
|
|
1855
1781
|
* @group Authentication / Init
|
|
1856
1782
|
*/
|
|
1857
1783
|
export declare enum AuthType {
|
|
1858
1784
|
/**
|
|
1859
1785
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
1860
1786
|
* `Passthrough`.
|
|
1861
|
-
*
|
|
1862
1787
|
* @example
|
|
1863
1788
|
* ```js
|
|
1864
1789
|
* init({
|
|
@@ -1876,7 +1801,6 @@ export declare enum AuthType {
|
|
|
1876
1801
|
* To use this:
|
|
1877
1802
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1878
1803
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1879
|
-
*
|
|
1880
1804
|
* @example
|
|
1881
1805
|
* ```js
|
|
1882
1806
|
* init({
|
|
@@ -1889,14 +1813,12 @@ export declare enum AuthType {
|
|
|
1889
1813
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1890
1814
|
/**
|
|
1891
1815
|
* SSO using SAML
|
|
1892
|
-
*
|
|
1893
1816
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1894
1817
|
* @hidden
|
|
1895
1818
|
*/
|
|
1896
1819
|
SSO = "SSO_SAML",
|
|
1897
1820
|
/**
|
|
1898
1821
|
* SSO using SAML
|
|
1899
|
-
*
|
|
1900
1822
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1901
1823
|
* @hidden
|
|
1902
1824
|
*/
|
|
@@ -1908,7 +1830,6 @@ export declare enum AuthType {
|
|
|
1908
1830
|
*
|
|
1909
1831
|
* This redirects the host application to the SAML IdP. The host application
|
|
1910
1832
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1911
|
-
*
|
|
1912
1833
|
* @example
|
|
1913
1834
|
* ```js
|
|
1914
1835
|
* init({
|
|
@@ -1949,7 +1870,6 @@ export declare enum AuthType {
|
|
|
1949
1870
|
SAMLRedirect = "SSO_SAML",
|
|
1950
1871
|
/**
|
|
1951
1872
|
* SSO using OIDC
|
|
1952
|
-
*
|
|
1953
1873
|
* @hidden
|
|
1954
1874
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
1955
1875
|
*/
|
|
@@ -1962,7 +1882,6 @@ export declare enum AuthType {
|
|
|
1962
1882
|
OIDCRedirect = "SSO_OIDC",
|
|
1963
1883
|
/**
|
|
1964
1884
|
* Trusted authentication server
|
|
1965
|
-
*
|
|
1966
1885
|
* @hidden
|
|
1967
1886
|
* @deprecated Use {@link TrustedAuth} instead
|
|
1968
1887
|
*/
|
|
@@ -1971,7 +1890,6 @@ export declare enum AuthType {
|
|
|
1971
1890
|
* Trusted authentication server. Use your own authentication server
|
|
1972
1891
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1973
1892
|
* from ThoughtSpot.
|
|
1974
|
-
*
|
|
1975
1893
|
* @example
|
|
1976
1894
|
* ```js
|
|
1977
1895
|
* init({
|
|
@@ -1983,6 +1901,7 @@ export declare enum AuthType {
|
|
|
1983
1901
|
* .then((data) => data.token);
|
|
1984
1902
|
* }
|
|
1985
1903
|
* });
|
|
1904
|
+
* });
|
|
1986
1905
|
* ```
|
|
1987
1906
|
*/
|
|
1988
1907
|
TrustedAuthToken = "AuthServer",
|
|
@@ -1992,7 +1911,6 @@ export declare enum AuthType {
|
|
|
1992
1911
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1993
1912
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1994
1913
|
* implemented by some browsers.
|
|
1995
|
-
*
|
|
1996
1914
|
* @example
|
|
1997
1915
|
* ```js
|
|
1998
1916
|
* init({
|
|
@@ -2065,7 +1983,6 @@ export interface customCssInterface {
|
|
|
2065
1983
|
/**
|
|
2066
1984
|
* Can be used to define a custom font face
|
|
2067
1985
|
* like:
|
|
2068
|
-
*
|
|
2069
1986
|
* @example
|
|
2070
1987
|
* ```js
|
|
2071
1988
|
* rules_UNSTABLE?: {
|
|
@@ -2105,7 +2022,6 @@ export interface CustomStyles {
|
|
|
2105
2022
|
* Thoughtspot components.
|
|
2106
2023
|
* You can customize styles, text strings, and icons.
|
|
2107
2024
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2108
|
-
*
|
|
2109
2025
|
* @example
|
|
2110
2026
|
* ```js
|
|
2111
2027
|
* init({
|
|
@@ -2148,7 +2064,6 @@ export interface CustomisationsInterface {
|
|
|
2148
2064
|
* It includes the ThoughtSpot hostname or IP address,
|
|
2149
2065
|
* the type of authentication, and the authentication endpoint
|
|
2150
2066
|
* if a trusted authentication server is used.
|
|
2151
|
-
*
|
|
2152
2067
|
* @group Authentication / Init
|
|
2153
2068
|
*/
|
|
2154
2069
|
export interface EmbedConfig {
|
|
@@ -2196,7 +2111,6 @@ export interface EmbedConfig {
|
|
|
2196
2111
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
2197
2112
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
2198
2113
|
* place.
|
|
2199
|
-
*
|
|
2200
2114
|
* @default false
|
|
2201
2115
|
* @deprecated
|
|
2202
2116
|
*/
|
|
@@ -2207,7 +2121,6 @@ export interface EmbedConfig {
|
|
|
2207
2121
|
*
|
|
2208
2122
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
2209
2123
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
2210
|
-
*
|
|
2211
2124
|
* @default false
|
|
2212
2125
|
* @version SDK: 1.18.0
|
|
2213
2126
|
*/
|
|
@@ -2218,7 +2131,6 @@ export interface EmbedConfig {
|
|
|
2218
2131
|
* terminated.
|
|
2219
2132
|
*
|
|
2220
2133
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
2221
|
-
*
|
|
2222
2134
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
2223
2135
|
*/
|
|
2224
2136
|
redirectPath?: string;
|
|
@@ -2228,7 +2140,6 @@ export interface EmbedConfig {
|
|
|
2228
2140
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
2229
2141
|
* should be encoded in base64. This provides additional security to
|
|
2230
2142
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
2231
|
-
*
|
|
2232
2143
|
* @default false
|
|
2233
2144
|
*/
|
|
2234
2145
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -2238,7 +2149,6 @@ export interface EmbedConfig {
|
|
|
2238
2149
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
2239
2150
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
2240
2151
|
* in this case.
|
|
2241
|
-
*
|
|
2242
2152
|
* @default false
|
|
2243
2153
|
*/
|
|
2244
2154
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -2246,14 +2156,12 @@ export interface EmbedConfig {
|
|
|
2246
2156
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
2247
2157
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
2248
2158
|
* persists even in the case of a non-logged-in user.
|
|
2249
|
-
*
|
|
2250
2159
|
* @default false
|
|
2251
2160
|
*/
|
|
2252
2161
|
ignoreNoCookieAccess?: boolean;
|
|
2253
2162
|
/**
|
|
2254
2163
|
* Re-login a user with the previous login options
|
|
2255
2164
|
* when a user session expires.
|
|
2256
|
-
*
|
|
2257
2165
|
* @default false
|
|
2258
2166
|
*/
|
|
2259
2167
|
autoLogin?: boolean;
|
|
@@ -2262,20 +2170,17 @@ export interface EmbedConfig {
|
|
|
2262
2170
|
* This flag is typically used alongside the combination of authentication modes such
|
|
2263
2171
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
2264
2172
|
* EmbedConfig.autoLogin}
|
|
2265
|
-
*
|
|
2266
2173
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
2267
2174
|
* @default false
|
|
2268
2175
|
*/
|
|
2269
2176
|
disableLoginRedirect?: boolean;
|
|
2270
2177
|
/**
|
|
2271
2178
|
* This message is displayed in the embedded view when a user login fails.
|
|
2272
|
-
*
|
|
2273
2179
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2274
2180
|
*/
|
|
2275
2181
|
loginFailedMessage?: string;
|
|
2276
2182
|
/**
|
|
2277
2183
|
* Calls the prefetch method internally when set to `true`
|
|
2278
|
-
*
|
|
2279
2184
|
* @default false
|
|
2280
2185
|
*/
|
|
2281
2186
|
callPrefetch?: boolean;
|
|
@@ -2283,7 +2188,6 @@ export interface EmbedConfig {
|
|
|
2283
2188
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
2284
2189
|
* to start after the previous embed's render is complete. This helps improve
|
|
2285
2190
|
* performance by decreasing the load on the browser.
|
|
2286
|
-
*
|
|
2287
2191
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2288
2192
|
* @default false
|
|
2289
2193
|
*/
|
|
@@ -2291,7 +2195,6 @@ export interface EmbedConfig {
|
|
|
2291
2195
|
/**
|
|
2292
2196
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
2293
2197
|
* You would also need to set `style-src` in the CSP settings.
|
|
2294
|
-
*
|
|
2295
2198
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2296
2199
|
* @default ''
|
|
2297
2200
|
*/
|
|
@@ -2303,13 +2206,11 @@ export interface EmbedConfig {
|
|
|
2303
2206
|
*
|
|
2304
2207
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
2305
2208
|
* involves an extra network call.
|
|
2306
|
-
*
|
|
2307
2209
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2308
2210
|
*/
|
|
2309
2211
|
detectCookieAccessSlow?: boolean;
|
|
2310
2212
|
/**
|
|
2311
2213
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
2312
|
-
*
|
|
2313
2214
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
2314
2215
|
*/
|
|
2315
2216
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -2320,7 +2221,6 @@ export interface EmbedConfig {
|
|
|
2320
2221
|
suppressSageEmbedBetaWarning?: boolean;
|
|
2321
2222
|
/**
|
|
2322
2223
|
* Custom style params for embed Config.
|
|
2323
|
-
*
|
|
2324
2224
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2325
2225
|
*/
|
|
2326
2226
|
customizations?: CustomisationsInterface;
|
|
@@ -2328,7 +2228,6 @@ export interface EmbedConfig {
|
|
|
2328
2228
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
2329
2229
|
* button that the user can click to trigger the flow.
|
|
2330
2230
|
* This attribute sets a containing element for that button.
|
|
2331
|
-
*
|
|
2332
2231
|
* @example
|
|
2333
2232
|
* ```js
|
|
2334
2233
|
* init({
|
|
@@ -2350,7 +2249,6 @@ export interface EmbedConfig {
|
|
|
2350
2249
|
/**
|
|
2351
2250
|
* Text to show in the button which triggers the popup auth flow.
|
|
2352
2251
|
* Default: `Authorize`.
|
|
2353
|
-
*
|
|
2354
2252
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2355
2253
|
*/
|
|
2356
2254
|
authTriggerText?: string;
|
|
@@ -2358,14 +2256,12 @@ export interface EmbedConfig {
|
|
|
2358
2256
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
2359
2257
|
* access to the embedded application users
|
|
2360
2258
|
* outside of the iframe.
|
|
2361
|
-
*
|
|
2362
2259
|
* @default true
|
|
2363
2260
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
2364
2261
|
*/
|
|
2365
2262
|
blockNonEmbedFullAppAccess?: boolean;
|
|
2366
2263
|
/**
|
|
2367
2264
|
* Host config in case embedded app is inside TS app itself
|
|
2368
|
-
*
|
|
2369
2265
|
* @hidden
|
|
2370
2266
|
*/
|
|
2371
2267
|
hostConfig?: {
|
|
@@ -2376,19 +2272,16 @@ export interface EmbedConfig {
|
|
|
2376
2272
|
/**
|
|
2377
2273
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
2378
2274
|
* 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).
|
|
2379
|
-
*
|
|
2380
2275
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
2381
2276
|
*/
|
|
2382
2277
|
pendoTrackingKey?: string;
|
|
2383
2278
|
/**
|
|
2384
2279
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
2385
|
-
*
|
|
2386
2280
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
2387
2281
|
*/
|
|
2388
2282
|
suppressErrorAlerts?: boolean;
|
|
2389
2283
|
/**
|
|
2390
2284
|
* Log level for the SDK.
|
|
2391
|
-
*
|
|
2392
2285
|
* @default LogLevel.ERROR
|
|
2393
2286
|
* @example
|
|
2394
2287
|
* ```js
|
|
@@ -2402,16 +2295,43 @@ export interface EmbedConfig {
|
|
|
2402
2295
|
logLevel?: LogLevel;
|
|
2403
2296
|
/**
|
|
2404
2297
|
* Disables the Mixpanel tracking from the SDK.
|
|
2405
|
-
*
|
|
2406
2298
|
* @version SDK: 1.27.9
|
|
2407
2299
|
*/
|
|
2408
2300
|
disableSDKTracking?: boolean;
|
|
2301
|
+
/**
|
|
2302
|
+
* Overrides default/user preffered locale for date formatting
|
|
2303
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2304
|
+
*/
|
|
2305
|
+
dateFormatLocale?: string;
|
|
2306
|
+
/**
|
|
2307
|
+
* Overrides default/user preffered locale for number formatting
|
|
2308
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2309
|
+
*/
|
|
2310
|
+
numberFormatLocale?: string;
|
|
2311
|
+
/**
|
|
2312
|
+
* Format to be used for currency when currency format is set to infer from browser
|
|
2313
|
+
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2314
|
+
*/
|
|
2315
|
+
currencyFormat?: string;
|
|
2316
|
+
/**
|
|
2317
|
+
* This flag is used to disable the token verification in the SDK.
|
|
2318
|
+
* Enabling this flag will also disable the caching of the token.
|
|
2319
|
+
* @hidden
|
|
2320
|
+
* @example
|
|
2321
|
+
* ```js
|
|
2322
|
+
* init({
|
|
2323
|
+
* ...embedConfig,
|
|
2324
|
+
* disableTokenVerification : true
|
|
2325
|
+
* })
|
|
2326
|
+
* ```
|
|
2327
|
+
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
2328
|
+
*/
|
|
2329
|
+
disableTokenVerification?: boolean;
|
|
2409
2330
|
}
|
|
2410
2331
|
export interface LayoutConfig {
|
|
2411
2332
|
}
|
|
2412
2333
|
/**
|
|
2413
2334
|
* Embedded iframe configuration
|
|
2414
|
-
*
|
|
2415
2335
|
* @group Embed components
|
|
2416
2336
|
*/
|
|
2417
2337
|
export interface FrameParams {
|
|
@@ -2446,9 +2366,7 @@ export interface ViewConfig {
|
|
|
2446
2366
|
/**
|
|
2447
2367
|
* The width and height dimensions to render an embedded
|
|
2448
2368
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2449
|
-
*
|
|
2450
2369
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2451
|
-
*
|
|
2452
2370
|
* @example
|
|
2453
2371
|
* ```js
|
|
2454
2372
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2474,7 +2392,6 @@ export interface ViewConfig {
|
|
|
2474
2392
|
* (...), and the contextual menu. These actions will be disabled
|
|
2475
2393
|
* for the user.
|
|
2476
2394
|
* Use this to disable actions.
|
|
2477
|
-
*
|
|
2478
2395
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2479
2396
|
* @example
|
|
2480
2397
|
* ```js
|
|
@@ -2502,9 +2419,7 @@ export interface ViewConfig {
|
|
|
2502
2419
|
* The list of actions to hide from the embedded.
|
|
2503
2420
|
* This actions will be hidden from the user.
|
|
2504
2421
|
* Use this to hide an action.
|
|
2505
|
-
*
|
|
2506
2422
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2507
|
-
*
|
|
2508
2423
|
* @example
|
|
2509
2424
|
* ```js
|
|
2510
2425
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2522,10 +2437,8 @@ export interface ViewConfig {
|
|
|
2522
2437
|
* Use this to hide all actions except the ones you want to show.
|
|
2523
2438
|
*
|
|
2524
2439
|
* Use either this or hiddenActions.
|
|
2525
|
-
*
|
|
2526
2440
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2527
2441
|
* @important
|
|
2528
|
-
*
|
|
2529
2442
|
* @example
|
|
2530
2443
|
* ```js
|
|
2531
2444
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2537,9 +2450,7 @@ export interface ViewConfig {
|
|
|
2537
2450
|
visibleActions?: Action[];
|
|
2538
2451
|
/**
|
|
2539
2452
|
* Show alert messages and toast messages in the embedded view.
|
|
2540
|
-
*
|
|
2541
2453
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2542
|
-
*
|
|
2543
2454
|
* @example
|
|
2544
2455
|
* ```js
|
|
2545
2456
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2552,9 +2463,7 @@ export interface ViewConfig {
|
|
|
2552
2463
|
/**
|
|
2553
2464
|
* The list of runtime filters to apply to a search answer,
|
|
2554
2465
|
* visualization, or Liveboard.
|
|
2555
|
-
*
|
|
2556
2466
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2557
|
-
*
|
|
2558
2467
|
* @example
|
|
2559
2468
|
* ```js
|
|
2560
2469
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2573,9 +2482,7 @@ export interface ViewConfig {
|
|
|
2573
2482
|
/**
|
|
2574
2483
|
* The list of parameter override to apply to a search answer,
|
|
2575
2484
|
* visualization, or Liveboard.
|
|
2576
|
-
*
|
|
2577
2485
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2578
|
-
*
|
|
2579
2486
|
* @example
|
|
2580
2487
|
* ```js
|
|
2581
2488
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2592,7 +2499,6 @@ export interface ViewConfig {
|
|
|
2592
2499
|
runtimeParameters?: RuntimeParameter[];
|
|
2593
2500
|
/**
|
|
2594
2501
|
* The locale/language to use for the embedded view.
|
|
2595
|
-
*
|
|
2596
2502
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2597
2503
|
* @example
|
|
2598
2504
|
* ```js
|
|
@@ -2628,7 +2534,6 @@ export interface ViewConfig {
|
|
|
2628
2534
|
/**
|
|
2629
2535
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
2630
2536
|
* You would also need to set `style-src` in the CSP settings.
|
|
2631
|
-
*
|
|
2632
2537
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
2633
2538
|
* @default ''
|
|
2634
2539
|
*/
|
|
@@ -2636,9 +2541,7 @@ export interface ViewConfig {
|
|
|
2636
2541
|
/**
|
|
2637
2542
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2638
2543
|
* child inside it.
|
|
2639
|
-
*
|
|
2640
2544
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2641
|
-
*
|
|
2642
2545
|
* @example
|
|
2643
2546
|
* ```js
|
|
2644
2547
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2650,7 +2553,6 @@ export interface ViewConfig {
|
|
|
2650
2553
|
insertAsSibling?: boolean;
|
|
2651
2554
|
/**
|
|
2652
2555
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2653
|
-
*
|
|
2654
2556
|
* @example
|
|
2655
2557
|
* ```js
|
|
2656
2558
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2663,7 +2565,6 @@ export interface ViewConfig {
|
|
|
2663
2565
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2664
2566
|
/**
|
|
2665
2567
|
* Flag to override openNew tab context menu link
|
|
2666
|
-
*
|
|
2667
2568
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2668
2569
|
* @example
|
|
2669
2570
|
* ```js
|
|
@@ -2676,7 +2577,6 @@ export interface ViewConfig {
|
|
|
2676
2577
|
linkOverride?: boolean;
|
|
2677
2578
|
/**
|
|
2678
2579
|
* flag to enable insert into slides action
|
|
2679
|
-
*
|
|
2680
2580
|
* @hidden
|
|
2681
2581
|
* @private
|
|
2682
2582
|
*/
|
|
@@ -2684,7 +2584,6 @@ export interface ViewConfig {
|
|
|
2684
2584
|
/**
|
|
2685
2585
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2686
2586
|
* if available and matches the configuration.
|
|
2687
|
-
*
|
|
2688
2587
|
* @version SDK: 1.22.0
|
|
2689
2588
|
* @hidden
|
|
2690
2589
|
*
|
|
@@ -2698,7 +2597,6 @@ export interface ViewConfig {
|
|
|
2698
2597
|
*
|
|
2699
2598
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2700
2599
|
* embedded view.
|
|
2701
|
-
*
|
|
2702
2600
|
* @default false
|
|
2703
2601
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2704
2602
|
*/
|
|
@@ -2707,7 +2605,6 @@ export interface ViewConfig {
|
|
|
2707
2605
|
* The list of tab IDs to hide from the embedded.
|
|
2708
2606
|
* This Tabs will be hidden from their respective LBs.
|
|
2709
2607
|
* Use this to hide an tabID.
|
|
2710
|
-
*
|
|
2711
2608
|
* @example
|
|
2712
2609
|
* ```js
|
|
2713
2610
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2724,10 +2621,11 @@ export interface ViewConfig {
|
|
|
2724
2621
|
* Hide the home page modules
|
|
2725
2622
|
* For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
2726
2623
|
*
|
|
2624
|
+
*
|
|
2625
|
+
*
|
|
2727
2626
|
* **Note**: This option does not apply to the classic homepage.
|
|
2728
2627
|
* To access the updated modular homepage, set
|
|
2729
2628
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2730
|
-
*
|
|
2731
2629
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2732
2630
|
* @example
|
|
2733
2631
|
* ```js
|
|
@@ -2736,19 +2634,17 @@ export interface ViewConfig {
|
|
|
2736
2634
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2737
2635
|
* })
|
|
2738
2636
|
* ```
|
|
2739
|
-
*
|
|
2740
2637
|
*/
|
|
2741
2638
|
hiddenHomepageModules?: HomepageModule[];
|
|
2742
2639
|
/**
|
|
2743
2640
|
* reordering the home page modules
|
|
2744
2641
|
* eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
|
|
2745
2642
|
*
|
|
2643
|
+
*
|
|
2746
2644
|
* **Note**: This option does not apply to the classic homepage.
|
|
2747
2645
|
* To access the updated modular homepage, set
|
|
2748
2646
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2749
|
-
*
|
|
2750
2647
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
2751
|
-
*
|
|
2752
2648
|
* @example
|
|
2753
2649
|
* ```js
|
|
2754
2650
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2763,9 +2659,7 @@ export interface ViewConfig {
|
|
|
2763
2659
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2764
2660
|
*
|
|
2765
2661
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2766
|
-
*
|
|
2767
2662
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2768
|
-
*
|
|
2769
2663
|
* @example
|
|
2770
2664
|
* ```js
|
|
2771
2665
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2782,8 +2676,7 @@ export interface ViewConfig {
|
|
|
2782
2676
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2783
2677
|
* There are 8 eight home navigation list items.
|
|
2784
2678
|
* To hide these items, specify the string in the array.
|
|
2785
|
-
*
|
|
2786
|
-
* * @example
|
|
2679
|
+
* @example
|
|
2787
2680
|
* ```js
|
|
2788
2681
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2789
2682
|
* ... // other options
|
|
@@ -2791,10 +2684,11 @@ export interface ViewConfig {
|
|
|
2791
2684
|
* })
|
|
2792
2685
|
* ```
|
|
2793
2686
|
*
|
|
2687
|
+
*
|
|
2688
|
+
*
|
|
2794
2689
|
* **Note**: This option does not apply to the classic homepage.
|
|
2795
2690
|
* To access the updated modular homepage, set
|
|
2796
2691
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2797
|
-
*
|
|
2798
2692
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2799
2693
|
*/
|
|
2800
2694
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2802,7 +2696,6 @@ export interface ViewConfig {
|
|
|
2802
2696
|
* PreRender id to be used for PreRendering the embed.
|
|
2803
2697
|
* Use PreRender to render the embed in the background and then
|
|
2804
2698
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2805
|
-
*
|
|
2806
2699
|
* @example
|
|
2807
2700
|
* ```js
|
|
2808
2701
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2819,11 +2712,9 @@ export interface ViewConfig {
|
|
|
2819
2712
|
* of its embedding element and adjust its own size accordingly.
|
|
2820
2713
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2821
2714
|
* its dimensions based on changes to the size of the embedding element.
|
|
2822
|
-
*
|
|
2823
2715
|
* @type {boolean}
|
|
2824
2716
|
* @default false
|
|
2825
2717
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2826
|
-
*
|
|
2827
2718
|
* @example
|
|
2828
2719
|
* ```js
|
|
2829
2720
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2838,14 +2729,22 @@ export interface ViewConfig {
|
|
|
2838
2729
|
doNotTrackPreRenderSize?: boolean;
|
|
2839
2730
|
/**
|
|
2840
2731
|
* For internal tracking of the embed component type.
|
|
2841
|
-
*
|
|
2842
2732
|
* @hidden
|
|
2843
2733
|
*/
|
|
2844
2734
|
embedComponentType?: string;
|
|
2735
|
+
/**
|
|
2736
|
+
* Boolean to exclude runtimeParameters from the URL
|
|
2737
|
+
* when set to true, this flag removes runtime parameters from the URL.
|
|
2738
|
+
*
|
|
2739
|
+
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2740
|
+
* embedded view.
|
|
2741
|
+
* @default false
|
|
2742
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2743
|
+
*/
|
|
2744
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
2845
2745
|
}
|
|
2846
2746
|
/**
|
|
2847
2747
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
2848
|
-
*
|
|
2849
2748
|
* @group Events
|
|
2850
2749
|
*/
|
|
2851
2750
|
export type MessagePayload = {
|
|
@@ -2856,7 +2755,6 @@ export type MessagePayload = {
|
|
|
2856
2755
|
/**
|
|
2857
2756
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2858
2757
|
* option
|
|
2859
|
-
*
|
|
2860
2758
|
* @group Events
|
|
2861
2759
|
*/
|
|
2862
2760
|
export type MessageOptions = {
|
|
@@ -2868,7 +2766,6 @@ export type MessageOptions = {
|
|
|
2868
2766
|
};
|
|
2869
2767
|
/**
|
|
2870
2768
|
* MessageCallback: Embed event message callback
|
|
2871
|
-
*
|
|
2872
2769
|
* @group Events
|
|
2873
2770
|
*/
|
|
2874
2771
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -2958,7 +2855,6 @@ export declare enum RuntimeFilterOp {
|
|
|
2958
2855
|
* **Note**: This option does not apply to the classic homepage.
|
|
2959
2856
|
* To access the updated modular homepage, set
|
|
2960
2857
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2961
|
-
*
|
|
2962
2858
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2963
2859
|
*/
|
|
2964
2860
|
export declare enum HomepageModule {
|
|
@@ -3005,7 +2901,7 @@ export interface RuntimeFilter {
|
|
|
3005
2901
|
* a single operand, whereas other operators like BW and IN accept multiple
|
|
3006
2902
|
* operands.
|
|
3007
2903
|
*/
|
|
3008
|
-
values: (number | boolean | string)[];
|
|
2904
|
+
values: (number | boolean | string | bigint)[];
|
|
3009
2905
|
}
|
|
3010
2906
|
/**
|
|
3011
2907
|
* A filter that can be applied to ThoughtSpot Answers, Liveboards, or
|
|
@@ -3026,7 +2922,6 @@ export interface RuntimeParameter {
|
|
|
3026
2922
|
*
|
|
3027
2923
|
* To add an event listener use the corresponding
|
|
3028
2924
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
3029
|
-
*
|
|
3030
2925
|
* @example
|
|
3031
2926
|
* ```js
|
|
3032
2927
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3044,7 +2939,6 @@ export interface RuntimeParameter {
|
|
|
3044
2939
|
export declare enum EmbedEvent {
|
|
3045
2940
|
/**
|
|
3046
2941
|
* Rendering has initialized.
|
|
3047
|
-
*
|
|
3048
2942
|
* @example
|
|
3049
2943
|
*```js
|
|
3050
2944
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -3058,7 +2952,7 @@ export declare enum EmbedEvent {
|
|
|
3058
2952
|
Init = "init",
|
|
3059
2953
|
/**
|
|
3060
2954
|
* Authentication has either succeeded or failed.
|
|
3061
|
-
*
|
|
2955
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3062
2956
|
* @example
|
|
3063
2957
|
*```js
|
|
3064
2958
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -3070,8 +2964,8 @@ export declare enum EmbedEvent {
|
|
|
3070
2964
|
AuthInit = "authInit",
|
|
3071
2965
|
/**
|
|
3072
2966
|
* The embed object container has loaded.
|
|
3073
|
-
*
|
|
3074
2967
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2968
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3075
2969
|
* @example
|
|
3076
2970
|
*```js
|
|
3077
2971
|
* liveboardEmbed.on(EmbedEvent.Load, hideLoader)
|
|
@@ -3084,8 +2978,8 @@ export declare enum EmbedEvent {
|
|
|
3084
2978
|
Load = "load",
|
|
3085
2979
|
/**
|
|
3086
2980
|
* Data pertaining to answer or Liveboard is received
|
|
3087
|
-
*
|
|
3088
2981
|
* @return data - The answer or Liveboard data
|
|
2982
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3089
2983
|
* @example
|
|
3090
2984
|
*```js
|
|
3091
2985
|
* liveboardEmbed.on(EmbedEvent.Data, payload => {
|
|
@@ -3097,13 +2991,12 @@ export declare enum EmbedEvent {
|
|
|
3097
2991
|
Data = "data",
|
|
3098
2992
|
/**
|
|
3099
2993
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
3100
|
-
*
|
|
3101
2994
|
* @hidden
|
|
3102
2995
|
*/
|
|
3103
2996
|
FiltersChanged = "filtersChanged",
|
|
3104
2997
|
/**
|
|
3105
2998
|
* Search query has been updated by the user.
|
|
3106
|
-
*
|
|
2999
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3107
3000
|
* @example
|
|
3108
3001
|
*```js
|
|
3109
3002
|
* searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
|
|
@@ -3112,13 +3005,13 @@ export declare enum EmbedEvent {
|
|
|
3112
3005
|
QueryChanged = "queryChanged",
|
|
3113
3006
|
/**
|
|
3114
3007
|
* A drill-down operation has been performed.
|
|
3115
|
-
*
|
|
3008
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3116
3009
|
* @returns additionalFilters - Any additional filters applied
|
|
3117
3010
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
3118
3011
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
3119
3012
|
* @example
|
|
3120
3013
|
*```js
|
|
3121
|
-
* searchEmbed.
|
|
3014
|
+
* searchEmbed.on(EmbedEvent.DrillDown, {
|
|
3122
3015
|
* points: {
|
|
3123
3016
|
* clickedPoint,
|
|
3124
3017
|
* selectedPoints: selectedPoint
|
|
@@ -3149,8 +3042,8 @@ export declare enum EmbedEvent {
|
|
|
3149
3042
|
Drilldown = "drillDown",
|
|
3150
3043
|
/**
|
|
3151
3044
|
* One or more data sources have been selected.
|
|
3152
|
-
*
|
|
3153
3045
|
* @returns dataSourceIds - the list of data sources
|
|
3046
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3154
3047
|
* @example
|
|
3155
3048
|
* ```js
|
|
3156
3049
|
* searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
|
|
@@ -3161,7 +3054,6 @@ export declare enum EmbedEvent {
|
|
|
3161
3054
|
DataSourceSelected = "dataSourceSelected",
|
|
3162
3055
|
/**
|
|
3163
3056
|
* One or more data columns have been selected.
|
|
3164
|
-
*
|
|
3165
3057
|
* @returns columnIds - the list of columns
|
|
3166
3058
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3167
3059
|
* @example
|
|
@@ -3174,10 +3066,10 @@ export declare enum EmbedEvent {
|
|
|
3174
3066
|
AddRemoveColumns = "addRemoveColumns",
|
|
3175
3067
|
/**
|
|
3176
3068
|
* A custom action has been triggered.
|
|
3177
|
-
*
|
|
3178
3069
|
* @returns actionId - ID of the custom action
|
|
3179
3070
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
3180
3071
|
* Answer or Liveboard data
|
|
3072
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3181
3073
|
* @example
|
|
3182
3074
|
* ```js
|
|
3183
3075
|
* appEmbed.on(EmbedEvent.customAction, payload => {
|
|
@@ -3191,7 +3083,6 @@ export declare enum EmbedEvent {
|
|
|
3191
3083
|
CustomAction = "customAction",
|
|
3192
3084
|
/**
|
|
3193
3085
|
* Listen to double click actions on a visualization.
|
|
3194
|
-
*
|
|
3195
3086
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
3196
3087
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
3197
3088
|
* @example
|
|
@@ -3204,7 +3095,6 @@ export declare enum EmbedEvent {
|
|
|
3204
3095
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
3205
3096
|
/**
|
|
3206
3097
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
3207
|
-
*
|
|
3208
3098
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
3209
3099
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3210
3100
|
* @important
|
|
@@ -3225,21 +3115,22 @@ export declare enum EmbedEvent {
|
|
|
3225
3115
|
/**
|
|
3226
3116
|
* An error has occurred. This event is fired for the following error types:
|
|
3227
3117
|
*
|
|
3228
|
-
*
|
|
3118
|
+
* `API`: API call failure error.
|
|
3229
3119
|
*
|
|
3230
|
-
*
|
|
3120
|
+
* `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
|
|
3121
|
+
* mode.
|
|
3231
3122
|
*
|
|
3232
|
-
*
|
|
3123
|
+
* `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
|
|
3233
3124
|
*
|
|
3234
|
-
*
|
|
3125
|
+
* `NON_EXIST_FILTER`: Error due to a non-existent filter.
|
|
3235
3126
|
*
|
|
3236
|
-
*
|
|
3127
|
+
* `INVALID_DATE_VALUE`: Invalid date value error.
|
|
3237
3128
|
*
|
|
3238
|
-
*
|
|
3239
|
-
*
|
|
3240
|
-
* For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
|
|
3129
|
+
* `INVALID_OPERATOR`: Use of invalid operator during filter application.
|
|
3241
3130
|
*
|
|
3131
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
|
|
3242
3132
|
* @returns error - An error object or message
|
|
3133
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3243
3134
|
* @example
|
|
3244
3135
|
* ```js
|
|
3245
3136
|
* // API error
|
|
@@ -3263,8 +3154,8 @@ export declare enum EmbedEvent {
|
|
|
3263
3154
|
Error = "Error",
|
|
3264
3155
|
/**
|
|
3265
3156
|
* The embedded object has sent an alert.
|
|
3266
|
-
*
|
|
3267
3157
|
* @returns alert - An alert object
|
|
3158
|
+
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3268
3159
|
* @example
|
|
3269
3160
|
* ```js
|
|
3270
3161
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -3273,7 +3164,7 @@ export declare enum EmbedEvent {
|
|
|
3273
3164
|
Alert = "alert",
|
|
3274
3165
|
/**
|
|
3275
3166
|
* The ThoughtSpot auth session has expired.
|
|
3276
|
-
*
|
|
3167
|
+
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3277
3168
|
* @example
|
|
3278
3169
|
*```js
|
|
3279
3170
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -3286,26 +3177,22 @@ export declare enum EmbedEvent {
|
|
|
3286
3177
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3287
3178
|
/**
|
|
3288
3179
|
* ThoughtSpot failed to validate the auth session.
|
|
3289
|
-
*
|
|
3290
3180
|
* @hidden
|
|
3291
3181
|
*/
|
|
3292
3182
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
3293
3183
|
/**
|
|
3294
3184
|
* ThoughtSpot failed to validate the auth session.
|
|
3295
|
-
*
|
|
3296
3185
|
* @hidden
|
|
3297
3186
|
*/
|
|
3298
3187
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
3299
3188
|
/**
|
|
3300
3189
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
3301
|
-
*
|
|
3302
3190
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
3303
3191
|
* @hidden
|
|
3304
3192
|
*/
|
|
3305
3193
|
EmbedHeight = "EMBED_HEIGHT",
|
|
3306
3194
|
/**
|
|
3307
3195
|
* The center of visible iframe viewport is calculated.
|
|
3308
|
-
*
|
|
3309
3196
|
* @returns data - The center of the visible Iframe viewport.
|
|
3310
3197
|
* @hidden
|
|
3311
3198
|
*/
|
|
@@ -3313,7 +3200,6 @@ export declare enum EmbedEvent {
|
|
|
3313
3200
|
/**
|
|
3314
3201
|
* Emitted when the **Get Data** action is initiated.
|
|
3315
3202
|
* Applicable to `SearchBarEmbed` only.
|
|
3316
|
-
*
|
|
3317
3203
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3318
3204
|
* @example
|
|
3319
3205
|
*```js
|
|
@@ -3326,7 +3212,7 @@ export declare enum EmbedEvent {
|
|
|
3326
3212
|
GetDataClick = "getDataClick",
|
|
3327
3213
|
/**
|
|
3328
3214
|
* Detects the route change.
|
|
3329
|
-
*
|
|
3215
|
+
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3330
3216
|
* @example
|
|
3331
3217
|
*```js
|
|
3332
3218
|
* searchEmbed.on(EmbedEvent.RouteChange, payload =>
|
|
@@ -3336,15 +3222,13 @@ export declare enum EmbedEvent {
|
|
|
3336
3222
|
RouteChange = "ROUTE_CHANGE",
|
|
3337
3223
|
/**
|
|
3338
3224
|
* The v1 event type for Data
|
|
3339
|
-
*
|
|
3340
3225
|
* @hidden
|
|
3341
3226
|
*/
|
|
3342
3227
|
V1Data = "exportVizDataToParent",
|
|
3343
3228
|
/**
|
|
3344
3229
|
* Emitted when the embed does not have cookie access. This happens
|
|
3345
3230
|
* when Safari and other Web browsers block third-party cookies
|
|
3346
|
-
* are blocked by default.
|
|
3347
|
-
*
|
|
3231
|
+
* are blocked by default.
|
|
3348
3232
|
* @example
|
|
3349
3233
|
*```js
|
|
3350
3234
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -3354,14 +3238,12 @@ export declare enum EmbedEvent {
|
|
|
3354
3238
|
NoCookieAccess = "noCookieAccess",
|
|
3355
3239
|
/**
|
|
3356
3240
|
* Emitted when SAML is complete
|
|
3357
|
-
*
|
|
3358
3241
|
* @private
|
|
3359
3242
|
* @hidden
|
|
3360
3243
|
*/
|
|
3361
3244
|
SAMLComplete = "samlComplete",
|
|
3362
3245
|
/**
|
|
3363
3246
|
* Emitted when any modal is opened in the app
|
|
3364
|
-
*
|
|
3365
3247
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3366
3248
|
* @example
|
|
3367
3249
|
*```js
|
|
@@ -3373,7 +3255,6 @@ export declare enum EmbedEvent {
|
|
|
3373
3255
|
DialogOpen = "dialog-open",
|
|
3374
3256
|
/**
|
|
3375
3257
|
* Emitted when any modal is closed in the app
|
|
3376
|
-
*
|
|
3377
3258
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3378
3259
|
* @example
|
|
3379
3260
|
*```js
|
|
@@ -3386,8 +3267,7 @@ export declare enum EmbedEvent {
|
|
|
3386
3267
|
/**
|
|
3387
3268
|
* Emitted when the Liveboard shell loads.
|
|
3388
3269
|
* You can use this event as a hook to trigger
|
|
3389
|
-
*
|
|
3390
|
-
*
|
|
3270
|
+
* actions on the rendered Liveboard.
|
|
3391
3271
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3392
3272
|
* @example
|
|
3393
3273
|
*```js
|
|
@@ -3407,9 +3287,7 @@ export declare enum EmbedEvent {
|
|
|
3407
3287
|
*/
|
|
3408
3288
|
LiveboardRendered = "PinboardRendered",
|
|
3409
3289
|
/**
|
|
3410
|
-
*
|
|
3411
|
-
* is triggered on all events.
|
|
3412
|
-
*
|
|
3290
|
+
* Emits all events.
|
|
3413
3291
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3414
3292
|
* @example
|
|
3415
3293
|
*```js
|
|
@@ -3421,17 +3299,16 @@ export declare enum EmbedEvent {
|
|
|
3421
3299
|
ALL = "*",
|
|
3422
3300
|
/**
|
|
3423
3301
|
* Emitted when an Answer is saved in the app
|
|
3424
|
-
*
|
|
3425
3302
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3426
3303
|
* @example
|
|
3427
3304
|
*```js
|
|
3428
|
-
* //
|
|
3305
|
+
* //Emit when action starts
|
|
3429
3306
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3430
3307
|
* console.log('Save', payload)
|
|
3431
3308
|
* }, {
|
|
3432
3309
|
* start: true
|
|
3433
3310
|
* })
|
|
3434
|
-
* //
|
|
3311
|
+
* //emit when action ends
|
|
3435
3312
|
* searchEmbed.on(EmbedEvent.Save, payload => {
|
|
3436
3313
|
* console.log('Save', payload)
|
|
3437
3314
|
* })
|
|
@@ -3441,15 +3318,14 @@ export declare enum EmbedEvent {
|
|
|
3441
3318
|
/**
|
|
3442
3319
|
* Emitted when the download action is triggered on an answer
|
|
3443
3320
|
*
|
|
3444
|
-
* **Note**:
|
|
3321
|
+
* **Note**: This event is deprecated in v1.21.0.
|
|
3445
3322
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3446
3323
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3447
3324
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
3448
|
-
*
|
|
3449
3325
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3450
3326
|
* @example
|
|
3451
3327
|
*```js
|
|
3452
|
-
* liveboardEmbed.
|
|
3328
|
+
* liveboardEmbed.on(EmbedEvent.Download, {
|
|
3453
3329
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'
|
|
3454
3330
|
* })
|
|
3455
3331
|
*```
|
|
@@ -3457,14 +3333,13 @@ export declare enum EmbedEvent {
|
|
|
3457
3333
|
Download = "download",
|
|
3458
3334
|
/**
|
|
3459
3335
|
* Emitted when the download action is triggered on an answer
|
|
3460
|
-
*
|
|
3461
3336
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3462
3337
|
* @example
|
|
3463
3338
|
*```js
|
|
3464
|
-
* //
|
|
3339
|
+
* //emit when action starts
|
|
3465
3340
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3466
3341
|
* console.log('download PNG', payload)}, {start: true })
|
|
3467
|
-
* //
|
|
3342
|
+
* //emit when action ends
|
|
3468
3343
|
* searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
|
|
3469
3344
|
* console.log('download PNG', payload)})
|
|
3470
3345
|
*```
|
|
@@ -3472,14 +3347,13 @@ export declare enum EmbedEvent {
|
|
|
3472
3347
|
DownloadAsPng = "downloadAsPng",
|
|
3473
3348
|
/**
|
|
3474
3349
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
3475
|
-
*
|
|
3476
3350
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3477
3351
|
* @example
|
|
3478
3352
|
*```js
|
|
3479
|
-
* //
|
|
3353
|
+
* //emit when action starts
|
|
3480
3354
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3481
3355
|
* console.log('download PDF', payload)}, {start: true })
|
|
3482
|
-
* //
|
|
3356
|
+
* //emit when action ends
|
|
3483
3357
|
* searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
|
|
3484
3358
|
* console.log('download PDF', payload)})
|
|
3485
3359
|
*```
|
|
@@ -3487,14 +3361,13 @@ export declare enum EmbedEvent {
|
|
|
3487
3361
|
DownloadAsPdf = "downloadAsPdf",
|
|
3488
3362
|
/**
|
|
3489
3363
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
3490
|
-
*
|
|
3491
3364
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3492
3365
|
* @example
|
|
3493
3366
|
*```js
|
|
3494
|
-
* //
|
|
3367
|
+
* //emit when action starts
|
|
3495
3368
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3496
3369
|
* console.log('download CSV', payload)}, {start: true })
|
|
3497
|
-
* //
|
|
3370
|
+
* //emit when action ends
|
|
3498
3371
|
* searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
|
|
3499
3372
|
* console.log('download CSV', payload)})
|
|
3500
3373
|
*```
|
|
@@ -3502,14 +3375,13 @@ export declare enum EmbedEvent {
|
|
|
3502
3375
|
DownloadAsCsv = "downloadAsCsv",
|
|
3503
3376
|
/**
|
|
3504
3377
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
3505
|
-
*
|
|
3506
3378
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3507
3379
|
* @example
|
|
3508
3380
|
*```js
|
|
3509
|
-
* //
|
|
3381
|
+
* //emit when action starts
|
|
3510
3382
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3511
3383
|
* console.log('download Xlsx', payload)}, { start: true })
|
|
3512
|
-
* //
|
|
3384
|
+
* //emit when action ends
|
|
3513
3385
|
* searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
|
|
3514
3386
|
* console.log('download Xlsx', payload)})
|
|
3515
3387
|
*```
|
|
@@ -3517,14 +3389,13 @@ export declare enum EmbedEvent {
|
|
|
3517
3389
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3518
3390
|
/**
|
|
3519
3391
|
* Emitted when an Answer is deleted in the app
|
|
3520
|
-
*
|
|
3521
3392
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3522
3393
|
* @example
|
|
3523
3394
|
*```js
|
|
3524
|
-
* //
|
|
3395
|
+
* //emit when action starts
|
|
3525
3396
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3526
3397
|
* console.log('delete answer', payload)}, {start: true })
|
|
3527
|
-
* //
|
|
3398
|
+
* //emit when action is completed
|
|
3528
3399
|
* appEmbed.on(EmbedEvent.AnswerDelete, payload => {
|
|
3529
3400
|
* console.log('delete answer', payload)})
|
|
3530
3401
|
*```
|
|
@@ -3532,17 +3403,16 @@ export declare enum EmbedEvent {
|
|
|
3532
3403
|
AnswerDelete = "answerDelete",
|
|
3533
3404
|
/**
|
|
3534
3405
|
* Emitted when an answer is pinned to a Liveboard
|
|
3535
|
-
*
|
|
3536
3406
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3537
3407
|
* @example
|
|
3538
3408
|
*```js
|
|
3539
|
-
* //
|
|
3409
|
+
* //emit when action starts
|
|
3540
3410
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3541
3411
|
* console.log('pin', payload)
|
|
3542
3412
|
* }, {
|
|
3543
3413
|
* start: true
|
|
3544
3414
|
* })
|
|
3545
|
-
* //
|
|
3415
|
+
* //emit when action ends
|
|
3546
3416
|
* searchEmbed.on(EmbedEvent.Pin, payload => {
|
|
3547
3417
|
* console.log('pin', payload)
|
|
3548
3418
|
* })
|
|
@@ -3551,17 +3421,16 @@ export declare enum EmbedEvent {
|
|
|
3551
3421
|
Pin = "pin",
|
|
3552
3422
|
/**
|
|
3553
3423
|
* Emitted when SpotIQ analysis is triggered
|
|
3554
|
-
*
|
|
3555
3424
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3556
3425
|
* @example
|
|
3557
3426
|
*```js
|
|
3558
|
-
* //
|
|
3427
|
+
* //emit when action starts
|
|
3559
3428
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3560
3429
|
* console.log('SpotIQAnalyze', payload)
|
|
3561
3430
|
* }, {
|
|
3562
3431
|
* start: true
|
|
3563
3432
|
* })
|
|
3564
|
-
* //
|
|
3433
|
+
* //emit when action ends
|
|
3565
3434
|
* searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
|
|
3566
3435
|
* console.log('SpotIQ analyze', payload)
|
|
3567
3436
|
* })
|
|
@@ -3570,17 +3439,16 @@ export declare enum EmbedEvent {
|
|
|
3570
3439
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3571
3440
|
/**
|
|
3572
3441
|
* Emitted when a user shares an object with another user or group
|
|
3573
|
-
*
|
|
3574
3442
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3575
3443
|
* @example
|
|
3576
3444
|
*```js
|
|
3577
|
-
* //
|
|
3445
|
+
* //emit when action starts
|
|
3578
3446
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3579
3447
|
* console.log('Share', payload)
|
|
3580
3448
|
* }, {
|
|
3581
3449
|
* start: true
|
|
3582
3450
|
* })
|
|
3583
|
-
* //
|
|
3451
|
+
* //emit when action ends
|
|
3584
3452
|
* searchEmbed.on(EmbedEvent.Share, payload => {
|
|
3585
3453
|
* console.log('Share', payload)
|
|
3586
3454
|
* })
|
|
@@ -3590,7 +3458,6 @@ export declare enum EmbedEvent {
|
|
|
3590
3458
|
/**
|
|
3591
3459
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
3592
3460
|
* data on a chart or table.
|
|
3593
|
-
*
|
|
3594
3461
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3595
3462
|
* @example
|
|
3596
3463
|
*```js
|
|
@@ -3603,7 +3470,6 @@ export declare enum EmbedEvent {
|
|
|
3603
3470
|
/**
|
|
3604
3471
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
3605
3472
|
* data on a chart or table
|
|
3606
|
-
*
|
|
3607
3473
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3608
3474
|
* @example
|
|
3609
3475
|
*```js
|
|
@@ -3615,7 +3481,6 @@ export declare enum EmbedEvent {
|
|
|
3615
3481
|
DrillExclude = "context-menu-item-exclude",
|
|
3616
3482
|
/**
|
|
3617
3483
|
* Emitted when a column value is copied in the embedded app.
|
|
3618
|
-
*
|
|
3619
3484
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3620
3485
|
* @example
|
|
3621
3486
|
*```js
|
|
@@ -3627,7 +3492,6 @@ export declare enum EmbedEvent {
|
|
|
3627
3492
|
CopyToClipboard = "context-menu-item-copy-to-clipboard",
|
|
3628
3493
|
/**
|
|
3629
3494
|
* Emitted when a user clicks the **Update TML** action
|
|
3630
|
-
*
|
|
3631
3495
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3632
3496
|
* @example
|
|
3633
3497
|
*```js
|
|
@@ -3638,7 +3502,6 @@ export declare enum EmbedEvent {
|
|
|
3638
3502
|
UpdateTML = "updateTSL",
|
|
3639
3503
|
/**
|
|
3640
3504
|
* Emitted when a user clicks the **Edit TML** action
|
|
3641
|
-
*
|
|
3642
3505
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3643
3506
|
* @example
|
|
3644
3507
|
*```js
|
|
@@ -3651,14 +3514,13 @@ export declare enum EmbedEvent {
|
|
|
3651
3514
|
/**
|
|
3652
3515
|
* Emitted when the **Export TML** action is triggered on an
|
|
3653
3516
|
* an embedded object in the app
|
|
3654
|
-
*
|
|
3655
3517
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3656
3518
|
* @example
|
|
3657
3519
|
*```js
|
|
3658
|
-
* //
|
|
3520
|
+
* //emit when action starts
|
|
3659
3521
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3660
3522
|
* console.log('Export TML', payload)}, { start: true })
|
|
3661
|
-
* //
|
|
3523
|
+
* //emit when action ends
|
|
3662
3524
|
* searchEmbed.on(EmbedEvent.ExportTML, payload => {
|
|
3663
3525
|
* console.log('Export TML', payload)})
|
|
3664
3526
|
*```
|
|
@@ -3666,7 +3528,6 @@ export declare enum EmbedEvent {
|
|
|
3666
3528
|
ExportTML = "exportTSL",
|
|
3667
3529
|
/**
|
|
3668
3530
|
* Emitted when an Answer is saved as a View.
|
|
3669
|
-
*
|
|
3670
3531
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3671
3532
|
* @example
|
|
3672
3533
|
*```js
|
|
@@ -3678,14 +3539,13 @@ export declare enum EmbedEvent {
|
|
|
3678
3539
|
SaveAsView = "saveAsView",
|
|
3679
3540
|
/**
|
|
3680
3541
|
* Emitted when the user creates a copy of an Answer
|
|
3681
|
-
*
|
|
3682
3542
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3683
3543
|
* @example
|
|
3684
3544
|
*```js
|
|
3685
|
-
* //
|
|
3545
|
+
* //emit when action starts
|
|
3686
3546
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3687
3547
|
* console.log('Copy and edit', payload)}, {start: true })
|
|
3688
|
-
* //
|
|
3548
|
+
* //emit when action ends
|
|
3689
3549
|
* appEmbed.on(EmbedEvent.CopyAEdit, payload => {
|
|
3690
3550
|
* console.log('Copy and edit', payload)})
|
|
3691
3551
|
*```
|
|
@@ -3693,7 +3553,6 @@ export declare enum EmbedEvent {
|
|
|
3693
3553
|
CopyAEdit = "copyAEdit",
|
|
3694
3554
|
/**
|
|
3695
3555
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
3696
|
-
*
|
|
3697
3556
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3698
3557
|
* @example
|
|
3699
3558
|
*```js
|
|
@@ -3705,7 +3564,6 @@ export declare enum EmbedEvent {
|
|
|
3705
3564
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3706
3565
|
/**
|
|
3707
3566
|
* Emitted when an answer is switched to a chart or table view.
|
|
3708
|
-
*
|
|
3709
3567
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3710
3568
|
* @example
|
|
3711
3569
|
*```js
|
|
@@ -3717,13 +3575,11 @@ export declare enum EmbedEvent {
|
|
|
3717
3575
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3718
3576
|
/**
|
|
3719
3577
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
3720
|
-
*
|
|
3721
3578
|
* @hidden
|
|
3722
3579
|
*/
|
|
3723
3580
|
APP_INIT = "appInit",
|
|
3724
3581
|
/**
|
|
3725
3582
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3726
|
-
*
|
|
3727
3583
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3728
3584
|
* @example
|
|
3729
3585
|
*```js
|
|
@@ -3735,7 +3591,6 @@ export declare enum EmbedEvent {
|
|
|
3735
3591
|
LiveboardInfo = "pinboardInfo",
|
|
3736
3592
|
/**
|
|
3737
3593
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3738
|
-
*
|
|
3739
3594
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3740
3595
|
* @example
|
|
3741
3596
|
*```js
|
|
@@ -3747,7 +3602,6 @@ export declare enum EmbedEvent {
|
|
|
3747
3602
|
AddToFavorites = "addToFavorites",
|
|
3748
3603
|
/**
|
|
3749
3604
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3750
|
-
*
|
|
3751
3605
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3752
3606
|
* @example
|
|
3753
3607
|
*```js
|
|
@@ -3759,7 +3613,6 @@ export declare enum EmbedEvent {
|
|
|
3759
3613
|
Schedule = "subscription",
|
|
3760
3614
|
/**
|
|
3761
3615
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3762
|
-
*
|
|
3763
3616
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3764
3617
|
* @example
|
|
3765
3618
|
*```js
|
|
@@ -3771,7 +3624,6 @@ export declare enum EmbedEvent {
|
|
|
3771
3624
|
Edit = "edit",
|
|
3772
3625
|
/**
|
|
3773
3626
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3774
|
-
*
|
|
3775
3627
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3776
3628
|
* @example
|
|
3777
3629
|
*```js
|
|
@@ -3783,11 +3635,10 @@ export declare enum EmbedEvent {
|
|
|
3783
3635
|
MakeACopy = "makeACopy",
|
|
3784
3636
|
/**
|
|
3785
3637
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3786
|
-
*
|
|
3787
3638
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3788
3639
|
* @example
|
|
3789
3640
|
*```js
|
|
3790
|
-
* liveboardEmbed.
|
|
3641
|
+
* liveboardEmbed.on(EmbedEvent.Present)
|
|
3791
3642
|
*```
|
|
3792
3643
|
* @example
|
|
3793
3644
|
*```js
|
|
@@ -3799,71 +3650,64 @@ export declare enum EmbedEvent {
|
|
|
3799
3650
|
Present = "present",
|
|
3800
3651
|
/**
|
|
3801
3652
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3802
|
-
*
|
|
3803
3653
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3804
3654
|
* @example
|
|
3805
3655
|
*```js
|
|
3806
|
-
* liveboardEmbed.
|
|
3656
|
+
* liveboardEmbed.on(EmbedEvent.Delete,
|
|
3807
3657
|
* {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3808
3658
|
*```
|
|
3809
3659
|
*/
|
|
3810
3660
|
Delete = "delete",
|
|
3811
3661
|
/**
|
|
3812
3662
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3813
|
-
*
|
|
3814
3663
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3815
3664
|
* @example
|
|
3816
3665
|
*```js
|
|
3817
|
-
* liveboardEmbed.
|
|
3666
|
+
* liveboardEmbed.on(EmbedEvent.SchedulesList)
|
|
3818
3667
|
*```
|
|
3819
3668
|
*/
|
|
3820
3669
|
SchedulesList = "schedule-list",
|
|
3821
3670
|
/**
|
|
3822
3671
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3823
|
-
*
|
|
3824
3672
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3825
3673
|
* @example
|
|
3826
3674
|
*```js
|
|
3827
|
-
* liveboardEmbed.
|
|
3675
|
+
* liveboardEmbed.on(EmbedEvent.Cancel)
|
|
3828
3676
|
*```
|
|
3829
3677
|
*/
|
|
3830
3678
|
Cancel = "cancel",
|
|
3831
3679
|
/**
|
|
3832
3680
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3833
|
-
*
|
|
3834
3681
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3835
3682
|
* @example
|
|
3836
3683
|
*```js
|
|
3837
|
-
* liveboardEmbed.
|
|
3684
|
+
* liveboardEmbed.on(EmbedEvent.Explore, {
|
|
3838
3685
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3839
3686
|
*```
|
|
3840
3687
|
*/
|
|
3841
3688
|
Explore = "explore",
|
|
3842
3689
|
/**
|
|
3843
3690
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3844
|
-
*
|
|
3845
3691
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3846
3692
|
* @example
|
|
3847
3693
|
*```js
|
|
3848
|
-
* liveboardEmbed.
|
|
3694
|
+
* liveboardEmbed.on(EmbedEvent.CopyLink, {
|
|
3849
3695
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3850
3696
|
*```
|
|
3851
3697
|
*/
|
|
3852
3698
|
CopyLink = "embedDocument",
|
|
3853
3699
|
/**
|
|
3854
3700
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3855
|
-
*
|
|
3856
3701
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3857
3702
|
* @example
|
|
3858
3703
|
*```js
|
|
3859
|
-
* liveboardEmbed.
|
|
3704
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3860
3705
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3861
3706
|
*```
|
|
3862
3707
|
*/
|
|
3863
3708
|
CrossFilterChanged = "cross-filter-changed",
|
|
3864
3709
|
/**
|
|
3865
3710
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3866
|
-
*
|
|
3867
3711
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3868
3712
|
* @example
|
|
3869
3713
|
*```js
|
|
@@ -3875,44 +3719,53 @@ export declare enum EmbedEvent {
|
|
|
3875
3719
|
VizPointRightClick = "vizPointRightClick",
|
|
3876
3720
|
/**
|
|
3877
3721
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
3878
|
-
*
|
|
3879
3722
|
* @hidden
|
|
3880
3723
|
*/
|
|
3881
3724
|
InsertIntoSlide = "insertInToSlide",
|
|
3882
3725
|
/**
|
|
3883
|
-
* @hidden
|
|
3884
3726
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3727
|
+
* Returns filter type and name, column name and ID, and runtime
|
|
3728
|
+
* filter details.
|
|
3729
|
+
* @example
|
|
3730
|
+
*
|
|
3731
|
+
*```js
|
|
3732
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3733
|
+
* console.log('payload', payload);
|
|
3734
|
+
* })
|
|
3735
|
+
*
|
|
3885
3736
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
|
|
3737
|
+
* @example
|
|
3738
|
+
*
|
|
3739
|
+
*```js
|
|
3740
|
+
* LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
|
|
3741
|
+
* console.log('payload', payload);
|
|
3742
|
+
* })
|
|
3743
|
+
*```
|
|
3886
3744
|
*/
|
|
3887
3745
|
FilterChanged = "filterChanged",
|
|
3888
3746
|
/**
|
|
3889
3747
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
3890
|
-
*
|
|
3891
3748
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3892
3749
|
*/
|
|
3893
3750
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3894
3751
|
/**
|
|
3895
3752
|
* Emitted when a user selects a data source.
|
|
3896
|
-
*
|
|
3897
3753
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3898
3754
|
*/
|
|
3899
3755
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3900
3756
|
/**
|
|
3901
3757
|
* Emitted when a user updates a connection on the **Data** page
|
|
3902
|
-
*
|
|
3903
3758
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3904
3759
|
*/
|
|
3905
3760
|
UpdateConnection = "updateConnection",
|
|
3906
3761
|
/**
|
|
3907
3762
|
* Emitted when a user updates a connection on the **Data** page
|
|
3908
|
-
*
|
|
3909
3763
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3910
3764
|
*/
|
|
3911
3765
|
CreateConnection = "createConnection",
|
|
3912
3766
|
/**
|
|
3913
3767
|
* Emitted when name, status (private or public) or filter values of a
|
|
3914
3768
|
* Personalised view is updated.
|
|
3915
|
-
*
|
|
3916
3769
|
* @returns viewName: string
|
|
3917
3770
|
* @returns viewId: string
|
|
3918
3771
|
* @returns liveboardId: string
|
|
@@ -3922,7 +3775,6 @@ export declare enum EmbedEvent {
|
|
|
3922
3775
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3923
3776
|
/**
|
|
3924
3777
|
* Emitted when a Personalised view is saved.
|
|
3925
|
-
*
|
|
3926
3778
|
* @returns viewName: string
|
|
3927
3779
|
* @returns viewId: string
|
|
3928
3780
|
* @returns liveboardId: string
|
|
@@ -3932,7 +3784,6 @@ export declare enum EmbedEvent {
|
|
|
3932
3784
|
SavePersonalisedView = "savePersonalisedView",
|
|
3933
3785
|
/**
|
|
3934
3786
|
* Emitted when a Liveboard is reset.
|
|
3935
|
-
*
|
|
3936
3787
|
* @returns viewName: string
|
|
3937
3788
|
* @returns viewId: string
|
|
3938
3789
|
* @returns liveboardId: string
|
|
@@ -3942,7 +3793,6 @@ export declare enum EmbedEvent {
|
|
|
3942
3793
|
ResetLiveboard = "resetLiveboard",
|
|
3943
3794
|
/**
|
|
3944
3795
|
* Emitted when a PersonalisedView is deleted.
|
|
3945
|
-
*
|
|
3946
3796
|
* @returns views: string[]
|
|
3947
3797
|
* @returns liveboardId: string
|
|
3948
3798
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -3950,13 +3800,11 @@ export declare enum EmbedEvent {
|
|
|
3950
3800
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3951
3801
|
/**
|
|
3952
3802
|
* Emitted when a user creates a new worksheet
|
|
3953
|
-
*
|
|
3954
3803
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3955
3804
|
*/
|
|
3956
3805
|
CreateWorksheet = "createWorksheet",
|
|
3957
3806
|
/**
|
|
3958
3807
|
* Emitted when Ask Sage is initialized.
|
|
3959
|
-
*
|
|
3960
3808
|
* @returns viewName: string
|
|
3961
3809
|
* @returns viewId: string
|
|
3962
3810
|
* @returns liveboardId: string
|
|
@@ -3966,10 +3814,32 @@ export declare enum EmbedEvent {
|
|
|
3966
3814
|
AskSageInit = "AskSageInit",
|
|
3967
3815
|
/**
|
|
3968
3816
|
* Emitted when a LB/viz is renamed
|
|
3969
|
-
*
|
|
3970
3817
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3971
3818
|
*/
|
|
3972
|
-
Rename = "rename"
|
|
3819
|
+
Rename = "rename",
|
|
3820
|
+
/**
|
|
3821
|
+
* Emitted when user wants to intercept the search execution
|
|
3822
|
+
*
|
|
3823
|
+
* Make isOnBeforeGetVizDataEnabled : true to use this embed
|
|
3824
|
+
* event
|
|
3825
|
+
*
|
|
3826
|
+
*```js
|
|
3827
|
+
* searchEmbed.on(EmbedEvent.OnBeforeGetVizData, (payload, responder) => {
|
|
3828
|
+
* responder({
|
|
3829
|
+
* data: {
|
|
3830
|
+
* execute: true,
|
|
3831
|
+
* error: {errorText: "My own customised error"}
|
|
3832
|
+
* }})
|
|
3833
|
+
* })
|
|
3834
|
+
*```
|
|
3835
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3836
|
+
*/
|
|
3837
|
+
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
3838
|
+
/**
|
|
3839
|
+
* Emitted when runtime parameters changes
|
|
3840
|
+
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3841
|
+
*/
|
|
3842
|
+
ParameterChanged = "ParameterChanged"
|
|
3973
3843
|
}
|
|
3974
3844
|
/**
|
|
3975
3845
|
* Event types that can be triggered by the host application
|
|
@@ -3978,7 +3848,6 @@ export declare enum EmbedEvent {
|
|
|
3978
3848
|
* To trigger an event use the corresponding
|
|
3979
3849
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
3980
3850
|
* SearchEmbed.trigger} method.
|
|
3981
|
-
*
|
|
3982
3851
|
* @example
|
|
3983
3852
|
* ```js
|
|
3984
3853
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3999,7 +3868,6 @@ export declare enum HostEvent {
|
|
|
3999
3868
|
* the search query string.
|
|
4000
3869
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
4001
3870
|
* Includes the following properties:
|
|
4002
|
-
*
|
|
4003
3871
|
* @param - `searchQuery` - query string with search tokens
|
|
4004
3872
|
* @param - `dataSources` - Data source GUID to Search on
|
|
4005
3873
|
* - Although an array, only a single source
|
|
@@ -4018,7 +3886,6 @@ export declare enum HostEvent {
|
|
|
4018
3886
|
/**
|
|
4019
3887
|
* Triggers a drill on certain points of the specified column
|
|
4020
3888
|
* Includes the following properties:
|
|
4021
|
-
*
|
|
4022
3889
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
4023
3890
|
* to drill to. For example, { selectedPoints: []}
|
|
4024
3891
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -4068,19 +3935,16 @@ export declare enum HostEvent {
|
|
|
4068
3935
|
DrillDown = "triggerDrillDown",
|
|
4069
3936
|
/**
|
|
4070
3937
|
* Apply filters
|
|
4071
|
-
*
|
|
4072
3938
|
* @hidden
|
|
4073
3939
|
*/
|
|
4074
3940
|
Filter = "filter",
|
|
4075
3941
|
/**
|
|
4076
3942
|
* Reload the answer or visualization
|
|
4077
|
-
*
|
|
4078
3943
|
* @hidden
|
|
4079
3944
|
*/
|
|
4080
3945
|
Reload = "reload",
|
|
4081
3946
|
/**
|
|
4082
3947
|
* Display specific visualizations on a Liveboard.
|
|
4083
|
-
*
|
|
4084
3948
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
4085
3949
|
* in this parameter will be hidden.
|
|
4086
3950
|
* @example
|
|
@@ -4094,7 +3958,6 @@ export declare enum HostEvent {
|
|
|
4094
3958
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
4095
3959
|
/**
|
|
4096
3960
|
* Set a Liveboard tab as an active tab.
|
|
4097
|
-
*
|
|
4098
3961
|
* @param - tabId - string of id of Tab to show
|
|
4099
3962
|
* @example
|
|
4100
3963
|
* ```js
|
|
@@ -4110,18 +3973,21 @@ export declare enum HostEvent {
|
|
|
4110
3973
|
* runtime filters passed here are appended to the existing runtime
|
|
4111
3974
|
* filters.
|
|
4112
3975
|
* Pass an array of runtime filters with the following attributes:
|
|
3976
|
+
*
|
|
4113
3977
|
* `columnName`
|
|
4114
3978
|
* _String_. The name of the column to filter on.
|
|
3979
|
+
*
|
|
4115
3980
|
* `operator`
|
|
4116
|
-
*
|
|
4117
|
-
*
|
|
3981
|
+
* Runtime filter operator to apply. For information,
|
|
3982
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
|
|
3983
|
+
*
|
|
4118
3984
|
* `values`
|
|
4119
|
-
*
|
|
4120
|
-
*
|
|
4121
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
4122
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
4123
|
-
* embedding (SageEmbed).
|
|
3985
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
3986
|
+
* operators such as BW and IN accept multiple operands.
|
|
4124
3987
|
*
|
|
3988
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3989
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3990
|
+
* embedding (SageEmbed).
|
|
4125
3991
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
4126
3992
|
* @example
|
|
4127
3993
|
* ```js
|
|
@@ -4137,7 +4003,6 @@ export declare enum HostEvent {
|
|
|
4137
4003
|
/**
|
|
4138
4004
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
4139
4005
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
4140
|
-
*
|
|
4141
4006
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
4142
4007
|
* be a number; for example, `1`, `-1`.
|
|
4143
4008
|
* @example
|
|
@@ -4150,7 +4015,6 @@ export declare enum HostEvent {
|
|
|
4150
4015
|
/**
|
|
4151
4016
|
* Open the filter panel for a particular column.
|
|
4152
4017
|
* Works with Search and Liveboard embed.
|
|
4153
|
-
*
|
|
4154
4018
|
* @param - { columnId: string,
|
|
4155
4019
|
* name: string,
|
|
4156
4020
|
* type: INT64/CHAR/DATE,
|
|
@@ -4167,7 +4031,6 @@ export declare enum HostEvent {
|
|
|
4167
4031
|
OpenFilter = "openFilter",
|
|
4168
4032
|
/**
|
|
4169
4033
|
* Add columns to the current search query.
|
|
4170
|
-
*
|
|
4171
4034
|
* @param - { columnIds: string[] }
|
|
4172
4035
|
* @example
|
|
4173
4036
|
* ```js
|
|
@@ -4178,7 +4041,6 @@ export declare enum HostEvent {
|
|
|
4178
4041
|
AddColumns = "addColumns",
|
|
4179
4042
|
/**
|
|
4180
4043
|
* Remove a column from the current search query.
|
|
4181
|
-
*
|
|
4182
4044
|
* @param - { columnId: string }
|
|
4183
4045
|
* @example
|
|
4184
4046
|
* ```js
|
|
@@ -4193,10 +4055,9 @@ export declare enum HostEvent {
|
|
|
4193
4055
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
4194
4056
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
4195
4057
|
* sorting, toggling of legends, and data drill down.
|
|
4196
|
-
*
|
|
4197
4058
|
* @example
|
|
4198
4059
|
* ```js
|
|
4199
|
-
* liveboardEmbed.trigger(HostEvent.
|
|
4060
|
+
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
4200
4061
|
* data=>console.log(data))
|
|
4201
4062
|
* ```
|
|
4202
4063
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
|
|
@@ -4204,7 +4065,6 @@ export declare enum HostEvent {
|
|
|
4204
4065
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
4205
4066
|
/**
|
|
4206
4067
|
* Trigger the **Pin** action on an embedded object
|
|
4207
|
-
*
|
|
4208
4068
|
* @param - Liveboard embed takes the `vizId` as a
|
|
4209
4069
|
* key. Can be left undefined when embedding Search, full app, or
|
|
4210
4070
|
* a visualization.
|
|
@@ -4221,7 +4081,6 @@ export declare enum HostEvent {
|
|
|
4221
4081
|
/**
|
|
4222
4082
|
* Trigger the **Show Liveboard details** action
|
|
4223
4083
|
* on an embedded Liveboard.
|
|
4224
|
-
*
|
|
4225
4084
|
* @example
|
|
4226
4085
|
*```js
|
|
4227
4086
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -4231,7 +4090,6 @@ export declare enum HostEvent {
|
|
|
4231
4090
|
LiveboardInfo = "pinboardInfo",
|
|
4232
4091
|
/**
|
|
4233
4092
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
4234
|
-
*
|
|
4235
4093
|
* @example
|
|
4236
4094
|
* ```js
|
|
4237
4095
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -4241,7 +4099,6 @@ export declare enum HostEvent {
|
|
|
4241
4099
|
Schedule = "subscription",
|
|
4242
4100
|
/**
|
|
4243
4101
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
4244
|
-
*
|
|
4245
4102
|
* @example
|
|
4246
4103
|
* ```js
|
|
4247
4104
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -4251,7 +4108,6 @@ export declare enum HostEvent {
|
|
|
4251
4108
|
SchedulesList = "schedule-list",
|
|
4252
4109
|
/**
|
|
4253
4110
|
* Trigger the **Export TML** action on an embedded Liveboard.
|
|
4254
|
-
*
|
|
4255
4111
|
* @example
|
|
4256
4112
|
* ```js
|
|
4257
4113
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
@@ -4261,7 +4117,6 @@ export declare enum HostEvent {
|
|
|
4261
4117
|
ExportTML = "exportTSL",
|
|
4262
4118
|
/**
|
|
4263
4119
|
* Trigger the **Edit TML** action on an embedded Liveboard.
|
|
4264
|
-
*
|
|
4265
4120
|
* @example
|
|
4266
4121
|
* ```js
|
|
4267
4122
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -4271,7 +4126,6 @@ export declare enum HostEvent {
|
|
|
4271
4126
|
EditTML = "editTSL",
|
|
4272
4127
|
/**
|
|
4273
4128
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
4274
|
-
*
|
|
4275
4129
|
* @example
|
|
4276
4130
|
* ```js
|
|
4277
4131
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -4281,7 +4135,6 @@ export declare enum HostEvent {
|
|
|
4281
4135
|
UpdateTML = "updateTSL",
|
|
4282
4136
|
/**
|
|
4283
4137
|
* Trigger the **Download PDF** action on an embedded Liveboard.
|
|
4284
|
-
*
|
|
4285
4138
|
* @example
|
|
4286
4139
|
* ```js
|
|
4287
4140
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -4292,7 +4145,6 @@ export declare enum HostEvent {
|
|
|
4292
4145
|
/**
|
|
4293
4146
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
4294
4147
|
* visualization page.
|
|
4295
|
-
*
|
|
4296
4148
|
* @example
|
|
4297
4149
|
* ```js
|
|
4298
4150
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -4308,7 +4160,6 @@ export declare enum HostEvent {
|
|
|
4308
4160
|
MakeACopy = "makeACopy",
|
|
4309
4161
|
/**
|
|
4310
4162
|
* Trigger the **Delete** action for a Liveboard.
|
|
4311
|
-
*
|
|
4312
4163
|
* @example
|
|
4313
4164
|
* ```js
|
|
4314
4165
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -4318,7 +4169,6 @@ export declare enum HostEvent {
|
|
|
4318
4169
|
Remove = "delete",
|
|
4319
4170
|
/**
|
|
4320
4171
|
* Trigger the **Explore** action on a visualization.
|
|
4321
|
-
*
|
|
4322
4172
|
* @param - an object with `vizId` as a key
|
|
4323
4173
|
* @example
|
|
4324
4174
|
* ```js
|
|
@@ -4329,7 +4179,6 @@ export declare enum HostEvent {
|
|
|
4329
4179
|
Explore = "explore",
|
|
4330
4180
|
/**
|
|
4331
4181
|
* Trigger the **Create alert** action on a visualization
|
|
4332
|
-
*
|
|
4333
4182
|
* @param - an object with `vizId` as a key
|
|
4334
4183
|
* @example
|
|
4335
4184
|
* ```js
|
|
@@ -4342,7 +4191,6 @@ export declare enum HostEvent {
|
|
|
4342
4191
|
CreateMonitor = "createMonitor",
|
|
4343
4192
|
/**
|
|
4344
4193
|
* Trigger the **Manage alerts** action on a visualization
|
|
4345
|
-
*
|
|
4346
4194
|
* @param - an object with `vizId` as a key
|
|
4347
4195
|
* @example
|
|
4348
4196
|
* ```js
|
|
@@ -4355,7 +4203,6 @@ export declare enum HostEvent {
|
|
|
4355
4203
|
ManageMonitor = "manageMonitor",
|
|
4356
4204
|
/**
|
|
4357
4205
|
* Trigger the **Edit** action on a Liveboard or visualization
|
|
4358
|
-
*
|
|
4359
4206
|
* @param - object - To trigger the action for a specific visualization
|
|
4360
4207
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
4361
4208
|
* Can be left undefined when embedding Search, full app, or
|
|
@@ -4376,7 +4223,6 @@ export declare enum HostEvent {
|
|
|
4376
4223
|
Edit = "edit",
|
|
4377
4224
|
/**
|
|
4378
4225
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
4379
|
-
*
|
|
4380
4226
|
* @param - object - to trigger the action for a
|
|
4381
4227
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
4382
4228
|
* @example
|
|
@@ -4394,7 +4240,6 @@ export declare enum HostEvent {
|
|
|
4394
4240
|
CopyLink = "embedDocument",
|
|
4395
4241
|
/**
|
|
4396
4242
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
4397
|
-
*
|
|
4398
4243
|
* @param - object - to trigger the action for a specific visualization
|
|
4399
4244
|
* in Liveboard embed, pass in `vizId` as a key
|
|
4400
4245
|
* @example
|
|
@@ -4412,12 +4257,11 @@ export declare enum HostEvent {
|
|
|
4412
4257
|
Present = "present",
|
|
4413
4258
|
/**
|
|
4414
4259
|
* Get TML for the current search.
|
|
4415
|
-
*
|
|
4416
4260
|
* @example
|
|
4417
4261
|
* ```js
|
|
4418
4262
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
4419
4263
|
* console.log(
|
|
4420
|
-
* tml.search_query // TML representation of the search query
|
|
4264
|
+
* tml.answer.search_query // TML representation of the search query
|
|
4421
4265
|
* );
|
|
4422
4266
|
* })
|
|
4423
4267
|
* ```
|
|
@@ -4427,7 +4271,6 @@ export declare enum HostEvent {
|
|
|
4427
4271
|
GetTML = "getTML",
|
|
4428
4272
|
/**
|
|
4429
4273
|
* Trigger the **Show underlying data** action on visualization or search
|
|
4430
|
-
*
|
|
4431
4274
|
* @param - an object with vizId as a key
|
|
4432
4275
|
* @example
|
|
4433
4276
|
* ```js
|
|
@@ -4447,7 +4290,6 @@ export declare enum HostEvent {
|
|
|
4447
4290
|
* Trigger the **Delete** action for a visualization
|
|
4448
4291
|
* in an embedded Liveboard, or a chart or table
|
|
4449
4292
|
* generated from Search.
|
|
4450
|
-
*
|
|
4451
4293
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
4452
4294
|
* Can be left empty if embedding Search or visualization.
|
|
4453
4295
|
* @example
|
|
@@ -4464,7 +4306,6 @@ export declare enum HostEvent {
|
|
|
4464
4306
|
/**
|
|
4465
4307
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
4466
4308
|
* or search.
|
|
4467
|
-
*
|
|
4468
4309
|
* @param - Liveboard embed takes `vizId` as a
|
|
4469
4310
|
* key. Can be left undefined when embedding Search or
|
|
4470
4311
|
* visualization.
|
|
@@ -4485,7 +4326,6 @@ export declare enum HostEvent {
|
|
|
4485
4326
|
/**
|
|
4486
4327
|
* Trigger the **Download** action on charts in
|
|
4487
4328
|
* the embedded view.
|
|
4488
|
-
*
|
|
4489
4329
|
* @example
|
|
4490
4330
|
* ```js
|
|
4491
4331
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -4502,7 +4342,6 @@ export declare enum HostEvent {
|
|
|
4502
4342
|
/**
|
|
4503
4343
|
* Trigger the **Download** > **PNG** action on
|
|
4504
4344
|
* charts in the embedded view.
|
|
4505
|
-
*
|
|
4506
4345
|
* @example
|
|
4507
4346
|
* ```js
|
|
4508
4347
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -4518,7 +4357,6 @@ export declare enum HostEvent {
|
|
|
4518
4357
|
/**
|
|
4519
4358
|
* Trigger the **Download** > **CSV** action on tables in
|
|
4520
4359
|
* the embedded view.
|
|
4521
|
-
*
|
|
4522
4360
|
* @example
|
|
4523
4361
|
* ```js
|
|
4524
4362
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -4536,7 +4374,6 @@ export declare enum HostEvent {
|
|
|
4536
4374
|
/**
|
|
4537
4375
|
* Trigger the **Download** > **XLSX** action on tables
|
|
4538
4376
|
* in the embedded view.
|
|
4539
|
-
*
|
|
4540
4377
|
* @example
|
|
4541
4378
|
* ```js
|
|
4542
4379
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -4554,7 +4391,6 @@ export declare enum HostEvent {
|
|
|
4554
4391
|
/**
|
|
4555
4392
|
* Trigger the **Share** action on an embedded
|
|
4556
4393
|
* Liveboard or Answer.
|
|
4557
|
-
*
|
|
4558
4394
|
* @example
|
|
4559
4395
|
* ```js
|
|
4560
4396
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -4568,7 +4404,6 @@ export declare enum HostEvent {
|
|
|
4568
4404
|
/**
|
|
4569
4405
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
4570
4406
|
* Saves the changes.
|
|
4571
|
-
*
|
|
4572
4407
|
* @example
|
|
4573
4408
|
* ```js
|
|
4574
4409
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -4582,7 +4417,6 @@ export declare enum HostEvent {
|
|
|
4582
4417
|
/**
|
|
4583
4418
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
4584
4419
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
4585
|
-
*
|
|
4586
4420
|
* @param - an object with `vizId` as a key
|
|
4587
4421
|
* @example
|
|
4588
4422
|
* ```js
|
|
@@ -4599,7 +4433,6 @@ export declare enum HostEvent {
|
|
|
4599
4433
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
4600
4434
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
4601
4435
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
4602
|
-
*
|
|
4603
4436
|
* @param - an object with vizId as a key
|
|
4604
4437
|
* @example
|
|
4605
4438
|
* ```js
|
|
@@ -4616,7 +4449,6 @@ export declare enum HostEvent {
|
|
|
4616
4449
|
* Trigger the **Manage pipelines** action on an embedded
|
|
4617
4450
|
* visualization or Answer.
|
|
4618
4451
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
4619
|
-
*
|
|
4620
4452
|
* @param - an object with `vizId` as a key
|
|
4621
4453
|
* @example
|
|
4622
4454
|
* ```js
|
|
@@ -4631,7 +4463,6 @@ export declare enum HostEvent {
|
|
|
4631
4463
|
ManagePipelines = "manage-pipeline",
|
|
4632
4464
|
/**
|
|
4633
4465
|
* Reset search operation on the Search or Answer page.
|
|
4634
|
-
*
|
|
4635
4466
|
* @example
|
|
4636
4467
|
* ```js
|
|
4637
4468
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -4643,32 +4474,70 @@ export declare enum HostEvent {
|
|
|
4643
4474
|
*/
|
|
4644
4475
|
ResetSearch = "resetSearch",
|
|
4645
4476
|
/**
|
|
4646
|
-
*
|
|
4647
|
-
* Get the currents visible and runtime filters applied on a Liveboard
|
|
4648
|
-
*
|
|
4477
|
+
* Get details of the visible and runtime filters applied on Liveboard.
|
|
4649
4478
|
* @example
|
|
4650
|
-
*
|
|
4479
|
+
* ```js
|
|
4480
|
+
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
4481
|
+
* console.log('data', data);
|
|
4482
|
+
* ```
|
|
4651
4483
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4652
4484
|
*/
|
|
4653
4485
|
GetFilters = "getFilters",
|
|
4654
4486
|
/**
|
|
4487
|
+
* Update one or several filters applied on a Liveboard.
|
|
4488
|
+
* @param - `filter`: a single filter object containing column name,
|
|
4489
|
+
* filter operator, and values.
|
|
4490
|
+
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
4491
|
+
* and values for each.
|
|
4655
4492
|
*
|
|
4656
|
-
*
|
|
4493
|
+
* Each filter object must include the following attributes:
|
|
4494
|
+
*
|
|
4495
|
+
* `column` - Name of the column to filter on.
|
|
4496
|
+
*
|
|
4497
|
+
* `oper` - Filter operator, for example, EQ, IN, CONTAINS.
|
|
4498
|
+
* For information about the supported filter operators,
|
|
4499
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
|
|
4500
|
+
*
|
|
4501
|
+
* `values` - An array of one or several values. The value definition on the
|
|
4502
|
+
* data type you choose to filter on. For a complete list of supported data types,
|
|
4503
|
+
* see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
|
|
4504
|
+
* @example
|
|
4505
|
+
* ```js
|
|
4657
4506
|
*
|
|
4658
|
-
*
|
|
4507
|
+
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4508
|
+
* filter: {
|
|
4509
|
+
* column: "item type",
|
|
4510
|
+
* oper: "IN",
|
|
4511
|
+
* values: ["bags","shirts"],
|
|
4512
|
+
* }
|
|
4513
|
+
* });
|
|
4514
|
+
* ```
|
|
4659
4515
|
* @example
|
|
4660
4516
|
*
|
|
4661
4517
|
* ```js
|
|
4662
4518
|
* liveboardEmbed.trigger(HostEvent.UpdateFilters, {
|
|
4663
|
-
*
|
|
4664
|
-
*
|
|
4519
|
+
* filters: [{
|
|
4520
|
+
* column: "Item Type",
|
|
4521
|
+
* oper: 'IN',
|
|
4522
|
+
* values: ["bags","shirts"]
|
|
4523
|
+
* },
|
|
4524
|
+
* {
|
|
4525
|
+
* column: "Region",
|
|
4526
|
+
* oper: 'IN',
|
|
4527
|
+
* values: ["West","Midwest"]
|
|
4528
|
+
* },
|
|
4529
|
+
* {
|
|
4530
|
+
* column: "Date",
|
|
4531
|
+
* oper: 'EQ',
|
|
4532
|
+
* values: ["1656680400"]
|
|
4533
|
+
* }]
|
|
4534
|
+
* });
|
|
4665
4535
|
* ```
|
|
4666
4536
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4667
4537
|
*/
|
|
4668
4538
|
UpdateFilters = "updateFilters",
|
|
4669
4539
|
/**
|
|
4670
4540
|
* Get tab details for the current Liveboard.
|
|
4671
|
-
*
|
|
4672
4541
|
* @example
|
|
4673
4542
|
* ```js
|
|
4674
4543
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -4682,7 +4551,6 @@ export declare enum HostEvent {
|
|
|
4682
4551
|
GetTabs = "getTabs",
|
|
4683
4552
|
/**
|
|
4684
4553
|
* Set the visible tabs on a Liveboard.
|
|
4685
|
-
*
|
|
4686
4554
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
4687
4555
|
* will be hidden.
|
|
4688
4556
|
* @example
|
|
@@ -4696,7 +4564,6 @@ export declare enum HostEvent {
|
|
|
4696
4564
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4697
4565
|
/**
|
|
4698
4566
|
* Set the hidden tabs on a Liveboard.
|
|
4699
|
-
*
|
|
4700
4567
|
* @param - an array of the IDs of the tabs to hide.
|
|
4701
4568
|
* The IDs not passed will be shown.
|
|
4702
4569
|
* @example
|
|
@@ -4710,7 +4577,6 @@ export declare enum HostEvent {
|
|
|
4710
4577
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4711
4578
|
/**
|
|
4712
4579
|
* Updates the search query string for Natural Language Search operations.
|
|
4713
|
-
*
|
|
4714
4580
|
* @param - `queryString`: Text string in Natural Language format
|
|
4715
4581
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
4716
4582
|
* @example
|
|
@@ -4725,7 +4591,6 @@ export declare enum HostEvent {
|
|
|
4725
4591
|
UpdateSageQuery = "updateSageQuery",
|
|
4726
4592
|
/**
|
|
4727
4593
|
* Get the answer session for a Search / Visualization.
|
|
4728
|
-
*
|
|
4729
4594
|
* @example
|
|
4730
4595
|
* ```js
|
|
4731
4596
|
* const {session} = await embed.trigger(
|
|
@@ -4738,7 +4603,6 @@ export declare enum HostEvent {
|
|
|
4738
4603
|
GetAnswerSession = "getAnswerSession",
|
|
4739
4604
|
/**
|
|
4740
4605
|
* Trigger Ask Sage for viz
|
|
4741
|
-
*
|
|
4742
4606
|
* @example
|
|
4743
4607
|
* ```js
|
|
4744
4608
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -4749,7 +4613,6 @@ export declare enum HostEvent {
|
|
|
4749
4613
|
AskSage = "AskSage",
|
|
4750
4614
|
/**
|
|
4751
4615
|
* Trigger UpdateCrossFilter for Liveboard
|
|
4752
|
-
*
|
|
4753
4616
|
* @example
|
|
4754
4617
|
* ```js
|
|
4755
4618
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4765,14 +4628,42 @@ export declare enum HostEvent {
|
|
|
4765
4628
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4766
4629
|
/**
|
|
4767
4630
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
4768
|
-
*
|
|
4769
4631
|
* @example
|
|
4770
4632
|
* ```js
|
|
4771
4633
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
4772
4634
|
* ```
|
|
4773
4635
|
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4774
4636
|
*/
|
|
4775
|
-
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView"
|
|
4637
|
+
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4638
|
+
/**
|
|
4639
|
+
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4640
|
+
* @example
|
|
4641
|
+
* ```js
|
|
4642
|
+
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
4643
|
+
*
|
|
4644
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4645
|
+
*/
|
|
4646
|
+
CreateLiveboard = "CreateLiveboard",
|
|
4647
|
+
/**
|
|
4648
|
+
* Triggers Update RuntimeParameters for answers and liveboard
|
|
4649
|
+
* @example
|
|
4650
|
+
* ```js
|
|
4651
|
+
* liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
|
|
4652
|
+
* name: "Color",
|
|
4653
|
+
* value: "almond"
|
|
4654
|
+
* }])
|
|
4655
|
+
*
|
|
4656
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4657
|
+
*/
|
|
4658
|
+
UpdateParameters = "UpdateParameters",
|
|
4659
|
+
/**
|
|
4660
|
+
* Triggers GetParameters to fetch the runtime parameters
|
|
4661
|
+
* ```js
|
|
4662
|
+
* liveboardEmbed.trigger(HostEvent.GetParameters);
|
|
4663
|
+
*
|
|
4664
|
+
* @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
4665
|
+
*/
|
|
4666
|
+
GetParameters = "GetParameters"
|
|
4776
4667
|
}
|
|
4777
4668
|
/**
|
|
4778
4669
|
* The different visual modes that the data sources panel within
|
|
@@ -4869,7 +4760,15 @@ export declare enum Param {
|
|
|
4869
4760
|
ClientLogLevel = "clientLogLevel",
|
|
4870
4761
|
OverrideNativeConsole = "overrideConsoleLogs",
|
|
4871
4762
|
enableAskSage = "enableAskSage",
|
|
4872
|
-
CollapseSearchBarInitially = "collapseSearchBarInitially"
|
|
4763
|
+
CollapseSearchBarInitially = "collapseSearchBarInitially",
|
|
4764
|
+
DataPanelCustomGroupsAccordionInitialState = "dataPanelCustomGroupsAccordionInitialState",
|
|
4765
|
+
EnableCustomColumnGroups = "enableCustomColumnGroups",
|
|
4766
|
+
DateFormatLocale = "dateFormatLocale",
|
|
4767
|
+
NumberFormatLocale = "numberFormatLocale",
|
|
4768
|
+
CurrencyFormat = "currencyFormat",
|
|
4769
|
+
Enable2ColumnLayout = "enable2ColumnLayout",
|
|
4770
|
+
IsFullAppEmbed = "isFullAppEmbed",
|
|
4771
|
+
IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled"
|
|
4873
4772
|
}
|
|
4874
4773
|
/**
|
|
4875
4774
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -4878,7 +4777,6 @@ export declare enum Param {
|
|
|
4878
4777
|
* specific actions in the embedded view, define the Action
|
|
4879
4778
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
4880
4779
|
* or `hiddenActions` array.
|
|
4881
|
-
*
|
|
4882
4780
|
* @example
|
|
4883
4781
|
* ```js
|
|
4884
4782
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -4902,10 +4800,9 @@ export declare enum Action {
|
|
|
4902
4800
|
/**
|
|
4903
4801
|
* The **Save** action on an Answer or Liveboard.
|
|
4904
4802
|
* Allows users to save the changes.
|
|
4905
|
-
*
|
|
4906
4803
|
* @example
|
|
4907
4804
|
* ```js
|
|
4908
|
-
* disabledActions: [Action.
|
|
4805
|
+
* disabledActions: [Action.Save]
|
|
4909
4806
|
* ```
|
|
4910
4807
|
*/
|
|
4911
4808
|
Save = "save",
|
|
@@ -4920,7 +4817,6 @@ export declare enum Action {
|
|
|
4920
4817
|
/**
|
|
4921
4818
|
* The **Save as View** action on the Answer
|
|
4922
4819
|
* page. Saves an Answer as a View object.
|
|
4923
|
-
*
|
|
4924
4820
|
* @example
|
|
4925
4821
|
* ```js
|
|
4926
4822
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -4934,7 +4830,6 @@ export declare enum Action {
|
|
|
4934
4830
|
* visualizations in the embedded Liveboard view.
|
|
4935
4831
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
4936
4832
|
* Liveboards and visualizations.
|
|
4937
|
-
*
|
|
4938
4833
|
* @example
|
|
4939
4834
|
* ```js
|
|
4940
4835
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -4944,7 +4839,6 @@ export declare enum Action {
|
|
|
4944
4839
|
/**
|
|
4945
4840
|
* The **Copy and Edit** action on a Liveboard.
|
|
4946
4841
|
* This action is now replaced with `Action.MakeACopy`.
|
|
4947
|
-
*
|
|
4948
4842
|
* @example
|
|
4949
4843
|
* ```js
|
|
4950
4844
|
* disabledActions: [Action.EditACopy]
|
|
@@ -4954,7 +4848,6 @@ export declare enum Action {
|
|
|
4954
4848
|
/**
|
|
4955
4849
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
4956
4850
|
* Copies the visualization URL
|
|
4957
|
-
*
|
|
4958
4851
|
* @example
|
|
4959
4852
|
* ```js
|
|
4960
4853
|
* disabledActions: [Action.CopyLink]
|
|
@@ -4968,7 +4861,6 @@ export declare enum Action {
|
|
|
4968
4861
|
/**
|
|
4969
4862
|
* The **Schedule** menu action on a Liveboard.
|
|
4970
4863
|
* Allows scheduling a Liveboard notification.
|
|
4971
|
-
*
|
|
4972
4864
|
* @example
|
|
4973
4865
|
* ```js
|
|
4974
4866
|
* disabledActions: [Action.Schedule]
|
|
@@ -4978,7 +4870,6 @@ export declare enum Action {
|
|
|
4978
4870
|
/**
|
|
4979
4871
|
* The **Manage schedules** menu action on a Liveboard.
|
|
4980
4872
|
* Allows users to manage scheduled Liveboard jobs.
|
|
4981
|
-
*
|
|
4982
4873
|
* @example
|
|
4983
4874
|
* ```js
|
|
4984
4875
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -4988,7 +4879,6 @@ export declare enum Action {
|
|
|
4988
4879
|
/**
|
|
4989
4880
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
4990
4881
|
* Allows users to share an object with other users and groups.
|
|
4991
|
-
*
|
|
4992
4882
|
* @example
|
|
4993
4883
|
* ```js
|
|
4994
4884
|
* disabledActions: [Action.Share]
|
|
@@ -4998,7 +4888,6 @@ export declare enum Action {
|
|
|
4998
4888
|
/**
|
|
4999
4889
|
* The **Add filter** action on a Liveboard and Search page.
|
|
5000
4890
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
5001
|
-
*
|
|
5002
4891
|
* @example
|
|
5003
4892
|
* ```js
|
|
5004
4893
|
* disabledActions: [Action.AddFilter]
|
|
@@ -5009,7 +4898,6 @@ export declare enum Action {
|
|
|
5009
4898
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
5010
4899
|
* Allows to show action menu to add different objects (like
|
|
5011
4900
|
* formulas, parameters) in data panel v2.
|
|
5012
|
-
*
|
|
5013
4901
|
* @example
|
|
5014
4902
|
* ```js
|
|
5015
4903
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -5021,7 +4909,6 @@ export declare enum Action {
|
|
|
5021
4909
|
* Filter configuration options on a Liveboard and Search page.
|
|
5022
4910
|
* Allows configuring filter options when adding filters to a
|
|
5023
4911
|
* Liveboard or Answer.
|
|
5024
|
-
*
|
|
5025
4912
|
* @example
|
|
5026
4913
|
* ```js
|
|
5027
4914
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -5032,7 +4919,6 @@ export declare enum Action {
|
|
|
5032
4919
|
/**
|
|
5033
4920
|
* The **Choose sources** button on Search page.
|
|
5034
4921
|
* Allows selecting data sources for search queries.
|
|
5035
|
-
*
|
|
5036
4922
|
* @example
|
|
5037
4923
|
* ```js
|
|
5038
4924
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -5042,7 +4928,6 @@ export declare enum Action {
|
|
|
5042
4928
|
/**
|
|
5043
4929
|
* The **Create formula** action on a Search or Answer page.
|
|
5044
4930
|
* Allows adding formulas to an Answer.
|
|
5045
|
-
*
|
|
5046
4931
|
* @example
|
|
5047
4932
|
* ```js
|
|
5048
4933
|
* disabledActions: [Action.AddFormula]
|
|
@@ -5052,7 +4937,6 @@ export declare enum Action {
|
|
|
5052
4937
|
/**
|
|
5053
4938
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
5054
4939
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
5055
|
-
*
|
|
5056
4940
|
* @example
|
|
5057
4941
|
* ```js
|
|
5058
4942
|
* disabledActions: [Action.AddParameter]
|
|
@@ -5062,7 +4946,6 @@ export declare enum Action {
|
|
|
5062
4946
|
/**
|
|
5063
4947
|
* The **Add Column Set** action on a Answer.
|
|
5064
4948
|
* Allows adding column sets to a Answer.
|
|
5065
|
-
*
|
|
5066
4949
|
* @example
|
|
5067
4950
|
* ```js
|
|
5068
4951
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -5073,7 +4956,6 @@ export declare enum Action {
|
|
|
5073
4956
|
/**
|
|
5074
4957
|
* The **Add Query Set** action on a Answer.
|
|
5075
4958
|
* Allows adding query sets to a Answer.
|
|
5076
|
-
*
|
|
5077
4959
|
* @example
|
|
5078
4960
|
* ```js
|
|
5079
4961
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -5088,7 +4970,6 @@ export declare enum Action {
|
|
|
5088
4970
|
/**
|
|
5089
4971
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
5090
4972
|
* Answer page.
|
|
5091
|
-
*
|
|
5092
4973
|
* @example
|
|
5093
4974
|
* ```js
|
|
5094
4975
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -5111,7 +4992,6 @@ export declare enum Action {
|
|
|
5111
4992
|
/**
|
|
5112
4993
|
* The **Show underlying data** menu action on a visualization or
|
|
5113
4994
|
* Answer page.
|
|
5114
|
-
*
|
|
5115
4995
|
* @example
|
|
5116
4996
|
* ```js
|
|
5117
4997
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5122,7 +5002,6 @@ export declare enum Action {
|
|
|
5122
5002
|
* The **Download** menu action on Liveboard visualizations
|
|
5123
5003
|
* and Answers.
|
|
5124
5004
|
* Allows downloading a visualization or Answer.
|
|
5125
|
-
*
|
|
5126
5005
|
* @example
|
|
5127
5006
|
* ```js
|
|
5128
5007
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5133,7 +5012,6 @@ export declare enum Action {
|
|
|
5133
5012
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
5134
5013
|
* or Answer page.
|
|
5135
5014
|
* Downloads a visualization or Answer as a PNG file.
|
|
5136
|
-
*
|
|
5137
5015
|
* @example
|
|
5138
5016
|
* ```js
|
|
5139
5017
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5141,9 +5019,12 @@ export declare enum Action {
|
|
|
5141
5019
|
*/
|
|
5142
5020
|
DownloadAsPng = "downloadAsPng",
|
|
5143
5021
|
/**
|
|
5144
|
-
* The **Download** > **PDF** menu action on a Liveboard.
|
|
5145
|
-
* Downloads a visualization or Answer as a PDF file.
|
|
5146
5022
|
*
|
|
5023
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
5024
|
+
*visualization, or Answer as a PDF file.
|
|
5025
|
+
*
|
|
5026
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
5027
|
+
*visualizations and Answers if the data is in tabular format.
|
|
5147
5028
|
* @example
|
|
5148
5029
|
* ```js
|
|
5149
5030
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -5154,7 +5035,6 @@ export declare enum Action {
|
|
|
5154
5035
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
5155
5036
|
* or Answer page.
|
|
5156
5037
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5157
|
-
*
|
|
5158
5038
|
* @example
|
|
5159
5039
|
* ```js
|
|
5160
5040
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -5165,7 +5045,6 @@ export declare enum Action {
|
|
|
5165
5045
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
5166
5046
|
* or Answer page.
|
|
5167
5047
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5168
|
-
*
|
|
5169
5048
|
* @example
|
|
5170
5049
|
* ```js
|
|
5171
5050
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -5180,7 +5059,6 @@ export declare enum Action {
|
|
|
5180
5059
|
* The **Export TML** menu action on Liveboard, Answers
|
|
5181
5060
|
* Worksheets and Data Connections page.
|
|
5182
5061
|
* Exports an object as a TML file.
|
|
5183
|
-
*
|
|
5184
5062
|
* @example
|
|
5185
5063
|
* ```js
|
|
5186
5064
|
* disabledActions: [Action.ExportTML]
|
|
@@ -5190,7 +5068,6 @@ export declare enum Action {
|
|
|
5190
5068
|
/**
|
|
5191
5069
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
5192
5070
|
* Imports TML representation of ThoughtSpot objects.
|
|
5193
|
-
*
|
|
5194
5071
|
* @example
|
|
5195
5072
|
* ```js
|
|
5196
5073
|
* disabledActions: [Action.ImportTML]
|
|
@@ -5200,7 +5077,6 @@ export declare enum Action {
|
|
|
5200
5077
|
/**
|
|
5201
5078
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
5202
5079
|
* Update TML representation of ThoughtSpot objects.
|
|
5203
|
-
*
|
|
5204
5080
|
* @example
|
|
5205
5081
|
* ```js
|
|
5206
5082
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -5210,7 +5086,6 @@ export declare enum Action {
|
|
|
5210
5086
|
/**
|
|
5211
5087
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
5212
5088
|
* Opens the TML editor.
|
|
5213
|
-
*
|
|
5214
5089
|
* @example
|
|
5215
5090
|
* ```js
|
|
5216
5091
|
* disabledActions: [Action.EditTML]
|
|
@@ -5221,7 +5096,6 @@ export declare enum Action {
|
|
|
5221
5096
|
* The **Present** menu action for Liveboards and Answers.
|
|
5222
5097
|
* Allows presenting a Liveboard or visualization in
|
|
5223
5098
|
* slideshow mode.
|
|
5224
|
-
*
|
|
5225
5099
|
* @example
|
|
5226
5100
|
* ```js
|
|
5227
5101
|
* disabledActions: [Action.Present]
|
|
@@ -5231,7 +5105,6 @@ export declare enum Action {
|
|
|
5231
5105
|
/**
|
|
5232
5106
|
* The tile resize options in the visualization menu.
|
|
5233
5107
|
* Allows switching between different preset layouts.
|
|
5234
|
-
*
|
|
5235
5108
|
* @example
|
|
5236
5109
|
* ```js
|
|
5237
5110
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -5242,7 +5115,6 @@ export declare enum Action {
|
|
|
5242
5115
|
* The *Edit* action on the Liveboard page and in the
|
|
5243
5116
|
* visualization menu.
|
|
5244
5117
|
* Opens a Liveboard or visualization in edit mode.
|
|
5245
|
-
*
|
|
5246
5118
|
* @example
|
|
5247
5119
|
* ```js
|
|
5248
5120
|
* disabledActions: [Action.Edit]
|
|
@@ -5251,7 +5123,6 @@ export declare enum Action {
|
|
|
5251
5123
|
Edit = "edit",
|
|
5252
5124
|
/**
|
|
5253
5125
|
* The text edit option for Liveboard and visualization titles.
|
|
5254
|
-
*
|
|
5255
5126
|
* @example
|
|
5256
5127
|
* ```js
|
|
5257
5128
|
* disabledActions: [Action.EditTitle]
|
|
@@ -5261,7 +5132,6 @@ export declare enum Action {
|
|
|
5261
5132
|
/**
|
|
5262
5133
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
5263
5134
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
5264
|
-
*
|
|
5265
5135
|
* @example
|
|
5266
5136
|
* ```js
|
|
5267
5137
|
* disabledActions: [Action.Remove]
|
|
@@ -5293,7 +5163,6 @@ export declare enum Action {
|
|
|
5293
5163
|
* Displays details such as the name, description, and
|
|
5294
5164
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
5295
5165
|
* and update.
|
|
5296
|
-
*
|
|
5297
5166
|
* @example
|
|
5298
5167
|
* ```js
|
|
5299
5168
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -5311,7 +5180,6 @@ export declare enum Action {
|
|
|
5311
5180
|
/**
|
|
5312
5181
|
* The **Pin** menu action on an Answer or
|
|
5313
5182
|
* Search results page.
|
|
5314
|
-
*
|
|
5315
5183
|
* @example
|
|
5316
5184
|
* ```js
|
|
5317
5185
|
* disabledActions: [Action.Pin]
|
|
@@ -5324,7 +5192,6 @@ export declare enum Action {
|
|
|
5324
5192
|
AnalysisInfo = "analysisInfo",
|
|
5325
5193
|
/**
|
|
5326
5194
|
* The **Schedule** menu action on a Liveboard.
|
|
5327
|
-
*
|
|
5328
5195
|
* @example
|
|
5329
5196
|
* ```js
|
|
5330
5197
|
* disabledActions: [Action.Subscription]
|
|
@@ -5333,7 +5200,6 @@ export declare enum Action {
|
|
|
5333
5200
|
Subscription = "subscription",
|
|
5334
5201
|
/**
|
|
5335
5202
|
* The **Explore** action on Liveboard visualizations
|
|
5336
|
-
*
|
|
5337
5203
|
* @example
|
|
5338
5204
|
* ```js
|
|
5339
5205
|
* disabledActions: [Action.Explore]
|
|
@@ -5343,7 +5209,6 @@ export declare enum Action {
|
|
|
5343
5209
|
/**
|
|
5344
5210
|
* The action to include data points on a drilled-down Answer
|
|
5345
5211
|
* or visualization
|
|
5346
|
-
*
|
|
5347
5212
|
* @example
|
|
5348
5213
|
* ```js
|
|
5349
5214
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5353,7 +5218,6 @@ export declare enum Action {
|
|
|
5353
5218
|
/**
|
|
5354
5219
|
* The action to exclude data points on a drilled-down Answer
|
|
5355
5220
|
* or visualization
|
|
5356
|
-
*
|
|
5357
5221
|
* @example
|
|
5358
5222
|
* ```js
|
|
5359
5223
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5364,7 +5228,6 @@ export declare enum Action {
|
|
|
5364
5228
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
5365
5229
|
* or Liveboard.
|
|
5366
5230
|
* Copies the selected data point.
|
|
5367
|
-
*
|
|
5368
5231
|
* @example
|
|
5369
5232
|
* ```js
|
|
5370
5233
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -5382,7 +5245,6 @@ export declare enum Action {
|
|
|
5382
5245
|
* The **Drill down** menu action on Answers and Liveboard
|
|
5383
5246
|
* visualizations.
|
|
5384
5247
|
* Allows drilling down to a specific data point on a chart or table.
|
|
5385
|
-
*
|
|
5386
5248
|
* @example
|
|
5387
5249
|
* ```js
|
|
5388
5250
|
* disabledActions: [Action.DrillDown]
|
|
@@ -5392,7 +5254,6 @@ export declare enum Action {
|
|
|
5392
5254
|
/**
|
|
5393
5255
|
* The request access action on Liveboards.
|
|
5394
5256
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
5395
|
-
*
|
|
5396
5257
|
* @example
|
|
5397
5258
|
* ```js
|
|
5398
5259
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -5402,7 +5263,6 @@ export declare enum Action {
|
|
|
5402
5263
|
/**
|
|
5403
5264
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
5404
5265
|
* of the Answer page
|
|
5405
|
-
*
|
|
5406
5266
|
* @example
|
|
5407
5267
|
* ```js
|
|
5408
5268
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5411,7 +5271,6 @@ export declare enum Action {
|
|
|
5411
5271
|
QueryDetailsButtons = "queryDetailsButtons",
|
|
5412
5272
|
/**
|
|
5413
5273
|
* The **Delete** action for Answers.
|
|
5414
|
-
*
|
|
5415
5274
|
* @example
|
|
5416
5275
|
* ```js
|
|
5417
5276
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -5421,7 +5280,6 @@ export declare enum Action {
|
|
|
5421
5280
|
AnswerDelete = "onDeleteAnswer",
|
|
5422
5281
|
/**
|
|
5423
5282
|
* The Chart switcher icon on Answer and visualization pages.
|
|
5424
|
-
*
|
|
5425
5283
|
* @example
|
|
5426
5284
|
* ```js
|
|
5427
5285
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5431,7 +5289,6 @@ export declare enum Action {
|
|
|
5431
5289
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5432
5290
|
/**
|
|
5433
5291
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
5434
|
-
*
|
|
5435
5292
|
* @example
|
|
5436
5293
|
* ```js
|
|
5437
5294
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5441,7 +5298,6 @@ export declare enum Action {
|
|
|
5441
5298
|
AddToFavorites = "addToFavorites",
|
|
5442
5299
|
/**
|
|
5443
5300
|
* The edit icon on Liveboards (Classic experience).
|
|
5444
|
-
*
|
|
5445
5301
|
* @example
|
|
5446
5302
|
* ```js
|
|
5447
5303
|
* disabledActions: [Action.EditDetails]
|
|
@@ -5451,7 +5307,6 @@ export declare enum Action {
|
|
|
5451
5307
|
EditDetails = "editDetails",
|
|
5452
5308
|
/**
|
|
5453
5309
|
* The Create alert action on KPI charts.
|
|
5454
|
-
*
|
|
5455
5310
|
* @example
|
|
5456
5311
|
* ```js
|
|
5457
5312
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -5470,7 +5325,6 @@ export declare enum Action {
|
|
|
5470
5325
|
/**
|
|
5471
5326
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
5472
5327
|
* Allows sending data to a Google Sheet.
|
|
5473
|
-
*
|
|
5474
5328
|
* @example
|
|
5475
5329
|
* ```js
|
|
5476
5330
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -5482,7 +5336,6 @@ export declare enum Action {
|
|
|
5482
5336
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
5483
5337
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
5484
5338
|
* Microsoft Teams, and so on.
|
|
5485
|
-
*
|
|
5486
5339
|
* @example
|
|
5487
5340
|
* ```js
|
|
5488
5341
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5493,7 +5346,6 @@ export declare enum Action {
|
|
|
5493
5346
|
/**
|
|
5494
5347
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
5495
5348
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5496
|
-
*
|
|
5497
5349
|
* @example
|
|
5498
5350
|
* ```js
|
|
5499
5351
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5504,7 +5356,6 @@ export declare enum Action {
|
|
|
5504
5356
|
/**
|
|
5505
5357
|
* The **Filter** action on Liveboard visualizations.
|
|
5506
5358
|
* Allows users to apply cross-filters on a Liveboard.
|
|
5507
|
-
*
|
|
5508
5359
|
* @example
|
|
5509
5360
|
* ```js
|
|
5510
5361
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -5515,7 +5366,6 @@ export declare enum Action {
|
|
|
5515
5366
|
/**
|
|
5516
5367
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5517
5368
|
* Allows sending data to third-party apps Slack
|
|
5518
|
-
*
|
|
5519
5369
|
* @example
|
|
5520
5370
|
* ```js
|
|
5521
5371
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -5526,7 +5376,6 @@ export declare enum Action {
|
|
|
5526
5376
|
/**
|
|
5527
5377
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5528
5378
|
* Allows sending data to third-party apps Team
|
|
5529
|
-
*
|
|
5530
5379
|
* @example
|
|
5531
5380
|
* ```js
|
|
5532
5381
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -5538,7 +5387,6 @@ export declare enum Action {
|
|
|
5538
5387
|
* The **Remove** action that appears when cross filters are applied
|
|
5539
5388
|
* on a Liveboard.
|
|
5540
5389
|
* Removes filters applied o a visualization.
|
|
5541
|
-
*
|
|
5542
5390
|
* @example
|
|
5543
5391
|
* ```js
|
|
5544
5392
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5550,7 +5398,6 @@ export declare enum Action {
|
|
|
5550
5398
|
* The **Aggregate** option in the chart axis or the
|
|
5551
5399
|
* table column customization menu.
|
|
5552
5400
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
5553
|
-
*
|
|
5554
5401
|
* @example
|
|
5555
5402
|
* ```js
|
|
5556
5403
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -5562,7 +5409,6 @@ export declare enum Action {
|
|
|
5562
5409
|
* The **Time bucket** option in the chart axis or table column
|
|
5563
5410
|
* customization menu.
|
|
5564
5411
|
* Allows defining time metric for date comparison.
|
|
5565
|
-
*
|
|
5566
5412
|
* @example
|
|
5567
5413
|
* ```js
|
|
5568
5414
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -5573,7 +5419,6 @@ export declare enum Action {
|
|
|
5573
5419
|
/**
|
|
5574
5420
|
* The **Filter** action in the chart axis or table column
|
|
5575
5421
|
* customization menu.
|
|
5576
|
-
*
|
|
5577
5422
|
* @example
|
|
5578
5423
|
* ```js
|
|
5579
5424
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -5585,7 +5430,6 @@ export declare enum Action {
|
|
|
5585
5430
|
* The **Conditional formatting** action on chart or table.
|
|
5586
5431
|
* Allows adding rules for conditional formatting of data
|
|
5587
5432
|
* points on a chart or table.
|
|
5588
|
-
*
|
|
5589
5433
|
* @example
|
|
5590
5434
|
* ```js
|
|
5591
5435
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5597,7 +5441,6 @@ export declare enum Action {
|
|
|
5597
5441
|
* The **Sort** menu action on a table or chart axis
|
|
5598
5442
|
* Sorts data in ascending or descending order.
|
|
5599
5443
|
* Allows adding, editing, or removing filters.
|
|
5600
|
-
*
|
|
5601
5444
|
* @example
|
|
5602
5445
|
* ```js
|
|
5603
5446
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5610,7 +5453,6 @@ export declare enum Action {
|
|
|
5610
5453
|
* customization menu.
|
|
5611
5454
|
* Allows grouping data points if the axes use the same
|
|
5612
5455
|
* unit of measurement and a similar scale.
|
|
5613
|
-
*
|
|
5614
5456
|
* @example
|
|
5615
5457
|
* ```js
|
|
5616
5458
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -5622,7 +5464,6 @@ export declare enum Action {
|
|
|
5622
5464
|
* The **Position** option in the axis customization menu.
|
|
5623
5465
|
* Allows changing the position of the axis to the
|
|
5624
5466
|
* left or right side of the chart.
|
|
5625
|
-
*
|
|
5626
5467
|
* @example
|
|
5627
5468
|
* ```js
|
|
5628
5469
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -5633,7 +5474,6 @@ export declare enum Action {
|
|
|
5633
5474
|
/**
|
|
5634
5475
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
5635
5476
|
* Renames the axis label on a chart or the column header on a table.
|
|
5636
|
-
*
|
|
5637
5477
|
* @example
|
|
5638
5478
|
* ```js
|
|
5639
5479
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -5645,7 +5485,6 @@ export declare enum Action {
|
|
|
5645
5485
|
* The **Edit** action in the axis customization menu.
|
|
5646
5486
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
5647
5487
|
* and format of a column.
|
|
5648
|
-
*
|
|
5649
5488
|
* @example
|
|
5650
5489
|
* ```js
|
|
5651
5490
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -5656,7 +5495,6 @@ export declare enum Action {
|
|
|
5656
5495
|
/**
|
|
5657
5496
|
* The **Number format** action to customize the format of
|
|
5658
5497
|
* the data labels on a chart or table.
|
|
5659
|
-
*
|
|
5660
5498
|
* @example
|
|
5661
5499
|
* ```js
|
|
5662
5500
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -5667,7 +5505,6 @@ export declare enum Action {
|
|
|
5667
5505
|
/**
|
|
5668
5506
|
* The **Text wrapping** action on a table.
|
|
5669
5507
|
* Wraps or clips column text on a table.
|
|
5670
|
-
*
|
|
5671
5508
|
* @example
|
|
5672
5509
|
* ```js
|
|
5673
5510
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -5680,7 +5517,6 @@ export declare enum Action {
|
|
|
5680
5517
|
* customization menu.
|
|
5681
5518
|
* Removes the data labels from a chart or the column of a
|
|
5682
5519
|
* table visualization.
|
|
5683
|
-
*
|
|
5684
5520
|
* @example
|
|
5685
5521
|
* ```js
|
|
5686
5522
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -5695,7 +5531,6 @@ export declare enum Action {
|
|
|
5695
5531
|
/**
|
|
5696
5532
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
5697
5533
|
* Allows renaming a Liveboard or visualization.
|
|
5698
|
-
*
|
|
5699
5534
|
* @example
|
|
5700
5535
|
* ```js
|
|
5701
5536
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -5739,7 +5574,6 @@ export declare enum Action {
|
|
|
5739
5574
|
/**
|
|
5740
5575
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
5741
5576
|
* Allows moving a visualization to a different tab.
|
|
5742
|
-
*
|
|
5743
5577
|
* @example
|
|
5744
5578
|
* ```js
|
|
5745
5579
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -5748,7 +5582,6 @@ export declare enum Action {
|
|
|
5748
5582
|
MoveToTab = "onContainerMove",
|
|
5749
5583
|
/**
|
|
5750
5584
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
5751
|
-
*
|
|
5752
5585
|
* @example
|
|
5753
5586
|
* ```js
|
|
5754
5587
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5757,7 +5590,6 @@ export declare enum Action {
|
|
|
5757
5590
|
ManageMonitor = "ManageMonitor",
|
|
5758
5591
|
/**
|
|
5759
5592
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5760
|
-
*
|
|
5761
5593
|
* @example
|
|
5762
5594
|
* ```js
|
|
5763
5595
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -5767,7 +5599,6 @@ export declare enum Action {
|
|
|
5767
5599
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5768
5600
|
/**
|
|
5769
5601
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
5770
|
-
*
|
|
5771
5602
|
* @example
|
|
5772
5603
|
* ```js
|
|
5773
5604
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -5779,7 +5610,6 @@ export declare enum Action {
|
|
|
5779
5610
|
* Action ID for the Parent TML action
|
|
5780
5611
|
* The parent action **TML** must be included to access TML-related options
|
|
5781
5612
|
* within the cascading menu (specific to the answer page)
|
|
5782
|
-
*
|
|
5783
5613
|
* @example
|
|
5784
5614
|
* ```js
|
|
5785
5615
|
* // to include specific TML actions
|
|
@@ -5791,13 +5621,11 @@ export declare enum Action {
|
|
|
5791
5621
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5792
5622
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5793
5623
|
* ```
|
|
5794
|
-
*
|
|
5795
|
-
* @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
|
|
5624
|
+
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5796
5625
|
*/
|
|
5797
5626
|
TML = "tml",
|
|
5798
5627
|
/**
|
|
5799
5628
|
* Action ID for to hide Verified Liveboard Banner
|
|
5800
|
-
*
|
|
5801
5629
|
* @example
|
|
5802
5630
|
* ```js
|
|
5803
5631
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -5807,7 +5635,6 @@ export declare enum Action {
|
|
|
5807
5635
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
5808
5636
|
/**
|
|
5809
5637
|
* Action ID for ask sage button
|
|
5810
|
-
*
|
|
5811
5638
|
* @example
|
|
5812
5639
|
* ```js
|
|
5813
5640
|
* hiddenAction: [Action.AskAi]
|
|
@@ -5817,7 +5644,6 @@ export declare enum Action {
|
|
|
5817
5644
|
AskAi = "AskAi",
|
|
5818
5645
|
/**
|
|
5819
5646
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
5820
|
-
*
|
|
5821
5647
|
* @example
|
|
5822
5648
|
* ```js
|
|
5823
5649
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -5827,7 +5653,6 @@ export declare enum Action {
|
|
|
5827
5653
|
AddToWatchlist = "addToWatchlist",
|
|
5828
5654
|
/**
|
|
5829
5655
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
5830
|
-
*
|
|
5831
5656
|
* @example
|
|
5832
5657
|
* ```js
|
|
5833
5658
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -5835,19 +5660,8 @@ export declare enum Action {
|
|
|
5835
5660
|
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
5836
5661
|
*/
|
|
5837
5662
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
5838
|
-
/**
|
|
5839
|
-
* The **Copy KPI Link** menu action on KPI watchlist.
|
|
5840
|
-
*
|
|
5841
|
-
* @example
|
|
5842
|
-
* ```js
|
|
5843
|
-
* disabledActions: [Action.CopyKpiLink]
|
|
5844
|
-
* ```
|
|
5845
|
-
* @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
|
|
5846
|
-
*/
|
|
5847
|
-
CopyKpiLink = "copyKpiLink",
|
|
5848
5663
|
/**
|
|
5849
5664
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
5850
|
-
*
|
|
5851
5665
|
* @example
|
|
5852
5666
|
* ```js
|
|
5853
5667
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -5857,7 +5671,6 @@ export declare enum Action {
|
|
|
5857
5671
|
OrganiseFavourites = "organiseFavourites",
|
|
5858
5672
|
/**
|
|
5859
5673
|
* Action ID for AI Highlights button
|
|
5860
|
-
*
|
|
5861
5674
|
* @example
|
|
5862
5675
|
* ```js
|
|
5863
5676
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -5926,7 +5739,6 @@ export interface CustomActionPayload {
|
|
|
5926
5739
|
export declare enum LogLevel {
|
|
5927
5740
|
/**
|
|
5928
5741
|
* No logs will be logged in the console.
|
|
5929
|
-
*
|
|
5930
5742
|
* @example
|
|
5931
5743
|
* ```js
|
|
5932
5744
|
* init({
|
|
@@ -5939,7 +5751,6 @@ export declare enum LogLevel {
|
|
|
5939
5751
|
SILENT = "SILENT",
|
|
5940
5752
|
/**
|
|
5941
5753
|
* Only ERROR logs will be logged in the console.
|
|
5942
|
-
*
|
|
5943
5754
|
* @example
|
|
5944
5755
|
* ```js
|
|
5945
5756
|
* init({
|
|
@@ -5952,7 +5763,6 @@ export declare enum LogLevel {
|
|
|
5952
5763
|
ERROR = "ERROR",
|
|
5953
5764
|
/**
|
|
5954
5765
|
* Only WARN and ERROR logs will be logged in the console.
|
|
5955
|
-
*
|
|
5956
5766
|
* @example
|
|
5957
5767
|
* ```js
|
|
5958
5768
|
* init({
|
|
@@ -5965,7 +5775,6 @@ export declare enum LogLevel {
|
|
|
5965
5775
|
WARN = "WARN",
|
|
5966
5776
|
/**
|
|
5967
5777
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
5968
|
-
*
|
|
5969
5778
|
* @example
|
|
5970
5779
|
* ```js
|
|
5971
5780
|
* init({
|
|
@@ -5978,7 +5787,6 @@ export declare enum LogLevel {
|
|
|
5978
5787
|
INFO = "INFO",
|
|
5979
5788
|
/**
|
|
5980
5789
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
5981
|
-
*
|
|
5982
5790
|
* @example
|
|
5983
5791
|
* ```js
|
|
5984
5792
|
* init({
|
|
@@ -5991,7 +5799,6 @@ export declare enum LogLevel {
|
|
|
5991
5799
|
DEBUG = "DEBUG",
|
|
5992
5800
|
/**
|
|
5993
5801
|
* All logs will be logged in the console.
|
|
5994
|
-
*
|
|
5995
5802
|
* @example
|
|
5996
5803
|
* ```js
|
|
5997
5804
|
* init({
|
|
@@ -6366,7 +6173,6 @@ export interface UnderlyingDataPoint {
|
|
|
6366
6173
|
* custom action payload. This service could be used to run
|
|
6367
6174
|
* graphql queries in the context of the answer on which the
|
|
6368
6175
|
* custom action was triggered.
|
|
6369
|
-
*
|
|
6370
6176
|
* @example
|
|
6371
6177
|
* ```js
|
|
6372
6178
|
* embed.on(EmbedEvent.CustomAction, e => {
|
|
@@ -6376,13 +6182,22 @@ export interface UnderlyingDataPoint {
|
|
|
6376
6182
|
* const data = await underlying.fetchData(0, 100);
|
|
6377
6183
|
* })
|
|
6378
6184
|
* ```
|
|
6185
|
+
* @example
|
|
6186
|
+
* ```js
|
|
6187
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6188
|
+
* const service = await embed.getAnswerService();
|
|
6189
|
+
* await service.addColumns([
|
|
6190
|
+
* "<column guid>"
|
|
6191
|
+
* ]);
|
|
6192
|
+
* console.log(await service.fetchData());
|
|
6193
|
+
* });
|
|
6194
|
+
* ```
|
|
6379
6195
|
* @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
|
|
6380
6196
|
* @group Events
|
|
6381
6197
|
*/
|
|
6382
6198
|
export declare class AnswerService {
|
|
6383
6199
|
/**
|
|
6384
6200
|
* Should not need to be called directly.
|
|
6385
|
-
*
|
|
6386
6201
|
* @param session
|
|
6387
6202
|
* @param answer
|
|
6388
6203
|
* @param thoughtSpotHost
|
|
@@ -6396,21 +6211,42 @@ export declare class AnswerService {
|
|
|
6396
6211
|
getSourceDetail(): Promise<any>;
|
|
6397
6212
|
/**
|
|
6398
6213
|
* Remove columnIds and return updated answer session.
|
|
6399
|
-
*
|
|
6400
6214
|
* @param columnIds
|
|
6401
6215
|
* @returns
|
|
6402
6216
|
*/
|
|
6403
6217
|
removeColumns(columnIds: string[]): Promise<any>;
|
|
6404
6218
|
/**
|
|
6405
6219
|
* Add columnIds and return updated answer session.
|
|
6406
|
-
*
|
|
6407
6220
|
* @param columnIds
|
|
6408
6221
|
* @returns
|
|
6409
6222
|
*/
|
|
6410
6223
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6224
|
+
/**
|
|
6225
|
+
* Add columns by names and return updated answer session.
|
|
6226
|
+
* @param columnNames
|
|
6227
|
+
* @returns
|
|
6228
|
+
* @example
|
|
6229
|
+
* ```js
|
|
6230
|
+
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6231
|
+
* const service = await embed.getAnswerService();
|
|
6232
|
+
* await service.addColumnsByNames([
|
|
6233
|
+
* "col name 1",
|
|
6234
|
+
* "col name 2"
|
|
6235
|
+
* ]);
|
|
6236
|
+
* console.log(await service.fetchData());
|
|
6237
|
+
* });
|
|
6238
|
+
*/
|
|
6239
|
+
addColumnsByNames(columnNames: string[]): Promise<any>;
|
|
6240
|
+
/**
|
|
6241
|
+
* Add a filter to the answer.
|
|
6242
|
+
* @param columnName
|
|
6243
|
+
* @param operator
|
|
6244
|
+
* @param values
|
|
6245
|
+
* @returns
|
|
6246
|
+
*/
|
|
6247
|
+
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6411
6248
|
/**
|
|
6412
6249
|
* Fetch data from the answer.
|
|
6413
|
-
*
|
|
6414
6250
|
* @param offset
|
|
6415
6251
|
* @param size
|
|
6416
6252
|
* @returns
|
|
@@ -6422,7 +6258,6 @@ export declare class AnswerService {
|
|
|
6422
6258
|
/**
|
|
6423
6259
|
* Fetch the data for the answer as a CSV blob. This might be
|
|
6424
6260
|
* quicker for larger data.
|
|
6425
|
-
*
|
|
6426
6261
|
* @param userLocale
|
|
6427
6262
|
* @param includeInfo Include the CSV header in the output
|
|
6428
6263
|
* @returns Response
|
|
@@ -6431,7 +6266,6 @@ export declare class AnswerService {
|
|
|
6431
6266
|
/**
|
|
6432
6267
|
* Just get the internal URL for this answer's data
|
|
6433
6268
|
* as a CSV blob.
|
|
6434
|
-
*
|
|
6435
6269
|
* @param userLocale
|
|
6436
6270
|
* @param includeInfo
|
|
6437
6271
|
* @returns
|
|
@@ -6441,7 +6275,6 @@ export declare class AnswerService {
|
|
|
6441
6275
|
* Get underlying data given a point and the output column names.
|
|
6442
6276
|
* In case of a context menu action, the selectedPoints are
|
|
6443
6277
|
* automatically passed.
|
|
6444
|
-
*
|
|
6445
6278
|
* @param outputColumnNames
|
|
6446
6279
|
* @param selectedPoints
|
|
6447
6280
|
* @example
|
|
@@ -6458,7 +6291,6 @@ export declare class AnswerService {
|
|
|
6458
6291
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
6459
6292
|
/**
|
|
6460
6293
|
* Execute a custom graphql query in the context of the answer.
|
|
6461
|
-
*
|
|
6462
6294
|
* @param query graphql query
|
|
6463
6295
|
* @param variables graphql variables
|
|
6464
6296
|
* @returns
|
|
@@ -6466,15 +6298,14 @@ export declare class AnswerService {
|
|
|
6466
6298
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
6467
6299
|
/**
|
|
6468
6300
|
* Get the internal session details for the answer.
|
|
6469
|
-
*
|
|
6470
6301
|
* @returns
|
|
6471
6302
|
*/
|
|
6472
6303
|
getSession(): SessionInterface;
|
|
6304
|
+
getAnswer(): Promise<any>;
|
|
6473
6305
|
}
|
|
6474
6306
|
|
|
6475
6307
|
/**
|
|
6476
6308
|
* Gets the configuration embed was initialized with.
|
|
6477
|
-
*
|
|
6478
6309
|
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
6479
6310
|
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
6480
6311
|
* @group Global methods
|
|
@@ -6483,7 +6314,6 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
6483
6314
|
/**
|
|
6484
6315
|
* Sets the configuration embed was initialized with.
|
|
6485
6316
|
* And returns the new configuration.
|
|
6486
|
-
*
|
|
6487
6317
|
* @param newConfig The configuration to set.
|
|
6488
6318
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
6489
6319
|
* @group Global methods
|
|
@@ -6506,7 +6336,6 @@ export declare const MIXPANEL_EVENT: {
|
|
|
6506
6336
|
};
|
|
6507
6337
|
/**
|
|
6508
6338
|
* Pushes the event with its Property key-value map to mixpanel.
|
|
6509
|
-
*
|
|
6510
6339
|
* @param eventId
|
|
6511
6340
|
* @param eventProps
|
|
6512
6341
|
*/
|
|
@@ -6515,7 +6344,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
|
|
|
6515
6344
|
*
|
|
6516
6345
|
* @param sessionInfo
|
|
6517
6346
|
*/
|
|
6518
|
-
export declare function initMixpanel(sessionInfo:
|
|
6347
|
+
export declare function initMixpanel(sessionInfo: any): void;
|
|
6519
6348
|
/**
|
|
6520
6349
|
*
|
|
6521
6350
|
*/
|
|
@@ -6524,7 +6353,6 @@ export declare function testResetMixpanel(): void;
|
|
|
6524
6353
|
/**
|
|
6525
6354
|
* Fetch wrapper that adds the authentication token to the request.
|
|
6526
6355
|
* Use this to call the ThoughtSpot APIs when using the visual embed sdk.
|
|
6527
|
-
*
|
|
6528
6356
|
* @param input
|
|
6529
6357
|
* @param init
|
|
6530
6358
|
* @version SDK: 1.28.0
|
|
@@ -6532,15 +6360,14 @@ export declare function testResetMixpanel(): void;
|
|
|
6532
6360
|
*/
|
|
6533
6361
|
export declare const tokenizedFetch: typeof fetch;
|
|
6534
6362
|
|
|
6535
|
-
export declare
|
|
6363
|
+
export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
|
|
6536
6364
|
/**
|
|
6537
6365
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
6538
|
-
*
|
|
6539
6366
|
* @example
|
|
6540
6367
|
* ```js
|
|
6541
6368
|
* resetCachedAuthToken();
|
|
6542
6369
|
* ```
|
|
6543
|
-
* @version SDK: 1.28.
|
|
6370
|
+
* @version SDK: 1.28.2 | ThoughtSpot: *
|
|
6544
6371
|
* @group Authentication / Init
|
|
6545
6372
|
*/
|
|
6546
6373
|
export declare const resetCachedAuthToken: () => void;
|
|
@@ -6549,7 +6376,6 @@ export declare const resetCachedAuthToken: () => void;
|
|
|
6549
6376
|
* Copyright (c) 2022
|
|
6550
6377
|
*
|
|
6551
6378
|
* Base classes
|
|
6552
|
-
*
|
|
6553
6379
|
* @summary Base classes
|
|
6554
6380
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
6555
6381
|
*/
|
|
@@ -6598,19 +6424,16 @@ export declare class TsEmbed {
|
|
|
6598
6424
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
6599
6425
|
/**
|
|
6600
6426
|
* Handles errors within the SDK
|
|
6601
|
-
*
|
|
6602
6427
|
* @param error The error message or object
|
|
6603
6428
|
*/
|
|
6604
6429
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
6605
6430
|
/**
|
|
6606
6431
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
6607
|
-
*
|
|
6608
6432
|
* @param query
|
|
6609
6433
|
*/
|
|
6610
6434
|
protected getEmbedBasePath(query: string): string;
|
|
6611
6435
|
/**
|
|
6612
6436
|
* Common query params set for all the embed modes.
|
|
6613
|
-
*
|
|
6614
6437
|
* @param queryParams
|
|
6615
6438
|
* @returns queryParams
|
|
6616
6439
|
*/
|
|
@@ -6618,7 +6441,6 @@ export declare class TsEmbed {
|
|
|
6618
6441
|
/**
|
|
6619
6442
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
6620
6443
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
6621
|
-
*
|
|
6622
6444
|
* @param queryString The query string to append to the URL.
|
|
6623
6445
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
6624
6446
|
* the full application.
|
|
@@ -6631,7 +6453,6 @@ export declare class TsEmbed {
|
|
|
6631
6453
|
/**
|
|
6632
6454
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
6633
6455
|
* event listeners.
|
|
6634
|
-
*
|
|
6635
6456
|
* @param url - The URL of the embedded ThoughtSpot app.
|
|
6636
6457
|
*/
|
|
6637
6458
|
protected renderIFrame(url: string): Promise<any>;
|
|
@@ -6645,13 +6466,11 @@ export declare class TsEmbed {
|
|
|
6645
6466
|
protected insertIntoDOM(child: string | Node): void;
|
|
6646
6467
|
/**
|
|
6647
6468
|
* Sets the height of the iframe
|
|
6648
|
-
*
|
|
6649
6469
|
* @param height The height in pixels
|
|
6650
6470
|
*/
|
|
6651
6471
|
protected setIFrameHeight(height: number | string): void;
|
|
6652
6472
|
/**
|
|
6653
6473
|
* Executes all registered event handlers for a particular event type
|
|
6654
|
-
*
|
|
6655
6474
|
* @param eventType The event type
|
|
6656
6475
|
* @param data The payload invoked with the event handler
|
|
6657
6476
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -6663,7 +6482,6 @@ export declare class TsEmbed {
|
|
|
6663
6482
|
protected getThoughtSpotHost(): string;
|
|
6664
6483
|
/**
|
|
6665
6484
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
6666
|
-
*
|
|
6667
6485
|
* @param eventType The v2 event type
|
|
6668
6486
|
* @returns The corresponding v1 event type if one exists
|
|
6669
6487
|
* or else the v2 event type itself
|
|
@@ -6673,7 +6491,6 @@ export declare class TsEmbed {
|
|
|
6673
6491
|
* Calculates the iframe center for the current visible viewPort
|
|
6674
6492
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
6675
6493
|
* in Host app. ViewPort height of the tab.
|
|
6676
|
-
*
|
|
6677
6494
|
* @returns iframe Center in visible viewport,
|
|
6678
6495
|
* Iframe height,
|
|
6679
6496
|
* View port height.
|
|
@@ -6688,7 +6505,6 @@ export declare class TsEmbed {
|
|
|
6688
6505
|
/**
|
|
6689
6506
|
* Registers an event listener to trigger an alert when the ThoughtSpot app
|
|
6690
6507
|
* sends an event of a particular message type to the host application.
|
|
6691
|
-
*
|
|
6692
6508
|
* @param messageType The message type
|
|
6693
6509
|
* @param callback A callback as a function
|
|
6694
6510
|
* @param options The message options
|
|
@@ -6712,7 +6528,6 @@ export declare class TsEmbed {
|
|
|
6712
6528
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
|
|
6713
6529
|
/**
|
|
6714
6530
|
* Removes an event listener for a particular event type.
|
|
6715
|
-
*
|
|
6716
6531
|
* @param messageType The message type
|
|
6717
6532
|
* @param callback The callback to remove
|
|
6718
6533
|
* @example
|
|
@@ -6725,7 +6540,6 @@ export declare class TsEmbed {
|
|
|
6725
6540
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
6726
6541
|
/**
|
|
6727
6542
|
* Triggers an event to the embedded app
|
|
6728
|
-
*
|
|
6729
6543
|
* @param messageType The event type
|
|
6730
6544
|
* @param data The payload to send with the message
|
|
6731
6545
|
*/
|
|
@@ -6734,7 +6548,6 @@ export declare class TsEmbed {
|
|
|
6734
6548
|
* Marks the ThoughtSpot object to have been rendered
|
|
6735
6549
|
* Needs to be overridden by subclasses to do the actual
|
|
6736
6550
|
* rendering of the iframe.
|
|
6737
|
-
*
|
|
6738
6551
|
* @param args
|
|
6739
6552
|
*/
|
|
6740
6553
|
render(): Promise<TsEmbed>;
|
|
@@ -6742,7 +6555,6 @@ export declare class TsEmbed {
|
|
|
6742
6555
|
protected handleRenderForPrerender(): void;
|
|
6743
6556
|
/**
|
|
6744
6557
|
* Creates the preRender shell
|
|
6745
|
-
*
|
|
6746
6558
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
6747
6559
|
*/
|
|
6748
6560
|
preRender(showPreRenderByDefault?: boolean): TsEmbed;
|
|
@@ -6750,13 +6562,11 @@ export declare class TsEmbed {
|
|
|
6750
6562
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
6751
6563
|
* host app URL.
|
|
6752
6564
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
6753
|
-
*
|
|
6754
6565
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
6755
6566
|
*/
|
|
6756
6567
|
getThoughtSpotPostUrlParams(): string;
|
|
6757
6568
|
/**
|
|
6758
6569
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
6759
|
-
*
|
|
6760
6570
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
6761
6571
|
*/
|
|
6762
6572
|
destroy(): void;
|
|
@@ -6765,7 +6575,6 @@ export declare class TsEmbed {
|
|
|
6765
6575
|
* Prerenders a generic instance of the TS component.
|
|
6766
6576
|
* This means without the path but with the flags already applied.
|
|
6767
6577
|
* This is useful for prerendering the component in the background.
|
|
6768
|
-
*
|
|
6769
6578
|
* @version SDK: 1.22.0
|
|
6770
6579
|
* @returns
|
|
6771
6580
|
*/
|
|
@@ -6783,7 +6592,6 @@ export declare class TsEmbed {
|
|
|
6783
6592
|
* element. This function adjusts the position, width, and height of the PreRender
|
|
6784
6593
|
* component
|
|
6785
6594
|
* to match the dimensions and position of the embedding element.
|
|
6786
|
-
*
|
|
6787
6595
|
* @throws {Error} Throws an error if the embedding element (passed as domSelector)
|
|
6788
6596
|
* is not defined or not found.
|
|
6789
6597
|
*/
|
|
@@ -6796,7 +6604,6 @@ export declare class TsEmbed {
|
|
|
6796
6604
|
/**
|
|
6797
6605
|
* Retrieves unique HTML element IDs for PreRender-related elements.
|
|
6798
6606
|
* These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
|
|
6799
|
-
*
|
|
6800
6607
|
* @returns {object} An object containing the IDs for the PreRender elements.
|
|
6801
6608
|
* @property {string} wrapper - The HTML element ID for the PreRender wrapper.
|
|
6802
6609
|
* @property {string} child - The HTML element ID for the PreRender child.
|
|
@@ -6808,7 +6615,6 @@ export declare class TsEmbed {
|
|
|
6808
6615
|
/**
|
|
6809
6616
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
6810
6617
|
* session.
|
|
6811
|
-
*
|
|
6812
6618
|
* @param vizId [Optional] to get for a specific viz in case of a liveboard.
|
|
6813
6619
|
* @version SDK: 1.25.0 / ThoughtSpot 9.10.0
|
|
6814
6620
|
*/
|
|
@@ -6818,7 +6624,6 @@ export declare class TsEmbed {
|
|
|
6818
6624
|
* Base class for embedding v1 experience
|
|
6819
6625
|
* Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
|
|
6820
6626
|
* which is currently under migration to v2
|
|
6821
|
-
*
|
|
6822
6627
|
* @inheritdoc
|
|
6823
6628
|
*/
|
|
6824
6629
|
export declare class V1Embed extends TsEmbed {
|
|
@@ -6826,7 +6631,6 @@ export declare class V1Embed extends TsEmbed {
|
|
|
6826
6631
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
6827
6632
|
/**
|
|
6828
6633
|
* Render the app in an iframe and set up event handlers
|
|
6829
|
-
*
|
|
6830
6634
|
* @param iframeSrc
|
|
6831
6635
|
*/
|
|
6832
6636
|
protected renderV1Embed(iframeSrc: string): Promise<any>;
|