@thoughtspot/visual-embed-sdk 1.30.0-alpha.1 → 1.30.0
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 +1 -1
- package/cjs/src/auth.d.ts +0 -15
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +2 -13
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +0 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +0 -1
- package/cjs/src/authToken.js.map +1 -1
- 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 +0 -49
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +0 -8
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +0 -6
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +0 -7
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -1
- package/cjs/src/embed/base.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/liveboard.d.ts +0 -30
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +0 -5
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +2 -18
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +0 -5
- package/cjs/src/embed/sage.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 +0 -33
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +0 -3
- package/cjs/src/embed/search.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 +6 -37
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/index.d.ts +0 -1
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +0 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +0 -1
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +0 -1
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -12
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +1 -11
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +14 -2
- 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 +19 -337
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +18 -264
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +0 -1
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +0 -1
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +19 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +2 -14
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +43 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/cjs/src/utils/graphql/graphql-request.js +2 -1
- package/cjs/src/utils/graphql/graphql-request.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 +0 -9
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +0 -11
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +0 -15
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +0 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/config.d.ts +0 -1
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +0 -49
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +0 -6
- 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 +0 -30
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +2 -18
- 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 +0 -33
- 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 +0 -1
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +0 -1
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -12
- 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 +19 -337
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +0 -1
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/graphql/graphql-request.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 +0 -9
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +2030 -2380
- package/dist/tsembed-react.js +1871 -2217
- package/dist/tsembed.es.js +3443 -3790
- package/dist/tsembed.js +6371 -6710
- package/dist/visual-embed-sdk-react-full.d.ts +24 -550
- package/dist/visual-embed-sdk-react.d.ts +24 -550
- package/dist/visual-embed-sdk.d.ts +23 -538
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +0 -15
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +3 -14
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +0 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +0 -1
- package/lib/src/authToken.js.map +1 -1
- 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 +0 -49
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +0 -8
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +0 -6
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +0 -7
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.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/liveboard.d.ts +0 -30
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +1 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/sage.d.ts +2 -18
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +0 -5
- package/lib/src/embed/sage.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 +0 -33
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +0 -3
- package/lib/src/embed/search.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 +9 -40
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/index.d.ts +0 -1
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +0 -1
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +0 -1
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +0 -1
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -12
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +1 -11
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +15 -3
- 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 +19 -337
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +18 -264
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +0 -1
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +0 -1
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +1 -1
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +18 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -14
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +2 -14
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +44 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/graphql/graphql-request.d.ts.map +1 -1
- package/lib/src/utils/graphql/graphql-request.js +2 -1
- package/lib/src/utils/graphql/graphql-request.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 +0 -9
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +0 -11
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +24 -539
- package/package.json +1 -1
- package/src/auth.ts +6 -23
- package/src/authToken.ts +0 -1
- package/src/config.ts +0 -2
- package/src/embed/app.ts +0 -49
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +0 -7
- package/src/embed/embedConfig.ts +0 -2
- package/src/embed/liveboard.ts +1 -38
- package/src/embed/sage.ts +2 -18
- package/src/embed/search-bar.tsx +0 -11
- package/src/embed/search.ts +0 -33
- package/src/embed/ts-embed.ts +38 -72
- package/src/index.ts +0 -1
- package/src/mixpanel-service.ts +0 -1
- package/src/react/index.spec.tsx +47 -59
- package/src/react/index.tsx +1 -12
- package/src/test/test-utils.ts +0 -2
- package/src/tokenizedFetch.ts +0 -1
- package/src/types.ts +19 -337
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/authService/authService.ts +0 -1
- package/src/utils/graphql/answerService/answer-queries.ts +19 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +53 -1
- package/src/utils/graphql/answerService/answerService.ts +2 -14
- package/src/utils/graphql/graphql-request.ts +2 -1
- package/src/utils/processTrigger.ts +0 -2
- package/src/utils.ts +0 -11
|
@@ -9,7 +9,6 @@ import EventEmitter from 'eventemitter3';
|
|
|
9
9
|
*
|
|
10
10
|
* ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
|
|
11
11
|
* in other web applications.
|
|
12
|
-
*
|
|
13
12
|
* @summary ThoughtSpot Visual Embed SDK
|
|
14
13
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
15
14
|
*/
|
|
@@ -20,7 +19,6 @@ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportT
|
|
|
20
19
|
*
|
|
21
20
|
* Full application embedding
|
|
22
21
|
* https://developers.thoughtspot.com/docs/?pageid=full-embed
|
|
23
|
-
*
|
|
24
22
|
* @summary Full app embed
|
|
25
23
|
* @module
|
|
26
24
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
@@ -78,7 +76,6 @@ export enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
78
76
|
}
|
|
79
77
|
/**
|
|
80
78
|
* The view configuration for full app embedding.
|
|
81
|
-
*
|
|
82
79
|
* @group Embed components
|
|
83
80
|
*/
|
|
84
81
|
export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
@@ -86,10 +83,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
86
83
|
* If true, the top navigation bar within the ThoughtSpot app
|
|
87
84
|
* is displayed. By default, the navigation bar is hidden.
|
|
88
85
|
* This flag also controls the homepage left navigation bar.
|
|
89
|
-
*
|
|
90
86
|
* @default true
|
|
91
87
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
92
|
-
*
|
|
93
88
|
* @example
|
|
94
89
|
* ```js
|
|
95
90
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -108,10 +103,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
108
103
|
* **Note**: This option does not apply to the classic homepage.
|
|
109
104
|
* To access the updated modular homepage, set
|
|
110
105
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
111
|
-
*
|
|
112
106
|
* @default false
|
|
113
107
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
114
|
-
*
|
|
115
108
|
* @example
|
|
116
109
|
* ```js
|
|
117
110
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -126,7 +119,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
126
119
|
* Global nav-bar. By default, these buttons are visible on the nav-bar.
|
|
127
120
|
* @default false
|
|
128
121
|
* @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
|
|
129
|
-
*
|
|
130
122
|
* @example
|
|
131
123
|
* ```js
|
|
132
124
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -143,10 +135,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
143
135
|
* **Note**: This option does not apply to the classic homepage.
|
|
144
136
|
* To access the updated modular homepage, set
|
|
145
137
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
146
|
-
*
|
|
147
138
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
148
139
|
* @default false
|
|
149
|
-
*
|
|
150
140
|
* @example
|
|
151
141
|
* ```js
|
|
152
142
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -163,10 +153,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
163
153
|
* **Note**: This option does not apply to the classic homepage.
|
|
164
154
|
* To access the updated modular homepage, set
|
|
165
155
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
166
|
-
*
|
|
167
156
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
168
157
|
* @default true
|
|
169
|
-
*
|
|
170
158
|
* @example
|
|
171
159
|
* ```js
|
|
172
160
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -184,9 +172,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
184
172
|
*
|
|
185
173
|
* For eg, if you want the component to open to a specific Liveboard
|
|
186
174
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
187
|
-
*
|
|
188
175
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
189
|
-
*
|
|
190
176
|
* @example
|
|
191
177
|
* ```js
|
|
192
178
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -202,9 +188,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
202
188
|
*
|
|
203
189
|
* Use this to open to particular page in the app. To open to a specific
|
|
204
190
|
* path within the app, use the `path` attribute which is more flexible.
|
|
205
|
-
*
|
|
206
191
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
207
|
-
*
|
|
208
192
|
* @example
|
|
209
193
|
* ```js
|
|
210
194
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -218,7 +202,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
218
202
|
* This puts a filter tag on the application. All metadata lists in the
|
|
219
203
|
* application, such as Liveboards and answers, would be filtered by this
|
|
220
204
|
* tag.
|
|
221
|
-
*
|
|
222
205
|
* @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
|
|
223
206
|
* @example
|
|
224
207
|
* ```js
|
|
@@ -231,9 +214,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
231
214
|
tag?: string;
|
|
232
215
|
/**
|
|
233
216
|
* The array of GUIDs to be hidden
|
|
234
|
-
*
|
|
235
217
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
236
|
-
*
|
|
237
218
|
* @example
|
|
238
219
|
* ```js
|
|
239
220
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -249,7 +230,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
249
230
|
/**
|
|
250
231
|
* Render liveboards using the new v2 rendering mode
|
|
251
232
|
* This is a transient flag which is primarily meant for internal use
|
|
252
|
-
*
|
|
253
233
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
|
|
254
234
|
* @hidden
|
|
255
235
|
*/
|
|
@@ -257,9 +237,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
257
237
|
/**
|
|
258
238
|
* If set to true, the Search Assist feature is enabled.
|
|
259
239
|
* @default true
|
|
260
|
-
*
|
|
261
240
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
262
|
-
*
|
|
263
241
|
* @example
|
|
264
242
|
* ```js
|
|
265
243
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -272,9 +250,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
272
250
|
/**
|
|
273
251
|
* If set to true, the embedded object container dynamically resizes
|
|
274
252
|
* according to the height of the pages which support fullHeight mode.
|
|
275
|
-
*
|
|
276
253
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
|
|
277
|
-
*
|
|
278
254
|
* @example
|
|
279
255
|
* ```js
|
|
280
256
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -286,7 +262,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
286
262
|
fullHeight?: boolean;
|
|
287
263
|
/**
|
|
288
264
|
* Flag to control Data panel experience
|
|
289
|
-
*
|
|
290
265
|
* @default false
|
|
291
266
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
292
267
|
* @hidden
|
|
@@ -294,10 +269,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
294
269
|
dataPanelV2?: boolean;
|
|
295
270
|
/**
|
|
296
271
|
* Show or hide Liveboard header
|
|
297
|
-
*
|
|
298
272
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
299
273
|
* @default false
|
|
300
|
-
*
|
|
301
274
|
* @example
|
|
302
275
|
* ```js
|
|
303
276
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -309,10 +282,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
309
282
|
hideLiveboardHeader?: boolean;
|
|
310
283
|
/**
|
|
311
284
|
* Show or hide Liveboard title
|
|
312
|
-
*
|
|
313
285
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
314
286
|
* @default false
|
|
315
|
-
*
|
|
316
287
|
* @example
|
|
317
288
|
* ```js
|
|
318
289
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -324,10 +295,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
324
295
|
showLiveboardTitle?: boolean;
|
|
325
296
|
/**
|
|
326
297
|
* Show or hide Liveboard description
|
|
327
|
-
*
|
|
328
298
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
329
299
|
* @default false
|
|
330
|
-
*
|
|
331
300
|
* @example
|
|
332
301
|
* ```js
|
|
333
302
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -339,10 +308,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
339
308
|
showLiveboardDescription?: boolean;
|
|
340
309
|
/**
|
|
341
310
|
* Flag to control new Modular Home experience.
|
|
342
|
-
*
|
|
343
311
|
* @default false
|
|
344
312
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
345
|
-
*
|
|
346
313
|
* @example
|
|
347
314
|
* ```js
|
|
348
315
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -354,7 +321,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
354
321
|
modularHomeExperience?: boolean;
|
|
355
322
|
/**
|
|
356
323
|
* Boolean to control if Liveboard header is sticky or not.
|
|
357
|
-
*
|
|
358
324
|
* @example
|
|
359
325
|
* ```js
|
|
360
326
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -367,24 +333,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
367
333
|
isLiveboardHeaderSticky?: boolean;
|
|
368
334
|
/**
|
|
369
335
|
* enable or disable ask sage
|
|
370
|
-
*
|
|
371
336
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
372
337
|
* @default false
|
|
373
338
|
*/
|
|
374
339
|
enableAskSage?: boolean;
|
|
375
340
|
/**
|
|
376
341
|
* To set the initial state of the search bar in case of saved-answers.
|
|
377
|
-
*
|
|
378
342
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
379
343
|
* @default false
|
|
380
344
|
*/
|
|
381
345
|
collapseSearchBarInitially?: boolean;
|
|
382
346
|
/**
|
|
383
347
|
* To enable custom column groups in data panel v2.
|
|
384
|
-
*
|
|
385
348
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
386
349
|
* @default false
|
|
387
|
-
*
|
|
388
350
|
* @example
|
|
389
351
|
* ```js
|
|
390
352
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -401,10 +363,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
401
363
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
402
364
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
403
365
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
404
|
-
*
|
|
405
366
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
406
367
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
407
|
-
*
|
|
408
368
|
* @example
|
|
409
369
|
* ```js
|
|
410
370
|
* const embed = new AppEmbed('#embed', {
|
|
@@ -417,11 +377,9 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
417
377
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
418
378
|
/**
|
|
419
379
|
* This flag is used to enable the 2 column layout in liveboard
|
|
420
|
-
*
|
|
421
380
|
* @type {boolean}
|
|
422
381
|
* @default false
|
|
423
382
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
424
|
-
*
|
|
425
383
|
* @example
|
|
426
384
|
* ```js
|
|
427
385
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -433,14 +391,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
433
391
|
enable2ColumnLayout?: boolean;
|
|
434
392
|
/**
|
|
435
393
|
* Flag to use OnBeforeSearchExecute embed event
|
|
436
|
-
*
|
|
437
394
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
438
395
|
*/
|
|
439
396
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
440
397
|
}
|
|
441
398
|
/**
|
|
442
399
|
* Embeds full ThoughtSpot experience in a host application.
|
|
443
|
-
*
|
|
444
400
|
* @group Embed components
|
|
445
401
|
*/
|
|
446
402
|
export class AppEmbed extends V1Embed {
|
|
@@ -453,14 +409,12 @@ export class AppEmbed extends V1Embed {
|
|
|
453
409
|
protected getEmbedParams(): string;
|
|
454
410
|
/**
|
|
455
411
|
* Constructs the URL of the ThoughtSpot app page to be rendered.
|
|
456
|
-
*
|
|
457
412
|
* @param pageId The ID of the page to be embedded.
|
|
458
413
|
*/
|
|
459
414
|
getIFrameSrc(): string;
|
|
460
415
|
/**
|
|
461
416
|
* Set the iframe height as per the computed height received
|
|
462
417
|
* from the ThoughtSpot app.
|
|
463
|
-
*
|
|
464
418
|
* @param data The event payload
|
|
465
419
|
*/
|
|
466
420
|
protected updateIFrameHeight: (data: MessagePayload) => void;
|
|
@@ -468,7 +422,6 @@ export class AppEmbed extends V1Embed {
|
|
|
468
422
|
* Navigate to particular page for app embed. eg:answers/pinboards/home
|
|
469
423
|
* This is used for embedding answers, pinboards, visualizations and full application
|
|
470
424
|
* only.
|
|
471
|
-
*
|
|
472
425
|
* @param path string | number The string, set to iframe src and navigate to new page
|
|
473
426
|
* eg: appEmbed.navigateToPage('pinboards')
|
|
474
427
|
* When used with `noReload` (default: true) this can also be a number
|
|
@@ -479,7 +432,6 @@ export class AppEmbed extends V1Embed {
|
|
|
479
432
|
navigateToPage(path: string | number, noReload?: boolean): void;
|
|
480
433
|
/**
|
|
481
434
|
* Renders the embedded application pages in the ThoughtSpot app.
|
|
482
|
-
*
|
|
483
435
|
* @param renderOptions An object containing the page ID
|
|
484
436
|
* to be embedded.
|
|
485
437
|
*/
|
|
@@ -511,7 +463,6 @@ export const handleAuth: () => Promise<boolean>;
|
|
|
511
463
|
* Prefetches static resources from the specified URL. Web browsers can then cache the
|
|
512
464
|
* prefetched resources and serve them from the user's local disk to provide faster access
|
|
513
465
|
* to your app.
|
|
514
|
-
*
|
|
515
466
|
* @param url The URL provided for prefetch
|
|
516
467
|
* @param prefetchFeatures Specify features which needs to be prefetched.
|
|
517
468
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
|
|
@@ -523,7 +474,6 @@ export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) =>
|
|
|
523
474
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
524
475
|
* component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
|
|
525
476
|
* to actually embed. That is handled internally.
|
|
526
|
-
*
|
|
527
477
|
* @param embedConfig The configuration object containing ThoughtSpot host,
|
|
528
478
|
* authentication mechanism and so on.
|
|
529
479
|
* @example
|
|
@@ -550,7 +500,6 @@ export function disableAutoLogin(): void;
|
|
|
550
500
|
*
|
|
551
501
|
* You can call the `init` method again to re login, if autoLogin is set to
|
|
552
502
|
* true in this second call it will be honored.
|
|
553
|
-
*
|
|
554
503
|
* @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
|
|
555
504
|
* @returns Promise which resolves when logout completes.
|
|
556
505
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
|
|
@@ -560,13 +509,11 @@ export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
|
|
|
560
509
|
/**
|
|
561
510
|
* Renders functions in a queue, resolves to next function only after the callback next
|
|
562
511
|
* is called
|
|
563
|
-
*
|
|
564
512
|
* @param fn The function being registered
|
|
565
513
|
*/
|
|
566
514
|
export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
|
|
567
515
|
/**
|
|
568
516
|
* Imports TML representation of the metadata objects into ThoughtSpot.
|
|
569
|
-
*
|
|
570
517
|
* @param data
|
|
571
518
|
* @example
|
|
572
519
|
* ```js
|
|
@@ -591,7 +538,6 @@ export const executeTML: (data: executeTMLInput) => Promise<any>;
|
|
|
591
538
|
/**
|
|
592
539
|
* Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
|
|
593
540
|
* format.
|
|
594
|
-
*
|
|
595
541
|
* @param data
|
|
596
542
|
* @example
|
|
597
543
|
* ```js
|
|
@@ -630,13 +576,11 @@ export function reset(): void;
|
|
|
630
576
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
631
577
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
632
578
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
633
|
-
*
|
|
634
579
|
* @summary Liveboard & visualization embed
|
|
635
580
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
636
581
|
*/
|
|
637
582
|
/**
|
|
638
583
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
639
|
-
*
|
|
640
584
|
* @group Embed components
|
|
641
585
|
*/
|
|
642
586
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -649,9 +593,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
649
593
|
* visualizations to display on the screen.
|
|
650
594
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
651
595
|
* incrementally as users scroll the page to view the charts and tables.
|
|
652
|
-
*
|
|
653
596
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
654
|
-
*
|
|
655
597
|
* @example
|
|
656
598
|
* ```js
|
|
657
599
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -665,7 +607,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
665
607
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
666
608
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
667
609
|
* other screens navigable from a Liveboard.
|
|
668
|
-
*
|
|
669
610
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
670
611
|
* @default 500
|
|
671
612
|
* @example
|
|
@@ -680,7 +621,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
680
621
|
defaultHeight?: number;
|
|
681
622
|
/**
|
|
682
623
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
683
|
-
*
|
|
684
624
|
* @example
|
|
685
625
|
* ```js
|
|
686
626
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -688,14 +628,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
688
628
|
* enableVizTransformations:true,
|
|
689
629
|
* })
|
|
690
630
|
* ```
|
|
691
|
-
*
|
|
692
631
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
693
632
|
*/
|
|
694
633
|
enableVizTransformations?: boolean;
|
|
695
634
|
/**
|
|
696
635
|
* The Liveboard to display in the embedded view.
|
|
697
636
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
698
|
-
*
|
|
699
637
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
700
638
|
* @example
|
|
701
639
|
* ```js
|
|
@@ -707,15 +645,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
707
645
|
liveboardId?: string;
|
|
708
646
|
/**
|
|
709
647
|
* To support backward compatibility
|
|
710
|
-
*
|
|
711
648
|
* @hidden
|
|
712
649
|
*/
|
|
713
650
|
pinboardId?: string;
|
|
714
651
|
/**
|
|
715
652
|
* The visualization within the Liveboard to display.
|
|
716
|
-
*
|
|
717
653
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
718
|
-
*
|
|
719
654
|
* @example
|
|
720
655
|
* ```js
|
|
721
656
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -728,7 +663,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
728
663
|
/**
|
|
729
664
|
* If set to true, all filter chips from a
|
|
730
665
|
* Liveboard page will be read-only (no X buttons)
|
|
731
|
-
*
|
|
732
666
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
733
667
|
* @example
|
|
734
668
|
* ```js
|
|
@@ -743,9 +677,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
743
677
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
744
678
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
745
679
|
* event.
|
|
746
|
-
*
|
|
747
680
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
748
|
-
*
|
|
749
681
|
* @example
|
|
750
682
|
* ```js
|
|
751
683
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -759,14 +691,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
759
691
|
visibleVizs?: string[];
|
|
760
692
|
/**
|
|
761
693
|
* To support backward compatibility
|
|
762
|
-
*
|
|
763
694
|
* @hidden
|
|
764
695
|
*/
|
|
765
696
|
preventPinboardFilterRemoval?: boolean;
|
|
766
697
|
/**
|
|
767
698
|
* Render embedded Liveboards and visualizations in the
|
|
768
699
|
* new Liveboard experience mode.
|
|
769
|
-
*
|
|
770
700
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
771
701
|
* @example
|
|
772
702
|
* ```js
|
|
@@ -780,7 +710,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
780
710
|
/**
|
|
781
711
|
* Set a Liveboard tab as an active tab.
|
|
782
712
|
* Specify the tab ID.
|
|
783
|
-
*
|
|
784
713
|
* @example
|
|
785
714
|
* ```js
|
|
786
715
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -793,9 +722,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
793
722
|
activeTabId?: string;
|
|
794
723
|
/**
|
|
795
724
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
796
|
-
*
|
|
797
725
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
798
|
-
*
|
|
799
726
|
* @example
|
|
800
727
|
* ```js
|
|
801
728
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -807,7 +734,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
807
734
|
hideTabPanel?: boolean;
|
|
808
735
|
/**
|
|
809
736
|
* Show or hide the Liveboard header.
|
|
810
|
-
*
|
|
811
737
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
812
738
|
* @default false
|
|
813
739
|
* @example
|
|
@@ -823,7 +749,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
823
749
|
* Show or hide the Liveboard title.
|
|
824
750
|
* @default false
|
|
825
751
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
826
|
-
*
|
|
827
752
|
* @example
|
|
828
753
|
* ```js
|
|
829
754
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -837,7 +762,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
837
762
|
* Show or hide the Liveboard description.
|
|
838
763
|
* @default false
|
|
839
764
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
840
|
-
*
|
|
841
765
|
* @example
|
|
842
766
|
* ```js
|
|
843
767
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -851,7 +775,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
851
775
|
* Control the position and visibility of
|
|
852
776
|
* the Liveboard header as the users scroll down the
|
|
853
777
|
* embedded Liveboard page.
|
|
854
|
-
*
|
|
855
778
|
* @example
|
|
856
779
|
* ```js
|
|
857
780
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -864,7 +787,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
864
787
|
isLiveboardHeaderSticky?: boolean;
|
|
865
788
|
/**
|
|
866
789
|
* enable or disable ask sage
|
|
867
|
-
*
|
|
868
790
|
* @default false
|
|
869
791
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
870
792
|
* @example
|
|
@@ -878,11 +800,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
878
800
|
enableAskSage?: boolean;
|
|
879
801
|
/**
|
|
880
802
|
* This flag is used to enable the 2 column layout in liveboard
|
|
881
|
-
*
|
|
882
803
|
* @type {boolean}
|
|
883
804
|
* @default false
|
|
884
805
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
885
|
-
*
|
|
886
806
|
* @example
|
|
887
807
|
* ```js
|
|
888
808
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -897,7 +817,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
897
817
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
898
818
|
* waits for the authentication to complete, so you need not wait for
|
|
899
819
|
* `AuthStatus.SUCCESS`.
|
|
900
|
-
*
|
|
901
820
|
* @example
|
|
902
821
|
* ```js
|
|
903
822
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -921,14 +840,12 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
921
840
|
protected handleRenderForPrerender(): void;
|
|
922
841
|
/**
|
|
923
842
|
* Triggers an event to the embedded app
|
|
924
|
-
*
|
|
925
843
|
* @param messageType The event type
|
|
926
844
|
* @param data The payload to send with the message
|
|
927
845
|
*/
|
|
928
846
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
929
847
|
/**
|
|
930
848
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
931
|
-
*
|
|
932
849
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
933
850
|
* visualization ID and the runtime filters.
|
|
934
851
|
*/
|
|
@@ -945,7 +862,6 @@ export class PinboardEmbed extends LiveboardEmbed {
|
|
|
945
862
|
* Copyright (c) 2022
|
|
946
863
|
*
|
|
947
864
|
* Embed ThoughtSpot search or a saved answer
|
|
948
|
-
*
|
|
949
865
|
* @summary Search embed
|
|
950
866
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
951
867
|
*/
|
|
@@ -986,16 +902,13 @@ export enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
986
902
|
}
|
|
987
903
|
/**
|
|
988
904
|
* The configuration attributes for the embedded search view.
|
|
989
|
-
*
|
|
990
905
|
* @group Embed components
|
|
991
906
|
*/
|
|
992
907
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
993
908
|
/**
|
|
994
909
|
* If set to true, the data sources panel is collapsed on load,
|
|
995
910
|
* but can be expanded manually.
|
|
996
|
-
*
|
|
997
911
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
998
|
-
*
|
|
999
912
|
* @example
|
|
1000
913
|
* ```js
|
|
1001
914
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1007,9 +920,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1007
920
|
collapseDataSources?: boolean;
|
|
1008
921
|
/**
|
|
1009
922
|
* Show or hide the data sources panel.
|
|
1010
|
-
*
|
|
1011
923
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
1012
|
-
*
|
|
1013
924
|
* @example
|
|
1014
925
|
* ```js
|
|
1015
926
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1023,9 +934,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1023
934
|
* Show or hide the charts and tables in search answers.
|
|
1024
935
|
* This attribute can be used to create a custom visualization
|
|
1025
936
|
* using raw answer data.
|
|
1026
|
-
*
|
|
1027
937
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
1028
|
-
*
|
|
1029
938
|
* @example
|
|
1030
939
|
* ```js
|
|
1031
940
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1037,9 +946,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1037
946
|
hideResults?: boolean;
|
|
1038
947
|
/**
|
|
1039
948
|
* If set to true, the Search Assist feature is enabled.
|
|
1040
|
-
*
|
|
1041
949
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
1042
|
-
*
|
|
1043
950
|
* @example
|
|
1044
951
|
* ```js
|
|
1045
952
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1052,9 +959,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1052
959
|
/**
|
|
1053
960
|
* If set to true, the tabular view is set as the default
|
|
1054
961
|
* format for presenting search data.
|
|
1055
|
-
*
|
|
1056
962
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1057
|
-
*
|
|
1058
963
|
* @example
|
|
1059
964
|
* ```js
|
|
1060
965
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1066,9 +971,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1066
971
|
/**
|
|
1067
972
|
* The array of data source GUIDs to set on load.
|
|
1068
973
|
* Only a single data source is supported currently.
|
|
1069
|
-
*
|
|
1070
974
|
* @deprecated Use `dataSource` instead.
|
|
1071
|
-
*
|
|
1072
975
|
* @example
|
|
1073
976
|
* ```js
|
|
1074
977
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1080,9 +983,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1080
983
|
dataSources?: string[];
|
|
1081
984
|
/**
|
|
1082
985
|
* The array of data source GUIDs to set on load.
|
|
1083
|
-
*
|
|
1084
986
|
* @version: SDK: 1.19.0
|
|
1085
|
-
*
|
|
1086
987
|
* @example
|
|
1087
988
|
* ```js
|
|
1088
989
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1094,7 +995,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1094
995
|
dataSource?: string;
|
|
1095
996
|
/**
|
|
1096
997
|
* The initial search query to load the answer with.
|
|
1097
|
-
*
|
|
1098
998
|
* @deprecated
|
|
1099
999
|
*
|
|
1100
1000
|
* Use {@link searchOptions} instead.
|
|
@@ -1110,7 +1010,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1110
1010
|
* If it is executed, the focus is placed on the results.
|
|
1111
1011
|
* If it’s not executed, the focus is placed at the end of
|
|
1112
1012
|
* the token string in the search bar.
|
|
1113
|
-
*
|
|
1114
1013
|
* @example
|
|
1115
1014
|
* ```js
|
|
1116
1015
|
* searchOptions: {
|
|
@@ -1122,9 +1021,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1122
1021
|
searchOptions?: SearchOptions;
|
|
1123
1022
|
/**
|
|
1124
1023
|
* The GUID of a saved answer to load initially.
|
|
1125
|
-
*
|
|
1126
1024
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
1127
|
-
*
|
|
1128
1025
|
* @example
|
|
1129
1026
|
* ```js
|
|
1130
1027
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1137,9 +1034,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1137
1034
|
/**
|
|
1138
1035
|
* If set to true, the search page will render without the Search Bar
|
|
1139
1036
|
* The chart/table should still be visible.
|
|
1140
|
-
*
|
|
1141
1037
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
1142
|
-
*
|
|
1143
1038
|
* @example
|
|
1144
1039
|
* ```js
|
|
1145
1040
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1151,10 +1046,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1151
1046
|
hideSearchBar?: boolean;
|
|
1152
1047
|
/**
|
|
1153
1048
|
* Flag to control Data panel experience
|
|
1154
|
-
*
|
|
1155
1049
|
* @default false
|
|
1156
1050
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
1157
|
-
*
|
|
1158
1051
|
* @example
|
|
1159
1052
|
* ```js
|
|
1160
1053
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1166,23 +1059,19 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1166
1059
|
dataPanelV2?: boolean;
|
|
1167
1060
|
/**
|
|
1168
1061
|
* Flag to set if last selected dataSource should be used
|
|
1169
|
-
*
|
|
1170
1062
|
* @version: SDK: 1.24.0
|
|
1171
1063
|
*/
|
|
1172
1064
|
useLastSelectedSources?: boolean;
|
|
1173
1065
|
/**
|
|
1174
1066
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1175
|
-
*
|
|
1176
1067
|
* @default false
|
|
1177
1068
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1178
1069
|
*/
|
|
1179
1070
|
collapseSearchBarInitially?: boolean;
|
|
1180
1071
|
/**
|
|
1181
1072
|
* To enable custom column groups in data panel v2
|
|
1182
|
-
*
|
|
1183
1073
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1184
1074
|
* @default false
|
|
1185
|
-
*
|
|
1186
1075
|
* @example
|
|
1187
1076
|
* ```js
|
|
1188
1077
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1194,7 +1083,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1194
1083
|
enableCustomColumnGroups?: boolean;
|
|
1195
1084
|
/**
|
|
1196
1085
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1197
|
-
*
|
|
1198
1086
|
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
1199
1087
|
*/
|
|
1200
1088
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
@@ -1205,10 +1093,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1205
1093
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
1206
1094
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
1207
1095
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1208
|
-
*
|
|
1209
1096
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
1210
1097
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1211
|
-
*
|
|
1212
1098
|
* @example
|
|
1213
1099
|
* ```js
|
|
1214
1100
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -1223,7 +1109,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
1223
1109
|
export const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
1224
1110
|
/**
|
|
1225
1111
|
* Embed ThoughtSpot search
|
|
1226
|
-
*
|
|
1227
1112
|
* @group Embed components
|
|
1228
1113
|
*/
|
|
1229
1114
|
export class SearchEmbed extends TsEmbed {
|
|
@@ -1236,7 +1121,6 @@ export class SearchEmbed extends TsEmbed {
|
|
|
1236
1121
|
/**
|
|
1237
1122
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
1238
1123
|
* loaded in the iframe
|
|
1239
|
-
*
|
|
1240
1124
|
* @param answerId The GUID of a saved answer
|
|
1241
1125
|
* @param dataSources A list of data source GUIDs
|
|
1242
1126
|
*/
|
|
@@ -1254,11 +1138,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1254
1138
|
/**
|
|
1255
1139
|
* The array of data source GUIDs to set on load.
|
|
1256
1140
|
* Only a single data source is supported currently.
|
|
1257
|
-
*
|
|
1258
1141
|
* @deprecated Use `dataSource` instead
|
|
1259
|
-
*
|
|
1260
1142
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
1261
|
-
*
|
|
1262
1143
|
* @example
|
|
1263
1144
|
* ```js
|
|
1264
1145
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1270,9 +1151,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1270
1151
|
dataSources?: string[];
|
|
1271
1152
|
/**
|
|
1272
1153
|
* Pass the ID of the source to be selected.
|
|
1273
|
-
*
|
|
1274
1154
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
1275
|
-
*
|
|
1276
1155
|
* @example
|
|
1277
1156
|
* ```js
|
|
1278
1157
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1284,9 +1163,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1284
1163
|
dataSource?: string;
|
|
1285
1164
|
/**
|
|
1286
1165
|
* Boolean to define if the last selected data source should be used
|
|
1287
|
-
*
|
|
1288
1166
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
1289
|
-
*
|
|
1290
1167
|
* @example
|
|
1291
1168
|
* ```js
|
|
1292
1169
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1306,9 +1183,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1306
1183
|
* If it is executed, the focus is placed on the results.
|
|
1307
1184
|
* If it’s not executed, the focus is placed at the end of
|
|
1308
1185
|
* the token string in the search bar.
|
|
1309
|
-
*
|
|
1310
1186
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
1311
|
-
*
|
|
1312
1187
|
* @example
|
|
1313
1188
|
* ```js
|
|
1314
1189
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -1324,7 +1199,6 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
1324
1199
|
}
|
|
1325
1200
|
/**
|
|
1326
1201
|
* Embed ThoughtSpot search bar
|
|
1327
|
-
*
|
|
1328
1202
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
1329
1203
|
* @group Embed components
|
|
1330
1204
|
*/
|
|
@@ -1354,7 +1228,6 @@ interface sessionInfoInterface {
|
|
|
1354
1228
|
/**
|
|
1355
1229
|
* Enum for auth failure types. This is the parameter passed to the listner
|
|
1356
1230
|
* of {@link AuthStatus.FAILURE}.
|
|
1357
|
-
*
|
|
1358
1231
|
* @group Authentication / Init
|
|
1359
1232
|
*/
|
|
1360
1233
|
export enum AuthFailureType {
|
|
@@ -1365,7 +1238,6 @@ export enum AuthFailureType {
|
|
|
1365
1238
|
}
|
|
1366
1239
|
/**
|
|
1367
1240
|
* Enum for auth status emitted by the emitter returned from {@link init}.
|
|
1368
|
-
*
|
|
1369
1241
|
* @group Authentication / Init
|
|
1370
1242
|
*/
|
|
1371
1243
|
export enum AuthStatus {
|
|
@@ -1389,27 +1261,23 @@ export enum AuthStatus {
|
|
|
1389
1261
|
* Emitted when inPopup is true in the SAMLRedirect flow and the
|
|
1390
1262
|
* popup is waiting to be triggered either programmatically
|
|
1391
1263
|
* or by the trigger button.
|
|
1392
|
-
*
|
|
1393
1264
|
* @version SDK: 1.19.0
|
|
1394
1265
|
*/
|
|
1395
1266
|
WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
|
|
1396
1267
|
}
|
|
1397
1268
|
/**
|
|
1398
1269
|
* Event emitter returned from {@link init}.
|
|
1399
|
-
*
|
|
1400
1270
|
* @group Authentication / Init
|
|
1401
1271
|
*/
|
|
1402
1272
|
export interface AuthEventEmitter {
|
|
1403
1273
|
/**
|
|
1404
1274
|
* Register a listener on Auth failure.
|
|
1405
|
-
*
|
|
1406
1275
|
* @param event
|
|
1407
1276
|
* @param listener
|
|
1408
1277
|
*/
|
|
1409
1278
|
on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
|
|
1410
1279
|
/**
|
|
1411
1280
|
* Register a listener on Auth SDK success.
|
|
1412
|
-
*
|
|
1413
1281
|
* @param event
|
|
1414
1282
|
* @param listener
|
|
1415
1283
|
*/
|
|
@@ -1420,13 +1288,11 @@ export interface AuthEventEmitter {
|
|
|
1420
1288
|
once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
|
|
1421
1289
|
/**
|
|
1422
1290
|
* Trigger an event on the emitter returned from init.
|
|
1423
|
-
*
|
|
1424
1291
|
* @param {@link AuthEvent}
|
|
1425
1292
|
*/
|
|
1426
1293
|
emit(event: AuthEvent, ...args: any[]): boolean;
|
|
1427
1294
|
/**
|
|
1428
1295
|
* Remove listener from the emitter returned from init.
|
|
1429
|
-
*
|
|
1430
1296
|
* @param event
|
|
1431
1297
|
* @param listener
|
|
1432
1298
|
* @param context
|
|
@@ -1435,14 +1301,12 @@ export interface AuthEventEmitter {
|
|
|
1435
1301
|
off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
|
|
1436
1302
|
/**
|
|
1437
1303
|
* Remove all the event listeners
|
|
1438
|
-
*
|
|
1439
1304
|
* @param event
|
|
1440
1305
|
*/
|
|
1441
1306
|
removeAllListeners(event: AuthStatus): this;
|
|
1442
1307
|
}
|
|
1443
1308
|
/**
|
|
1444
1309
|
* Events which can be triggered on the emitter returned from {@link init}.
|
|
1445
|
-
*
|
|
1446
1310
|
* @group Authentication / Init
|
|
1447
1311
|
*/
|
|
1448
1312
|
export enum AuthEvent {
|
|
@@ -1487,19 +1351,16 @@ export function getReleaseVersion(): string;
|
|
|
1487
1351
|
/**
|
|
1488
1352
|
* Return a promise that resolves with the session information when
|
|
1489
1353
|
* authentication is successful. And info is available.
|
|
1490
|
-
*
|
|
1491
1354
|
* @group Global methods
|
|
1492
1355
|
*/
|
|
1493
1356
|
export function getSessionInfo(): Promise<sessionInfoInterface>;
|
|
1494
1357
|
/**
|
|
1495
1358
|
* Perform token based authentication
|
|
1496
|
-
*
|
|
1497
1359
|
* @param embedConfig The embed configuration
|
|
1498
1360
|
*/
|
|
1499
1361
|
export const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1500
1362
|
/**
|
|
1501
1363
|
* Validate embedConfig parameters required for cookielessTokenAuth
|
|
1502
|
-
*
|
|
1503
1364
|
* @param embedConfig The embed configuration
|
|
1504
1365
|
*/
|
|
1505
1366
|
export const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1509,7 +1370,6 @@ export const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolea
|
|
|
1509
1370
|
*
|
|
1510
1371
|
* Warning: This feature is primarily intended for developer testing. It is
|
|
1511
1372
|
* strongly advised not to use this authentication method in production.
|
|
1512
|
-
*
|
|
1513
1373
|
* @param embedConfig The embed configuration
|
|
1514
1374
|
*/
|
|
1515
1375
|
export const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1518,7 +1378,6 @@ export const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
|
1518
1378
|
export const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
1519
1379
|
/**
|
|
1520
1380
|
* Perform authentication on the ThoughtSpot cluster
|
|
1521
|
-
*
|
|
1522
1381
|
* @param embedConfig The embed configuration
|
|
1523
1382
|
*/
|
|
1524
1383
|
export const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
|
|
@@ -1532,21 +1391,18 @@ export {};
|
|
|
1532
1391
|
* Copyright (c) 2023
|
|
1533
1392
|
*
|
|
1534
1393
|
* TypeScript type definitions for ThoughtSpot Visual Embed SDK
|
|
1535
|
-
*
|
|
1536
1394
|
* @summary Type definitions for Embed SDK
|
|
1537
1395
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
1538
1396
|
*/
|
|
1539
1397
|
/**
|
|
1540
1398
|
* The authentication mechanism for allowing access to the
|
|
1541
1399
|
* the embedded app
|
|
1542
|
-
*
|
|
1543
1400
|
* @group Authentication / Init
|
|
1544
1401
|
*/
|
|
1545
1402
|
export enum AuthType {
|
|
1546
1403
|
/**
|
|
1547
1404
|
* No authentication on the SDK. Passthrough to the embedded App. Alias for
|
|
1548
1405
|
* `Passthrough`.
|
|
1549
|
-
*
|
|
1550
1406
|
* @example
|
|
1551
1407
|
* ```js
|
|
1552
1408
|
* init({
|
|
@@ -1564,7 +1420,6 @@ export enum AuthType {
|
|
|
1564
1420
|
* To use this:
|
|
1565
1421
|
* Your SAML or OpenID provider must allow iframe redirects.
|
|
1566
1422
|
* For example, if you are using Okta as IdP, you can enable iframe embedding.
|
|
1567
|
-
*
|
|
1568
1423
|
* @example
|
|
1569
1424
|
* ```js
|
|
1570
1425
|
* init({
|
|
@@ -1577,14 +1432,12 @@ export enum AuthType {
|
|
|
1577
1432
|
EmbeddedSSO = "EmbeddedSSO",
|
|
1578
1433
|
/**
|
|
1579
1434
|
* SSO using SAML
|
|
1580
|
-
*
|
|
1581
1435
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1582
1436
|
* @hidden
|
|
1583
1437
|
*/
|
|
1584
1438
|
SSO = "SSO_SAML",
|
|
1585
1439
|
/**
|
|
1586
1440
|
* SSO using SAML
|
|
1587
|
-
*
|
|
1588
1441
|
* @deprecated Use {@link SAMLRedirect} instead
|
|
1589
1442
|
* @hidden
|
|
1590
1443
|
*/
|
|
@@ -1596,7 +1449,6 @@ export enum AuthType {
|
|
|
1596
1449
|
*
|
|
1597
1450
|
* This redirects the host application to the SAML IdP. The host application
|
|
1598
1451
|
* will be redirected back to the ThoughtSpot app after authentication.
|
|
1599
|
-
*
|
|
1600
1452
|
* @example
|
|
1601
1453
|
* ```js
|
|
1602
1454
|
* init({
|
|
@@ -1637,7 +1489,6 @@ export enum AuthType {
|
|
|
1637
1489
|
SAMLRedirect = "SSO_SAML",
|
|
1638
1490
|
/**
|
|
1639
1491
|
* SSO using OIDC
|
|
1640
|
-
*
|
|
1641
1492
|
* @hidden
|
|
1642
1493
|
* @deprecated Use {@link OIDCRedirect} instead
|
|
1643
1494
|
*/
|
|
@@ -1650,7 +1501,6 @@ export enum AuthType {
|
|
|
1650
1501
|
OIDCRedirect = "SSO_OIDC",
|
|
1651
1502
|
/**
|
|
1652
1503
|
* Trusted authentication server
|
|
1653
|
-
*
|
|
1654
1504
|
* @hidden
|
|
1655
1505
|
* @deprecated Use {@link TrustedAuth} instead
|
|
1656
1506
|
*/
|
|
@@ -1659,7 +1509,6 @@ export enum AuthType {
|
|
|
1659
1509
|
* Trusted authentication server. Use your own authentication server
|
|
1660
1510
|
* which returns a bearer token, generated using the `secret_key` obtained
|
|
1661
1511
|
* from ThoughtSpot.
|
|
1662
|
-
*
|
|
1663
1512
|
* @example
|
|
1664
1513
|
* ```js
|
|
1665
1514
|
* init({
|
|
@@ -1680,7 +1529,6 @@ export enum AuthType {
|
|
|
1680
1529
|
* obtained from ThoughtSpot. This uses a cookieless authentication
|
|
1681
1530
|
* approach, recommended to bypass the third-party cookie-blocking restriction
|
|
1682
1531
|
* implemented by some browsers.
|
|
1683
|
-
*
|
|
1684
1532
|
* @example
|
|
1685
1533
|
* ```js
|
|
1686
1534
|
* init({
|
|
@@ -1753,7 +1601,6 @@ export interface customCssInterface {
|
|
|
1753
1601
|
/**
|
|
1754
1602
|
* Can be used to define a custom font face
|
|
1755
1603
|
* like:
|
|
1756
|
-
*
|
|
1757
1604
|
* @example
|
|
1758
1605
|
* ```js
|
|
1759
1606
|
* rules_UNSTABLE?: {
|
|
@@ -1793,7 +1640,6 @@ export interface CustomStyles {
|
|
|
1793
1640
|
* Thoughtspot components.
|
|
1794
1641
|
* You can customize styles, text strings, and icons.
|
|
1795
1642
|
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
1796
|
-
*
|
|
1797
1643
|
* @example
|
|
1798
1644
|
* ```js
|
|
1799
1645
|
* init({
|
|
@@ -1836,7 +1682,6 @@ export interface CustomisationsInterface {
|
|
|
1836
1682
|
* It includes the ThoughtSpot hostname or IP address,
|
|
1837
1683
|
* the type of authentication, and the authentication endpoint
|
|
1838
1684
|
* if a trusted authentication server is used.
|
|
1839
|
-
*
|
|
1840
1685
|
* @group Authentication / Init
|
|
1841
1686
|
*/
|
|
1842
1687
|
export interface EmbedConfig {
|
|
@@ -1884,7 +1729,6 @@ export interface EmbedConfig {
|
|
|
1884
1729
|
* [SSO] For SSO Authentication, if `noRedirect` is set to true, it will
|
|
1885
1730
|
* open the SAML auth flow in a popup, instead of redirecting the browser in
|
|
1886
1731
|
* place.
|
|
1887
|
-
*
|
|
1888
1732
|
* @default false
|
|
1889
1733
|
* @deprecated
|
|
1890
1734
|
*/
|
|
@@ -1895,7 +1739,6 @@ export interface EmbedConfig {
|
|
|
1895
1739
|
*
|
|
1896
1740
|
* Need to use this with `authTriggerContainer`. Or manually trigger
|
|
1897
1741
|
* the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction.
|
|
1898
|
-
*
|
|
1899
1742
|
* @default false
|
|
1900
1743
|
* @version SDK: 1.18.0
|
|
1901
1744
|
*/
|
|
@@ -1906,7 +1749,6 @@ export interface EmbedConfig {
|
|
|
1906
1749
|
* terminated.
|
|
1907
1750
|
*
|
|
1908
1751
|
* Eg: "/dashboard", "#/foo" [Do not include the host]
|
|
1909
|
-
*
|
|
1910
1752
|
* @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw
|
|
1911
1753
|
*/
|
|
1912
1754
|
redirectPath?: string;
|
|
@@ -1916,7 +1758,6 @@ export interface EmbedConfig {
|
|
|
1916
1758
|
* Boolean to define if the query parameters in the ThoughtSpot URL
|
|
1917
1759
|
* should be encoded in base64. This provides additional security to
|
|
1918
1760
|
* Thoughtspot clusters against cross-site scripting attacks.
|
|
1919
|
-
*
|
|
1920
1761
|
* @default false
|
|
1921
1762
|
*/
|
|
1922
1763
|
shouldEncodeUrlQueryParams?: boolean;
|
|
@@ -1926,7 +1767,6 @@ export interface EmbedConfig {
|
|
|
1926
1767
|
* some web browsers like Safari. If you set this attribute to `true`,
|
|
1927
1768
|
* you are encouraged to handle `noCookieAccess` event, to show your own treatment
|
|
1928
1769
|
* in this case.
|
|
1929
|
-
*
|
|
1930
1770
|
* @default false
|
|
1931
1771
|
*/
|
|
1932
1772
|
suppressNoCookieAccessAlert?: boolean;
|
|
@@ -1934,14 +1774,12 @@ export interface EmbedConfig {
|
|
|
1934
1774
|
* Ignore the cookie access alert when third-party cookies are blocked by the
|
|
1935
1775
|
* user's browser. If you set this to `true`, the embedded iframe behaviour
|
|
1936
1776
|
* persists even in the case of a non-logged-in user.
|
|
1937
|
-
*
|
|
1938
1777
|
* @default false
|
|
1939
1778
|
*/
|
|
1940
1779
|
ignoreNoCookieAccess?: boolean;
|
|
1941
1780
|
/**
|
|
1942
1781
|
* Re-login a user with the previous login options
|
|
1943
1782
|
* when a user session expires.
|
|
1944
|
-
*
|
|
1945
1783
|
* @default false
|
|
1946
1784
|
*/
|
|
1947
1785
|
autoLogin?: boolean;
|
|
@@ -1950,20 +1788,17 @@ export interface EmbedConfig {
|
|
|
1950
1788
|
* This flag is typically used alongside the combination of authentication modes such
|
|
1951
1789
|
* as {@link AuthType.AuthServer} and auto-login behavior {@link
|
|
1952
1790
|
* EmbedConfig.autoLogin}
|
|
1953
|
-
*
|
|
1954
1791
|
* @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
1955
1792
|
* @default false
|
|
1956
1793
|
*/
|
|
1957
1794
|
disableLoginRedirect?: boolean;
|
|
1958
1795
|
/**
|
|
1959
1796
|
* This message is displayed in the embedded view when a user login fails.
|
|
1960
|
-
*
|
|
1961
1797
|
* @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1962
1798
|
*/
|
|
1963
1799
|
loginFailedMessage?: string;
|
|
1964
1800
|
/**
|
|
1965
1801
|
* Calls the prefetch method internally when set to `true`
|
|
1966
|
-
*
|
|
1967
1802
|
* @default false
|
|
1968
1803
|
*/
|
|
1969
1804
|
callPrefetch?: boolean;
|
|
@@ -1971,7 +1806,6 @@ export interface EmbedConfig {
|
|
|
1971
1806
|
* When there are multiple objects embedded, queue the rendering of embedded objects
|
|
1972
1807
|
* to start after the previous embed's render is complete. This helps improve
|
|
1973
1808
|
* performance by decreasing the load on the browser.
|
|
1974
|
-
*
|
|
1975
1809
|
* @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
1976
1810
|
* @default false
|
|
1977
1811
|
*/
|
|
@@ -1979,7 +1813,6 @@ export interface EmbedConfig {
|
|
|
1979
1813
|
/**
|
|
1980
1814
|
* Dynamic CSS URL to be injected in the loaded application.
|
|
1981
1815
|
* You would also need to set `style-src` in the CSP settings.
|
|
1982
|
-
*
|
|
1983
1816
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
1984
1817
|
* @default ''
|
|
1985
1818
|
*/
|
|
@@ -1991,13 +1824,11 @@ export interface EmbedConfig {
|
|
|
1991
1824
|
*
|
|
1992
1825
|
* This is slightly slower than letting the browser handle the cookie check, as it
|
|
1993
1826
|
* involves an extra network call.
|
|
1994
|
-
*
|
|
1995
1827
|
* @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
1996
1828
|
*/
|
|
1997
1829
|
detectCookieAccessSlow?: boolean;
|
|
1998
1830
|
/**
|
|
1999
1831
|
* Hide the `beta` alert warning message for SearchEmbed.
|
|
2000
|
-
*
|
|
2001
1832
|
* @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
|
|
2002
1833
|
*/
|
|
2003
1834
|
suppressSearchEmbedBetaWarning?: boolean;
|
|
@@ -2008,7 +1839,6 @@ export interface EmbedConfig {
|
|
|
2008
1839
|
suppressSageEmbedBetaWarning?: boolean;
|
|
2009
1840
|
/**
|
|
2010
1841
|
* Custom style params for embed Config.
|
|
2011
|
-
*
|
|
2012
1842
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2013
1843
|
*/
|
|
2014
1844
|
customizations?: CustomisationsInterface;
|
|
@@ -2016,7 +1846,6 @@ export interface EmbedConfig {
|
|
|
2016
1846
|
* For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a
|
|
2017
1847
|
* button that the user can click to trigger the flow.
|
|
2018
1848
|
* This attribute sets a containing element for that button.
|
|
2019
|
-
*
|
|
2020
1849
|
* @example
|
|
2021
1850
|
* ```js
|
|
2022
1851
|
* init({
|
|
@@ -2038,7 +1867,6 @@ export interface EmbedConfig {
|
|
|
2038
1867
|
/**
|
|
2039
1868
|
* Text to show in the button which triggers the popup auth flow.
|
|
2040
1869
|
* Default: `Authorize`.
|
|
2041
|
-
*
|
|
2042
1870
|
* @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw
|
|
2043
1871
|
*/
|
|
2044
1872
|
authTriggerText?: string;
|
|
@@ -2046,14 +1874,12 @@ export interface EmbedConfig {
|
|
|
2046
1874
|
* Prevent users from accessing the full application or ThoughtSpot application pages
|
|
2047
1875
|
* access to the embedded application users
|
|
2048
1876
|
* outside of the iframe.
|
|
2049
|
-
*
|
|
2050
1877
|
* @default true
|
|
2051
1878
|
* @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw
|
|
2052
1879
|
*/
|
|
2053
1880
|
blockNonEmbedFullAppAccess?: boolean;
|
|
2054
1881
|
/**
|
|
2055
1882
|
* Host config in case embedded app is inside TS app itself
|
|
2056
|
-
*
|
|
2057
1883
|
* @hidden
|
|
2058
1884
|
*/
|
|
2059
1885
|
hostConfig?: {
|
|
@@ -2064,19 +1890,16 @@ export interface EmbedConfig {
|
|
|
2064
1890
|
/**
|
|
2065
1891
|
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
2066
1892
|
* is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
|
|
2067
|
-
*
|
|
2068
1893
|
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
2069
1894
|
*/
|
|
2070
1895
|
pendoTrackingKey?: string;
|
|
2071
1896
|
/**
|
|
2072
1897
|
* If passed as true all alerts will be suppressed in the embedded app.
|
|
2073
|
-
*
|
|
2074
1898
|
* @version SDK: 1.26.2 | ThoughtSpot: *
|
|
2075
1899
|
*/
|
|
2076
1900
|
suppressErrorAlerts?: boolean;
|
|
2077
1901
|
/**
|
|
2078
1902
|
* Log level for the SDK.
|
|
2079
|
-
*
|
|
2080
1903
|
* @default LogLevel.ERROR
|
|
2081
1904
|
* @example
|
|
2082
1905
|
* ```js
|
|
@@ -2090,34 +1913,28 @@ export interface EmbedConfig {
|
|
|
2090
1913
|
logLevel?: LogLevel;
|
|
2091
1914
|
/**
|
|
2092
1915
|
* Disables the Mixpanel tracking from the SDK.
|
|
2093
|
-
*
|
|
2094
1916
|
* @version SDK: 1.27.9
|
|
2095
1917
|
*/
|
|
2096
1918
|
disableSDKTracking?: boolean;
|
|
2097
1919
|
/**
|
|
2098
1920
|
* Overrides default/user preffered locale for date formatting
|
|
2099
|
-
*
|
|
2100
1921
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2101
1922
|
*/
|
|
2102
1923
|
dateFormatLocale?: string;
|
|
2103
1924
|
/**
|
|
2104
1925
|
* Overrides default/user preffered locale for number formatting
|
|
2105
|
-
*
|
|
2106
1926
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2107
1927
|
*/
|
|
2108
1928
|
numberFormatLocale?: string;
|
|
2109
1929
|
/**
|
|
2110
1930
|
* Format to be used for currency when currency format is set to infer from browser
|
|
2111
|
-
*
|
|
2112
1931
|
* @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
|
|
2113
1932
|
*/
|
|
2114
1933
|
currencyFormat?: string;
|
|
2115
1934
|
/**
|
|
2116
1935
|
* This flag is used to disable the token verification in the SDK.
|
|
2117
1936
|
* Enabling this flag will also disable the caching of the token.
|
|
2118
|
-
*
|
|
2119
1937
|
* @hidden
|
|
2120
|
-
*
|
|
2121
1938
|
* @example
|
|
2122
1939
|
* ```js
|
|
2123
1940
|
* init({
|
|
@@ -2125,7 +1942,6 @@ export interface EmbedConfig {
|
|
|
2125
1942
|
* disableTokenVerification : true
|
|
2126
1943
|
* })
|
|
2127
1944
|
* ```
|
|
2128
|
-
*
|
|
2129
1945
|
* @version SDK: 1.28.5 | Thoughtspot: *
|
|
2130
1946
|
*/
|
|
2131
1947
|
disableTokenVerification?: boolean;
|
|
@@ -2134,7 +1950,6 @@ export interface LayoutConfig {
|
|
|
2134
1950
|
}
|
|
2135
1951
|
/**
|
|
2136
1952
|
* Embedded iframe configuration
|
|
2137
|
-
*
|
|
2138
1953
|
* @group Embed components
|
|
2139
1954
|
*/
|
|
2140
1955
|
export interface FrameParams {
|
|
@@ -2169,9 +1984,7 @@ export interface ViewConfig {
|
|
|
2169
1984
|
/**
|
|
2170
1985
|
* The width and height dimensions to render an embedded
|
|
2171
1986
|
* object inside your app. Specify the values in pixels or percentage.
|
|
2172
|
-
*
|
|
2173
1987
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
2174
|
-
*
|
|
2175
1988
|
* @example
|
|
2176
1989
|
* ```js
|
|
2177
1990
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2197,7 +2010,6 @@ export interface ViewConfig {
|
|
|
2197
2010
|
* (...), and the contextual menu. These actions will be disabled
|
|
2198
2011
|
* for the user.
|
|
2199
2012
|
* Use this to disable actions.
|
|
2200
|
-
*
|
|
2201
2013
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2202
2014
|
* @example
|
|
2203
2015
|
* ```js
|
|
@@ -2225,9 +2037,7 @@ export interface ViewConfig {
|
|
|
2225
2037
|
* The list of actions to hide from the embedded.
|
|
2226
2038
|
* This actions will be hidden from the user.
|
|
2227
2039
|
* Use this to hide an action.
|
|
2228
|
-
*
|
|
2229
2040
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2230
|
-
*
|
|
2231
2041
|
* @example
|
|
2232
2042
|
* ```js
|
|
2233
2043
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2245,10 +2055,8 @@ export interface ViewConfig {
|
|
|
2245
2055
|
* Use this to hide all actions except the ones you want to show.
|
|
2246
2056
|
*
|
|
2247
2057
|
* Use either this or hiddenActions.
|
|
2248
|
-
*
|
|
2249
2058
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
2250
2059
|
* @important
|
|
2251
|
-
*
|
|
2252
2060
|
* @example
|
|
2253
2061
|
* ```js
|
|
2254
2062
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2260,9 +2068,7 @@ export interface ViewConfig {
|
|
|
2260
2068
|
visibleActions?: Action[];
|
|
2261
2069
|
/**
|
|
2262
2070
|
* Show alert messages and toast messages in the embedded view.
|
|
2263
|
-
*
|
|
2264
2071
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2265
|
-
*
|
|
2266
2072
|
* @example
|
|
2267
2073
|
* ```js
|
|
2268
2074
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2275,9 +2081,7 @@ export interface ViewConfig {
|
|
|
2275
2081
|
/**
|
|
2276
2082
|
* The list of runtime filters to apply to a search answer,
|
|
2277
2083
|
* visualization, or Liveboard.
|
|
2278
|
-
*
|
|
2279
2084
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2280
|
-
*
|
|
2281
2085
|
* @example
|
|
2282
2086
|
* ```js
|
|
2283
2087
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2296,9 +2100,7 @@ export interface ViewConfig {
|
|
|
2296
2100
|
/**
|
|
2297
2101
|
* The list of parameter override to apply to a search answer,
|
|
2298
2102
|
* visualization, or Liveboard.
|
|
2299
|
-
*
|
|
2300
2103
|
* @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
|
|
2301
|
-
*
|
|
2302
2104
|
* @example
|
|
2303
2105
|
* ```js
|
|
2304
2106
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2315,7 +2117,6 @@ export interface ViewConfig {
|
|
|
2315
2117
|
runtimeParameters?: RuntimeParameter[];
|
|
2316
2118
|
/**
|
|
2317
2119
|
* The locale/language to use for the embedded view.
|
|
2318
|
-
*
|
|
2319
2120
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2320
2121
|
* @example
|
|
2321
2122
|
* ```js
|
|
@@ -2351,7 +2152,6 @@ export interface ViewConfig {
|
|
|
2351
2152
|
/**
|
|
2352
2153
|
* Dynamic CSSUrl and customCSS to be injected in the loaded application.
|
|
2353
2154
|
* You would also need to set `style-src` in the CSP settings.
|
|
2354
|
-
*
|
|
2355
2155
|
* @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl
|
|
2356
2156
|
* @default ''
|
|
2357
2157
|
*/
|
|
@@ -2359,9 +2159,7 @@ export interface ViewConfig {
|
|
|
2359
2159
|
/**
|
|
2360
2160
|
* Insert as a sibling of the target container, instead of appending to a
|
|
2361
2161
|
* child inside it.
|
|
2362
|
-
*
|
|
2363
2162
|
* @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
|
|
2364
|
-
*
|
|
2365
2163
|
* @example
|
|
2366
2164
|
* ```js
|
|
2367
2165
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2373,7 +2171,6 @@ export interface ViewConfig {
|
|
|
2373
2171
|
insertAsSibling?: boolean;
|
|
2374
2172
|
/**
|
|
2375
2173
|
* flag to set ContextMenu Trigger to either left or right click.
|
|
2376
|
-
*
|
|
2377
2174
|
* @example
|
|
2378
2175
|
* ```js
|
|
2379
2176
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2386,7 +2183,6 @@ export interface ViewConfig {
|
|
|
2386
2183
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2387
2184
|
/**
|
|
2388
2185
|
* Flag to override openNew tab context menu link
|
|
2389
|
-
*
|
|
2390
2186
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2391
2187
|
* @example
|
|
2392
2188
|
* ```js
|
|
@@ -2399,7 +2195,6 @@ export interface ViewConfig {
|
|
|
2399
2195
|
linkOverride?: boolean;
|
|
2400
2196
|
/**
|
|
2401
2197
|
* flag to enable insert into slides action
|
|
2402
|
-
*
|
|
2403
2198
|
* @hidden
|
|
2404
2199
|
* @private
|
|
2405
2200
|
*/
|
|
@@ -2407,7 +2202,6 @@ export interface ViewConfig {
|
|
|
2407
2202
|
/**
|
|
2408
2203
|
* Use a pre-rendered iframe from a pool of pre-rendered iframes
|
|
2409
2204
|
* if available and matches the configuration.
|
|
2410
|
-
*
|
|
2411
2205
|
* @version SDK: 1.22.0
|
|
2412
2206
|
* @hidden
|
|
2413
2207
|
*
|
|
@@ -2421,7 +2215,6 @@ export interface ViewConfig {
|
|
|
2421
2215
|
*
|
|
2422
2216
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2423
2217
|
* embedded view.
|
|
2424
|
-
*
|
|
2425
2218
|
* @default false
|
|
2426
2219
|
* @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
|
|
2427
2220
|
*/
|
|
@@ -2430,7 +2223,6 @@ export interface ViewConfig {
|
|
|
2430
2223
|
* The list of tab IDs to hide from the embedded.
|
|
2431
2224
|
* This Tabs will be hidden from their respective LBs.
|
|
2432
2225
|
* Use this to hide an tabID.
|
|
2433
|
-
*
|
|
2434
2226
|
* @example
|
|
2435
2227
|
* ```js
|
|
2436
2228
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2450,7 +2242,6 @@ export interface ViewConfig {
|
|
|
2450
2242
|
* **Note**: This option does not apply to the classic homepage.
|
|
2451
2243
|
* To access the updated modular homepage, set
|
|
2452
2244
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2453
|
-
*
|
|
2454
2245
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2455
2246
|
* @example
|
|
2456
2247
|
* ```js
|
|
@@ -2459,7 +2250,6 @@ export interface ViewConfig {
|
|
|
2459
2250
|
* hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
|
|
2460
2251
|
* })
|
|
2461
2252
|
* ```
|
|
2462
|
-
*
|
|
2463
2253
|
*/
|
|
2464
2254
|
hiddenHomepageModules?: HomepageModule[];
|
|
2465
2255
|
/**
|
|
@@ -2469,9 +2259,7 @@ export interface ViewConfig {
|
|
|
2469
2259
|
* **Note**: This option does not apply to the classic homepage.
|
|
2470
2260
|
* To access the updated modular homepage, set
|
|
2471
2261
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2472
|
-
*
|
|
2473
2262
|
* @version SDK: 1.28.0| Thoughtspot: 9.12.5.cl
|
|
2474
|
-
*
|
|
2475
2263
|
* @example
|
|
2476
2264
|
* ```js
|
|
2477
2265
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -2486,9 +2274,7 @@ export interface ViewConfig {
|
|
|
2486
2274
|
* Only the tabs specified in the array will be shown in the Liveboard.
|
|
2487
2275
|
*
|
|
2488
2276
|
* Use either `visibleTabs` or `hiddenTabs`.
|
|
2489
|
-
*
|
|
2490
2277
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2491
|
-
*
|
|
2492
2278
|
* @example
|
|
2493
2279
|
* ```js
|
|
2494
2280
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -2505,8 +2291,7 @@ export interface ViewConfig {
|
|
|
2505
2291
|
* homepageLeftNavItems : Show or hide the left navigation bar items.
|
|
2506
2292
|
* There are 8 eight home navigation list items.
|
|
2507
2293
|
* To hide these items, specify the string in the array.
|
|
2508
|
-
*
|
|
2509
|
-
* * @example
|
|
2294
|
+
* @example
|
|
2510
2295
|
* ```js
|
|
2511
2296
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
2512
2297
|
* ... // other options
|
|
@@ -2517,7 +2302,6 @@ export interface ViewConfig {
|
|
|
2517
2302
|
* **Note**: This option does not apply to the classic homepage.
|
|
2518
2303
|
* To access the updated modular homepage, set
|
|
2519
2304
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2520
|
-
*
|
|
2521
2305
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2522
2306
|
*/
|
|
2523
2307
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -2525,7 +2309,6 @@ export interface ViewConfig {
|
|
|
2525
2309
|
* PreRender id to be used for PreRendering the embed.
|
|
2526
2310
|
* Use PreRender to render the embed in the background and then
|
|
2527
2311
|
* show or hide the rendered embed using showPreRender or hidePreRender respectively.
|
|
2528
|
-
*
|
|
2529
2312
|
* @example
|
|
2530
2313
|
* ```js
|
|
2531
2314
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -2542,11 +2325,9 @@ export interface ViewConfig {
|
|
|
2542
2325
|
* of its embedding element and adjust its own size accordingly.
|
|
2543
2326
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2544
2327
|
* its dimensions based on changes to the size of the embedding element.
|
|
2545
|
-
*
|
|
2546
2328
|
* @type {boolean}
|
|
2547
2329
|
* @default false
|
|
2548
2330
|
* @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
|
|
2549
|
-
*
|
|
2550
2331
|
* @example
|
|
2551
2332
|
* ```js
|
|
2552
2333
|
* // Disable tracking PreRender size in the configuration
|
|
@@ -2561,7 +2342,6 @@ export interface ViewConfig {
|
|
|
2561
2342
|
doNotTrackPreRenderSize?: boolean;
|
|
2562
2343
|
/**
|
|
2563
2344
|
* For internal tracking of the embed component type.
|
|
2564
|
-
*
|
|
2565
2345
|
* @hidden
|
|
2566
2346
|
*/
|
|
2567
2347
|
embedComponentType?: string;
|
|
@@ -2571,7 +2351,6 @@ export interface ViewConfig {
|
|
|
2571
2351
|
*
|
|
2572
2352
|
* Irrespective of this flag, runtime filters ( if passed ) will be applied to the
|
|
2573
2353
|
* embedded view.
|
|
2574
|
-
*
|
|
2575
2354
|
* @default false
|
|
2576
2355
|
* @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
2577
2356
|
*/
|
|
@@ -2579,7 +2358,6 @@ export interface ViewConfig {
|
|
|
2579
2358
|
}
|
|
2580
2359
|
/**
|
|
2581
2360
|
* MessagePayload: Embed event payload: message type, data and status (start/end)
|
|
2582
|
-
*
|
|
2583
2361
|
* @group Events
|
|
2584
2362
|
*/
|
|
2585
2363
|
export type MessagePayload = {
|
|
@@ -2590,7 +2368,6 @@ export type MessagePayload = {
|
|
|
2590
2368
|
/**
|
|
2591
2369
|
* MessageOptions: By providing options, getting specific event start / end based on
|
|
2592
2370
|
* option
|
|
2593
|
-
*
|
|
2594
2371
|
* @group Events
|
|
2595
2372
|
*/
|
|
2596
2373
|
export type MessageOptions = {
|
|
@@ -2602,7 +2379,6 @@ export type MessageOptions = {
|
|
|
2602
2379
|
};
|
|
2603
2380
|
/**
|
|
2604
2381
|
* MessageCallback: Embed event message callback
|
|
2605
|
-
*
|
|
2606
2382
|
* @group Events
|
|
2607
2383
|
*/
|
|
2608
2384
|
export type MessageCallback = (payload: MessagePayload,
|
|
@@ -2696,7 +2472,6 @@ export enum RuntimeFilterOp {
|
|
|
2696
2472
|
* **Note**: This option does not apply to the classic homepage.
|
|
2697
2473
|
* To access the updated modular homepage, set
|
|
2698
2474
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
2699
|
-
*
|
|
2700
2475
|
* @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
|
|
2701
2476
|
*/
|
|
2702
2477
|
export enum HomepageModule {
|
|
@@ -2764,7 +2539,6 @@ export interface RuntimeParameter {
|
|
|
2764
2539
|
*
|
|
2765
2540
|
* To add an event listener use the corresponding
|
|
2766
2541
|
* {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
|
|
2767
|
-
*
|
|
2768
2542
|
* @example
|
|
2769
2543
|
* ```js
|
|
2770
2544
|
* import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -2782,7 +2556,6 @@ export interface RuntimeParameter {
|
|
|
2782
2556
|
export enum EmbedEvent {
|
|
2783
2557
|
/**
|
|
2784
2558
|
* Rendering has initialized.
|
|
2785
|
-
*
|
|
2786
2559
|
* @example
|
|
2787
2560
|
*```js
|
|
2788
2561
|
* liveboardEmbed.on(EmbedEvent.Init, showLoader)
|
|
@@ -2796,9 +2569,7 @@ export enum EmbedEvent {
|
|
|
2796
2569
|
Init = "init",
|
|
2797
2570
|
/**
|
|
2798
2571
|
* Authentication has either succeeded or failed.
|
|
2799
|
-
*
|
|
2800
2572
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2801
|
-
*
|
|
2802
2573
|
* @example
|
|
2803
2574
|
*```js
|
|
2804
2575
|
* appEmbed.on(EmbedEvent.AuthInit, payload => {
|
|
@@ -2810,9 +2581,7 @@ export enum EmbedEvent {
|
|
|
2810
2581
|
AuthInit = "authInit",
|
|
2811
2582
|
/**
|
|
2812
2583
|
* The embed object container has loaded.
|
|
2813
|
-
*
|
|
2814
2584
|
* @returns timestamp - The timestamp when the event was generated.
|
|
2815
|
-
*
|
|
2816
2585
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2817
2586
|
* @example
|
|
2818
2587
|
*```js
|
|
@@ -2826,9 +2595,7 @@ export enum EmbedEvent {
|
|
|
2826
2595
|
Load = "load",
|
|
2827
2596
|
/**
|
|
2828
2597
|
* Data pertaining to answer or Liveboard is received
|
|
2829
|
-
*
|
|
2830
2598
|
* @return data - The answer or Liveboard data
|
|
2831
|
-
*
|
|
2832
2599
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2833
2600
|
* @example
|
|
2834
2601
|
*```js
|
|
@@ -2841,13 +2608,11 @@ export enum EmbedEvent {
|
|
|
2841
2608
|
Data = "data",
|
|
2842
2609
|
/**
|
|
2843
2610
|
* Search/Answer/Liveboard filters have been applied/updated by the user.
|
|
2844
|
-
*
|
|
2845
2611
|
* @hidden
|
|
2846
2612
|
*/
|
|
2847
2613
|
FiltersChanged = "filtersChanged",
|
|
2848
2614
|
/**
|
|
2849
2615
|
* Search query has been updated by the user.
|
|
2850
|
-
*
|
|
2851
2616
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
2852
2617
|
* @example
|
|
2853
2618
|
*```js
|
|
@@ -2857,9 +2622,7 @@ export enum EmbedEvent {
|
|
|
2857
2622
|
QueryChanged = "queryChanged",
|
|
2858
2623
|
/**
|
|
2859
2624
|
* A drill-down operation has been performed.
|
|
2860
|
-
*
|
|
2861
2625
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2862
|
-
*
|
|
2863
2626
|
* @returns additionalFilters - Any additional filters applied
|
|
2864
2627
|
* @returns drillDownColumns - The columns on which drill down was performed
|
|
2865
2628
|
* @returns nonFilteredColumns - The columns that were not filtered
|
|
@@ -2896,9 +2659,7 @@ export enum EmbedEvent {
|
|
|
2896
2659
|
Drilldown = "drillDown",
|
|
2897
2660
|
/**
|
|
2898
2661
|
* One or more data sources have been selected.
|
|
2899
|
-
*
|
|
2900
2662
|
* @returns dataSourceIds - the list of data sources
|
|
2901
|
-
*
|
|
2902
2663
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2903
2664
|
* @example
|
|
2904
2665
|
* ```js
|
|
@@ -2910,7 +2671,6 @@ export enum EmbedEvent {
|
|
|
2910
2671
|
DataSourceSelected = "dataSourceSelected",
|
|
2911
2672
|
/**
|
|
2912
2673
|
* One or more data columns have been selected.
|
|
2913
|
-
*
|
|
2914
2674
|
* @returns columnIds - the list of columns
|
|
2915
2675
|
* @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
2916
2676
|
* @example
|
|
@@ -2923,11 +2683,9 @@ export enum EmbedEvent {
|
|
|
2923
2683
|
AddRemoveColumns = "addRemoveColumns",
|
|
2924
2684
|
/**
|
|
2925
2685
|
* A custom action has been triggered.
|
|
2926
|
-
*
|
|
2927
2686
|
* @returns actionId - ID of the custom action
|
|
2928
2687
|
* @returns payload {@link CustomActionPayload} - Response payload with the
|
|
2929
2688
|
* Answer or Liveboard data
|
|
2930
|
-
*
|
|
2931
2689
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2932
2690
|
* @example
|
|
2933
2691
|
* ```js
|
|
@@ -2942,7 +2700,6 @@ export enum EmbedEvent {
|
|
|
2942
2700
|
CustomAction = "customAction",
|
|
2943
2701
|
/**
|
|
2944
2702
|
* Listen to double click actions on a visualization.
|
|
2945
|
-
*
|
|
2946
2703
|
* @return ContextMenuInputPoints - Data point that is double-clicked
|
|
2947
2704
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
2948
2705
|
* @example
|
|
@@ -2955,7 +2712,6 @@ export enum EmbedEvent {
|
|
|
2955
2712
|
VizPointDoubleClick = "vizPointDoubleClick",
|
|
2956
2713
|
/**
|
|
2957
2714
|
* Listen to clicks on a visualization in a Liveboard or Search result.
|
|
2958
|
-
*
|
|
2959
2715
|
* @return viz, clickedPoint - metadata about the point that is clicked
|
|
2960
2716
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
2961
2717
|
* @important
|
|
@@ -2976,17 +2732,15 @@ export enum EmbedEvent {
|
|
|
2976
2732
|
/**
|
|
2977
2733
|
* An error has occurred. This event is fired for the following error types:
|
|
2978
2734
|
*
|
|
2979
|
-
*
|
|
2980
|
-
*
|
|
2981
|
-
*
|
|
2982
|
-
*
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
2985
|
-
*
|
|
2986
|
-
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
2735
|
+
* `API` - API call failure error.
|
|
2736
|
+
* `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
|
|
2737
|
+
* mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
|
|
2738
|
+
* filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
|
|
2739
|
+
* `INVALID_DATE_VALUE` - Invalid date value error.
|
|
2740
|
+
* `INVALID_OPERATOR` - Use of invalid operator during filter application.
|
|
2987
2741
|
*
|
|
2742
|
+
* For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
|
|
2988
2743
|
* @returns error - An error object or message
|
|
2989
|
-
*
|
|
2990
2744
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
2991
2745
|
* @example
|
|
2992
2746
|
* ```js
|
|
@@ -3011,11 +2765,8 @@ export enum EmbedEvent {
|
|
|
3011
2765
|
Error = "Error",
|
|
3012
2766
|
/**
|
|
3013
2767
|
* The embedded object has sent an alert.
|
|
3014
|
-
*
|
|
3015
2768
|
* @returns alert - An alert object
|
|
3016
|
-
*
|
|
3017
2769
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3018
|
-
*
|
|
3019
2770
|
* @example
|
|
3020
2771
|
* ```js
|
|
3021
2772
|
* searchEmbed.on(EmbedEvent.Alert)
|
|
@@ -3024,9 +2775,7 @@ export enum EmbedEvent {
|
|
|
3024
2775
|
Alert = "alert",
|
|
3025
2776
|
/**
|
|
3026
2777
|
* The ThoughtSpot auth session has expired.
|
|
3027
|
-
*
|
|
3028
2778
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3029
|
-
*
|
|
3030
2779
|
* @example
|
|
3031
2780
|
*```js
|
|
3032
2781
|
* appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
|
|
@@ -3039,26 +2788,22 @@ export enum EmbedEvent {
|
|
|
3039
2788
|
AuthExpire = "ThoughtspotAuthExpired",
|
|
3040
2789
|
/**
|
|
3041
2790
|
* ThoughtSpot failed to validate the auth session.
|
|
3042
|
-
*
|
|
3043
2791
|
* @hidden
|
|
3044
2792
|
*/
|
|
3045
2793
|
AuthFailure = "ThoughtspotAuthFailure",
|
|
3046
2794
|
/**
|
|
3047
2795
|
* ThoughtSpot failed to validate the auth session.
|
|
3048
|
-
*
|
|
3049
2796
|
* @hidden
|
|
3050
2797
|
*/
|
|
3051
2798
|
AuthLogout = "ThoughtspotAuthLogout",
|
|
3052
2799
|
/**
|
|
3053
2800
|
* The height of the embedded Liveboard or visualization has been computed.
|
|
3054
|
-
*
|
|
3055
2801
|
* @returns data - The height of the embedded Liveboard or visualization
|
|
3056
2802
|
* @hidden
|
|
3057
2803
|
*/
|
|
3058
2804
|
EmbedHeight = "EMBED_HEIGHT",
|
|
3059
2805
|
/**
|
|
3060
2806
|
* The center of visible iframe viewport is calculated.
|
|
3061
|
-
*
|
|
3062
2807
|
* @returns data - The center of the visible Iframe viewport.
|
|
3063
2808
|
* @hidden
|
|
3064
2809
|
*/
|
|
@@ -3066,7 +2811,6 @@ export enum EmbedEvent {
|
|
|
3066
2811
|
/**
|
|
3067
2812
|
* Emitted when the **Get Data** action is initiated.
|
|
3068
2813
|
* Applicable to `SearchBarEmbed` only.
|
|
3069
|
-
*
|
|
3070
2814
|
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
|
|
3071
2815
|
* @example
|
|
3072
2816
|
*```js
|
|
@@ -3079,7 +2823,6 @@ export enum EmbedEvent {
|
|
|
3079
2823
|
GetDataClick = "getDataClick",
|
|
3080
2824
|
/**
|
|
3081
2825
|
* Detects the route change.
|
|
3082
|
-
*
|
|
3083
2826
|
* @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
|
|
3084
2827
|
* @example
|
|
3085
2828
|
*```js
|
|
@@ -3090,7 +2833,6 @@ export enum EmbedEvent {
|
|
|
3090
2833
|
RouteChange = "ROUTE_CHANGE",
|
|
3091
2834
|
/**
|
|
3092
2835
|
* The v1 event type for Data
|
|
3093
|
-
*
|
|
3094
2836
|
* @hidden
|
|
3095
2837
|
*/
|
|
3096
2838
|
V1Data = "exportVizDataToParent",
|
|
@@ -3098,7 +2840,6 @@ export enum EmbedEvent {
|
|
|
3098
2840
|
* Emitted when the embed does not have cookie access. This happens
|
|
3099
2841
|
* when Safari and other Web browsers block third-party cookies
|
|
3100
2842
|
* are blocked by default. `NoCookieAccess` can trigger
|
|
3101
|
-
*
|
|
3102
2843
|
* @example
|
|
3103
2844
|
*```js
|
|
3104
2845
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -3108,14 +2849,12 @@ export enum EmbedEvent {
|
|
|
3108
2849
|
NoCookieAccess = "noCookieAccess",
|
|
3109
2850
|
/**
|
|
3110
2851
|
* Emitted when SAML is complete
|
|
3111
|
-
*
|
|
3112
2852
|
* @private
|
|
3113
2853
|
* @hidden
|
|
3114
2854
|
*/
|
|
3115
2855
|
SAMLComplete = "samlComplete",
|
|
3116
2856
|
/**
|
|
3117
2857
|
* Emitted when any modal is opened in the app
|
|
3118
|
-
*
|
|
3119
2858
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3120
2859
|
* @example
|
|
3121
2860
|
*```js
|
|
@@ -3127,7 +2866,6 @@ export enum EmbedEvent {
|
|
|
3127
2866
|
DialogOpen = "dialog-open",
|
|
3128
2867
|
/**
|
|
3129
2868
|
* Emitted when any modal is closed in the app
|
|
3130
|
-
*
|
|
3131
2869
|
* @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
|
|
3132
2870
|
* @example
|
|
3133
2871
|
*```js
|
|
@@ -3141,7 +2879,6 @@ export enum EmbedEvent {
|
|
|
3141
2879
|
* Emitted when the Liveboard shell loads.
|
|
3142
2880
|
* You can use this event as a hook to trigger
|
|
3143
2881
|
* other events on the rendered Liveboard.
|
|
3144
|
-
*
|
|
3145
2882
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
|
|
3146
2883
|
* @example
|
|
3147
2884
|
*```js
|
|
@@ -3162,7 +2899,6 @@ export enum EmbedEvent {
|
|
|
3162
2899
|
LiveboardRendered = "PinboardRendered",
|
|
3163
2900
|
/**
|
|
3164
2901
|
* Emits all events.
|
|
3165
|
-
*
|
|
3166
2902
|
* @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
|
|
3167
2903
|
* @example
|
|
3168
2904
|
*```js
|
|
@@ -3174,7 +2910,6 @@ export enum EmbedEvent {
|
|
|
3174
2910
|
ALL = "*",
|
|
3175
2911
|
/**
|
|
3176
2912
|
* Emitted when an Answer is saved in the app
|
|
3177
|
-
*
|
|
3178
2913
|
* @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3179
2914
|
* @example
|
|
3180
2915
|
*```js
|
|
@@ -3198,7 +2933,6 @@ export enum EmbedEvent {
|
|
|
3198
2933
|
* To fire an event when a download action is initiated on a chart or table,
|
|
3199
2934
|
* use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
|
|
3200
2935
|
* or `EmbedEvent.DownloadAsXLSX`
|
|
3201
|
-
*
|
|
3202
2936
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3203
2937
|
* @example
|
|
3204
2938
|
*```js
|
|
@@ -3210,7 +2944,6 @@ export enum EmbedEvent {
|
|
|
3210
2944
|
Download = "download",
|
|
3211
2945
|
/**
|
|
3212
2946
|
* Emitted when the download action is triggered on an answer
|
|
3213
|
-
*
|
|
3214
2947
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3215
2948
|
* @example
|
|
3216
2949
|
*```js
|
|
@@ -3225,7 +2958,6 @@ export enum EmbedEvent {
|
|
|
3225
2958
|
DownloadAsPng = "downloadAsPng",
|
|
3226
2959
|
/**
|
|
3227
2960
|
* Emitted when the Download as PDF action is triggered on an answer
|
|
3228
|
-
*
|
|
3229
2961
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3230
2962
|
* @example
|
|
3231
2963
|
*```js
|
|
@@ -3240,7 +2972,6 @@ export enum EmbedEvent {
|
|
|
3240
2972
|
DownloadAsPdf = "downloadAsPdf",
|
|
3241
2973
|
/**
|
|
3242
2974
|
* Emitted when the Download as CSV action is triggered on an answer
|
|
3243
|
-
*
|
|
3244
2975
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3245
2976
|
* @example
|
|
3246
2977
|
*```js
|
|
@@ -3255,7 +2986,6 @@ export enum EmbedEvent {
|
|
|
3255
2986
|
DownloadAsCsv = "downloadAsCsv",
|
|
3256
2987
|
/**
|
|
3257
2988
|
* Emitted when the Download as XLSX action is triggered on an answer
|
|
3258
|
-
*
|
|
3259
2989
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3260
2990
|
* @example
|
|
3261
2991
|
*```js
|
|
@@ -3270,7 +3000,6 @@ export enum EmbedEvent {
|
|
|
3270
3000
|
DownloadAsXlsx = "downloadAsXlsx",
|
|
3271
3001
|
/**
|
|
3272
3002
|
* Emitted when an Answer is deleted in the app
|
|
3273
|
-
*
|
|
3274
3003
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3275
3004
|
* @example
|
|
3276
3005
|
*```js
|
|
@@ -3285,7 +3014,6 @@ export enum EmbedEvent {
|
|
|
3285
3014
|
AnswerDelete = "answerDelete",
|
|
3286
3015
|
/**
|
|
3287
3016
|
* Emitted when an answer is pinned to a Liveboard
|
|
3288
|
-
*
|
|
3289
3017
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3290
3018
|
* @example
|
|
3291
3019
|
*```js
|
|
@@ -3304,7 +3032,6 @@ export enum EmbedEvent {
|
|
|
3304
3032
|
Pin = "pin",
|
|
3305
3033
|
/**
|
|
3306
3034
|
* Emitted when SpotIQ analysis is triggered
|
|
3307
|
-
*
|
|
3308
3035
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3309
3036
|
* @example
|
|
3310
3037
|
*```js
|
|
@@ -3323,7 +3050,6 @@ export enum EmbedEvent {
|
|
|
3323
3050
|
SpotIQAnalyze = "spotIQAnalyze",
|
|
3324
3051
|
/**
|
|
3325
3052
|
* Emitted when a user shares an object with another user or group
|
|
3326
|
-
*
|
|
3327
3053
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3328
3054
|
* @example
|
|
3329
3055
|
*```js
|
|
@@ -3343,7 +3069,6 @@ export enum EmbedEvent {
|
|
|
3343
3069
|
/**
|
|
3344
3070
|
* Emitted when a user clicks the **Include** action to include a specific value or
|
|
3345
3071
|
* data on a chart or table.
|
|
3346
|
-
*
|
|
3347
3072
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3348
3073
|
* @example
|
|
3349
3074
|
*```js
|
|
@@ -3356,7 +3081,6 @@ export enum EmbedEvent {
|
|
|
3356
3081
|
/**
|
|
3357
3082
|
* Emitted when a user clicks the **Exclude** action to exclude a specific value or
|
|
3358
3083
|
* data on a chart or table
|
|
3359
|
-
*
|
|
3360
3084
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3361
3085
|
* @example
|
|
3362
3086
|
*```js
|
|
@@ -3368,7 +3092,6 @@ export enum EmbedEvent {
|
|
|
3368
3092
|
DrillExclude = "context-menu-item-exclude",
|
|
3369
3093
|
/**
|
|
3370
3094
|
* Emitted when a column value is copied in the embedded app.
|
|
3371
|
-
*
|
|
3372
3095
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3373
3096
|
* @example
|
|
3374
3097
|
*```js
|
|
@@ -3381,7 +3104,6 @@ export enum EmbedEvent {
|
|
|
3381
3104
|
/**
|
|
3382
3105
|
* Emitted when a user clicks the **Update TML** action on
|
|
3383
3106
|
* embedded Liveboard.
|
|
3384
|
-
*
|
|
3385
3107
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3386
3108
|
* @example
|
|
3387
3109
|
*```js
|
|
@@ -3393,7 +3115,6 @@ export enum EmbedEvent {
|
|
|
3393
3115
|
/**
|
|
3394
3116
|
* Emitted when a user clicks the **Edit TML** action
|
|
3395
3117
|
* on an embedded Liveboard.
|
|
3396
|
-
*
|
|
3397
3118
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3398
3119
|
* @example
|
|
3399
3120
|
*```js
|
|
@@ -3406,7 +3127,6 @@ export enum EmbedEvent {
|
|
|
3406
3127
|
/**
|
|
3407
3128
|
* Emitted when the **Export TML** action is triggered on an
|
|
3408
3129
|
* an embedded object in the app
|
|
3409
|
-
*
|
|
3410
3130
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3411
3131
|
* @example
|
|
3412
3132
|
*```js
|
|
@@ -3421,7 +3141,6 @@ export enum EmbedEvent {
|
|
|
3421
3141
|
ExportTML = "exportTSL",
|
|
3422
3142
|
/**
|
|
3423
3143
|
* Emitted when an Answer is saved as a View.
|
|
3424
|
-
*
|
|
3425
3144
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3426
3145
|
* @example
|
|
3427
3146
|
*```js
|
|
@@ -3433,7 +3152,6 @@ export enum EmbedEvent {
|
|
|
3433
3152
|
SaveAsView = "saveAsView",
|
|
3434
3153
|
/**
|
|
3435
3154
|
* Emitted when the user creates a copy of an Answer
|
|
3436
|
-
*
|
|
3437
3155
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3438
3156
|
* @example
|
|
3439
3157
|
*```js
|
|
@@ -3448,7 +3166,6 @@ export enum EmbedEvent {
|
|
|
3448
3166
|
CopyAEdit = "copyAEdit",
|
|
3449
3167
|
/**
|
|
3450
3168
|
* Emitted when a user clicks Show underlying data on an Answer
|
|
3451
|
-
*
|
|
3452
3169
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3453
3170
|
* @example
|
|
3454
3171
|
*```js
|
|
@@ -3460,7 +3177,6 @@ export enum EmbedEvent {
|
|
|
3460
3177
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3461
3178
|
/**
|
|
3462
3179
|
* Emitted when an answer is switched to a chart or table view.
|
|
3463
|
-
*
|
|
3464
3180
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3465
3181
|
* @example
|
|
3466
3182
|
*```js
|
|
@@ -3472,13 +3188,11 @@ export enum EmbedEvent {
|
|
|
3472
3188
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
3473
3189
|
/**
|
|
3474
3190
|
* Internal event to communicate the initial settings back to the ThoughtSpot app
|
|
3475
|
-
*
|
|
3476
3191
|
* @hidden
|
|
3477
3192
|
*/
|
|
3478
3193
|
APP_INIT = "appInit",
|
|
3479
3194
|
/**
|
|
3480
3195
|
* Emitted when a user clicks **Show Liveboard details** on a Liveboard
|
|
3481
|
-
*
|
|
3482
3196
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3483
3197
|
* @example
|
|
3484
3198
|
*```js
|
|
@@ -3490,7 +3204,6 @@ export enum EmbedEvent {
|
|
|
3490
3204
|
LiveboardInfo = "pinboardInfo",
|
|
3491
3205
|
/**
|
|
3492
3206
|
* Emitted when a user clicks on the Favorite icon on a Liveboard
|
|
3493
|
-
*
|
|
3494
3207
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3495
3208
|
* @example
|
|
3496
3209
|
*```js
|
|
@@ -3502,7 +3215,6 @@ export enum EmbedEvent {
|
|
|
3502
3215
|
AddToFavorites = "addToFavorites",
|
|
3503
3216
|
/**
|
|
3504
3217
|
* Emitted when a user clicks **Schedule** on a Liveboard
|
|
3505
|
-
*
|
|
3506
3218
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3507
3219
|
* @example
|
|
3508
3220
|
*```js
|
|
@@ -3514,7 +3226,6 @@ export enum EmbedEvent {
|
|
|
3514
3226
|
Schedule = "subscription",
|
|
3515
3227
|
/**
|
|
3516
3228
|
* Emitted when a user clicks **Edit** on a Liveboard or visualization
|
|
3517
|
-
*
|
|
3518
3229
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3519
3230
|
* @example
|
|
3520
3231
|
*```js
|
|
@@ -3526,7 +3237,6 @@ export enum EmbedEvent {
|
|
|
3526
3237
|
Edit = "edit",
|
|
3527
3238
|
/**
|
|
3528
3239
|
* Emitted when a user clicks *Make a copy* on a Liveboard
|
|
3529
|
-
*
|
|
3530
3240
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3531
3241
|
* @example
|
|
3532
3242
|
*```js
|
|
@@ -3538,7 +3248,6 @@ export enum EmbedEvent {
|
|
|
3538
3248
|
MakeACopy = "makeACopy",
|
|
3539
3249
|
/**
|
|
3540
3250
|
* Emitted when a user clicks **Present** on a Liveboard or visualization
|
|
3541
|
-
*
|
|
3542
3251
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3543
3252
|
* @example
|
|
3544
3253
|
*```js
|
|
@@ -3554,7 +3263,6 @@ export enum EmbedEvent {
|
|
|
3554
3263
|
Present = "present",
|
|
3555
3264
|
/**
|
|
3556
3265
|
* Emitted when a user clicks **Delete** on a visualization
|
|
3557
|
-
*
|
|
3558
3266
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3559
3267
|
* @example
|
|
3560
3268
|
*```js
|
|
@@ -3565,7 +3273,6 @@ export enum EmbedEvent {
|
|
|
3565
3273
|
Delete = "delete",
|
|
3566
3274
|
/**
|
|
3567
3275
|
* Emitted when a user clicks Manage schedules on a Liveboard
|
|
3568
|
-
*
|
|
3569
3276
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3570
3277
|
* @example
|
|
3571
3278
|
*```js
|
|
@@ -3575,7 +3282,6 @@ export enum EmbedEvent {
|
|
|
3575
3282
|
SchedulesList = "schedule-list",
|
|
3576
3283
|
/**
|
|
3577
3284
|
* Emitted when a user clicks **Cancel** in edit mode on a Liveboard
|
|
3578
|
-
*
|
|
3579
3285
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3580
3286
|
* @example
|
|
3581
3287
|
*```js
|
|
@@ -3585,7 +3291,6 @@ export enum EmbedEvent {
|
|
|
3585
3291
|
Cancel = "cancel",
|
|
3586
3292
|
/**
|
|
3587
3293
|
* Emitted when a user clicks **Explore** on a visualization
|
|
3588
|
-
*
|
|
3589
3294
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3590
3295
|
* @example
|
|
3591
3296
|
*```js
|
|
@@ -3596,7 +3301,6 @@ export enum EmbedEvent {
|
|
|
3596
3301
|
Explore = "explore",
|
|
3597
3302
|
/**
|
|
3598
3303
|
* Emitted when a user clicks **Copy link** action on a visualization
|
|
3599
|
-
*
|
|
3600
3304
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
3601
3305
|
* @example
|
|
3602
3306
|
*```js
|
|
@@ -3607,7 +3311,6 @@ export enum EmbedEvent {
|
|
|
3607
3311
|
CopyLink = "embedDocument",
|
|
3608
3312
|
/**
|
|
3609
3313
|
* Emitted when a user interacts with cross filters on a visualization or Liveboard
|
|
3610
|
-
*
|
|
3611
3314
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3612
3315
|
* @example
|
|
3613
3316
|
*```js
|
|
@@ -3618,7 +3321,6 @@ export enum EmbedEvent {
|
|
|
3618
3321
|
CrossFilterChanged = "cross-filter-changed",
|
|
3619
3322
|
/**
|
|
3620
3323
|
* Emitted when a user right clicks on a visualization (chart or table)
|
|
3621
|
-
*
|
|
3622
3324
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3623
3325
|
* @example
|
|
3624
3326
|
*```js
|
|
@@ -3630,7 +3332,6 @@ export enum EmbedEvent {
|
|
|
3630
3332
|
VizPointRightClick = "vizPointRightClick",
|
|
3631
3333
|
/**
|
|
3632
3334
|
* Emitted when a user clicks **Insert to slide** on a visualization
|
|
3633
|
-
*
|
|
3634
3335
|
* @hidden
|
|
3635
3336
|
*/
|
|
3636
3337
|
InsertIntoSlide = "insertInToSlide",
|
|
@@ -3638,7 +3339,6 @@ export enum EmbedEvent {
|
|
|
3638
3339
|
* Emitted when a user changes any filter on a Liveboard.
|
|
3639
3340
|
* Returns filter type and name, column name and ID, and runtime
|
|
3640
3341
|
* filter details.
|
|
3641
|
-
*
|
|
3642
3342
|
* @example
|
|
3643
3343
|
*
|
|
3644
3344
|
*```js
|
|
@@ -3651,32 +3351,27 @@ export enum EmbedEvent {
|
|
|
3651
3351
|
FilterChanged = "filterChanged",
|
|
3652
3352
|
/**
|
|
3653
3353
|
* Emitted when a user clicks the **Go** button on the Search page
|
|
3654
|
-
*
|
|
3655
3354
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3656
3355
|
*/
|
|
3657
3356
|
SageEmbedQuery = "sageEmbedQuery",
|
|
3658
3357
|
/**
|
|
3659
3358
|
* Emitted when a user selects a data source.
|
|
3660
|
-
*
|
|
3661
3359
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
3662
3360
|
*/
|
|
3663
3361
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
3664
3362
|
/**
|
|
3665
3363
|
* Emitted when a user updates a connection on the **Data** page
|
|
3666
|
-
*
|
|
3667
3364
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3668
3365
|
*/
|
|
3669
3366
|
UpdateConnection = "updateConnection",
|
|
3670
3367
|
/**
|
|
3671
3368
|
* Emitted when a user updates a connection on the **Data** page
|
|
3672
|
-
*
|
|
3673
3369
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
3674
3370
|
*/
|
|
3675
3371
|
CreateConnection = "createConnection",
|
|
3676
3372
|
/**
|
|
3677
3373
|
* Emitted when name, status (private or public) or filter values of a
|
|
3678
3374
|
* Personalised view is updated.
|
|
3679
|
-
*
|
|
3680
3375
|
* @returns viewName: string
|
|
3681
3376
|
* @returns viewId: string
|
|
3682
3377
|
* @returns liveboardId: string
|
|
@@ -3686,7 +3381,6 @@ export enum EmbedEvent {
|
|
|
3686
3381
|
UpdatePersonalisedView = "updatePersonalisedView",
|
|
3687
3382
|
/**
|
|
3688
3383
|
* Emitted when a Personalised view is saved.
|
|
3689
|
-
*
|
|
3690
3384
|
* @returns viewName: string
|
|
3691
3385
|
* @returns viewId: string
|
|
3692
3386
|
* @returns liveboardId: string
|
|
@@ -3696,7 +3390,6 @@ export enum EmbedEvent {
|
|
|
3696
3390
|
SavePersonalisedView = "savePersonalisedView",
|
|
3697
3391
|
/**
|
|
3698
3392
|
* Emitted when a Liveboard is reset.
|
|
3699
|
-
*
|
|
3700
3393
|
* @returns viewName: string
|
|
3701
3394
|
* @returns viewId: string
|
|
3702
3395
|
* @returns liveboardId: string
|
|
@@ -3706,7 +3399,6 @@ export enum EmbedEvent {
|
|
|
3706
3399
|
ResetLiveboard = "resetLiveboard",
|
|
3707
3400
|
/**
|
|
3708
3401
|
* Emitted when a PersonalisedView is deleted.
|
|
3709
|
-
*
|
|
3710
3402
|
* @returns views: string[]
|
|
3711
3403
|
* @returns liveboardId: string
|
|
3712
3404
|
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
@@ -3714,13 +3406,11 @@ export enum EmbedEvent {
|
|
|
3714
3406
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
3715
3407
|
/**
|
|
3716
3408
|
* Emitted when a user creates a new worksheet
|
|
3717
|
-
*
|
|
3718
3409
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
3719
3410
|
*/
|
|
3720
3411
|
CreateWorksheet = "createWorksheet",
|
|
3721
3412
|
/**
|
|
3722
3413
|
* Emitted when Ask Sage is initialized.
|
|
3723
|
-
*
|
|
3724
3414
|
* @returns viewName: string
|
|
3725
3415
|
* @returns viewId: string
|
|
3726
3416
|
* @returns liveboardId: string
|
|
@@ -3730,7 +3420,6 @@ export enum EmbedEvent {
|
|
|
3730
3420
|
AskSageInit = "AskSageInit",
|
|
3731
3421
|
/**
|
|
3732
3422
|
* Emitted when a LB/viz is renamed
|
|
3733
|
-
*
|
|
3734
3423
|
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
3735
3424
|
*/
|
|
3736
3425
|
Rename = "rename",
|
|
@@ -3754,7 +3443,6 @@ export enum EmbedEvent {
|
|
|
3754
3443
|
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
3755
3444
|
/**
|
|
3756
3445
|
* Emitted when runtime parameters changes
|
|
3757
|
-
*
|
|
3758
3446
|
* @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
|
|
3759
3447
|
*/
|
|
3760
3448
|
ParameterChanged = "ParameterChanged"
|
|
@@ -3766,7 +3454,6 @@ export enum EmbedEvent {
|
|
|
3766
3454
|
* To trigger an event use the corresponding
|
|
3767
3455
|
* {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
|
|
3768
3456
|
* SearchEmbed.trigger} method.
|
|
3769
|
-
*
|
|
3770
3457
|
* @example
|
|
3771
3458
|
* ```js
|
|
3772
3459
|
* import { HostEvent } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -3787,7 +3474,6 @@ export enum HostEvent {
|
|
|
3787
3474
|
* the search query string.
|
|
3788
3475
|
* Supported in `AppEmbed` and `SearchEmbed` deployments.
|
|
3789
3476
|
* Includes the following properties:
|
|
3790
|
-
*
|
|
3791
3477
|
* @param - `searchQuery` - query string with search tokens
|
|
3792
3478
|
* @param - `dataSources` - Data source GUID to Search on
|
|
3793
3479
|
* - Although an array, only a single source
|
|
@@ -3806,7 +3492,6 @@ export enum HostEvent {
|
|
|
3806
3492
|
/**
|
|
3807
3493
|
* Triggers a drill on certain points of the specified column
|
|
3808
3494
|
* Includes the following properties:
|
|
3809
|
-
*
|
|
3810
3495
|
* @param - points - an object containing selectedPoints/clickedPoints
|
|
3811
3496
|
* to drill to. For example, { selectedPoints: []}
|
|
3812
3497
|
* @param - columnGuid - Optional. GUID of the column to drill
|
|
@@ -3856,19 +3541,16 @@ export enum HostEvent {
|
|
|
3856
3541
|
DrillDown = "triggerDrillDown",
|
|
3857
3542
|
/**
|
|
3858
3543
|
* Apply filters
|
|
3859
|
-
*
|
|
3860
3544
|
* @hidden
|
|
3861
3545
|
*/
|
|
3862
3546
|
Filter = "filter",
|
|
3863
3547
|
/**
|
|
3864
3548
|
* Reload the answer or visualization
|
|
3865
|
-
*
|
|
3866
3549
|
* @hidden
|
|
3867
3550
|
*/
|
|
3868
3551
|
Reload = "reload",
|
|
3869
3552
|
/**
|
|
3870
3553
|
* Display specific visualizations on a Liveboard.
|
|
3871
|
-
*
|
|
3872
3554
|
* @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
|
|
3873
3555
|
* in this parameter will be hidden.
|
|
3874
3556
|
* @example
|
|
@@ -3882,7 +3564,6 @@ export enum HostEvent {
|
|
|
3882
3564
|
SetVisibleVizs = "SetPinboardVisibleVizs",
|
|
3883
3565
|
/**
|
|
3884
3566
|
* Set a Liveboard tab as an active tab.
|
|
3885
|
-
*
|
|
3886
3567
|
* @param - tabId - string of id of Tab to show
|
|
3887
3568
|
* @example
|
|
3888
3569
|
* ```js
|
|
@@ -3903,17 +3584,16 @@ export enum HostEvent {
|
|
|
3903
3584
|
* _String_. The name of the column to filter on.
|
|
3904
3585
|
*
|
|
3905
3586
|
* `operator`
|
|
3906
|
-
*
|
|
3907
|
-
*
|
|
3587
|
+
* Runtime filter operator to apply. For information,
|
|
3588
|
+
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
3908
3589
|
*
|
|
3909
3590
|
* `values`
|
|
3910
|
-
*
|
|
3911
|
-
*
|
|
3912
|
-
*
|
|
3913
|
-
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3914
|
-
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3915
|
-
* embedding (SageEmbed).
|
|
3591
|
+
* List of operands. Some operators such as EQ, LE allow a single value, whereas
|
|
3592
|
+
* operators such as BW and IN accept multiple operands.
|
|
3916
3593
|
*
|
|
3594
|
+
* **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
|
|
3595
|
+
* Search embedding (SearchEmbed) and Natural Language Search
|
|
3596
|
+
* embedding (SageEmbed).
|
|
3917
3597
|
* @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
|
|
3918
3598
|
* @example
|
|
3919
3599
|
* ```js
|
|
@@ -3929,7 +3609,6 @@ export enum HostEvent {
|
|
|
3929
3609
|
/**
|
|
3930
3610
|
* Navigate to a specific page in the embedded ThoughtSpot application.
|
|
3931
3611
|
* This is the same as calling `appEmbed.navigateToPage(path, true)`
|
|
3932
|
-
*
|
|
3933
3612
|
* @param - `path` - the path to navigate to to go forward or back. The path value can
|
|
3934
3613
|
* be a number; for example, `1`, `-1`.
|
|
3935
3614
|
* @example
|
|
@@ -3942,7 +3621,6 @@ export enum HostEvent {
|
|
|
3942
3621
|
/**
|
|
3943
3622
|
* Open the filter panel for a particular column.
|
|
3944
3623
|
* Works with Search and Liveboard embed.
|
|
3945
|
-
*
|
|
3946
3624
|
* @param - { columnId: string,
|
|
3947
3625
|
* name: string,
|
|
3948
3626
|
* type: INT64/CHAR/DATE,
|
|
@@ -3959,7 +3637,6 @@ export enum HostEvent {
|
|
|
3959
3637
|
OpenFilter = "openFilter",
|
|
3960
3638
|
/**
|
|
3961
3639
|
* Add columns to the current search query.
|
|
3962
|
-
*
|
|
3963
3640
|
* @param - { columnIds: string[] }
|
|
3964
3641
|
* @example
|
|
3965
3642
|
* ```js
|
|
@@ -3970,7 +3647,6 @@ export enum HostEvent {
|
|
|
3970
3647
|
AddColumns = "addColumns",
|
|
3971
3648
|
/**
|
|
3972
3649
|
* Remove a column from the current search query.
|
|
3973
|
-
*
|
|
3974
3650
|
* @param - { columnId: string }
|
|
3975
3651
|
* @example
|
|
3976
3652
|
* ```js
|
|
@@ -3985,7 +3661,6 @@ export enum HostEvent {
|
|
|
3985
3661
|
* Liveboard filters, runtime filters applied on visualizations on a
|
|
3986
3662
|
* Liveboard, and Liveboard layout, changes to visualizations such as
|
|
3987
3663
|
* sorting, toggling of legends, and data drill down.
|
|
3988
|
-
*
|
|
3989
3664
|
* @example
|
|
3990
3665
|
* ```js
|
|
3991
3666
|
* liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
|
|
@@ -3996,7 +3671,6 @@ export enum HostEvent {
|
|
|
3996
3671
|
getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
|
|
3997
3672
|
/**
|
|
3998
3673
|
* Trigger the **Pin** action on an embedded object
|
|
3999
|
-
*
|
|
4000
3674
|
* @param - Liveboard embed takes the `vizId` as a
|
|
4001
3675
|
* key. Can be left undefined when embedding Search, full app, or
|
|
4002
3676
|
* a visualization.
|
|
@@ -4013,7 +3687,6 @@ export enum HostEvent {
|
|
|
4013
3687
|
/**
|
|
4014
3688
|
* Trigger the **Show Liveboard details** action
|
|
4015
3689
|
* on an embedded Liveboard.
|
|
4016
|
-
*
|
|
4017
3690
|
* @example
|
|
4018
3691
|
*```js
|
|
4019
3692
|
* liveboardEmbed.trigger(HostEvent.LiveboardInfo)
|
|
@@ -4023,7 +3696,6 @@ export enum HostEvent {
|
|
|
4023
3696
|
LiveboardInfo = "pinboardInfo",
|
|
4024
3697
|
/**
|
|
4025
3698
|
* Trigger the **Schedule** action on an embedded Liveboard.
|
|
4026
|
-
*
|
|
4027
3699
|
* @example
|
|
4028
3700
|
* ```js
|
|
4029
3701
|
* liveboardEmbed.trigger(HostEvent.Schedule)
|
|
@@ -4033,7 +3705,6 @@ export enum HostEvent {
|
|
|
4033
3705
|
Schedule = "subscription",
|
|
4034
3706
|
/**
|
|
4035
3707
|
* Trigger the **Manage schedule** action on an embedded Liveboard
|
|
4036
|
-
*
|
|
4037
3708
|
* @example
|
|
4038
3709
|
* ```js
|
|
4039
3710
|
* liveboardEmbed.trigger(HostEvent.ScheduleList)
|
|
@@ -4044,20 +3715,16 @@ export enum HostEvent {
|
|
|
4044
3715
|
/**
|
|
4045
3716
|
* Trigger the **Export TML** action on an embedded Liveboard or
|
|
4046
3717
|
* Answer.
|
|
4047
|
-
*
|
|
4048
3718
|
* @example
|
|
4049
3719
|
* ```js
|
|
4050
3720
|
* liveboardEmbed.trigger(HostEvent.ExportTML)
|
|
4051
3721
|
* ```
|
|
4052
|
-
*
|
|
4053
3722
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4054
3723
|
*/
|
|
4055
3724
|
ExportTML = "exportTSL",
|
|
4056
3725
|
/**
|
|
4057
3726
|
* Trigger the **Edit TML** action on an embedded Liveboard or
|
|
4058
3727
|
* saved Answers in the full application embedding.
|
|
4059
|
-
*
|
|
4060
|
-
*
|
|
4061
3728
|
* @example
|
|
4062
3729
|
* ```js
|
|
4063
3730
|
* liveboardEmbed.trigger(HostEvent.EditTML)
|
|
@@ -4067,7 +3734,6 @@ export enum HostEvent {
|
|
|
4067
3734
|
EditTML = "editTSL",
|
|
4068
3735
|
/**
|
|
4069
3736
|
* Trigger the **Update TML** action on an embedded Liveboard.
|
|
4070
|
-
*
|
|
4071
3737
|
* @example
|
|
4072
3738
|
* ```js
|
|
4073
3739
|
* liveboardEmbed.trigger(HostEvent.UpdateTML)
|
|
@@ -4081,7 +3747,6 @@ export enum HostEvent {
|
|
|
4081
3747
|
*
|
|
4082
3748
|
* **NOTE**: The **Download** > **PDF** action is available on
|
|
4083
3749
|
* visualizations and Answers if the data is in tabular format.
|
|
4084
|
-
*
|
|
4085
3750
|
* @example
|
|
4086
3751
|
* ```js
|
|
4087
3752
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
|
|
@@ -4092,7 +3757,6 @@ export enum HostEvent {
|
|
|
4092
3757
|
/**
|
|
4093
3758
|
* Trigger the **Make a copy** action on a Liveboard, Search, or
|
|
4094
3759
|
* visualization page.
|
|
4095
|
-
*
|
|
4096
3760
|
* @example
|
|
4097
3761
|
* ```js
|
|
4098
3762
|
* liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
@@ -4108,7 +3772,6 @@ export enum HostEvent {
|
|
|
4108
3772
|
MakeACopy = "makeACopy",
|
|
4109
3773
|
/**
|
|
4110
3774
|
* Trigger the **Delete** action for a Liveboard.
|
|
4111
|
-
*
|
|
4112
3775
|
* @example
|
|
4113
3776
|
* ```js
|
|
4114
3777
|
* appEmbed.trigger(HostEvent.Remove)
|
|
@@ -4118,7 +3781,6 @@ export enum HostEvent {
|
|
|
4118
3781
|
Remove = "delete",
|
|
4119
3782
|
/**
|
|
4120
3783
|
* Trigger the **Explore** action on a visualization.
|
|
4121
|
-
*
|
|
4122
3784
|
* @param - an object with `vizId` as a key
|
|
4123
3785
|
* @example
|
|
4124
3786
|
* ```js
|
|
@@ -4129,7 +3791,6 @@ export enum HostEvent {
|
|
|
4129
3791
|
Explore = "explore",
|
|
4130
3792
|
/**
|
|
4131
3793
|
* Trigger the **Create alert** action on a visualization
|
|
4132
|
-
*
|
|
4133
3794
|
* @param - an object with `vizId` as a key
|
|
4134
3795
|
* @example
|
|
4135
3796
|
* ```js
|
|
@@ -4142,7 +3803,6 @@ export enum HostEvent {
|
|
|
4142
3803
|
CreateMonitor = "createMonitor",
|
|
4143
3804
|
/**
|
|
4144
3805
|
* Trigger the **Manage alerts** action on a visualization
|
|
4145
|
-
*
|
|
4146
3806
|
* @param - an object with `vizId` as a key
|
|
4147
3807
|
* @example
|
|
4148
3808
|
* ```js
|
|
@@ -4158,10 +3818,8 @@ export enum HostEvent {
|
|
|
4158
3818
|
* on a Liveboard.
|
|
4159
3819
|
*
|
|
4160
3820
|
* This event is not supported in visualization embed and search embed.
|
|
4161
|
-
*
|
|
4162
3821
|
* @param - object - To trigger the action for a specific visualization
|
|
4163
3822
|
* in Liveboard embed, pass in `vizId` as a key.
|
|
4164
|
-
*
|
|
4165
3823
|
* @example
|
|
4166
3824
|
* ```js
|
|
4167
3825
|
* liveboardEmbed.trigger(HostEvent.Edit)
|
|
@@ -4175,7 +3833,6 @@ export enum HostEvent {
|
|
|
4175
3833
|
Edit = "edit",
|
|
4176
3834
|
/**
|
|
4177
3835
|
* Trigger the **Copy link** action on a Liveboard or visualization
|
|
4178
|
-
*
|
|
4179
3836
|
* @param - object - to trigger the action for a
|
|
4180
3837
|
* specific visualization in Liveboard embed, pass in `vizId` as a key
|
|
4181
3838
|
* @example
|
|
@@ -4193,7 +3850,6 @@ export enum HostEvent {
|
|
|
4193
3850
|
CopyLink = "embedDocument",
|
|
4194
3851
|
/**
|
|
4195
3852
|
* Trigger the **Present** action on a Liveboard or visualization
|
|
4196
|
-
*
|
|
4197
3853
|
* @param - object - to trigger the action for a specific visualization
|
|
4198
3854
|
* in Liveboard embed, pass in `vizId` as a key
|
|
4199
3855
|
* @example
|
|
@@ -4211,7 +3867,6 @@ export enum HostEvent {
|
|
|
4211
3867
|
Present = "present",
|
|
4212
3868
|
/**
|
|
4213
3869
|
* Get TML for the current search.
|
|
4214
|
-
*
|
|
4215
3870
|
* @example
|
|
4216
3871
|
* ```js
|
|
4217
3872
|
* searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
|
|
@@ -4226,7 +3881,6 @@ export enum HostEvent {
|
|
|
4226
3881
|
GetTML = "getTML",
|
|
4227
3882
|
/**
|
|
4228
3883
|
* Trigger the **Show underlying data** action on visualization or search
|
|
4229
|
-
*
|
|
4230
3884
|
* @param - an object with vizId as a key
|
|
4231
3885
|
* @example
|
|
4232
3886
|
* ```js
|
|
@@ -4246,7 +3900,6 @@ export enum HostEvent {
|
|
|
4246
3900
|
* Trigger the **Delete** action for a visualization
|
|
4247
3901
|
* in an embedded Liveboard, or a chart or table
|
|
4248
3902
|
* generated from Search.
|
|
4249
|
-
*
|
|
4250
3903
|
* @param - Liveboard embed takes an object with `vizId` as a key.
|
|
4251
3904
|
* Can be left empty if embedding Search or visualization.
|
|
4252
3905
|
* @example
|
|
@@ -4263,7 +3916,6 @@ export enum HostEvent {
|
|
|
4263
3916
|
/**
|
|
4264
3917
|
* Trigger the **SpotIQ analyze** action on visualization
|
|
4265
3918
|
* or search.
|
|
4266
|
-
*
|
|
4267
3919
|
* @param - Liveboard embed takes `vizId` as a
|
|
4268
3920
|
* key. Can be left undefined when embedding Search or
|
|
4269
3921
|
* visualization.
|
|
@@ -4284,7 +3936,6 @@ export enum HostEvent {
|
|
|
4284
3936
|
/**
|
|
4285
3937
|
* Trigger the **Download** action on charts in
|
|
4286
3938
|
* the embedded view.
|
|
4287
|
-
*
|
|
4288
3939
|
* @example
|
|
4289
3940
|
* ```js
|
|
4290
3941
|
* liveboardEmbed.trigger(HostEvent.Download, {vizId:
|
|
@@ -4301,7 +3952,6 @@ export enum HostEvent {
|
|
|
4301
3952
|
/**
|
|
4302
3953
|
* Trigger the **Download** > **PNG** action on
|
|
4303
3954
|
* charts in the embedded view.
|
|
4304
|
-
*
|
|
4305
3955
|
* @example
|
|
4306
3956
|
* ```js
|
|
4307
3957
|
* liveboardEmbed.trigger(HostEvent.DownloadAsPng,
|
|
@@ -4317,7 +3967,6 @@ export enum HostEvent {
|
|
|
4317
3967
|
/**
|
|
4318
3968
|
* Trigger the **Download** > **CSV** action on tables in
|
|
4319
3969
|
* the embedded view.
|
|
4320
|
-
*
|
|
4321
3970
|
* @example
|
|
4322
3971
|
* ```js
|
|
4323
3972
|
* liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
|
|
@@ -4335,7 +3984,6 @@ export enum HostEvent {
|
|
|
4335
3984
|
/**
|
|
4336
3985
|
* Trigger the **Download** > **XLSX** action on tables
|
|
4337
3986
|
* in the embedded view.
|
|
4338
|
-
*
|
|
4339
3987
|
* @example
|
|
4340
3988
|
* ```js
|
|
4341
3989
|
* liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
|
|
@@ -4353,7 +4001,6 @@ export enum HostEvent {
|
|
|
4353
4001
|
/**
|
|
4354
4002
|
* Trigger the **Share** action on an embedded
|
|
4355
4003
|
* Liveboard or Answer.
|
|
4356
|
-
*
|
|
4357
4004
|
* @example
|
|
4358
4005
|
* ```js
|
|
4359
4006
|
* liveboardEmbed.trigger(HostEvent.Share)
|
|
@@ -4367,7 +4014,6 @@ export enum HostEvent {
|
|
|
4367
4014
|
/**
|
|
4368
4015
|
* Trigger the **Save** action on a Liveboard or Answer.
|
|
4369
4016
|
* Saves the changes.
|
|
4370
|
-
*
|
|
4371
4017
|
* @example
|
|
4372
4018
|
* ```js
|
|
4373
4019
|
* liveboardEmbed.trigger(HostEvent.Save)
|
|
@@ -4381,7 +4027,6 @@ export enum HostEvent {
|
|
|
4381
4027
|
/**
|
|
4382
4028
|
* Trigger the **Sync to Sheets** action on an embedded visualization or Answer
|
|
4383
4029
|
* Sends data from an Answer or Liveboard visualization to a Google sheet.
|
|
4384
|
-
*
|
|
4385
4030
|
* @param - an object with `vizId` as a key
|
|
4386
4031
|
* @example
|
|
4387
4032
|
* ```js
|
|
@@ -4398,7 +4043,6 @@ export enum HostEvent {
|
|
|
4398
4043
|
* Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
|
|
4399
4044
|
* Sends data from an Answer or Liveboard visualization to third-party apps such
|
|
4400
4045
|
* as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
|
|
4401
|
-
*
|
|
4402
4046
|
* @param - an object with vizId as a key
|
|
4403
4047
|
* @example
|
|
4404
4048
|
* ```js
|
|
@@ -4415,7 +4059,6 @@ export enum HostEvent {
|
|
|
4415
4059
|
* Trigger the **Manage pipelines** action on an embedded
|
|
4416
4060
|
* visualization or Answer.
|
|
4417
4061
|
* Allows users to manage ThoughtSpot Sync pipelines.
|
|
4418
|
-
*
|
|
4419
4062
|
* @param - an object with `vizId` as a key
|
|
4420
4063
|
* @example
|
|
4421
4064
|
* ```js
|
|
@@ -4430,7 +4073,6 @@ export enum HostEvent {
|
|
|
4430
4073
|
ManagePipelines = "manage-pipeline",
|
|
4431
4074
|
/**
|
|
4432
4075
|
* Reset search operation on the Search or Answer page.
|
|
4433
|
-
*
|
|
4434
4076
|
* @example
|
|
4435
4077
|
* ```js
|
|
4436
4078
|
* searchEmbed.trigger(HostEvent.ResetSearch)
|
|
@@ -4444,19 +4086,16 @@ export enum HostEvent {
|
|
|
4444
4086
|
/**
|
|
4445
4087
|
* Get details of filters applied on the Liveboard.
|
|
4446
4088
|
* Returns arrays containing Liveboard filter and runtime filter elements.
|
|
4447
|
-
*
|
|
4448
4089
|
* @example
|
|
4449
4090
|
* ```js
|
|
4450
4091
|
* const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
|
|
4451
4092
|
* console.log('data', data);
|
|
4452
4093
|
* ```
|
|
4453
|
-
*
|
|
4454
4094
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4455
4095
|
*/
|
|
4456
4096
|
GetFilters = "getFilters",
|
|
4457
4097
|
/**
|
|
4458
4098
|
* Update one or several filters applied on a Liveboard.
|
|
4459
|
-
*
|
|
4460
4099
|
* @param - `filter`: a single filter object containing column name,
|
|
4461
4100
|
* filter operator, and values.
|
|
4462
4101
|
* @param - `filters`: multiple filter objects with column name, filter operator,
|
|
@@ -4473,7 +4112,6 @@ export enum HostEvent {
|
|
|
4473
4112
|
* `values` - An array of one or several values. The value definition on the
|
|
4474
4113
|
* data type you choose to filter on. For a complete list of supported data types,
|
|
4475
4114
|
* see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
|
|
4476
|
-
*
|
|
4477
4115
|
* @example
|
|
4478
4116
|
* ```js
|
|
4479
4117
|
*
|
|
@@ -4485,7 +4123,6 @@ export enum HostEvent {
|
|
|
4485
4123
|
* }
|
|
4486
4124
|
* });
|
|
4487
4125
|
* ```
|
|
4488
|
-
*
|
|
4489
4126
|
* @example
|
|
4490
4127
|
*
|
|
4491
4128
|
* ```js
|
|
@@ -4507,13 +4144,11 @@ export enum HostEvent {
|
|
|
4507
4144
|
* }]
|
|
4508
4145
|
* });
|
|
4509
4146
|
* ```
|
|
4510
|
-
*
|
|
4511
4147
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
4512
4148
|
*/
|
|
4513
4149
|
UpdateFilters = "updateFilters",
|
|
4514
4150
|
/**
|
|
4515
4151
|
* Get tab details for the current Liveboard.
|
|
4516
|
-
*
|
|
4517
4152
|
* @example
|
|
4518
4153
|
* ```js
|
|
4519
4154
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
@@ -4527,7 +4162,6 @@ export enum HostEvent {
|
|
|
4527
4162
|
GetTabs = "getTabs",
|
|
4528
4163
|
/**
|
|
4529
4164
|
* Set the visible tabs on a Liveboard.
|
|
4530
|
-
*
|
|
4531
4165
|
* @param - an array of ids of tabs to show, the IDs not passed
|
|
4532
4166
|
* will be hidden.
|
|
4533
4167
|
* @example
|
|
@@ -4541,7 +4175,6 @@ export enum HostEvent {
|
|
|
4541
4175
|
SetVisibleTabs = "SetPinboardVisibleTabs",
|
|
4542
4176
|
/**
|
|
4543
4177
|
* Set the hidden tabs on a Liveboard.
|
|
4544
|
-
*
|
|
4545
4178
|
* @param - an array of the IDs of the tabs to hide.
|
|
4546
4179
|
* The IDs not passed will be shown.
|
|
4547
4180
|
* @example
|
|
@@ -4555,7 +4188,6 @@ export enum HostEvent {
|
|
|
4555
4188
|
SetHiddenTabs = "SetPinboardHiddenTabs",
|
|
4556
4189
|
/**
|
|
4557
4190
|
* Updates the search query string for Natural Language Search operations.
|
|
4558
|
-
*
|
|
4559
4191
|
* @param - `queryString`: Text string in Natural Language format
|
|
4560
4192
|
* @param - `executeSearch`: Boolean to execute search and update search query
|
|
4561
4193
|
* @example
|
|
@@ -4570,7 +4202,6 @@ export enum HostEvent {
|
|
|
4570
4202
|
UpdateSageQuery = "updateSageQuery",
|
|
4571
4203
|
/**
|
|
4572
4204
|
* Get the answer session for a Search / Visualization.
|
|
4573
|
-
*
|
|
4574
4205
|
* @example
|
|
4575
4206
|
* ```js
|
|
4576
4207
|
* const {session} = await embed.trigger(
|
|
@@ -4583,7 +4214,6 @@ export enum HostEvent {
|
|
|
4583
4214
|
GetAnswerSession = "getAnswerSession",
|
|
4584
4215
|
/**
|
|
4585
4216
|
* Trigger Ask Sage for viz
|
|
4586
|
-
*
|
|
4587
4217
|
* @example
|
|
4588
4218
|
* ```js
|
|
4589
4219
|
* liveboardEmbed.trigger(HostEvent.AskSage,
|
|
@@ -4594,7 +4224,6 @@ export enum HostEvent {
|
|
|
4594
4224
|
AskSage = "AskSage",
|
|
4595
4225
|
/**
|
|
4596
4226
|
* Trigger UpdateCrossFilter for Liveboard
|
|
4597
|
-
*
|
|
4598
4227
|
* @example
|
|
4599
4228
|
* ```js
|
|
4600
4229
|
* liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
|
|
@@ -4610,7 +4239,6 @@ export enum HostEvent {
|
|
|
4610
4239
|
UpdateCrossFilter = "UpdateCrossFilter",
|
|
4611
4240
|
/**
|
|
4612
4241
|
* Trigger ResetLiveboardPersonalisedView for Liveboard
|
|
4613
|
-
*
|
|
4614
4242
|
* @example
|
|
4615
4243
|
* ```js
|
|
4616
4244
|
* liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
|
|
@@ -4620,7 +4248,6 @@ export enum HostEvent {
|
|
|
4620
4248
|
ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
|
|
4621
4249
|
/**
|
|
4622
4250
|
* Trigger CreateLiveboard for liveboard list page & Pin Modal
|
|
4623
|
-
*
|
|
4624
4251
|
* @example
|
|
4625
4252
|
* ```js
|
|
4626
4253
|
* liveboardEmbed.trigger(HostEvent.CreateLiveboard);
|
|
@@ -4761,7 +4388,6 @@ export enum Param {
|
|
|
4761
4388
|
* specific actions in the embedded view, define the Action
|
|
4762
4389
|
* enumeration members in the `disabledActions`, `visibleActions`,
|
|
4763
4390
|
* or `hiddenActions` array.
|
|
4764
|
-
*
|
|
4765
4391
|
* @example
|
|
4766
4392
|
* ```js
|
|
4767
4393
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -4785,7 +4411,6 @@ export enum Action {
|
|
|
4785
4411
|
/**
|
|
4786
4412
|
* The **Save** action on an Answer or Liveboard.
|
|
4787
4413
|
* Allows users to save the changes.
|
|
4788
|
-
*
|
|
4789
4414
|
* @example
|
|
4790
4415
|
* ```js
|
|
4791
4416
|
* disabledActions: [Action.Save]
|
|
@@ -4804,7 +4429,6 @@ export enum Action {
|
|
|
4804
4429
|
* The **Save as View** action on the Answer
|
|
4805
4430
|
* page. Saves an Answer as a View object in the full
|
|
4806
4431
|
* application embedding mode.
|
|
4807
|
-
*
|
|
4808
4432
|
* @example
|
|
4809
4433
|
* ```js
|
|
4810
4434
|
* disabledActions: [Action.SaveAsView]
|
|
@@ -4818,7 +4442,6 @@ export enum Action {
|
|
|
4818
4442
|
* visualizations in the embedded Liveboard view.
|
|
4819
4443
|
* In AppEmbed, the **Make a copy** action is available on both
|
|
4820
4444
|
* Liveboards and visualizations.
|
|
4821
|
-
*
|
|
4822
4445
|
* @example
|
|
4823
4446
|
* ```js
|
|
4824
4447
|
* disabledActions: [Action.MakeACopy]
|
|
@@ -4828,7 +4451,6 @@ export enum Action {
|
|
|
4828
4451
|
/**
|
|
4829
4452
|
* The **Copy and Edit** action on a Liveboard.
|
|
4830
4453
|
* This action is now replaced with `Action.MakeACopy`.
|
|
4831
|
-
*
|
|
4832
4454
|
* @example
|
|
4833
4455
|
* ```js
|
|
4834
4456
|
* disabledActions: [Action.EditACopy]
|
|
@@ -4838,7 +4460,6 @@ export enum Action {
|
|
|
4838
4460
|
/**
|
|
4839
4461
|
* The **Copy link** menu action on a Liveboard visualization.
|
|
4840
4462
|
* Copies the visualization URL
|
|
4841
|
-
*
|
|
4842
4463
|
* @example
|
|
4843
4464
|
* ```js
|
|
4844
4465
|
* disabledActions: [Action.CopyLink]
|
|
@@ -4852,7 +4473,6 @@ export enum Action {
|
|
|
4852
4473
|
/**
|
|
4853
4474
|
* The **Schedule** menu action on a Liveboard.
|
|
4854
4475
|
* Allows scheduling a Liveboard notification.
|
|
4855
|
-
*
|
|
4856
4476
|
* @example
|
|
4857
4477
|
* ```js
|
|
4858
4478
|
* disabledActions: [Action.Schedule]
|
|
@@ -4862,7 +4482,6 @@ export enum Action {
|
|
|
4862
4482
|
/**
|
|
4863
4483
|
* The **Manage schedules** menu action on a Liveboard.
|
|
4864
4484
|
* Allows users to manage scheduled Liveboard jobs.
|
|
4865
|
-
*
|
|
4866
4485
|
* @example
|
|
4867
4486
|
* ```js
|
|
4868
4487
|
* disabledActions: [Action.SchedulesList]
|
|
@@ -4872,7 +4491,6 @@ export enum Action {
|
|
|
4872
4491
|
/**
|
|
4873
4492
|
* The **Share** action on a Liveboard, Answer, or Worksheet.
|
|
4874
4493
|
* Allows users to share an object with other users and groups.
|
|
4875
|
-
*
|
|
4876
4494
|
* @example
|
|
4877
4495
|
* ```js
|
|
4878
4496
|
* disabledActions: [Action.Share]
|
|
@@ -4882,7 +4500,6 @@ export enum Action {
|
|
|
4882
4500
|
/**
|
|
4883
4501
|
* The **Add filter** action on a Liveboard and Search page.
|
|
4884
4502
|
* Allows adding filters to Answers and visualizations on a Liveboard.
|
|
4885
|
-
*
|
|
4886
4503
|
* @example
|
|
4887
4504
|
* ```js
|
|
4888
4505
|
* disabledActions: [Action.AddFilter]
|
|
@@ -4893,7 +4510,6 @@ export enum Action {
|
|
|
4893
4510
|
* The **Add Data Panel Objects** action on the data panel v2.
|
|
4894
4511
|
* Allows to show action menu to add different objects (like
|
|
4895
4512
|
* formulas, parameters) in data panel v2.
|
|
4896
|
-
*
|
|
4897
4513
|
* @example
|
|
4898
4514
|
* ```js
|
|
4899
4515
|
* disabledActions: [Action.AddDataPanelObjects]
|
|
@@ -4905,7 +4521,6 @@ export enum Action {
|
|
|
4905
4521
|
* Filter configuration options on a Liveboard and Search page.
|
|
4906
4522
|
* Allows configuring filter options when adding filters to a
|
|
4907
4523
|
* Liveboard or Answer.
|
|
4908
|
-
*
|
|
4909
4524
|
* @example
|
|
4910
4525
|
* ```js
|
|
4911
4526
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -4916,7 +4531,6 @@ export enum Action {
|
|
|
4916
4531
|
/**
|
|
4917
4532
|
* The **Choose sources** button on Search page.
|
|
4918
4533
|
* Allows selecting data sources for search queries.
|
|
4919
|
-
*
|
|
4920
4534
|
* @example
|
|
4921
4535
|
* ```js
|
|
4922
4536
|
* disabledActions: [Action.ChooseDataSources]
|
|
@@ -4926,7 +4540,6 @@ export enum Action {
|
|
|
4926
4540
|
/**
|
|
4927
4541
|
* The **Create formula** action on a Search or Answer page.
|
|
4928
4542
|
* Allows adding formulas to an Answer.
|
|
4929
|
-
*
|
|
4930
4543
|
* @example
|
|
4931
4544
|
* ```js
|
|
4932
4545
|
* disabledActions: [Action.AddFormula]
|
|
@@ -4936,7 +4549,6 @@ export enum Action {
|
|
|
4936
4549
|
/**
|
|
4937
4550
|
* The **Add parameter** action on a Liveboard or Answer.
|
|
4938
4551
|
* Allows adding Parameters to a Liveboard or Answer.
|
|
4939
|
-
*
|
|
4940
4552
|
* @example
|
|
4941
4553
|
* ```js
|
|
4942
4554
|
* disabledActions: [Action.AddParameter]
|
|
@@ -4946,7 +4558,6 @@ export enum Action {
|
|
|
4946
4558
|
/**
|
|
4947
4559
|
* The **Add Column Set** action on a Answer.
|
|
4948
4560
|
* Allows adding column sets to a Answer.
|
|
4949
|
-
*
|
|
4950
4561
|
* @example
|
|
4951
4562
|
* ```js
|
|
4952
4563
|
* disabledActions: [Action.AddColumnSet]
|
|
@@ -4957,7 +4568,6 @@ export enum Action {
|
|
|
4957
4568
|
/**
|
|
4958
4569
|
* The **Add Query Set** action on a Answer.
|
|
4959
4570
|
* Allows adding query sets to a Answer.
|
|
4960
|
-
*
|
|
4961
4571
|
* @example
|
|
4962
4572
|
* ```js
|
|
4963
4573
|
* disabledActions: [Action.AddQuerySet]
|
|
@@ -4972,7 +4582,6 @@ export enum Action {
|
|
|
4972
4582
|
/**
|
|
4973
4583
|
* The **SpotIQ analyze** menu action on a visualization or
|
|
4974
4584
|
* Answer page.
|
|
4975
|
-
*
|
|
4976
4585
|
* @example
|
|
4977
4586
|
* ```js
|
|
4978
4587
|
* disabledActions: [Action.SpotIQAnalyze]
|
|
@@ -4995,7 +4604,6 @@ export enum Action {
|
|
|
4995
4604
|
/**
|
|
4996
4605
|
* The **Show underlying data** menu action on a visualization or
|
|
4997
4606
|
* Answer page.
|
|
4998
|
-
*
|
|
4999
4607
|
* @example
|
|
5000
4608
|
* ```js
|
|
5001
4609
|
* disabledActions: [Action.ShowUnderlyingData]
|
|
@@ -5006,7 +4614,6 @@ export enum Action {
|
|
|
5006
4614
|
* The **Download** menu action on Liveboard visualizations
|
|
5007
4615
|
* and Answers.
|
|
5008
4616
|
* Allows downloading a visualization or Answer.
|
|
5009
|
-
*
|
|
5010
4617
|
* @example
|
|
5011
4618
|
* ```js
|
|
5012
4619
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5017,7 +4624,6 @@ export enum Action {
|
|
|
5017
4624
|
* The **Download** > **PNG** menu action for charts on a Liveboard
|
|
5018
4625
|
* or Answer page.
|
|
5019
4626
|
* Downloads a visualization or Answer as a PNG file.
|
|
5020
|
-
*
|
|
5021
4627
|
* @example
|
|
5022
4628
|
* ```js
|
|
5023
4629
|
* disabledActions: [Action.DownloadAsPng]
|
|
@@ -5026,13 +4632,12 @@ export enum Action {
|
|
|
5026
4632
|
DownloadAsPng = "downloadAsPng",
|
|
5027
4633
|
/**
|
|
5028
4634
|
*
|
|
5029
|
-
*
|
|
5030
|
-
*
|
|
5031
|
-
*
|
|
4635
|
+
*The **Download PDF** action that downloads a Liveboard,
|
|
4636
|
+
*visualization, or Answer as a PDF file.
|
|
5032
4637
|
*
|
|
5033
|
-
* **NOTE**: The **Download** > **PDF** action is available on
|
|
5034
|
-
* visualizations and Answers if the data is in tabular format.
|
|
5035
4638
|
*
|
|
4639
|
+
***NOTE**: The **Download** > **PDF** action is available on
|
|
4640
|
+
*visualizations and Answers if the data is in tabular format.
|
|
5036
4641
|
* @example
|
|
5037
4642
|
* ```js
|
|
5038
4643
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -5043,7 +4648,6 @@ export enum Action {
|
|
|
5043
4648
|
* The **Download** > **CSV** menu action for tables on a Liveboard
|
|
5044
4649
|
* or Answer page.
|
|
5045
4650
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5046
|
-
*
|
|
5047
4651
|
* @example
|
|
5048
4652
|
* ```js
|
|
5049
4653
|
* disabledActions: [Action.DownloadAsCsv]
|
|
@@ -5054,7 +4658,6 @@ export enum Action {
|
|
|
5054
4658
|
* The **Download** > **XLSX** menu action for tables on a Liveboard
|
|
5055
4659
|
* or Answer page.
|
|
5056
4660
|
* Downloads a visualization or Answer in the XLSX format.
|
|
5057
|
-
*
|
|
5058
4661
|
* @example
|
|
5059
4662
|
* ```js
|
|
5060
4663
|
* disabledActions: [Action.DownloadAsXlsx]
|
|
@@ -5069,7 +4672,6 @@ export enum Action {
|
|
|
5069
4672
|
* The **Export TML** menu action on Liveboard, Answers
|
|
5070
4673
|
* Worksheets and Data Connections page.
|
|
5071
4674
|
* Exports an object as a TML file.
|
|
5072
|
-
*
|
|
5073
4675
|
* @example
|
|
5074
4676
|
* ```js
|
|
5075
4677
|
* disabledActions: [Action.ExportTML]
|
|
@@ -5079,7 +4681,6 @@ export enum Action {
|
|
|
5079
4681
|
/**
|
|
5080
4682
|
* The **Import TML** menu action for Liveboards and Answers.
|
|
5081
4683
|
* Imports TML representation of ThoughtSpot objects.
|
|
5082
|
-
*
|
|
5083
4684
|
* @example
|
|
5084
4685
|
* ```js
|
|
5085
4686
|
* disabledActions: [Action.ImportTML]
|
|
@@ -5089,7 +4690,6 @@ export enum Action {
|
|
|
5089
4690
|
/**
|
|
5090
4691
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
5091
4692
|
* Update TML representation of ThoughtSpot objects.
|
|
5092
|
-
*
|
|
5093
4693
|
* @example
|
|
5094
4694
|
* ```js
|
|
5095
4695
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -5099,7 +4699,6 @@ export enum Action {
|
|
|
5099
4699
|
/**
|
|
5100
4700
|
* The **Edit TML** menu action for Liveboards and Answers.
|
|
5101
4701
|
* Opens the TML editor.
|
|
5102
|
-
*
|
|
5103
4702
|
* @example
|
|
5104
4703
|
* ```js
|
|
5105
4704
|
* disabledActions: [Action.EditTML]
|
|
@@ -5110,7 +4709,6 @@ export enum Action {
|
|
|
5110
4709
|
* The **Present** menu action for Liveboards and Answers.
|
|
5111
4710
|
* Allows presenting a Liveboard or visualization in
|
|
5112
4711
|
* slideshow mode.
|
|
5113
|
-
*
|
|
5114
4712
|
* @example
|
|
5115
4713
|
* ```js
|
|
5116
4714
|
* disabledActions: [Action.Present]
|
|
@@ -5120,7 +4718,6 @@ export enum Action {
|
|
|
5120
4718
|
/**
|
|
5121
4719
|
* The tile resize options in the visualization menu.
|
|
5122
4720
|
* Allows switching between different preset layouts.
|
|
5123
|
-
*
|
|
5124
4721
|
* @example
|
|
5125
4722
|
* ```js
|
|
5126
4723
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -5131,7 +4728,6 @@ export enum Action {
|
|
|
5131
4728
|
* The *Edit* action on the Liveboard page and in the
|
|
5132
4729
|
* visualization menu.
|
|
5133
4730
|
* Opens a Liveboard or visualization in edit mode.
|
|
5134
|
-
*
|
|
5135
4731
|
* @example
|
|
5136
4732
|
* ```js
|
|
5137
4733
|
* disabledActions: [Action.Edit]
|
|
@@ -5140,7 +4736,6 @@ export enum Action {
|
|
|
5140
4736
|
Edit = "edit",
|
|
5141
4737
|
/**
|
|
5142
4738
|
* The text edit option for Liveboard and visualization titles.
|
|
5143
|
-
*
|
|
5144
4739
|
* @example
|
|
5145
4740
|
* ```js
|
|
5146
4741
|
* disabledActions: [Action.EditTitle]
|
|
@@ -5150,7 +4745,6 @@ export enum Action {
|
|
|
5150
4745
|
/**
|
|
5151
4746
|
* The **Delete** menu action on Liveboards and visualizations.
|
|
5152
4747
|
* Deletes a Liveboard or a visualization from a Liveboard.
|
|
5153
|
-
*
|
|
5154
4748
|
* @example
|
|
5155
4749
|
* ```js
|
|
5156
4750
|
* disabledActions: [Action.Remove]
|
|
@@ -5182,7 +4776,6 @@ export enum Action {
|
|
|
5182
4776
|
* Displays details such as the name, description, and
|
|
5183
4777
|
* author of the Liveboard, and timestamp of Liveboard creation
|
|
5184
4778
|
* and update.
|
|
5185
|
-
*
|
|
5186
4779
|
* @example
|
|
5187
4780
|
* ```js
|
|
5188
4781
|
* disabledActions: [Action.LiveboardInfo]
|
|
@@ -5200,7 +4793,6 @@ export enum Action {
|
|
|
5200
4793
|
/**
|
|
5201
4794
|
* The **Pin** menu action on an Answer or
|
|
5202
4795
|
* Search results page.
|
|
5203
|
-
*
|
|
5204
4796
|
* @example
|
|
5205
4797
|
* ```js
|
|
5206
4798
|
* disabledActions: [Action.Pin]
|
|
@@ -5213,7 +4805,6 @@ export enum Action {
|
|
|
5213
4805
|
AnalysisInfo = "analysisInfo",
|
|
5214
4806
|
/**
|
|
5215
4807
|
* The **Schedule** menu action on a Liveboard.
|
|
5216
|
-
*
|
|
5217
4808
|
* @example
|
|
5218
4809
|
* ```js
|
|
5219
4810
|
* disabledActions: [Action.Subscription]
|
|
@@ -5222,7 +4813,6 @@ export enum Action {
|
|
|
5222
4813
|
Subscription = "subscription",
|
|
5223
4814
|
/**
|
|
5224
4815
|
* The **Explore** action on Liveboard visualizations
|
|
5225
|
-
*
|
|
5226
4816
|
* @example
|
|
5227
4817
|
* ```js
|
|
5228
4818
|
* disabledActions: [Action.Explore]
|
|
@@ -5232,7 +4822,6 @@ export enum Action {
|
|
|
5232
4822
|
/**
|
|
5233
4823
|
* The action to include data points on a drilled-down Answer
|
|
5234
4824
|
* or visualization
|
|
5235
|
-
*
|
|
5236
4825
|
* @example
|
|
5237
4826
|
* ```js
|
|
5238
4827
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5242,7 +4831,6 @@ export enum Action {
|
|
|
5242
4831
|
/**
|
|
5243
4832
|
* The action to exclude data points on a drilled-down Answer
|
|
5244
4833
|
* or visualization
|
|
5245
|
-
*
|
|
5246
4834
|
* @example
|
|
5247
4835
|
* ```js
|
|
5248
4836
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5253,7 +4841,6 @@ export enum Action {
|
|
|
5253
4841
|
* The **Copy to clipboard** menu action on tables in an Answer
|
|
5254
4842
|
* or Liveboard.
|
|
5255
4843
|
* Copies the selected data point.
|
|
5256
|
-
*
|
|
5257
4844
|
* @example
|
|
5258
4845
|
* ```js
|
|
5259
4846
|
* disabledActions: [Action.CopyToClipboard]
|
|
@@ -5271,7 +4858,6 @@ export enum Action {
|
|
|
5271
4858
|
* The **Drill down** menu action on Answers and Liveboard
|
|
5272
4859
|
* visualizations.
|
|
5273
4860
|
* Allows drilling down to a specific data point on a chart or table.
|
|
5274
|
-
*
|
|
5275
4861
|
* @example
|
|
5276
4862
|
* ```js
|
|
5277
4863
|
* disabledActions: [Action.DrillDown]
|
|
@@ -5281,7 +4867,6 @@ export enum Action {
|
|
|
5281
4867
|
/**
|
|
5282
4868
|
* The request access action on Liveboards.
|
|
5283
4869
|
* Allows users with view permissions to request edit access to a Liveboard.
|
|
5284
|
-
*
|
|
5285
4870
|
* @example
|
|
5286
4871
|
* ```js
|
|
5287
4872
|
* disabledActions: [Action.RequestAccess]
|
|
@@ -5291,7 +4876,6 @@ export enum Action {
|
|
|
5291
4876
|
/**
|
|
5292
4877
|
* The **Query visualizer** and **Query SQL** buttons in Query details panel
|
|
5293
4878
|
* of the Answer page
|
|
5294
|
-
*
|
|
5295
4879
|
* @example
|
|
5296
4880
|
* ```js
|
|
5297
4881
|
* disabledActions: [Action.QueryDetailsButtons]
|
|
@@ -5301,7 +4885,6 @@ export enum Action {
|
|
|
5301
4885
|
/**
|
|
5302
4886
|
* The **Delete** action for Answers in the full application
|
|
5303
4887
|
* embedding mode.
|
|
5304
|
-
*
|
|
5305
4888
|
* @example
|
|
5306
4889
|
* ```js
|
|
5307
4890
|
* disabledActions: [Action.AnswerDelete]
|
|
@@ -5311,7 +4894,6 @@ export enum Action {
|
|
|
5311
4894
|
AnswerDelete = "onDeleteAnswer",
|
|
5312
4895
|
/**
|
|
5313
4896
|
* The Chart switcher icon on Answer and visualization pages.
|
|
5314
|
-
*
|
|
5315
4897
|
* @example
|
|
5316
4898
|
* ```js
|
|
5317
4899
|
* disabledActions: [Action.AnswerChartSwitcher]
|
|
@@ -5321,7 +4903,6 @@ export enum Action {
|
|
|
5321
4903
|
AnswerChartSwitcher = "answerChartSwitcher",
|
|
5322
4904
|
/**
|
|
5323
4905
|
* Favorites icon (*) on Answers, Liveboard, and Data pages
|
|
5324
|
-
*
|
|
5325
4906
|
* @example
|
|
5326
4907
|
* ```js
|
|
5327
4908
|
* disabledActions: [Action.AddToFavorites]
|
|
@@ -5331,7 +4912,6 @@ export enum Action {
|
|
|
5331
4912
|
AddToFavorites = "addToFavorites",
|
|
5332
4913
|
/**
|
|
5333
4914
|
* The edit icon on Liveboards (Classic experience).
|
|
5334
|
-
*
|
|
5335
4915
|
* @example
|
|
5336
4916
|
* ```js
|
|
5337
4917
|
* disabledActions: [Action.EditDetails]
|
|
@@ -5341,7 +4921,6 @@ export enum Action {
|
|
|
5341
4921
|
EditDetails = "editDetails",
|
|
5342
4922
|
/**
|
|
5343
4923
|
* The Create alert action on KPI charts.
|
|
5344
|
-
*
|
|
5345
4924
|
* @example
|
|
5346
4925
|
* ```js
|
|
5347
4926
|
* disabledActions: [Action.CreateMonitor ]
|
|
@@ -5360,7 +4939,6 @@ export enum Action {
|
|
|
5360
4939
|
/**
|
|
5361
4940
|
* The **Sync to sheets** action on Answers and Liveboard visualizations.
|
|
5362
4941
|
* Allows sending data to a Google Sheet.
|
|
5363
|
-
*
|
|
5364
4942
|
* @example
|
|
5365
4943
|
* ```js
|
|
5366
4944
|
* disabledActions: [Action.SyncToSheets]
|
|
@@ -5372,7 +4950,6 @@ export enum Action {
|
|
|
5372
4950
|
* The **Sync to other apps** action on Answers and Liveboard visualizations.
|
|
5373
4951
|
* Allows sending data to third-party apps like Slack, Salesforce,
|
|
5374
4952
|
* Microsoft Teams, and so on.
|
|
5375
|
-
*
|
|
5376
4953
|
* @example
|
|
5377
4954
|
* ```js
|
|
5378
4955
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5383,7 +4960,6 @@ export enum Action {
|
|
|
5383
4960
|
/**
|
|
5384
4961
|
* The **Manage pipelines** action on Answers and Liveboard visualizations.
|
|
5385
4962
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5386
|
-
*
|
|
5387
4963
|
* @example
|
|
5388
4964
|
* ```js
|
|
5389
4965
|
* disabledActions: [Action.SyncToOtherApps]
|
|
@@ -5394,7 +4970,6 @@ export enum Action {
|
|
|
5394
4970
|
/**
|
|
5395
4971
|
* The **Filter** action on Liveboard visualizations.
|
|
5396
4972
|
* Allows users to apply cross-filters on a Liveboard.
|
|
5397
|
-
*
|
|
5398
4973
|
* @example
|
|
5399
4974
|
* ```js
|
|
5400
4975
|
* disabledActions: [Action.CrossFilter]
|
|
@@ -5405,7 +4980,6 @@ export enum Action {
|
|
|
5405
4980
|
/**
|
|
5406
4981
|
* The **Sync to Slack** action on Liveboard visualizations.
|
|
5407
4982
|
* Allows sending data to third-party apps Slack
|
|
5408
|
-
*
|
|
5409
4983
|
* @example
|
|
5410
4984
|
* ```js
|
|
5411
4985
|
* disabledActions: [Action.SyncToSlack]
|
|
@@ -5416,7 +4990,6 @@ export enum Action {
|
|
|
5416
4990
|
/**
|
|
5417
4991
|
* The **Sync to Teams** action on Liveboard visualizations.
|
|
5418
4992
|
* Allows sending data to third-party apps Team
|
|
5419
|
-
*
|
|
5420
4993
|
* @example
|
|
5421
4994
|
* ```js
|
|
5422
4995
|
* disabledActions: [Action.SyncToTeams]
|
|
@@ -5428,7 +5001,6 @@ export enum Action {
|
|
|
5428
5001
|
* The **Remove** action that appears when cross filters are applied
|
|
5429
5002
|
* on a Liveboard.
|
|
5430
5003
|
* Removes filters applied o a visualization.
|
|
5431
|
-
*
|
|
5432
5004
|
* @example
|
|
5433
5005
|
* ```js
|
|
5434
5006
|
* disabledActions: [Action.RemoveCrossFilter]
|
|
@@ -5440,7 +5012,6 @@ export enum Action {
|
|
|
5440
5012
|
* The **Aggregate** option in the chart axis or the
|
|
5441
5013
|
* table column customization menu.
|
|
5442
5014
|
* Provides aggregation options to analyze the data on a chart or table.
|
|
5443
|
-
*
|
|
5444
5015
|
* @example
|
|
5445
5016
|
* ```js
|
|
5446
5017
|
* disabledActions: [Action.AxisMenuAggregate]
|
|
@@ -5452,7 +5023,6 @@ export enum Action {
|
|
|
5452
5023
|
* The **Time bucket** option in the chart axis or table column
|
|
5453
5024
|
* customization menu.
|
|
5454
5025
|
* Allows defining time metric for date comparison.
|
|
5455
|
-
*
|
|
5456
5026
|
* @example
|
|
5457
5027
|
* ```js
|
|
5458
5028
|
* disabledActions: [Action.AxisMenuTimeBucket]
|
|
@@ -5463,7 +5033,6 @@ export enum Action {
|
|
|
5463
5033
|
/**
|
|
5464
5034
|
* The **Filter** action in the chart axis or table column
|
|
5465
5035
|
* customization menu.
|
|
5466
|
-
*
|
|
5467
5036
|
* @example
|
|
5468
5037
|
* ```js
|
|
5469
5038
|
* disabledActions: [Action.AxisMenuFilter]
|
|
@@ -5475,7 +5044,6 @@ export enum Action {
|
|
|
5475
5044
|
* The **Conditional formatting** action on chart or table.
|
|
5476
5045
|
* Allows adding rules for conditional formatting of data
|
|
5477
5046
|
* points on a chart or table.
|
|
5478
|
-
*
|
|
5479
5047
|
* @example
|
|
5480
5048
|
* ```js
|
|
5481
5049
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5487,7 +5055,6 @@ export enum Action {
|
|
|
5487
5055
|
* The **Sort** menu action on a table or chart axis
|
|
5488
5056
|
* Sorts data in ascending or descending order.
|
|
5489
5057
|
* Allows adding, editing, or removing filters.
|
|
5490
|
-
*
|
|
5491
5058
|
* @example
|
|
5492
5059
|
* ```js
|
|
5493
5060
|
* disabledActions: [Action.AxisMenuConditionalFormat]
|
|
@@ -5500,7 +5067,6 @@ export enum Action {
|
|
|
5500
5067
|
* customization menu.
|
|
5501
5068
|
* Allows grouping data points if the axes use the same
|
|
5502
5069
|
* unit of measurement and a similar scale.
|
|
5503
|
-
*
|
|
5504
5070
|
* @example
|
|
5505
5071
|
* ```js
|
|
5506
5072
|
* disabledActions: [Action.AxisMenuGroup]
|
|
@@ -5512,7 +5078,6 @@ export enum Action {
|
|
|
5512
5078
|
* The **Position** option in the axis customization menu.
|
|
5513
5079
|
* Allows changing the position of the axis to the
|
|
5514
5080
|
* left or right side of the chart.
|
|
5515
|
-
*
|
|
5516
5081
|
* @example
|
|
5517
5082
|
* ```js
|
|
5518
5083
|
* disabledActions: [Action.AxisMenuPosition]
|
|
@@ -5523,7 +5088,6 @@ export enum Action {
|
|
|
5523
5088
|
/**
|
|
5524
5089
|
* The **Rename** option in the chart axis or table column customization menu.
|
|
5525
5090
|
* Renames the axis label on a chart or the column header on a table.
|
|
5526
|
-
*
|
|
5527
5091
|
* @example
|
|
5528
5092
|
* ```js
|
|
5529
5093
|
* disabledActions: [Action.AxisMenuRename]
|
|
@@ -5535,7 +5099,6 @@ export enum Action {
|
|
|
5535
5099
|
* The **Edit** action in the axis customization menu.
|
|
5536
5100
|
* Allows editing the axis name, position, minimum and maximum values,
|
|
5537
5101
|
* and format of a column.
|
|
5538
|
-
*
|
|
5539
5102
|
* @example
|
|
5540
5103
|
* ```js
|
|
5541
5104
|
* disabledActions: [Action.AxisMenuEdit]
|
|
@@ -5546,7 +5109,6 @@ export enum Action {
|
|
|
5546
5109
|
/**
|
|
5547
5110
|
* The **Number format** action to customize the format of
|
|
5548
5111
|
* the data labels on a chart or table.
|
|
5549
|
-
*
|
|
5550
5112
|
* @example
|
|
5551
5113
|
* ```js
|
|
5552
5114
|
* disabledActions: [Action.AxisMenuNumberFormat]
|
|
@@ -5557,7 +5119,6 @@ export enum Action {
|
|
|
5557
5119
|
/**
|
|
5558
5120
|
* The **Text wrapping** action on a table.
|
|
5559
5121
|
* Wraps or clips column text on a table.
|
|
5560
|
-
*
|
|
5561
5122
|
* @example
|
|
5562
5123
|
* ```js
|
|
5563
5124
|
* disabledActions: [Action.AxisMenuTextWrapping]
|
|
@@ -5570,7 +5131,6 @@ export enum Action {
|
|
|
5570
5131
|
* customization menu.
|
|
5571
5132
|
* Removes the data labels from a chart or the column of a
|
|
5572
5133
|
* table visualization.
|
|
5573
|
-
*
|
|
5574
5134
|
* @example
|
|
5575
5135
|
* ```js
|
|
5576
5136
|
* disabledActions: [Action.AxisMenuRemove]
|
|
@@ -5585,7 +5145,6 @@ export enum Action {
|
|
|
5585
5145
|
/**
|
|
5586
5146
|
* The **Rename** menu action on Liveboards and visualizations.
|
|
5587
5147
|
* Allows renaming a Liveboard or visualization.
|
|
5588
|
-
*
|
|
5589
5148
|
* @example
|
|
5590
5149
|
* ```js
|
|
5591
5150
|
* disabledActions: [Action.RenameModalTitleDescription]
|
|
@@ -5629,7 +5188,6 @@ export enum Action {
|
|
|
5629
5188
|
/**
|
|
5630
5189
|
* The **Move to Tab** menu action on visualizations in liveboard edit mode.
|
|
5631
5190
|
* Allows moving a visualization to a different tab.
|
|
5632
|
-
*
|
|
5633
5191
|
* @example
|
|
5634
5192
|
* ```js
|
|
5635
5193
|
* disabledActions: [Action.MoveToTab]
|
|
@@ -5638,7 +5196,6 @@ export enum Action {
|
|
|
5638
5196
|
MoveToTab = "onContainerMove",
|
|
5639
5197
|
/**
|
|
5640
5198
|
* The **Manage Alertsb** menu action on KPI visualizations.
|
|
5641
|
-
*
|
|
5642
5199
|
* @example
|
|
5643
5200
|
* ```js
|
|
5644
5201
|
* disabledActions: [Action.ManageMonitor]
|
|
@@ -5647,7 +5204,6 @@ export enum Action {
|
|
|
5647
5204
|
ManageMonitor = "ManageMonitor",
|
|
5648
5205
|
/**
|
|
5649
5206
|
* Action ID for Liveboard Personalised Views dropdown
|
|
5650
|
-
*
|
|
5651
5207
|
* @example
|
|
5652
5208
|
* ```js
|
|
5653
5209
|
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
@@ -5657,7 +5213,6 @@ export enum Action {
|
|
|
5657
5213
|
PersonalisedViewsDropdown = "personalisedViewsDropdown",
|
|
5658
5214
|
/**
|
|
5659
5215
|
* Action ID for Liveboard Users ( Recently Visited / social proof )
|
|
5660
|
-
*
|
|
5661
5216
|
* @example
|
|
5662
5217
|
* ```js
|
|
5663
5218
|
* disabledActions: [Action.LiveboardUsers]
|
|
@@ -5669,7 +5224,6 @@ export enum Action {
|
|
|
5669
5224
|
* Action ID for the Parent TML action
|
|
5670
5225
|
* The parent action **TML** must be included to access TML-related options
|
|
5671
5226
|
* within the cascading menu (specific to the answer page)
|
|
5672
|
-
*
|
|
5673
5227
|
* @example
|
|
5674
5228
|
* ```js
|
|
5675
5229
|
* // to include specific TML actions
|
|
@@ -5681,13 +5235,11 @@ export enum Action {
|
|
|
5681
5235
|
* hiddenAction: [Action.TML] // hide all TML actions
|
|
5682
5236
|
* disabledActions: [Action.TML] // to disable all TML actions
|
|
5683
5237
|
* ```
|
|
5684
|
-
*
|
|
5685
5238
|
* @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
|
|
5686
5239
|
*/
|
|
5687
5240
|
TML = "tml",
|
|
5688
5241
|
/**
|
|
5689
5242
|
* Action ID for to hide Verified Liveboard Banner
|
|
5690
|
-
*
|
|
5691
5243
|
* @example
|
|
5692
5244
|
* ```js
|
|
5693
5245
|
* hiddenAction: [Action.VerifiedLiveboard]
|
|
@@ -5697,7 +5249,6 @@ export enum Action {
|
|
|
5697
5249
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
5698
5250
|
/**
|
|
5699
5251
|
* Action ID for ask sage button
|
|
5700
|
-
*
|
|
5701
5252
|
* @example
|
|
5702
5253
|
* ```js
|
|
5703
5254
|
* hiddenAction: [Action.AskAi]
|
|
@@ -5707,7 +5258,6 @@ export enum Action {
|
|
|
5707
5258
|
AskAi = "AskAi",
|
|
5708
5259
|
/**
|
|
5709
5260
|
* The **Add KPI to Watchlist** action on Home page watchlist.
|
|
5710
|
-
*
|
|
5711
5261
|
* @example
|
|
5712
5262
|
* ```js
|
|
5713
5263
|
* disabledActions: [Action.AddToWatchlist]
|
|
@@ -5717,7 +5267,6 @@ export enum Action {
|
|
|
5717
5267
|
AddToWatchlist = "addToWatchlist",
|
|
5718
5268
|
/**
|
|
5719
5269
|
* The **Remove from watchlist** menu action on KPI watchlist.
|
|
5720
|
-
*
|
|
5721
5270
|
* @example
|
|
5722
5271
|
* ```js
|
|
5723
5272
|
* disabledActions: [Action.RemoveFromWatchlist]
|
|
@@ -5727,7 +5276,6 @@ export enum Action {
|
|
|
5727
5276
|
RemoveFromWatchlist = "removeFromWatchlist",
|
|
5728
5277
|
/**
|
|
5729
5278
|
* The **Organise Favourites** action on Homepage Favourite Module.
|
|
5730
|
-
*
|
|
5731
5279
|
* @example
|
|
5732
5280
|
* ```js
|
|
5733
5281
|
* disabledActions: [Action.OrganiseFavourites]
|
|
@@ -5737,7 +5285,6 @@ export enum Action {
|
|
|
5737
5285
|
OrganiseFavourites = "organiseFavourites",
|
|
5738
5286
|
/**
|
|
5739
5287
|
* Action ID for AI Highlights button
|
|
5740
|
-
*
|
|
5741
5288
|
* @example
|
|
5742
5289
|
* ```js
|
|
5743
5290
|
* hiddenAction: [Action.AIHighlights]
|
|
@@ -5806,7 +5353,6 @@ export interface CustomActionPayload {
|
|
|
5806
5353
|
export enum LogLevel {
|
|
5807
5354
|
/**
|
|
5808
5355
|
* No logs will be logged in the console.
|
|
5809
|
-
*
|
|
5810
5356
|
* @example
|
|
5811
5357
|
* ```js
|
|
5812
5358
|
* init({
|
|
@@ -5819,7 +5365,6 @@ export enum LogLevel {
|
|
|
5819
5365
|
SILENT = "SILENT",
|
|
5820
5366
|
/**
|
|
5821
5367
|
* Only ERROR logs will be logged in the console.
|
|
5822
|
-
*
|
|
5823
5368
|
* @example
|
|
5824
5369
|
* ```js
|
|
5825
5370
|
* init({
|
|
@@ -5832,7 +5377,6 @@ export enum LogLevel {
|
|
|
5832
5377
|
ERROR = "ERROR",
|
|
5833
5378
|
/**
|
|
5834
5379
|
* Only WARN and ERROR logs will be logged in the console.
|
|
5835
|
-
*
|
|
5836
5380
|
* @example
|
|
5837
5381
|
* ```js
|
|
5838
5382
|
* init({
|
|
@@ -5845,7 +5389,6 @@ export enum LogLevel {
|
|
|
5845
5389
|
WARN = "WARN",
|
|
5846
5390
|
/**
|
|
5847
5391
|
* Only INFO, WARN, and ERROR logs will be logged in the console.
|
|
5848
|
-
*
|
|
5849
5392
|
* @example
|
|
5850
5393
|
* ```js
|
|
5851
5394
|
* init({
|
|
@@ -5858,7 +5401,6 @@ export enum LogLevel {
|
|
|
5858
5401
|
INFO = "INFO",
|
|
5859
5402
|
/**
|
|
5860
5403
|
* Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
|
|
5861
|
-
*
|
|
5862
5404
|
* @example
|
|
5863
5405
|
* ```js
|
|
5864
5406
|
* init({
|
|
@@ -5871,7 +5413,6 @@ export enum LogLevel {
|
|
|
5871
5413
|
DEBUG = "DEBUG",
|
|
5872
5414
|
/**
|
|
5873
5415
|
* All logs will be logged in the console.
|
|
5874
|
-
*
|
|
5875
5416
|
* @example
|
|
5876
5417
|
* ```js
|
|
5877
5418
|
* init({
|
|
@@ -6229,7 +5770,6 @@ export interface CustomCssVariables {
|
|
|
6229
5770
|
* Copyright (c) 2023
|
|
6230
5771
|
*
|
|
6231
5772
|
* Embed ThoughtSpot Sage
|
|
6232
|
-
*
|
|
6233
5773
|
* @summary TS Sage embed
|
|
6234
5774
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
6235
5775
|
*/
|
|
@@ -6252,7 +5792,6 @@ export interface SearchOptions {
|
|
|
6252
5792
|
/**
|
|
6253
5793
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
6254
5794
|
* GPT and LLM.
|
|
6255
|
-
*
|
|
6256
5795
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
6257
5796
|
* @group Embed components
|
|
6258
5797
|
*/
|
|
@@ -6261,7 +5800,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6261
5800
|
* If set to true, a list of Liveboard and Answers related
|
|
6262
5801
|
* to the natural language search will be shown below the
|
|
6263
5802
|
* AI generated answer.
|
|
6264
|
-
*
|
|
6265
5803
|
* @deprecated Currently Liveboard and Answers related
|
|
6266
5804
|
* to the natural language search will not be shown for sage
|
|
6267
5805
|
* embed
|
|
@@ -6269,11 +5807,10 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6269
5807
|
showObjectResults?: boolean;
|
|
6270
5808
|
/**
|
|
6271
5809
|
* flag used by the TS product tour page to show the blue search bar
|
|
6272
|
-
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
6273
|
-
* experience where it mimics closer to the non-embed case.
|
|
5810
|
+
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
5811
|
+
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
6274
5812
|
* The Sample questions container is collapsed when this value is set after
|
|
6275
5813
|
* does a search.
|
|
6276
|
-
*
|
|
6277
5814
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
6278
5815
|
* @hidden
|
|
6279
5816
|
*/
|
|
@@ -6281,38 +5818,32 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6281
5818
|
/**
|
|
6282
5819
|
* Show or hide the search bar title.
|
|
6283
5820
|
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6284
|
-
*
|
|
6285
5821
|
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
6286
5822
|
*/
|
|
6287
5823
|
hideSearchBarTitle?: boolean;
|
|
6288
5824
|
/**
|
|
6289
5825
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
6290
5826
|
* at the top of the Answer page.
|
|
6291
|
-
*
|
|
6292
5827
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
6293
5828
|
*/
|
|
6294
5829
|
hideSageAnswerHeader?: boolean;
|
|
6295
5830
|
/**
|
|
6296
5831
|
* Disable the worksheet selection option.
|
|
6297
|
-
*
|
|
6298
5832
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6299
5833
|
*/
|
|
6300
5834
|
disableWorksheetChange?: boolean;
|
|
6301
5835
|
/**
|
|
6302
5836
|
* Hide the worksheet selection panel.
|
|
6303
|
-
*
|
|
6304
5837
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6305
5838
|
*/
|
|
6306
5839
|
hideWorksheetSelector?: boolean;
|
|
6307
5840
|
/**
|
|
6308
5841
|
* Show or hide autocomplete suggestions for the search query string.
|
|
6309
|
-
*
|
|
6310
5842
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6311
5843
|
*/
|
|
6312
5844
|
hideAutocompleteSuggestions?: boolean;
|
|
6313
5845
|
/**
|
|
6314
5846
|
* Show or hide autocomplete suggestions for the search query string.
|
|
6315
|
-
*
|
|
6316
5847
|
* @deprecated
|
|
6317
5848
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
6318
5849
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -6322,7 +5853,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6322
5853
|
* Show or hide sample questions.
|
|
6323
5854
|
* The sample questions are autogenerated based on the worksheet
|
|
6324
5855
|
* selected for the search operation.
|
|
6325
|
-
*
|
|
6326
5856
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
6327
5857
|
*/
|
|
6328
5858
|
hideSampleQuestions?: boolean;
|
|
@@ -6340,7 +5870,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6340
5870
|
* If it is executed, the focus is placed on the results.
|
|
6341
5871
|
* If it’s not executed, the focus is placed at the end of
|
|
6342
5872
|
* the token string in the search bar.
|
|
6343
|
-
*
|
|
6344
5873
|
* @example
|
|
6345
5874
|
* ```js
|
|
6346
5875
|
* searchOptions: {
|
|
@@ -6354,7 +5883,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
6354
5883
|
}
|
|
6355
5884
|
/**
|
|
6356
5885
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
6357
|
-
*
|
|
6358
5886
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
6359
5887
|
* @group Embed components
|
|
6360
5888
|
*/
|
|
@@ -6368,20 +5896,17 @@ export class SageEmbed extends V1Embed {
|
|
|
6368
5896
|
/**
|
|
6369
5897
|
* Constructs a map of parameters to be passed on to the
|
|
6370
5898
|
* embedded Eureka or Sage search page.
|
|
6371
|
-
*
|
|
6372
5899
|
* @returns {string} query string
|
|
6373
5900
|
*/
|
|
6374
5901
|
protected getEmbedParams(): string;
|
|
6375
5902
|
/**
|
|
6376
5903
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
6377
5904
|
* loaded in the iframe
|
|
6378
|
-
*
|
|
6379
5905
|
* @returns {string} iframe url
|
|
6380
5906
|
*/
|
|
6381
5907
|
getIFrameSrc(): string;
|
|
6382
5908
|
/**
|
|
6383
5909
|
* Render the embedded ThoughtSpot Sage
|
|
6384
|
-
*
|
|
6385
5910
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
6386
5911
|
*/
|
|
6387
5912
|
render(): Promise<SageEmbed>;
|
|
@@ -6408,7 +5933,6 @@ export interface UnderlyingDataPoint {
|
|
|
6408
5933
|
* custom action payload. This service could be used to run
|
|
6409
5934
|
* graphql queries in the context of the answer on which the
|
|
6410
5935
|
* custom action was triggered.
|
|
6411
|
-
*
|
|
6412
5936
|
* @example
|
|
6413
5937
|
* ```js
|
|
6414
5938
|
* embed.on(EmbedEvent.CustomAction, e => {
|
|
@@ -6434,7 +5958,6 @@ export interface UnderlyingDataPoint {
|
|
|
6434
5958
|
export class AnswerService {
|
|
6435
5959
|
/**
|
|
6436
5960
|
* Should not need to be called directly.
|
|
6437
|
-
*
|
|
6438
5961
|
* @param session
|
|
6439
5962
|
* @param answer
|
|
6440
5963
|
* @param thoughtSpotHost
|
|
@@ -6448,38 +5971,34 @@ export class AnswerService {
|
|
|
6448
5971
|
getSourceDetail(): Promise<any>;
|
|
6449
5972
|
/**
|
|
6450
5973
|
* Remove columnIds and return updated answer session.
|
|
6451
|
-
*
|
|
6452
5974
|
* @param columnIds
|
|
6453
5975
|
* @returns
|
|
6454
5976
|
*/
|
|
6455
5977
|
removeColumns(columnIds: string[]): Promise<any>;
|
|
6456
5978
|
/**
|
|
6457
5979
|
* Add columnIds and return updated answer session.
|
|
6458
|
-
*
|
|
6459
5980
|
* @param columnIds
|
|
6460
5981
|
* @returns
|
|
6461
5982
|
*/
|
|
6462
5983
|
addColumns(columnIds: string[]): Promise<any>;
|
|
6463
5984
|
/**
|
|
6464
5985
|
* Add columns by names and return updated answer session.
|
|
6465
|
-
*
|
|
6466
5986
|
* @param columnNames
|
|
6467
5987
|
* @returns
|
|
6468
5988
|
* @example
|
|
6469
5989
|
* ```js
|
|
6470
5990
|
* embed.on(EmbedEvent.Data, async (e) => {
|
|
6471
5991
|
* const service = await embed.getAnswerService();
|
|
6472
|
-
* await service.
|
|
5992
|
+
* await service.addColumnsByName([
|
|
6473
5993
|
* "col name 1",
|
|
6474
5994
|
* "col name 2"
|
|
6475
5995
|
* ]);
|
|
6476
5996
|
* console.log(await service.fetchData());
|
|
6477
5997
|
* });
|
|
6478
5998
|
*/
|
|
6479
|
-
|
|
5999
|
+
addColumnsByName(columnNames: string[]): Promise<any>;
|
|
6480
6000
|
/**
|
|
6481
6001
|
* Add a filter to the answer.
|
|
6482
|
-
*
|
|
6483
6002
|
* @param columnName
|
|
6484
6003
|
* @param operator
|
|
6485
6004
|
* @param values
|
|
@@ -6488,7 +6007,6 @@ export class AnswerService {
|
|
|
6488
6007
|
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
|
|
6489
6008
|
/**
|
|
6490
6009
|
* Fetch data from the answer.
|
|
6491
|
-
*
|
|
6492
6010
|
* @param offset
|
|
6493
6011
|
* @param size
|
|
6494
6012
|
* @returns
|
|
@@ -6500,7 +6018,6 @@ export class AnswerService {
|
|
|
6500
6018
|
/**
|
|
6501
6019
|
* Fetch the data for the answer as a CSV blob. This might be
|
|
6502
6020
|
* quicker for larger data.
|
|
6503
|
-
*
|
|
6504
6021
|
* @param userLocale
|
|
6505
6022
|
* @param includeInfo Include the CSV header in the output
|
|
6506
6023
|
* @returns Response
|
|
@@ -6509,7 +6026,6 @@ export class AnswerService {
|
|
|
6509
6026
|
/**
|
|
6510
6027
|
* Just get the internal URL for this answer's data
|
|
6511
6028
|
* as a CSV blob.
|
|
6512
|
-
*
|
|
6513
6029
|
* @param userLocale
|
|
6514
6030
|
* @param includeInfo
|
|
6515
6031
|
* @returns
|
|
@@ -6519,7 +6035,6 @@ export class AnswerService {
|
|
|
6519
6035
|
* Get underlying data given a point and the output column names.
|
|
6520
6036
|
* In case of a context menu action, the selectedPoints are
|
|
6521
6037
|
* automatically passed.
|
|
6522
|
-
*
|
|
6523
6038
|
* @param outputColumnNames
|
|
6524
6039
|
* @param selectedPoints
|
|
6525
6040
|
* @example
|
|
@@ -6536,7 +6051,6 @@ export class AnswerService {
|
|
|
6536
6051
|
getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
|
|
6537
6052
|
/**
|
|
6538
6053
|
* Execute a custom graphql query in the context of the answer.
|
|
6539
|
-
*
|
|
6540
6054
|
* @param query graphql query
|
|
6541
6055
|
* @param variables graphql variables
|
|
6542
6056
|
* @returns
|
|
@@ -6544,7 +6058,6 @@ export class AnswerService {
|
|
|
6544
6058
|
executeQuery(query: string, variables: any): Promise<any>;
|
|
6545
6059
|
/**
|
|
6546
6060
|
* Get the internal session details for the answer.
|
|
6547
|
-
*
|
|
6548
6061
|
* @returns
|
|
6549
6062
|
*/
|
|
6550
6063
|
getSession(): SessionInterface;
|
|
@@ -6553,7 +6066,6 @@ export class AnswerService {
|
|
|
6553
6066
|
|
|
6554
6067
|
/**
|
|
6555
6068
|
* Gets the configuration embed was initialized with.
|
|
6556
|
-
*
|
|
6557
6069
|
* @returns {@link EmbedConfig} The configuration embed was initialized with.
|
|
6558
6070
|
* @version SDK: 1.19.0 | ThoughtSpot: *
|
|
6559
6071
|
* @group Global methods
|
|
@@ -6562,7 +6074,6 @@ export const getEmbedConfig: () => EmbedConfig;
|
|
|
6562
6074
|
/**
|
|
6563
6075
|
* Sets the configuration embed was initialized with.
|
|
6564
6076
|
* And returns the new configuration.
|
|
6565
|
-
*
|
|
6566
6077
|
* @param newConfig The configuration to set.
|
|
6567
6078
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
6568
6079
|
* @group Global methods
|
|
@@ -6585,7 +6096,6 @@ export const MIXPANEL_EVENT: {
|
|
|
6585
6096
|
};
|
|
6586
6097
|
/**
|
|
6587
6098
|
* Pushes the event with its Property key-value map to mixpanel.
|
|
6588
|
-
*
|
|
6589
6099
|
* @param eventId
|
|
6590
6100
|
* @param eventProps
|
|
6591
6101
|
*/
|
|
@@ -6603,7 +6113,6 @@ export function testResetMixpanel(): void;
|
|
|
6603
6113
|
/**
|
|
6604
6114
|
* Fetch wrapper that adds the authentication token to the request.
|
|
6605
6115
|
* Use this to call the ThoughtSpot APIs when using the visual embed sdk.
|
|
6606
|
-
*
|
|
6607
6116
|
* @param input
|
|
6608
6117
|
* @param init
|
|
6609
6118
|
* @version SDK: 1.28.0
|
|
@@ -6614,7 +6123,6 @@ export const tokenizedFetch: typeof fetch;
|
|
|
6614
6123
|
export const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
|
|
6615
6124
|
/**
|
|
6616
6125
|
* Resets the auth token and a new token will be fetched on the next request.
|
|
6617
|
-
*
|
|
6618
6126
|
* @example
|
|
6619
6127
|
* ```js
|
|
6620
6128
|
* resetCachedAuthToken();
|
|
@@ -6628,7 +6136,6 @@ export const resetCachedAuthToken: () => void;
|
|
|
6628
6136
|
* Copyright (c) 2022
|
|
6629
6137
|
*
|
|
6630
6138
|
* Base classes
|
|
6631
|
-
*
|
|
6632
6139
|
* @summary Base classes
|
|
6633
6140
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
6634
6141
|
*/
|
|
@@ -6677,19 +6184,16 @@ export class TsEmbed {
|
|
|
6677
6184
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
6678
6185
|
/**
|
|
6679
6186
|
* Handles errors within the SDK
|
|
6680
|
-
*
|
|
6681
6187
|
* @param error The error message or object
|
|
6682
6188
|
*/
|
|
6683
6189
|
protected handleError(error: string | Record<string, unknown>): void;
|
|
6684
6190
|
/**
|
|
6685
6191
|
* Constructs the base URL string to load the ThoughtSpot app.
|
|
6686
|
-
*
|
|
6687
6192
|
* @param query
|
|
6688
6193
|
*/
|
|
6689
6194
|
protected getEmbedBasePath(query: string): string;
|
|
6690
6195
|
/**
|
|
6691
6196
|
* Common query params set for all the embed modes.
|
|
6692
|
-
*
|
|
6693
6197
|
* @param queryParams
|
|
6694
6198
|
* @returns queryParams
|
|
6695
6199
|
*/
|
|
@@ -6697,7 +6201,6 @@ export class TsEmbed {
|
|
|
6697
6201
|
/**
|
|
6698
6202
|
* Constructs the base URL string to load v1 of the ThoughtSpot app.
|
|
6699
6203
|
* This is used for embedding Liveboards, visualizations, and full application.
|
|
6700
|
-
*
|
|
6701
6204
|
* @param queryString The query string to append to the URL.
|
|
6702
6205
|
* @param isAppEmbed A Boolean parameter to specify if you are embedding
|
|
6703
6206
|
* the full application.
|
|
@@ -6710,7 +6213,6 @@ export class TsEmbed {
|
|
|
6710
6213
|
/**
|
|
6711
6214
|
* Renders the embedded ThoughtSpot app in an iframe and sets up
|
|
6712
6215
|
* event listeners.
|
|
6713
|
-
*
|
|
6714
6216
|
* @param url - The URL of the embedded ThoughtSpot app.
|
|
6715
6217
|
*/
|
|
6716
6218
|
protected renderIFrame(url: string): Promise<any>;
|
|
@@ -6724,13 +6226,11 @@ export class TsEmbed {
|
|
|
6724
6226
|
protected insertIntoDOM(child: string | Node): void;
|
|
6725
6227
|
/**
|
|
6726
6228
|
* Sets the height of the iframe
|
|
6727
|
-
*
|
|
6728
6229
|
* @param height The height in pixels
|
|
6729
6230
|
*/
|
|
6730
6231
|
protected setIFrameHeight(height: number | string): void;
|
|
6731
6232
|
/**
|
|
6732
6233
|
* Executes all registered event handlers for a particular event type
|
|
6733
|
-
*
|
|
6734
6234
|
* @param eventType The event type
|
|
6735
6235
|
* @param data The payload invoked with the event handler
|
|
6736
6236
|
* @param eventPort The event Port for a specific MessageChannel
|
|
@@ -6742,7 +6242,6 @@ export class TsEmbed {
|
|
|
6742
6242
|
protected getThoughtSpotHost(): string;
|
|
6743
6243
|
/**
|
|
6744
6244
|
* Gets the v1 event type (if applicable) for the EmbedEvent type
|
|
6745
|
-
*
|
|
6746
6245
|
* @param eventType The v2 event type
|
|
6747
6246
|
* @returns The corresponding v1 event type if one exists
|
|
6748
6247
|
* or else the v2 event type itself
|
|
@@ -6752,7 +6251,6 @@ export class TsEmbed {
|
|
|
6752
6251
|
* Calculates the iframe center for the current visible viewPort
|
|
6753
6252
|
* of iframe using Scroll position of Host App, offsetTop for iframe
|
|
6754
6253
|
* in Host app. ViewPort height of the tab.
|
|
6755
|
-
*
|
|
6756
6254
|
* @returns iframe Center in visible viewport,
|
|
6757
6255
|
* Iframe height,
|
|
6758
6256
|
* View port height.
|
|
@@ -6767,7 +6265,6 @@ export class TsEmbed {
|
|
|
6767
6265
|
/**
|
|
6768
6266
|
* Registers an event listener to trigger an alert when the ThoughtSpot app
|
|
6769
6267
|
* sends an event of a particular message type to the host application.
|
|
6770
|
-
*
|
|
6771
6268
|
* @param messageType The message type
|
|
6772
6269
|
* @param callback A callback as a function
|
|
6773
6270
|
* @param options The message options
|
|
@@ -6791,7 +6288,6 @@ export class TsEmbed {
|
|
|
6791
6288
|
on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
|
|
6792
6289
|
/**
|
|
6793
6290
|
* Removes an event listener for a particular event type.
|
|
6794
|
-
*
|
|
6795
6291
|
* @param messageType The message type
|
|
6796
6292
|
* @param callback The callback to remove
|
|
6797
6293
|
* @example
|
|
@@ -6804,7 +6300,6 @@ export class TsEmbed {
|
|
|
6804
6300
|
off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
|
|
6805
6301
|
/**
|
|
6806
6302
|
* Triggers an event to the embedded app
|
|
6807
|
-
*
|
|
6808
6303
|
* @param messageType The event type
|
|
6809
6304
|
* @param data The payload to send with the message
|
|
6810
6305
|
*/
|
|
@@ -6813,7 +6308,6 @@ export class TsEmbed {
|
|
|
6813
6308
|
* Marks the ThoughtSpot object to have been rendered
|
|
6814
6309
|
* Needs to be overridden by subclasses to do the actual
|
|
6815
6310
|
* rendering of the iframe.
|
|
6816
|
-
*
|
|
6817
6311
|
* @param args
|
|
6818
6312
|
*/
|
|
6819
6313
|
render(): Promise<TsEmbed>;
|
|
@@ -6821,7 +6315,6 @@ export class TsEmbed {
|
|
|
6821
6315
|
protected handleRenderForPrerender(): void;
|
|
6822
6316
|
/**
|
|
6823
6317
|
* Creates the preRender shell
|
|
6824
|
-
*
|
|
6825
6318
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
6826
6319
|
*/
|
|
6827
6320
|
preRender(showPreRenderByDefault?: boolean): TsEmbed;
|
|
@@ -6829,13 +6322,11 @@ export class TsEmbed {
|
|
|
6829
6322
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
6830
6323
|
* host app URL.
|
|
6831
6324
|
* THOUGHTSPOT URL params starts with a prefix "ts-"
|
|
6832
|
-
*
|
|
6833
6325
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
|
|
6834
6326
|
*/
|
|
6835
6327
|
getThoughtSpotPostUrlParams(): string;
|
|
6836
6328
|
/**
|
|
6837
6329
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
6838
|
-
*
|
|
6839
6330
|
* @version SDK: 1.19.1 | ThoughtSpot: *
|
|
6840
6331
|
*/
|
|
6841
6332
|
destroy(): void;
|
|
@@ -6844,7 +6335,6 @@ export class TsEmbed {
|
|
|
6844
6335
|
* Prerenders a generic instance of the TS component.
|
|
6845
6336
|
* This means without the path but with the flags already applied.
|
|
6846
6337
|
* This is useful for prerendering the component in the background.
|
|
6847
|
-
*
|
|
6848
6338
|
* @version SDK: 1.22.0
|
|
6849
6339
|
* @returns
|
|
6850
6340
|
*/
|
|
@@ -6862,7 +6352,6 @@ export class TsEmbed {
|
|
|
6862
6352
|
* element. This function adjusts the position, width, and height of the PreRender
|
|
6863
6353
|
* component
|
|
6864
6354
|
* to match the dimensions and position of the embedding element.
|
|
6865
|
-
*
|
|
6866
6355
|
* @throws {Error} Throws an error if the embedding element (passed as domSelector)
|
|
6867
6356
|
* is not defined or not found.
|
|
6868
6357
|
*/
|
|
@@ -6875,7 +6364,6 @@ export class TsEmbed {
|
|
|
6875
6364
|
/**
|
|
6876
6365
|
* Retrieves unique HTML element IDs for PreRender-related elements.
|
|
6877
6366
|
* These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
|
|
6878
|
-
*
|
|
6879
6367
|
* @returns {object} An object containing the IDs for the PreRender elements.
|
|
6880
6368
|
* @property {string} wrapper - The HTML element ID for the PreRender wrapper.
|
|
6881
6369
|
* @property {string} child - The HTML element ID for the PreRender child.
|
|
@@ -6887,7 +6375,6 @@ export class TsEmbed {
|
|
|
6887
6375
|
/**
|
|
6888
6376
|
* Returns the answerService which can be used to make arbitrary graphql calls on top
|
|
6889
6377
|
* session.
|
|
6890
|
-
*
|
|
6891
6378
|
* @param vizId [Optional] to get for a specific viz in case of a liveboard.
|
|
6892
6379
|
* @version SDK: 1.25.0 / ThoughtSpot 9.10.0
|
|
6893
6380
|
*/
|
|
@@ -6897,7 +6384,6 @@ export class TsEmbed {
|
|
|
6897
6384
|
* Base class for embedding v1 experience
|
|
6898
6385
|
* Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
|
|
6899
6386
|
* which is currently under migration to v2
|
|
6900
|
-
*
|
|
6901
6387
|
* @inheritdoc
|
|
6902
6388
|
*/
|
|
6903
6389
|
export class V1Embed extends TsEmbed {
|
|
@@ -6905,7 +6391,6 @@ export class V1Embed extends TsEmbed {
|
|
|
6905
6391
|
constructor(domSelector: DOMSelector, viewConfig: ViewConfig);
|
|
6906
6392
|
/**
|
|
6907
6393
|
* Render the app in an iframe and set up event handlers
|
|
6908
|
-
*
|
|
6909
6394
|
* @param iframeSrc
|
|
6910
6395
|
*/
|
|
6911
6396
|
protected renderV1Embed(iframeSrc: string): Promise<any>;
|