@thoughtspot/visual-embed-sdk 1.38.0 → 1.38.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (216) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -1
  3. package/cjs/src/embed/app.d.ts +96 -156
  4. package/cjs/src/embed/app.d.ts.map +1 -1
  5. package/cjs/src/embed/app.js +7 -4
  6. package/cjs/src/embed/app.js.map +1 -1
  7. package/cjs/src/embed/app.spec.js +10 -0
  8. package/cjs/src/embed/app.spec.js.map +1 -1
  9. package/cjs/src/embed/bodyless-conversation.d.ts +4 -4
  10. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  11. package/cjs/src/embed/bodyless-conversation.js +1 -1
  12. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  13. package/cjs/src/embed/conversation.d.ts +22 -11
  14. package/cjs/src/embed/conversation.d.ts.map +1 -1
  15. package/cjs/src/embed/conversation.js +1 -1
  16. package/cjs/src/embed/conversation.js.map +1 -1
  17. package/cjs/src/embed/liveboard.d.ts +110 -167
  18. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  19. package/cjs/src/embed/liveboard.js +25 -11
  20. package/cjs/src/embed/liveboard.js.map +1 -1
  21. package/cjs/src/embed/liveboard.spec.js +11 -0
  22. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  23. package/cjs/src/embed/sage.d.ts +17 -2
  24. package/cjs/src/embed/sage.d.ts.map +1 -1
  25. package/cjs/src/embed/sage.js +2 -0
  26. package/cjs/src/embed/sage.js.map +1 -1
  27. package/cjs/src/embed/search-bar.d.ts +16 -6
  28. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  29. package/cjs/src/embed/search-bar.js.map +1 -1
  30. package/cjs/src/embed/search.d.ts +46 -14
  31. package/cjs/src/embed/search.d.ts.map +1 -1
  32. package/cjs/src/embed/search.js.map +1 -1
  33. package/cjs/src/embed/ts-embed.d.ts +19 -2
  34. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  35. package/cjs/src/embed/ts-embed.js +49 -0
  36. package/cjs/src/embed/ts-embed.js.map +1 -1
  37. package/cjs/src/embed/ts-embed.spec.js +45 -4
  38. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  39. package/cjs/src/index.d.ts +2 -2
  40. package/cjs/src/index.d.ts.map +1 -1
  41. package/cjs/src/index.js +2 -1
  42. package/cjs/src/index.js.map +1 -1
  43. package/cjs/src/react/all-types-export.d.ts +1 -1
  44. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  45. package/cjs/src/react/all-types-export.js +2 -1
  46. package/cjs/src/react/all-types-export.js.map +1 -1
  47. package/cjs/src/react/index.d.ts +1 -1
  48. package/cjs/src/react/index.d.ts.map +1 -1
  49. package/cjs/src/react/index.js +1 -1
  50. package/cjs/src/react/util.d.ts +7 -4
  51. package/cjs/src/react/util.d.ts.map +1 -1
  52. package/cjs/src/react/util.js.map +1 -1
  53. package/cjs/src/types.d.ts +482 -251
  54. package/cjs/src/types.d.ts.map +1 -1
  55. package/cjs/src/types.js +31 -14
  56. package/cjs/src/types.js.map +1 -1
  57. package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
  58. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  59. package/cjs/src/utils/graphql/answerService/answerService.js +2 -1
  60. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  61. package/cjs/src/utils/processData.d.ts.map +1 -1
  62. package/cjs/src/utils/processData.js +15 -0
  63. package/cjs/src/utils/processData.js.map +1 -1
  64. package/cjs/src/utils/processData.spec.js +15 -0
  65. package/cjs/src/utils/processData.spec.js.map +1 -1
  66. package/cjs/src/utils/processTrigger.d.ts.map +1 -1
  67. package/cjs/src/utils/processTrigger.js +14 -0
  68. package/cjs/src/utils/processTrigger.js.map +1 -1
  69. package/cjs/src/utils/processTrigger.spec.js +54 -0
  70. package/cjs/src/utils/processTrigger.spec.js.map +1 -1
  71. package/cjs/src/utils.d.ts +11 -2
  72. package/cjs/src/utils.d.ts.map +1 -1
  73. package/cjs/src/utils.js +70 -1
  74. package/cjs/src/utils.js.map +1 -1
  75. package/cjs/src/utils.spec.js +85 -0
  76. package/cjs/src/utils.spec.js.map +1 -1
  77. package/dist/{index-BIcnpmMY.js → index-BKIWUvTr.js} +1 -1
  78. package/dist/src/embed/app.d.ts +96 -156
  79. package/dist/src/embed/app.d.ts.map +1 -1
  80. package/dist/src/embed/bodyless-conversation.d.ts +4 -4
  81. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  82. package/dist/src/embed/conversation.d.ts +22 -11
  83. package/dist/src/embed/conversation.d.ts.map +1 -1
  84. package/dist/src/embed/liveboard.d.ts +110 -167
  85. package/dist/src/embed/liveboard.d.ts.map +1 -1
  86. package/dist/src/embed/sage.d.ts +17 -2
  87. package/dist/src/embed/sage.d.ts.map +1 -1
  88. package/dist/src/embed/search-bar.d.ts +16 -6
  89. package/dist/src/embed/search-bar.d.ts.map +1 -1
  90. package/dist/src/embed/search.d.ts +46 -14
  91. package/dist/src/embed/search.d.ts.map +1 -1
  92. package/dist/src/embed/ts-embed.d.ts +19 -2
  93. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  94. package/dist/src/index.d.ts +2 -2
  95. package/dist/src/index.d.ts.map +1 -1
  96. package/dist/src/react/all-types-export.d.ts +1 -1
  97. package/dist/src/react/all-types-export.d.ts.map +1 -1
  98. package/dist/src/react/index.d.ts +1 -1
  99. package/dist/src/react/index.d.ts.map +1 -1
  100. package/dist/src/react/util.d.ts +7 -4
  101. package/dist/src/react/util.d.ts.map +1 -1
  102. package/dist/src/types.d.ts +482 -251
  103. package/dist/src/types.d.ts.map +1 -1
  104. package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
  105. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  106. package/dist/src/utils/processData.d.ts.map +1 -1
  107. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  108. package/dist/src/utils.d.ts +11 -2
  109. package/dist/src/utils.d.ts.map +1 -1
  110. package/dist/tsembed-react.es.js +3498 -3322
  111. package/dist/tsembed-react.js +3497 -3321
  112. package/dist/tsembed.es.js +213 -37
  113. package/dist/tsembed.js +216 -40
  114. package/dist/visual-embed-sdk-react-full.d.ts +845 -655
  115. package/dist/visual-embed-sdk-react.d.ts +845 -655
  116. package/dist/visual-embed-sdk.d.ts +827 -640
  117. package/lib/package.json +1 -1
  118. package/lib/src/embed/app.d.ts +96 -156
  119. package/lib/src/embed/app.d.ts.map +1 -1
  120. package/lib/src/embed/app.js +7 -4
  121. package/lib/src/embed/app.js.map +1 -1
  122. package/lib/src/embed/app.spec.js +10 -0
  123. package/lib/src/embed/app.spec.js.map +1 -1
  124. package/lib/src/embed/bodyless-conversation.d.ts +4 -4
  125. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  126. package/lib/src/embed/bodyless-conversation.js +1 -1
  127. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  128. package/lib/src/embed/conversation.d.ts +22 -11
  129. package/lib/src/embed/conversation.d.ts.map +1 -1
  130. package/lib/src/embed/conversation.js +1 -1
  131. package/lib/src/embed/conversation.js.map +1 -1
  132. package/lib/src/embed/liveboard.d.ts +110 -167
  133. package/lib/src/embed/liveboard.d.ts.map +1 -1
  134. package/lib/src/embed/liveboard.js +25 -11
  135. package/lib/src/embed/liveboard.js.map +1 -1
  136. package/lib/src/embed/liveboard.spec.js +11 -0
  137. package/lib/src/embed/liveboard.spec.js.map +1 -1
  138. package/lib/src/embed/sage.d.ts +17 -2
  139. package/lib/src/embed/sage.d.ts.map +1 -1
  140. package/lib/src/embed/sage.js +2 -0
  141. package/lib/src/embed/sage.js.map +1 -1
  142. package/lib/src/embed/search-bar.d.ts +16 -6
  143. package/lib/src/embed/search-bar.d.ts.map +1 -1
  144. package/lib/src/embed/search-bar.js.map +1 -1
  145. package/lib/src/embed/search.d.ts +46 -14
  146. package/lib/src/embed/search.d.ts.map +1 -1
  147. package/lib/src/embed/search.js.map +1 -1
  148. package/lib/src/embed/ts-embed.d.ts +19 -2
  149. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  150. package/lib/src/embed/ts-embed.js +49 -0
  151. package/lib/src/embed/ts-embed.js.map +1 -1
  152. package/lib/src/embed/ts-embed.spec.js +45 -4
  153. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  154. package/lib/src/index.d.ts +2 -2
  155. package/lib/src/index.d.ts.map +1 -1
  156. package/lib/src/index.js +2 -2
  157. package/lib/src/index.js.map +1 -1
  158. package/lib/src/react/all-types-export.d.ts +1 -1
  159. package/lib/src/react/all-types-export.d.ts.map +1 -1
  160. package/lib/src/react/all-types-export.js +1 -1
  161. package/lib/src/react/all-types-export.js.map +1 -1
  162. package/lib/src/react/index.d.ts +1 -1
  163. package/lib/src/react/index.d.ts.map +1 -1
  164. package/lib/src/react/index.js +1 -1
  165. package/lib/src/react/util.d.ts +7 -4
  166. package/lib/src/react/util.d.ts.map +1 -1
  167. package/lib/src/react/util.js.map +1 -1
  168. package/lib/src/types.d.ts +482 -251
  169. package/lib/src/types.d.ts.map +1 -1
  170. package/lib/src/types.js +31 -14
  171. package/lib/src/types.js.map +1 -1
  172. package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
  173. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  174. package/lib/src/utils/graphql/answerService/answerService.js +2 -1
  175. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  176. package/lib/src/utils/processData.d.ts.map +1 -1
  177. package/lib/src/utils/processData.js +15 -0
  178. package/lib/src/utils/processData.js.map +1 -1
  179. package/lib/src/utils/processData.spec.js +15 -0
  180. package/lib/src/utils/processData.spec.js.map +1 -1
  181. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  182. package/lib/src/utils/processTrigger.js +14 -0
  183. package/lib/src/utils/processTrigger.js.map +1 -1
  184. package/lib/src/utils/processTrigger.spec.js +54 -0
  185. package/lib/src/utils/processTrigger.spec.js.map +1 -1
  186. package/lib/src/utils.d.ts +11 -2
  187. package/lib/src/utils.d.ts.map +1 -1
  188. package/lib/src/utils.js +67 -0
  189. package/lib/src/utils.js.map +1 -1
  190. package/lib/src/utils.spec.js +86 -1
  191. package/lib/src/utils.spec.js.map +1 -1
  192. package/lib/src/visual-embed-sdk.d.ts +836 -649
  193. package/package.json +1 -1
  194. package/src/embed/app.spec.ts +14 -0
  195. package/src/embed/app.ts +98 -153
  196. package/src/embed/bodyless-conversation.ts +4 -4
  197. package/src/embed/conversation.ts +23 -12
  198. package/src/embed/liveboard.spec.ts +15 -0
  199. package/src/embed/liveboard.ts +142 -182
  200. package/src/embed/sage.ts +17 -5
  201. package/src/embed/search-bar.tsx +16 -17
  202. package/src/embed/search.ts +47 -21
  203. package/src/embed/ts-embed.spec.ts +52 -4
  204. package/src/embed/ts-embed.ts +61 -6
  205. package/src/index.ts +2 -0
  206. package/src/react/all-types-export.ts +1 -0
  207. package/src/react/index.tsx +3 -3
  208. package/src/react/util.ts +6 -4
  209. package/src/types.ts +488 -253
  210. package/src/utils/graphql/answerService/answerService.ts +5 -4
  211. package/src/utils/processData.spec.ts +28 -0
  212. package/src/utils/processData.ts +17 -0
  213. package/src/utils/processTrigger.spec.ts +90 -0
  214. package/src/utils/processTrigger.ts +16 -1
  215. package/src/utils.spec.ts +113 -0
  216. package/src/utils.ts +78 -2
@@ -12,7 +12,7 @@ import EventEmitter from 'eventemitter3';
12
12
  * @summary ThoughtSpot Visual Embed SDK
13
13
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
14
14
  */
15
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
15
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
16
16
 
17
17
  /**
18
18
  * Copyright (c) 2022
@@ -85,7 +85,7 @@ export enum HomePageSearchBarMode {
85
85
  }
86
86
  /**
87
87
  * Define the version of the primary navbar
88
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
88
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
89
89
  */
90
90
  export enum PrimaryNavbarVersion {
91
91
  /**
@@ -97,7 +97,7 @@ export enum PrimaryNavbarVersion {
97
97
  }
98
98
  /**
99
99
  * Define the version of the home page
100
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
100
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
101
101
  */
102
102
  export enum HomePage {
103
103
  /**
@@ -108,7 +108,7 @@ export enum HomePage {
108
108
  }
109
109
  /**
110
110
  * Define the discovery experience
111
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
111
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
112
112
  */
113
113
  export interface DiscoveryExperience {
114
114
  /**
@@ -124,17 +124,19 @@ export interface DiscoveryExperience {
124
124
  * The view configuration for full app embedding.
125
125
  * @group Embed components
126
126
  */
127
- export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
127
+ export interface AppViewConfig extends AllEmbedViewConfig {
128
128
  /**
129
129
  * If true, the top navigation bar within the ThoughtSpot app
130
130
  * is displayed. By default, the navigation bar is hidden.
131
131
  * This flag also controls the homepage left navigation bar.
132
+ *
133
+ * Supported embed types: `AppEmbed`
132
134
  * @default true
133
135
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
134
136
  * @example
135
137
  * ```js
136
138
  * const embed = new AppEmbed('#tsEmbed', {
137
- * ... // other options
139
+ * ... // other embed view config
138
140
  * showPrimaryNavbar:true,
139
141
  * })
140
142
  * ```
@@ -149,12 +151,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
149
151
  * **Note**: This option does not apply to the classic homepage.
150
152
  * To access the updated modular homepage, set
151
153
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
154
+ *
155
+ * Supported embed types: `AppEmbed`
152
156
  * @default false
153
157
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
154
158
  * @example
155
159
  * ```js
156
160
  * const embed = new AppEmbed('#tsEmbed', {
157
- * ... // other options
161
+ * ... // other embed view config
158
162
  * hideHomepageLeftNav : true,
159
163
  * })
160
164
  * ```
@@ -163,12 +167,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
163
167
  /**
164
168
  * Control the visibility of the help (?) and profile buttons on the
165
169
  * Global nav-bar. By default, these buttons are visible on the nav-bar.
170
+ *
171
+ * Supported embed types: `AppEmbed`
166
172
  * @default false
167
173
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
168
174
  * @example
169
175
  * ```js
170
176
  * const embed = new AppEmbed('#tsEmbed', {
171
- * ... // other options
177
+ * ... // other embed view config
172
178
  * disableProfileAndHelp: true,
173
179
  * })
174
180
  * ```
@@ -179,10 +185,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
179
185
  * @default true
180
186
  * Whether the help menu in the top nav bar should be served
181
187
  * from Pendo or ThoughtSpot's internal help items.
188
+ *
189
+ * Supported embed types: `AppEmbed`
182
190
  * @example
183
191
  * ```js
184
192
  * const embed = new AppEmbed('#tsEmbed', {
185
- * ... // other options
193
+ * ... // other embed view config
186
194
  * enablePendoHelp: false,
187
195
  * });
188
196
  * ```
@@ -192,12 +200,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
192
200
  * Control the visibility of the hamburger icon on the top nav bar
193
201
  * available when new navigation V3 is enabled.
194
202
  *
203
+ * Supported embed types: `AppEmbed`
195
204
  * @default false
196
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
205
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
197
206
  * @example
198
207
  * ```js
199
208
  * const embed = new AppEmbed('#tsEmbed', {
200
- * ... // other options
209
+ * ... // other embed view config
201
210
  * hideHamburger : true,
202
211
  * })
203
212
  * ```
@@ -207,12 +216,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
207
216
  * Control the visibility of the Eureka search on the top nav bar
208
217
  * this will control for both new V2 and new navigation V3.
209
218
  *
219
+ * Supported embed types: `AppEmbed`
210
220
  * @default true
211
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
221
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
212
222
  * @example
213
223
  * ```js
214
224
  * const embed = new AppEmbed('#tsEmbed', {
215
- * ... // other options
225
+ * ... // other embed view config
216
226
  * hideObjectSearch: false,
217
227
  * })
218
228
  * ```
@@ -222,12 +232,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
222
232
  * Control the visibility of the notification on the top nav bar V3,
223
233
  * available when new navigation V3 is enabled.
224
234
  *
235
+ * Supported embed types: `AppEmbed`
225
236
  * @default true
226
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
237
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
227
238
  * @example
228
239
  * ```js
229
240
  * const embed = new AppEmbed('#tsEmbed', {
230
- * ... // other options
241
+ * ... // other embed view config
231
242
  * hideNotification: false,
232
243
  * })
233
244
  * ```
@@ -240,12 +251,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
240
251
  * **Note**: This option does not apply to the classic homepage.
241
252
  * To access the updated modular homepage, set
242
253
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
254
+ *
255
+ * Supported embed types: `AppEmbed`
243
256
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
244
257
  * @default false
245
258
  * @example
246
259
  * ```js
247
260
  * const embed = new AppEmbed('#tsEmbed', {
248
- * ... // other options
261
+ * ... // other embed view config
249
262
  * hideApplicationSwitcher : true,
250
263
  * })
251
264
  * ```
@@ -258,12 +271,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
258
271
  * **Note**: This option does not apply to the classic homepage.
259
272
  * To access the updated modular homepage, set
260
273
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
274
+ *
275
+ * Supported embed types: `AppEmbed`
261
276
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
262
277
  * @default true
263
278
  * @example
264
279
  * ```js
265
280
  * const embed = new AppEmbed('#tsEmbed', {
266
- * ... // other options
281
+ * ... // other embed view config
267
282
  * hideOrgSwitcher : true,
268
283
  * })
269
284
  * ```
@@ -277,12 +292,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
277
292
  *
278
293
  * For eg, if you want the component to open to a specific Liveboard
279
294
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
295
+ *
296
+ * Supported embed types: `AppEmbed`
280
297
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
281
298
  * @example
282
299
  * ```js
283
300
  * const embed = new AppEmbed('#tsEmbed', {
284
- * ... // other options
285
- * path:"pinboard/1234/tab/7464"
301
+ * ... // other embed view config
302
+ * path:"pinboard/1234/tab/7464",
286
303
  * })
287
304
  * ```
288
305
  */
@@ -293,12 +310,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
293
310
  *
294
311
  * Use this to open to particular page in the app. To open to a specific
295
312
  * path within the app, use the `path` attribute which is more flexible.
313
+ *
314
+ * Supported embed types: `AppEmbed`
296
315
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
297
316
  * @example
298
317
  * ```js
299
318
  * const embed = new AppEmbed('#tsEmbed', {
300
- * ... // other options
301
- * pageId : Page.Answers | Page.Data
319
+ * ... // other embed view config
320
+ * pageId : Page.Answers | Page.Data,
302
321
  * })
303
322
  * ```
304
323
  */
@@ -307,11 +326,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
307
326
  * This puts a filter tag on the application. All metadata lists in the
308
327
  * application, such as Liveboards and answers, would be filtered by this
309
328
  * tag.
329
+ *
330
+ * Supported embed types: `AppEmbed`
310
331
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
311
332
  * @example
312
333
  * ```js
313
334
  * const embed = new AppEmbed('#tsEmbed', {
314
- * ... // other options
335
+ * ... // other embed view config
315
336
  * tag:'value',
316
337
  * })
317
338
  * ```
@@ -319,11 +340,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
319
340
  tag?: string;
320
341
  /**
321
342
  * The array of GUIDs to be hidden
343
+ *
344
+ * Supported embed types: `AppEmbed`
322
345
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
323
346
  * @example
324
347
  * ```js
325
348
  * const embed = new AppEmbed('#tsEmbed', {
326
- * ... // other options
349
+ * ... // other embed view config
327
350
  * hideObjects: [
328
351
  * '430496d6-6903-4601-937e-2c691821af3c',
329
352
  * 'f547ec54-2a37-4516-a222-2b06719af726'
@@ -335,18 +358,22 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
335
358
  /**
336
359
  * Render liveboards using the new v2 rendering mode
337
360
  * This is a transient flag which is primarily meant for internal use
361
+ *
362
+ * Supported embed types: `AppEmbed`
338
363
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
339
364
  * @hidden
340
365
  */
341
366
  liveboardV2?: boolean;
342
367
  /**
343
368
  * If set to true, the Search Assist feature is enabled.
369
+ *
370
+ * Supported embed types: `AppEmbed`
344
371
  * @default true
345
372
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
346
373
  * @example
347
374
  * ```js
348
375
  * const embed = new AppEmbed('#tsEmbed', {
349
- * ... // other options
376
+ * ... // other embed view config
350
377
  * enableSearchAssist: true,
351
378
  * })
352
379
  * ```
@@ -364,63 +391,27 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
364
391
  * `false` fetches visualizations incrementally as
365
392
  * users scroll the page to view the charts and tables.
366
393
  *
394
+ * Supported embed types: `AppEmbed`
367
395
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
368
396
  * @example
369
397
  * ```js
370
398
  * const embed = new AppEmbed('#tsEmbed', {
371
- * ... // other options
399
+ * ... // other embed view config
372
400
  * fullHeight: true,
373
401
  * })
374
402
  * ```
375
403
  */
376
404
  fullHeight?: boolean;
377
- /**
378
- * Show or hide Liveboard header
379
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
380
- * @default false
381
- * @example
382
- * ```js
383
- * const embed = new AppEmbed('#tsEmbed', {
384
- * ... // other options
385
- * hideLiveboardHeader : true,
386
- * })
387
- * ```
388
- */
389
- hideLiveboardHeader?: boolean;
390
- /**
391
- * Show or hide Liveboard title
392
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
393
- * @default false
394
- * @example
395
- * ```js
396
- * const embed = new AppEmbed('#tsEmbed', {
397
- * ... // other options
398
- * showLiveboardTitle:true,
399
- * })
400
- * ```
401
- */
402
- showLiveboardTitle?: boolean;
403
- /**
404
- * Show or hide Liveboard description
405
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
406
- * @default false
407
- * @example
408
- * ```js
409
- * const embed = new AppEmbed('#tsEmbed', {
410
- * ... // other options
411
- * showLiveboardDescription:true,
412
- * })
413
- * ```
414
- */
415
- showLiveboardDescription?: boolean;
416
405
  /**
417
406
  * Flag to control new Modular Home experience.
407
+ *
408
+ * Supported embed types: `AppEmbed`
418
409
  * @default false
419
410
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
420
411
  * @example
421
412
  * ```js
422
413
  * const embed = new AppEmbed('#tsEmbed', {
423
- * ... // other options
414
+ * ... // other embed view config
424
415
  * modularHomeExperience : true,
425
416
  * })
426
417
  * ```
@@ -429,38 +420,21 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
429
420
  /**
430
421
  * To configure the top-left navigation and home page experience
431
422
  *
423
+ * Supported embed types: `AppEmbed`
432
424
  * @default false
433
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
425
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
434
426
  * @example
435
427
  * ```js
436
428
  * const embed = new AppEmbed('#tsEmbed', {
437
- * ... // other options
429
+ * ... // other embed view config
438
430
  * discoveryExperience : {
439
431
  * primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
440
- * homePage: HompePage.Modular,
432
+ * homePage: HomePage.Modular,
441
433
  * },
442
434
  * })
443
435
  * ```
444
436
  */
445
437
  discoveryExperience?: DiscoveryExperience;
446
- /**
447
- * Boolean to control if Liveboard header is sticky or not.
448
- * @example
449
- * ```js
450
- * const embed = new AppEmbed('#embed', {
451
- * ... // other app view config
452
- * isLiveboardHeaderSticky: true,
453
- * });
454
- * ```
455
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
456
- */
457
- isLiveboardHeaderSticky?: boolean;
458
- /**
459
- * enable or disable ask sage
460
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
461
- * @default false
462
- */
463
- enableAskSage?: boolean;
464
438
  /**
465
439
  * To set the initial state of the search bar in case of saved-answers.
466
440
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
@@ -475,6 +449,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
475
449
  * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
476
450
  * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
477
451
  * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
452
+ *
453
+ * Supported embed types: `AppEmbed`
478
454
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
479
455
  * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
480
456
  * @example
@@ -487,20 +463,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
487
463
  * ```
488
464
  */
489
465
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
490
- /**
491
- * This attribute can be used to enable the two-column layout on an embedded Liveboard
492
- * @type {boolean}
493
- * @default false
494
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
495
- * @example
496
- * ```js
497
- * const embed = new LiveboardEmbed('#embed-container', {
498
- * ... // other options
499
- * enable2ColumnLayout: true,
500
- * })
501
- * ```
502
- */
503
- enable2ColumnLayout?: boolean;
504
466
  /**
505
467
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
506
468
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
@@ -508,79 +470,57 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
508
470
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
509
471
  /**
510
472
  * Flag to use home page search bar mode
473
+ *
474
+ * Supported embed types: `AppEmbed`
511
475
  * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
512
476
  */
513
477
  homePageSearchBarMode?: HomePageSearchBarMode;
514
478
  /**
515
- * This flag can be used to enable the compact header in Liveboard
516
- * @type {boolean}
517
- * @default false
518
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
519
- * @example
520
- * ```js
521
- * const embed = new AppEmbed('#embed-container', {
522
- * ... // other options
523
- * isLiveboardCompactHeaderEnabled: true,
524
- * })
525
- * ```
526
- */
527
- isLiveboardCompactHeaderEnabled?: boolean;
528
- /**
529
- * This flag can be used to show or hide the Liveboard verified icon in the compact header.
530
- * @type {boolean}
479
+ * This flag is used to enable unified search experience for full app embed.
480
+ *
481
+ * Supported embed types: `AppEmbed`
482
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
531
483
  * @default true
532
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
533
- * @example
534
- * ```js
535
- * const embed = new AppEmbed('#embed-container', {
536
- * ... // other options
537
- * showLiveboardVerifiedBadge: true,
538
- * })
539
- * ```
540
- */
541
- showLiveboardVerifiedBadge?: boolean;
542
- /**
543
- * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
544
- * @type {boolean}
545
- * @default false
546
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
547
484
  * @example
548
485
  * ```js
549
- * const embed = new AppEmbed('#embed-container', {
550
- * ... // other options
551
- * hideIrrelevantChipsInLiveboardTabs: true,
486
+ * const embed = new AppEmbed('#tsEmbed', {
487
+ * ... // other embed view config
488
+ * isUnifiedSearchExperienceEnabled: true,
552
489
  * })
553
490
  * ```
554
491
  */
555
- hideIrrelevantChipsInLiveboardTabs?: boolean;
492
+ isUnifiedSearchExperienceEnabled?: boolean;
556
493
  /**
557
- * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
558
- * @type {boolean}
559
- * @default true
560
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
561
- * @example
562
- * ```js
563
- * const embed = new AppEmbed('#embed-container', {
564
- * ... // other options
565
- * showLiveboardReverifyBanner: true,
566
- * })
567
- * ```
568
- */
569
- showLiveboardReverifyBanner?: boolean;
494
+ * Show alert messages and toast messages in the embedded
495
+ * view in full app embed.
496
+ *
497
+ * Supported embed types: `AppEmbed`
498
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
499
+ * @example
500
+ * ```js
501
+ * const embed = new AppEmbed('#tsEmbed', {
502
+ * ... // other embed view config
503
+ * showAlerts:true,
504
+ * })
505
+ * ```
506
+ */
507
+ showAlerts?: boolean;
570
508
  /**
571
- * This flag is used to enable unified search experience for full app embed.
509
+ * This flag is used to enable/disable the styling and grouping in a Liveboard
510
+ *
511
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
572
512
  * @type {boolean}
573
- * @default true
574
- * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
513
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
575
514
  * @example
576
515
  * ```js
577
- * const embed = new AppEmbed('#embed-container', {
578
- * ... // other options
579
- * isUnifiedSearchExperienceEnabled: true,
516
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
517
+ * const embed = new <EmbedComponent>('#tsEmbed', {
518
+ * ... // other embed view config
519
+ * isLiveboardStylingAndGroupingEnabled: true,
580
520
  * })
581
521
  * ```
582
522
  */
583
- isUnifiedSearchExperienceEnabled?: boolean;
523
+ isLiveboardStylingAndGroupingEnabled?: boolean;
584
524
  }
585
525
  /**
586
526
  * Embeds full ThoughtSpot experience in a host application.
@@ -779,7 +719,7 @@ export function reset(): void;
779
719
  * The configuration for the embedded Liveboard or visualization page view.
780
720
  * @group Embed components
781
721
  */
782
- export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
722
+ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewConfig, LiveboardAppEmbedViewConfig {
783
723
  /**
784
724
  * If set to true, the embedded object container dynamically resizes
785
725
  * according to the height of the Liveboard.
@@ -792,6 +732,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
792
732
  * incrementally as users scroll the page to view the charts and tables.
793
733
  *
794
734
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
735
+ *
736
+ * Supported embed types: `LiveboardEmbed`
795
737
  * @example
796
738
  * ```js
797
739
  * const embed = new LiveboardEmbed('#embed', {
@@ -805,6 +747,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
805
747
  * This is the minimum height(in pixels) for a full-height Liveboard.
806
748
  * Setting this height helps resolve issues with empty Liveboards and
807
749
  * other screens navigable from a Liveboard.
750
+ *
751
+ * Supported embed types: `LiveboardEmbed`
808
752
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
809
753
  * @default 500
810
754
  * @example
@@ -822,7 +766,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
822
766
  * @example
823
767
  * ```js
824
768
  * const embed = new LiveboardEmbed('#tsEmbed', {
825
- * ... // other options
769
+ * ... //other embed view config
826
770
  * enableVizTransformations:true,
827
771
  * })
828
772
  * ```
@@ -832,11 +776,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
832
776
  /**
833
777
  * The Liveboard to display in the embedded view.
834
778
  * Use either liveboardId or pinboardId to reference the Liveboard to embed.
779
+ *
780
+ * Supported embed types: `LiveboardEmbed`
835
781
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
836
782
  * @example
837
783
  * ```js
838
- * const embed = new LiveboardEmbed('#embed-container', {
839
- * ... // other options
784
+ * const embed = new LiveboardEmbed('#tsEmbed', {
785
+ * ... //other embed view config
840
786
  * liveboardId:id of liveboard,
841
787
  * })
842
788
  */
@@ -848,11 +794,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
848
794
  pinboardId?: string;
849
795
  /**
850
796
  * The visualization within the Liveboard to display.
797
+ *
798
+ * Supported embed types: `LiveboardEmbed`
851
799
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
852
800
  * @example
853
801
  * ```js
854
- * const embed = new LiveboardEmbed('#embed-container', {
855
- * ... // other options
802
+ * const embed = new LiveboardEmbed('#tsEmbed', {
803
+ * ... //other embed view config
856
804
  * vizId:'430496d6-6903-4601-937e-2c691821af3c',
857
805
  * })
858
806
  * ```
@@ -861,11 +809,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
861
809
  /**
862
810
  * If set to true, all filter chips from a
863
811
  * Liveboard page will be read-only (no X buttons)
812
+ *
813
+ * Supported embed types: `LiveboardEmbed`
864
814
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
865
815
  * @example
866
816
  * ```js
867
- * const embed = new LiveboardEmbed('#embed-container', {
868
- * ... // other options
817
+ * const embed = new LiveboardEmbed('#tsEmbed', {
818
+ * ... //other embed view config
869
819
  * preventLiveboardFilterRemoval:true,
870
820
  * })
871
821
  * ```
@@ -875,11 +825,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
875
825
  * Array of visualization IDs which should be visible when the Liveboard
876
826
  * renders. This can be changed by triggering the `SetVisibleVizs`
877
827
  * event.
828
+ *
829
+ * Supported embed types: `LiveboardEmbed`
878
830
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
879
831
  * @example
880
832
  * ```js
881
- * const embed = new LiveboardEmbed('#embed-container', {
882
- * ... // other options
833
+ * const embed = new LiveboardEmbed('#tsEmbed', {
834
+ * ... //other embed view config
883
835
  * visibleVizs: [
884
836
  * '430496d6-6903-4601-937e-2c691821af3c',
885
837
  * 'f547ec54-2a37-4516-a222-2b06719af726'
@@ -895,11 +847,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
895
847
  /**
896
848
  * Render embedded Liveboards and visualizations in the
897
849
  * new Liveboard experience mode.
850
+ *
851
+ * Supported embed types: `LiveboardEmbed`
898
852
  * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
899
853
  * @example
900
854
  * ```js
901
- * const embed = new LiveboardEmbed('#embed-container', {
902
- * ... // other options
855
+ * const embed = new LiveboardEmbed('#tsEmbed', {
856
+ * ... //other embed view config
903
857
  * liveboardV2:true,
904
858
  * })
905
859
  * ```
@@ -908,10 +862,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
908
862
  /**
909
863
  * Set a Liveboard tab as an active tab.
910
864
  * Specify the tab ID.
865
+ *
866
+ * Supported embed types: `LiveboardEmbed`
911
867
  * @example
912
868
  * ```js
913
869
  * const embed = new LiveboardEmbed('#tsEmbed', {
914
- * ... // other options
870
+ * ... //other embed view config
915
871
  * activeTabId:'id-1234',
916
872
  * })
917
873
  * ```
@@ -920,96 +876,18 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
920
876
  activeTabId?: string;
921
877
  /**
922
878
  * Show or hide the tab panel of the embedded Liveboard.
879
+ *
880
+ * Supported embed types: `LiveboardEmbed`
923
881
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
924
882
  * @example
925
883
  * ```js
926
- * const embed = new LiveboardEmbed('#embed-container', {
927
- * ... // other options
884
+ * const embed = new LiveboardEmbed('#tsEmbed', {
885
+ * ... //other embed view config
928
886
  * hideTabPanel:true,
929
887
  * })
930
888
  * ```
931
889
  */
932
890
  hideTabPanel?: boolean;
933
- /**
934
- * Show or hide the Liveboard header.
935
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
936
- * @default false
937
- * @example
938
- * ```js
939
- * const embed = new LiveboardEmbed('#embed', {
940
- * ... // other liveboard view config
941
- * hideLiveboardHeader:true,
942
- * });
943
- * ```
944
- */
945
- hideLiveboardHeader?: boolean;
946
- /**
947
- * Show or hide the Liveboard title.
948
- * @default false
949
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
950
- * @example
951
- * ```js
952
- * const embed = new LiveboardEmbed('#embed-container', {
953
- * ... // other options
954
- * showLiveboardTitle:true,
955
- * })
956
- * ```
957
- */
958
- showLiveboardTitle?: boolean;
959
- /**
960
- * Show or hide the Liveboard description.
961
- * @default false
962
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
963
- * @example
964
- * ```js
965
- * const embed = new LiveboardEmbed('#embed-container', {
966
- * ... // other options
967
- * showLiveboardDescription:true,
968
- * })
969
- * ```
970
- */
971
- showLiveboardDescription?: boolean;
972
- /**
973
- * Control the position and visibility of
974
- * the Liveboard header as the users scroll down the
975
- * embedded Liveboard page.
976
- * @example
977
- * ```js
978
- * const embed = new LiveboardEmbed('#embed', {
979
- * ... // other Liveboard view config
980
- * isLiveboardHeaderSticky: true,
981
- * });
982
- * ```
983
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
984
- */
985
- isLiveboardHeaderSticky?: boolean;
986
- /**
987
- * enable or disable ask sage
988
- * @default false
989
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
990
- * @example
991
- * ```js
992
- * const embed = new SearchEmbed('#tsEmbed', {
993
- * ... // other options
994
- * enableAskSage:true,
995
- * })
996
- * ```
997
- */
998
- enableAskSage?: boolean;
999
- /**
1000
- * This flag is used to enable the 2 column layout on a Liveboard
1001
- * @type {boolean}
1002
- * @default false
1003
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1004
- * @example
1005
- * ```js
1006
- * const embed = new LiveboardEmbed('#embed-container', {
1007
- * ... // other options
1008
- * enable2ColumnLayout: true,
1009
- * })
1010
- * ```
1011
- */
1012
- enable2ColumnLayout?: boolean;
1013
891
  /**
1014
892
  * Show a preview image of the visualization before the visualization loads.
1015
893
  * Only works for visualizations embeds with a viz id.
@@ -1019,9 +897,11 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1019
897
  *
1020
898
  * Since, this will show preview images, be careful that it may show
1021
899
  * undesired data to the user when using row level security.
900
+ *
901
+ * Supported embed types: `LiveboardEmbed`
1022
902
  * @example
1023
903
  * ```js
1024
- * const embed = new LiveboardEmbed('#embed-container', {
904
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1025
905
  * liveboardId: 'liveboard-id',
1026
906
  * vizId: 'viz-id',
1027
907
  * showPreviewLoader: true,
@@ -1032,116 +912,119 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1032
912
  */
1033
913
  showPreviewLoader?: boolean;
1034
914
  /**
1035
- * Enables or disables the compact header feature on a Liveboard.
1036
- * Compact Liveboard header is turned off by default on Liveboards in
1037
- * ThoughtSpot Embedded apps.
915
+ * The Liveboard to run on regular intervals to fetch the cdw token.
1038
916
  *
1039
- * @type {boolean}
1040
- * @default false
1041
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
917
+ * Supported embed types: `LiveboardEmbed`
918
+ * @hidden
919
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1042
920
  * @example
1043
921
  * ```js
1044
- * const embed = new LiveboardEmbed('#embed-container', {
1045
- * ... // other options
1046
- * isLiveboardCompactHeaderEnabled: true,
922
+ * const embed = new LiveboardEmbed('#tsEmbed', {
923
+ * ... //other embed view config
924
+ * oAuthPollingInterval: value in milliseconds,
1047
925
  * })
1048
- * ```
1049
926
  */
1050
- isLiveboardCompactHeaderEnabled?: boolean;
927
+ oAuthPollingInterval?: number;
1051
928
  /**
1052
- * This flag is used to show/hide verified icon in the Liveboard compact header
1053
- * @type {boolean}
1054
- * @default true
1055
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
929
+ * The Liveboard is set to force a token fetch during the initial load.
930
+ *
931
+ * Supported embed types: `LiveboardEmbed`
932
+ * @hidden
933
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1056
934
  * @example
1057
935
  * ```js
1058
- * const embed = new LiveboardEmbed('#embed-container', {
1059
- * ... // other options
1060
- * showLiveboardVerifiedBadge: true,
936
+ * const embed = new LiveboardEmbed('#tsEmbed', {
937
+ * ... //other embed view config
938
+ * isForceRedirect: false,
1061
939
  * })
1062
- * ```
1063
940
  */
1064
- showLiveboardVerifiedBadge?: boolean;
941
+ isForceRedirect?: boolean;
1065
942
  /**
1066
- * This flag is used to show/hide the re-verify banner
1067
- * in Liveboard compact header
1068
- * @type {boolean}
1069
- * @default true
1070
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
943
+ * The source connection ID for authentication.
944
+ * @hidden
945
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
946
+ *
947
+ * Supported embed types: `LiveboardEmbed`
1071
948
  * @example
1072
949
  * ```js
1073
- * const embed = new LiveboardEmbed('#embed-container', {
1074
- * ... // other options
1075
- * showLiveboardReverifyBanner: true,
950
+ * const embed = new LiveboardEmbed('#tsEmbed', {
951
+ * ... //other embed view config
952
+ * dataSourceId: '',
1076
953
  * })
1077
- * ```
1078
954
  */
1079
- showLiveboardReverifyBanner?: boolean;
955
+ dataSourceId?: string;
1080
956
  /**
1081
- * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
1082
- * @type {boolean}
1083
- * @default false
1084
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
957
+ * This flag is for show/hide checkboxes for include or exclude
958
+ * cover page and filters in the Liveboard PDF.
959
+ *
960
+ * Supported embed types: `LiveboardEmbed`
961
+ * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
962
+ * @default true
963
+ * Supported embed types: `LiveboardEmbed`
1085
964
  * @example
1086
965
  * ```js
1087
- * const embed = new LiveboardEmbed('#embed-container', {
1088
- * ... // other options
1089
- * hideIrrelevantChipsInLiveboardTabs: true,
966
+ * const embed = new LiveboardEmbed('#tsEmbed', {
967
+ * ... //other embed view config
968
+ * coverAndFilterOptionInPDF: false,
1090
969
  * })
1091
970
  * ```
1092
971
  */
1093
- hideIrrelevantChipsInLiveboardTabs?: boolean;
1094
- /**
1095
- * The Liveboard to run on regular intervals to fetch the cdw token.
1096
- * @hidden
1097
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1098
- * @example
1099
- * ```js
1100
- * const embed = new LiveboardEmbed('#embed-container', {
1101
- * ... // other options
1102
- * oAuthPollingInterval: value in milliseconds,
1103
- * })
1104
- */
1105
- oAuthPollingInterval?: number;
972
+ coverAndFilterOptionInPDF?: boolean;
1106
973
  /**
1107
- * The Liveboard is set to force a token fetch during the initial load.
1108
- * @hidden
1109
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
974
+ * The list of tab IDs to hide from the embedded.
975
+ * This Tabs will be hidden from their respective LBs.
976
+ * Use this to hide an tabID.
977
+ *
978
+ * Supported embed types: `LiveboardEmbed`
1110
979
  * @example
1111
980
  * ```js
1112
- * const embed = new LiveboardEmbed('#embed-container', {
1113
- * ... // other options
1114
- * isForceRedirect: false,
1115
- * })
981
+ * const embed = new LiveboardEmbed('#tsEmbed', {
982
+ * ... // other embed view config
983
+ * hiddenTabs: [
984
+ * '430496d6-6903-4601-937e-2c691821af3c',
985
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
986
+ * ]
987
+ * });
988
+ * ```
989
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
1116
990
  */
1117
- isForceRedirect?: boolean;
991
+ hiddenTabs?: string[];
1118
992
  /**
1119
- * The source connection ID for authentication.
1120
- * @hidden
1121
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
993
+ * The list of tab IDs to show in the embedded Liveboard.
994
+ * Only the tabs specified in the array will be shown in the Liveboard.
995
+ *
996
+ * Use either `visibleTabs` or `hiddenTabs`.
997
+ *
998
+ * Supported embed types: `LiveboardEmbed`
999
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
1122
1000
  * @example
1123
1001
  * ```js
1124
- * const embed = new LiveboardEmbed('#embed-container', {
1125
- * ... // other options
1126
- * dataSourceId: '',
1002
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1003
+ * ... // other embed view config
1004
+ * visibleTabs: [
1005
+ * '430496d6-6903-4601-937e-2c691821af3c',
1006
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
1007
+ * ]
1127
1008
  * })
1009
+ * ```
1128
1010
  */
1129
- dataSourceId?: string;
1011
+ visibleTabs?: string[];
1130
1012
  /**
1131
- * This flag is for show/hide checkboxes for include or exclude
1132
- * cover page and filters in the Liveboard PDF.
1013
+ * This flag is used to enable/disable the styling and grouping in a Liveboard
1014
+ *
1015
+ * Supported embed types: `LiveboardEmbed`, `AppEmbed`
1133
1016
  * @type {boolean}
1134
- * @default true
1135
- * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
1017
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1136
1018
  * @example
1137
1019
  * ```js
1138
- * const embed = new LiveboardEmbed('#embed-container', {
1139
- * ... // other options
1140
- * coverAndFilterOptionInPDF: false,
1020
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
1021
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1022
+ * ... // other embed view config
1023
+ * isLiveboardStylingAndGroupingEnabled: true,
1141
1024
  * })
1142
1025
  * ```
1143
1026
  */
1144
- coverAndFilterOptionInPDF?: boolean;
1027
+ isLiveboardStylingAndGroupingEnabled?: boolean;
1145
1028
  }
1146
1029
  /**
1147
1030
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1241,15 +1124,17 @@ export enum DataPanelCustomColumnGroupsAccordionState {
1241
1124
  * The configuration attributes for the embedded search view.
1242
1125
  * @group Embed components
1243
1126
  */
1244
- export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
1127
+ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction'> {
1245
1128
  /**
1246
1129
  * If set to true, the data sources panel is collapsed on load,
1247
1130
  * but can be expanded manually.
1131
+ *
1132
+ * Supported embed types: `SearchEmbed`
1248
1133
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1249
1134
  * @example
1250
1135
  * ```js
1251
1136
  * const embed = new SearchEmbed('#tsEmbed', {
1252
- * ... // other options
1137
+ * ... // other embed view config
1253
1138
  * collapseDataSources:true,
1254
1139
  * })
1255
1140
  * ```
@@ -1258,11 +1143,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1258
1143
  /**
1259
1144
  * If set to true, the data panel is collapsed on load,
1260
1145
  * but can be expanded manually.
1146
+ *
1147
+ * Supported embed types: `SearchEmbed`
1261
1148
  * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
1262
1149
  * @example
1263
1150
  * ```js
1264
1151
  * const embed = new SearchEmbed('#tsEmbed', {
1265
- * ... // other options
1152
+ * ... // other embed view config
1266
1153
  * collapseDataPanel:true,
1267
1154
  * })
1268
1155
  * ```
@@ -1270,11 +1157,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1270
1157
  collapseDataPanel?: boolean;
1271
1158
  /**
1272
1159
  * Show or hide the data sources panel.
1160
+ *
1161
+ * Supported embed types: `SearchEmbed`
1273
1162
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
1274
1163
  * @example
1275
1164
  * ```js
1276
1165
  * const embed = new SearchEmbed('#tsEmbed', {
1277
- * ... // other options
1166
+ * ... // other embed view config
1278
1167
  * hideDataSources:true,
1279
1168
  * })
1280
1169
  * ```
@@ -1284,11 +1173,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1284
1173
  * Show or hide the charts and tables in search answers.
1285
1174
  * This attribute can be used to create a custom visualization
1286
1175
  * using raw answer data.
1176
+ *
1177
+ * Supported embed types: `SearchEmbed`
1287
1178
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
1288
1179
  * @example
1289
1180
  * ```js
1290
1181
  * const embed = new SearchEmbed('#tsEmbed', {
1291
- * ... // other options
1182
+ * ... // other embed view config
1292
1183
  * hideResults:true,
1293
1184
  * })
1294
1185
  * ```
@@ -1296,11 +1187,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1296
1187
  hideResults?: boolean;
1297
1188
  /**
1298
1189
  * If set to true, the Search Assist feature is enabled.
1190
+ *
1191
+ * Supported embed types: `SearchEmbed`
1299
1192
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1300
1193
  * @example
1301
1194
  * ```js
1302
1195
  * const embed = new SearchEmbed('#tsEmbed', {
1303
- * ... // other options
1196
+ * ... // other embed view config
1304
1197
  * enableSearchAssist:true,
1305
1198
  * })
1306
1199
  * ```
@@ -1309,11 +1202,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1309
1202
  /**
1310
1203
  * If set to true, the tabular view is set as the default
1311
1204
  * format for presenting search data.
1205
+ *
1206
+ * Supported embed types: `SearchEmbed`
1312
1207
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1313
1208
  * @example
1314
1209
  * ```js
1315
1210
  * const embed = new SearchEmbed('#tsEmbed', {
1316
- * ... // other options
1211
+ * ... // other embed view config
1317
1212
  * forceTable:true,
1318
1213
  * })
1319
1214
  */
@@ -1322,10 +1217,12 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1322
1217
  * The array of data source GUIDs to set on load.
1323
1218
  * Only a single data source is supported currently.
1324
1219
  * @deprecated Use `dataSource` instead.
1220
+ *
1221
+ * Supported embed types: `SearchEmbed`
1325
1222
  * @example
1326
1223
  * ```js
1327
1224
  * const embed = new SearchEmbed('#tsEmbed', {
1328
- * ... // other options
1225
+ * ... // other embed view config
1329
1226
  * dataSources:['id-234','id-456'],
1330
1227
  * })
1331
1228
  * ```
@@ -1333,11 +1230,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1333
1230
  dataSources?: string[];
1334
1231
  /**
1335
1232
  * The array of data source GUIDs to set on load.
1233
+ *
1234
+ * Supported embed types: `SearchEmbed`
1336
1235
  * @version: SDK: 1.19.0
1337
1236
  * @example
1338
1237
  * ```js
1339
1238
  * const embed = new SearchEmbed('#tsEmbed', {
1340
- * ... // other options
1239
+ * ... // other embed view config
1341
1240
  * dataSource:'id-234',
1342
1241
  * })
1343
1242
  * ```
@@ -1360,6 +1259,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1360
1259
  * If it is executed, the focus is placed on the results.
1361
1260
  * If it’s not executed, the focus is placed at the end of
1362
1261
  * the token string in the search bar.
1262
+ *
1263
+ * Supported embed types: `SearchEmbed`
1363
1264
  * @example
1364
1265
  * ```js
1365
1266
  * searchOptions: {
@@ -1372,6 +1273,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1372
1273
  /**
1373
1274
  * Exclude the search token string from the URL.
1374
1275
  * If set to true, the search token string is not appended to the URL.
1276
+ *
1277
+ * Supported embed types: `SearchEmbed`
1375
1278
  * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
1376
1279
  * @example
1377
1280
  * ```js
@@ -1387,11 +1290,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1387
1290
  excludeSearchTokenStringFromURL?: boolean;
1388
1291
  /**
1389
1292
  * The GUID of a saved answer to load initially.
1293
+ *
1294
+ * Supported embed types: `SearchEmbed`
1390
1295
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1391
1296
  * @example
1392
1297
  * ```js
1393
1298
  * const embed = new SearchEmbed('#tsEmbed', {
1394
- * ... // other options
1299
+ * ... // other embed view config
1395
1300
  * answerId:'sed-1234',
1396
1301
  * })
1397
1302
  * ```
@@ -1400,11 +1305,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1400
1305
  /**
1401
1306
  * If set to true, the search page will render without the Search Bar
1402
1307
  * The chart/table should still be visible.
1308
+ *
1309
+ * Supported embed types: `SearchEmbed`
1403
1310
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1404
1311
  * @example
1405
1312
  * ```js
1406
1313
  * const embed = new SearchEmbed('#tsEmbed', {
1407
- * ... // other options
1314
+ * ... // other embed view config
1408
1315
  * hideSearchBar:true,
1409
1316
  * })
1410
1317
  * ```
@@ -1412,6 +1319,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1412
1319
  hideSearchBar?: boolean;
1413
1320
  /**
1414
1321
  * Flag to set if last selected dataSource should be used
1322
+ *
1323
+ * Supported embed types: `SearchEmbed`
1415
1324
  * @version: SDK: 1.24.0
1416
1325
  */
1417
1326
  useLastSelectedSources?: boolean;
@@ -1424,6 +1333,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1424
1333
  collapseSearchBarInitially?: boolean;
1425
1334
  /**
1426
1335
  * Flag to enable onBeforeSearchExecute Embed Event
1336
+ *
1337
+ * Supported embed types: `SearchEmbed`
1427
1338
  * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
1428
1339
  */
1429
1340
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
@@ -1434,12 +1345,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1434
1345
  * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
1435
1346
  * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
1436
1347
  * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
1348
+ *
1349
+ * Supported embed types: `SearchEmbed`
1437
1350
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1438
1351
  * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
1439
1352
  * @example
1440
1353
  * ```js
1441
1354
  * const embed = new SearchEmbed('#tsEmbed', {
1442
- * ... // other options
1355
+ * ... // other embed view config
1443
1356
  * dataPanelCustomGroupsAccordionInitialState:
1444
1357
  * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
1445
1358
  * });
@@ -1449,12 +1362,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1449
1362
  /**
1450
1363
  * Flag to remove focus from search bar initially when user
1451
1364
  * lands on search embed page.
1365
+ *
1366
+ * Supported embed types: `SearchEmbed`
1452
1367
  * @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
1453
1368
  * @default true
1454
1369
  * @example
1455
1370
  * ```js
1456
1371
  * const embed = new SearchEmbed('#tsEmbed', {
1457
- * ... // other options
1372
+ * ... // other embed view config
1458
1373
  * focusSearchBarOnRender: false,
1459
1374
  * });
1460
1375
  * ```
@@ -1498,16 +1413,18 @@ export class SearchEmbed extends TsEmbed {
1498
1413
  /**
1499
1414
  * @group Embed components
1500
1415
  */
1501
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
1416
+ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig {
1502
1417
  /**
1503
1418
  * The array of data source GUIDs to set on load.
1504
1419
  * Only a single data source is supported currently.
1420
+ *
1421
+ * Supported embed types: `SearchBarEmbed`
1505
1422
  * @deprecated Use `dataSource` instead
1506
1423
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
1507
1424
  * @example
1508
1425
  * ```js
1509
1426
  * const embed = new SearchBarEmbed('#tsEmbed', {
1510
- * ... // other options
1427
+ * ... //other embed view config
1511
1428
  * dataSources:['id-2345','id-2345'],
1512
1429
  * })
1513
1430
  * ```
@@ -1515,11 +1432,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
1515
1432
  dataSources?: string[];
1516
1433
  /**
1517
1434
  * Pass the ID of the source to be selected.
1435
+ *
1436
+ * Supported embed types: `SearchBarEmbed`
1518
1437
  * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
1519
1438
  * @example
1520
1439
  * ```js
1521
1440
  * const embed = new SearchBarEmbed('#tsEmbed', {
1522
- * ... // other options
1441
+ * ... //other embed view config
1523
1442
  * dataSource:'id-2345',
1524
1443
  * })
1525
1444
  * ```
@@ -1527,11 +1446,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
1527
1446
  dataSource?: string;
1528
1447
  /**
1529
1448
  * Boolean to define if the last selected data source should be used
1449
+ *
1450
+ * Supported embed types: `SearchBarEmbed`
1530
1451
  * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
1531
1452
  * @example
1532
1453
  * ```js
1533
1454
  * const embed = new SearchBarEmbed('#tsEmbed', {
1534
- * ... // other options
1455
+ * ... //other embed view config
1535
1456
  * useLastSelectedSources:false,
1536
1457
  * })
1537
1458
  * ```
@@ -1547,11 +1468,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
1547
1468
  * If it is executed, the focus is placed on the results.
1548
1469
  * If it’s not executed, the focus is placed at the end of
1549
1470
  * the token string in the search bar.
1471
+ *
1472
+ * Supported embed types: `SearchBarEmbed`
1550
1473
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
1551
1474
  * @example
1552
1475
  * ```js
1553
1476
  * const embed = new SearchBarEmbed('#tsEmbed', {
1554
- * ... // other options
1477
+ * ... //other embed view config
1555
1478
  * searchOptions: {
1556
1479
  * searchTokenString: '[quantity purchased] [region]',
1557
1480
  * executeSearch: true,
@@ -1563,6 +1486,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
1563
1486
  /**
1564
1487
  * Exclude the search token string from the URL.
1565
1488
  * If set to true, the search token string is not appended to the URL.
1489
+ *
1490
+ * Supported embed types: `SearchBarEmbed`
1566
1491
  * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
1567
1492
  * @example
1568
1493
  * ```js
@@ -1606,7 +1531,7 @@ export class SearchBarEmbed extends TsEmbed {
1606
1531
  * Configuration for bodyless conversation options.
1607
1532
  * @group Embed components
1608
1533
  */
1609
- export interface SpotterAgentEmbedViewConfig extends ViewConfig {
1534
+ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
1610
1535
  /**
1611
1536
  * The ID of the worksheet to use for the conversation.
1612
1537
  */
@@ -1618,7 +1543,7 @@ export interface SpotterAgentEmbedViewConfig extends ViewConfig {
1618
1543
  }
1619
1544
  /**
1620
1545
  * Configuration for conversation options.
1621
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1546
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1622
1547
  * Use {@link SpotterAgentEmbedViewConfig} instead
1623
1548
  * @group Embed components
1624
1549
  */
@@ -1670,7 +1595,7 @@ export class SpotterAgentEmbed {
1670
1595
  /**
1671
1596
  * Create a conversation embed, which can be integrated inside
1672
1597
  * chatbots or other conversational interfaces.
1673
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1598
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1674
1599
  * Use {@link SpotterAgentEmbed} instead
1675
1600
  * @example
1676
1601
  * ```js
@@ -1705,9 +1630,9 @@ export interface SearchOptions {
1705
1630
  * The configuration for the embedded spotterEmbed options.
1706
1631
  * @group Embed components
1707
1632
  */
1708
- export interface SpotterEmbedViewConfig extends ViewConfig {
1633
+ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
1709
1634
  /**
1710
- * The ID of the worksheet to use for the conversation.
1635
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
1711
1636
  */
1712
1637
  worksheetId: string;
1713
1638
  /**
@@ -1717,10 +1642,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1717
1642
  /**
1718
1643
  * disableSourceSelection : Disables data source selection
1719
1644
  * but still display the selected data source.
1645
+ *
1646
+ * Supported embed types: `SpotterEmbed`
1720
1647
  * @example
1721
1648
  * ```js
1722
1649
  * const embed = new SpotterEmbed('#tsEmbed', {
1723
- * ... // other options
1650
+ * ... //other embed view config
1724
1651
  * disableSourceSelection : true,
1725
1652
  * })
1726
1653
  * ```
@@ -1729,10 +1656,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1729
1656
  disableSourceSelection?: boolean;
1730
1657
  /**
1731
1658
  * hideSourceSelection : Hide data source selection
1659
+ *
1660
+ * Supported embed types: `SpotterEmbed`
1732
1661
  * @example
1733
1662
  * ```js
1734
1663
  * const embed = new SpotterEmbed('#tsEmbed', {
1735
- * ... // other options
1664
+ * ... //other embed view config
1736
1665
  * hideSourceSelection : true,
1737
1666
  * })
1738
1667
  * ```
@@ -1741,12 +1670,15 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1741
1670
  hideSourceSelection?: boolean;
1742
1671
  /**
1743
1672
  * Flag to control Data panel experience
1673
+ *
1674
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1744
1675
  * @default false
1745
1676
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
1746
1677
  * @example
1747
1678
  * ```js
1748
- * const embed = new AppEmbed('#tsEmbed', {
1749
- * ... // other options
1679
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
1680
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1681
+ * ... // other embed view config
1750
1682
  * dataPanelV2: true,
1751
1683
  * })
1752
1684
  * ```
@@ -1756,10 +1688,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1756
1688
  * showSpotterLimitations : show limitation text
1757
1689
  * of the spotter underneath the chat input.
1758
1690
  * default is false.
1691
+ *
1692
+ * Supported embed types: `SpotterEmbed`
1759
1693
  * @example
1760
1694
  * ```js
1761
1695
  * const embed = new SpotterEmbed('#tsEmbed', {
1762
- * ... // other options
1696
+ * ... //other embed view config
1763
1697
  * showSpotterLimitations : true,
1764
1698
  * })
1765
1699
  * ```
@@ -1769,10 +1703,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1769
1703
  /**
1770
1704
  * hideSampleQuestions : Hide sample questions on
1771
1705
  * the initial screen of the conversation.
1706
+ *
1707
+ * Supported embed types: `SpotterEmbed`
1772
1708
  * @example
1773
1709
  * ```js
1774
1710
  * const embed = new SpotterEmbed('#tsEmbed', {
1775
- * ... // other options
1711
+ * ... //other embed view config
1776
1712
  * hideSampleQuestions : true,
1777
1713
  * })
1778
1714
  * ```
@@ -1782,7 +1718,7 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1782
1718
  }
1783
1719
  /**
1784
1720
  * The configuration for the embedded spotterEmbed options.
1785
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1721
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1786
1722
  * Use {@link SpotterEmbedViewConfig} instead
1787
1723
  * @group Embed components
1788
1724
  */
@@ -1811,7 +1747,7 @@ export class SpotterEmbed extends TsEmbed {
1811
1747
  }
1812
1748
  /**
1813
1749
  * Embed ThoughtSpot AI Conversation.
1814
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1750
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1815
1751
  * Use {@link SpotterEmbed} instead
1816
1752
  * @group Embed components
1817
1753
  * @example
@@ -2194,7 +2130,7 @@ export enum AuthType {
2194
2130
  * // ...
2195
2131
  * authType: AuthType.SAMLRedirect,
2196
2132
  * authTriggerText: 'Login with SAML',
2197
- * authTriggerContainer: '#embed-container',
2133
+ * authTriggerContainer: '#tsEmbed',
2198
2134
  * inPopup: true,
2199
2135
  * });
2200
2136
  * ```
@@ -2319,13 +2255,13 @@ export enum HomeLeftNavItem {
2319
2255
  /**
2320
2256
  * Create new options in the insights left navigation,
2321
2257
  * available when new navigation V3 is enabled.
2322
- * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2258
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2323
2259
  */
2324
2260
  Create = "create",
2325
2261
  /**
2326
2262
  * Spotter option in the insights left navigation,
2327
2263
  * available when new navigation V3 is enabled.
2328
- * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2264
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2329
2265
  */
2330
2266
  Spotter = "spotter"
2331
2267
  }
@@ -2733,6 +2669,20 @@ export interface EmbedConfig {
2733
2669
  */
2734
2670
  customVariablesForThirdPartyTools?: Record<string, any>;
2735
2671
  disablePreauthCache?: boolean;
2672
+ /**
2673
+ * Disable fullscreen presentation mode functionality. When enabled, prevents entering
2674
+ * and exiting fullscreen mode for embedded visualizations during presentations.
2675
+ * @default true (feature is disabled by default)
2676
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2677
+ * @example
2678
+ * ```js
2679
+ * init({
2680
+ * ... // other embed config options
2681
+ * disableFullscreenPresentation: false, // enables the feature
2682
+ * })
2683
+ * ```
2684
+ */
2685
+ disableFullscreenPresentation?: boolean;
2736
2686
  }
2737
2687
  export interface LayoutConfig {
2738
2688
  }
@@ -2762,9 +2712,9 @@ export interface FrameParams {
2762
2712
  [key: string]: string | number | boolean | undefined;
2763
2713
  }
2764
2714
  /**
2765
- * The configuration object for an embedded view.
2715
+ * The common configuration object for an embedded view.
2766
2716
  */
2767
- export interface ViewConfig {
2717
+ export interface BaseViewConfig {
2768
2718
  /**
2769
2719
  * @hidden
2770
2720
  */
@@ -2772,16 +2722,19 @@ export interface ViewConfig {
2772
2722
  /**
2773
2723
  * The width and height dimensions to render an embedded
2774
2724
  * object inside your app. Specify the values in pixels or percentage.
2725
+ *
2726
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2775
2727
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
2776
2728
  * @example
2777
2729
  * ```js
2778
- * const embed = new LiveboardEmbed('#embed', {
2779
- * ... // other liveboard view config
2780
- * frameParams: {
2781
- * width: '500px' | '50%',
2782
- * height: '400px' | '60%',
2783
- * },
2784
- * });
2730
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2731
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2732
+ * ... // other embed view config
2733
+ * frameParams: {
2734
+ * width: '500px' | '50%',
2735
+ * height: '400px' | '60%',
2736
+ * },
2737
+ * })
2785
2738
  * ```
2786
2739
  */
2787
2740
  frameParams?: FrameParams;
@@ -2798,38 +2751,31 @@ export interface ViewConfig {
2798
2751
  * (...), and the contextual menu. These actions will be disabled
2799
2752
  * for the user.
2800
2753
  * Use this to disable actions.
2754
+ *
2755
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2801
2756
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2802
2757
  * @example
2803
2758
  * ```js
2804
- * const embed = new LiveboardEmbed('#embed', {
2805
- * ... // other liveboard view config
2806
- * disabledActions: [Action.Download, Action.Save]
2759
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2760
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2761
+ * ... // other embed view config
2762
+ * disabledActions: [Action.Download, Action.Save],
2807
2763
  * });
2808
2764
  * ```
2809
2765
  */
2810
2766
  disabledActions?: Action[];
2811
- /**
2812
- * The primary action to display on top of the viz for Liveboard and App Embed.
2813
- * Use this to set the primary action.
2814
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2815
- * @example
2816
- * ```js
2817
- * const embed = new LiveboardEmbed('#embed', {
2818
- * ... // other liveboard view config
2819
- * primaryAction: Action.Download
2820
- * });
2821
- * ```
2822
- */
2823
- primaryAction?: Action | string;
2824
2767
  /**
2825
2768
  * The tooltip to display for disabled actions.
2769
+ *
2770
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2826
2771
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2827
2772
  * @example
2828
2773
  * ```js
2829
- * const embed = new LiveboardEmbed('#embed', {
2830
- * ... // other liveboard view config
2831
- * disabledActions: [Action.Download, Action.Save]
2832
- * disabledActionReason: "Reason for disabling",
2774
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2775
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2776
+ * ... // other embed view config
2777
+ * disabledActions: [Action.Download, Action.Save],
2778
+ * disabledActionReason: "Reason for disabling",
2833
2779
  * });
2834
2780
  * ```
2835
2781
  */
@@ -2838,12 +2784,15 @@ export interface ViewConfig {
2838
2784
  * The list of actions to hide from the embedded.
2839
2785
  * This actions will be hidden from the user.
2840
2786
  * Use this to hide an action.
2787
+ *
2788
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2841
2789
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2842
2790
  * @example
2843
2791
  * ```js
2844
- * const embed = new LiveboardEmbed('#embed', {
2845
- * ... // other liveboard view config
2846
- * hiddenActions: [Action.Download, Action.Export]
2792
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2793
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2794
+ * ... // other embed view config
2795
+ * hiddenActions: [Action.Download, Action.Export],
2847
2796
  * });
2848
2797
  * ```
2849
2798
  * @important
@@ -2856,74 +2805,30 @@ export interface ViewConfig {
2856
2805
  * Use this to hide all actions except the ones you want to show.
2857
2806
  *
2858
2807
  * Use either this or hiddenActions.
2808
+ *
2809
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2859
2810
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2860
2811
  * @important
2861
2812
  * @example
2862
2813
  * ```js
2863
- * const embed = new LiveboardEmbed('#embed', {
2864
- * ... // other liveboard view config
2865
- * visibleActions: [Action.Download, Action.Export]
2814
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2815
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2816
+ * ... // other embed view config
2817
+ * visibleActions: [Action.Download, Action.Export],
2866
2818
  * });
2867
2819
  * ```
2868
2820
  */
2869
2821
  visibleActions?: Action[];
2870
- /**
2871
- * Show alert messages and toast messages in the embedded
2872
- * view in full app embed.
2873
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2874
- * @example
2875
- * ```js
2876
- * const embed = new AppEmbed('#embed-container', {
2877
- * ... // other options
2878
- * showAlerts:true,
2879
- * })
2880
- * ```
2881
- */
2882
- showAlerts?: boolean;
2883
- /**
2884
- * The list of runtime filters to apply to a search Answer,
2885
- * visualization, or Liveboard.
2886
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2887
- * @example
2888
- * ```js
2889
- * const embed = new LiveboardEmbed('#embed-container', {
2890
- * ... // other options
2891
- * runtimeFilters: [
2892
- * {
2893
- * columnName: 'value',
2894
- * operator: RuntimeFilterOp.EQ,
2895
- * values: ['string' | 123 | true],
2896
- * },
2897
- * ],
2898
- * })
2899
- * ```
2900
- */
2901
- runtimeFilters?: RuntimeFilter[];
2902
- /**
2903
- * The list of parameter override to apply to a search Answer,
2904
- * visualization, or Liveboard.
2905
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2906
- * @example
2907
- * ```js
2908
- * const embed = new LiveboardEmbed('#embed-container', {
2909
- * ... // other options
2910
- * runtimeParameters: [
2911
- * {
2912
- * name: 'value',
2913
- * value: 'string' | 123 | true,
2914
- * },
2915
- * ],
2916
- * })
2917
- * ```
2918
- */
2919
- runtimeParameters?: RuntimeParameter[];
2920
2822
  /**
2921
2823
  * The locale settings to apply to the embedded view.
2824
+ *
2825
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2922
2826
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2923
2827
  * @example
2924
2828
  * ```js
2925
- * const embed = new LiveboardEmbed('#embed-container', {
2926
- * ... // other options
2829
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2830
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2831
+ * ... // other embed view config
2927
2832
  * locale:'en',
2928
2833
  * })
2929
2834
  * ```
@@ -2937,14 +2842,17 @@ export interface ViewConfig {
2937
2842
  * Warning: This option is for advanced use only and is used internally
2938
2843
  * to control embed behavior in non-regular ways. We do not publish the
2939
2844
  * list of supported keys and values associated with each.
2845
+ *
2846
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2940
2847
  * @example
2941
2848
  * ```js
2942
- * const embed = new LiveboardEmbed('#embed', {
2943
- * ... // other liveboard view config
2849
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2850
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2851
+ * ... // other embed view config
2944
2852
  * additionalFlags: {
2945
2853
  * flag1: 'value1',
2946
2854
  * flag2: 'value2'
2947
- * }
2855
+ * },
2948
2856
  * });
2949
2857
  * ```
2950
2858
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
@@ -2962,55 +2870,308 @@ export interface ViewConfig {
2962
2870
  /**
2963
2871
  * Insert as a sibling of the target container, instead of appending to a
2964
2872
  * child inside it.
2873
+ *
2874
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2965
2875
  * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
2966
2876
  * @example
2967
2877
  * ```js
2968
- * const embed = new LiveboardEmbed('#embed-container', {
2969
- * ... // other options
2878
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2879
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2880
+ * ... // other embed view config
2970
2881
  * insertAsSibling:true,
2971
2882
  * })
2972
2883
  * ```
2973
2884
  */
2974
2885
  insertAsSibling?: boolean;
2975
2886
  /**
2976
- * flag to set ContextMenu Trigger to either left or right click.
2887
+ * Use a pre-rendered iframe from a pool of pre-rendered iframes
2888
+ * if available and matches the configuration.
2889
+ * @version SDK: 1.22.0
2890
+ * @hidden
2891
+ *
2892
+ * See [docs]() on how to create a prerender pool.
2893
+ */
2894
+ usePrerenderedIfAvailable?: boolean;
2895
+ /**
2896
+ * PreRender id to be used for PreRendering the embed.
2897
+ * Use PreRender to render the embed in the background and then
2898
+ * show or hide the rendered embed using showPreRender or hidePreRender respectively.
2899
+ *
2900
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2977
2901
  * @example
2978
2902
  * ```js
2979
- * const embed = new LiveboardEmbed('#tsEmbed', {
2980
- * ... // other options
2981
- * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
2982
- * })
2903
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2904
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2905
+ * ... // other embed view config
2906
+ * preRenderId: "preRenderId-123",
2907
+ * });
2908
+ * embed.showPreRender();
2983
2909
  * ```
2984
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2910
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
2985
2911
  */
2986
- contextMenuTrigger?: ContextMenuTriggerOptions;
2912
+ preRenderId?: string;
2913
+ /**
2914
+ * Determines if the PreRender component should dynamically track the size
2915
+ * of its embedding element and adjust its own size accordingly.
2916
+ * Enabling this option allows the PreRender component to automatically adapt
2917
+ * its dimensions based on changes to the size of the embedding element.
2918
+ * @type {boolean}
2919
+ * @default false
2920
+ * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
2921
+ * @example
2922
+ * ```js
2923
+ * // Disable tracking PreRender size in the configuration
2924
+ * const config = {
2925
+ * doNotTrackPreRenderSize: true,
2926
+ * };
2927
+ *
2928
+ * // Instantiate an object with the configuration
2929
+ * const myComponent = new MyComponent(config);
2930
+ * ```
2931
+ */
2932
+ doNotTrackPreRenderSize?: boolean;
2933
+ /**
2934
+ * Enable the V2 shell. This can provide performance benefits
2935
+ * due to a lighterweight shell.
2936
+ *
2937
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2938
+ * @example
2939
+ * ```js
2940
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2941
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2942
+ * ... // other embed view config
2943
+ * enableV2Shell_experimental: true,
2944
+ * });
2945
+ * ```
2946
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
2947
+ */
2948
+ enableV2Shell_experimental?: boolean;
2949
+ /**
2950
+ * For internal tracking of the embed component type.
2951
+ * @hidden
2952
+ */
2953
+ embedComponentType?: string;
2954
+ /**
2955
+ * This flag can be used to expose translation IDs on the embedded app.
2956
+ * @default false
2957
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2958
+ */
2959
+ exposeTranslationIDs?: boolean;
2960
+ /**
2961
+ * This flag can be used to disable links inside the embedded app,
2962
+ * and disable redirection of links in a new tab.
2963
+ *
2964
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2965
+ * @example
2966
+ * ```js
2967
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2968
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2969
+ * ... // other embed view config
2970
+ * disableRedirectionLinksInNewTab: true,
2971
+ * });
2972
+ * ```
2973
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2974
+ */
2975
+ disableRedirectionLinksInNewTab?: boolean;
2976
+ /**
2977
+ * Overrides an Org context for embedding application users.
2978
+ * This parameter allows a user authenticated to one Org to view the
2979
+ * objects from another Org.
2980
+ * The `overrideOrgId` setting is honoured only if the
2981
+ * Per Org URL feature is enabled on your ThoughtSpot instance.
2982
+ *
2983
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2984
+ * @example
2985
+ * ```js
2986
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2987
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2988
+ * ... // other embed view config
2989
+ * overrideOrgId: 142536,
2990
+ * });
2991
+ * ```
2992
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
2993
+ */
2994
+ overrideOrgId?: number;
2987
2995
  /**
2988
2996
  * Flag to override the *Open Link in New Tab* context menu option.
2997
+ *
2998
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2989
2999
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2990
3000
  * @example
2991
3001
  * ```js
2992
- * const embed = new LiveboardEmbed('#embed-container', {
2993
- * ... // other options
3002
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3003
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3004
+ * ... // other embed view config
2994
3005
  * linkOverride:false,
2995
3006
  * })
2996
3007
  * ```
2997
3008
  */
2998
3009
  linkOverride?: boolean;
3010
+ /**
3011
+ * The primary action to display on top of the viz for Liveboard and App Embed.
3012
+ * Use this to set the primary action.
3013
+ *
3014
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3015
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
3016
+ * @example
3017
+ * ```js
3018
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3019
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3020
+ * ... // other embed view config
3021
+ * primaryAction: Action.Download
3022
+ * });
3023
+ * ```
3024
+ */
3025
+ primaryAction?: Action | string;
2999
3026
  /**
3000
3027
  * flag to enable insert into slides action
3001
3028
  * @hidden
3002
3029
  * @private
3003
3030
  */
3004
3031
  insertInToSlide?: boolean;
3032
+ }
3033
+ /**
3034
+ * The configuration object for Home page embeds configs.
3035
+ */
3036
+ export interface HomePageConfig {
3005
3037
  /**
3006
- * Use a pre-rendered iframe from a pool of pre-rendered iframes
3007
- * if available and matches the configuration.
3008
- * @version SDK: 1.22.0
3009
- * @hidden
3038
+ * Hide list page columns
3039
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3010
3040
  *
3011
- * See [docs]() on how to create a prerender pool.
3041
+ * **Note**: This option is available only in full app embedding.
3042
+ *
3043
+ * Supported embed types: `AppEmbed`
3044
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3045
+ * @example
3046
+ * ```js
3047
+ * const embed = new AppEmbed('#tsEmbed', {
3048
+ * ... //other embed view config
3049
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3050
+ * })
3051
+ * ```
3052
+ */
3053
+ hiddenListColumns?: ListPageColumns[];
3054
+ /**
3055
+ * Hide the home page modules
3056
+ * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
3057
+ *
3058
+ * **Note**: This option does not apply to the classic homepage.
3059
+ * To access the updated modular homepage, set
3060
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3061
+ *
3062
+ * Supported embed types: `AppEmbed`
3063
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3064
+ * @example
3065
+ * ```js
3066
+ * const embed = new AppEmbed('#tsEmbed', {
3067
+ * ... //other embed view config
3068
+ * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
3069
+ * })
3070
+ * ```
3071
+ */
3072
+ hiddenHomepageModules?: HomepageModule[];
3073
+ /**
3074
+ * reordering the home page modules
3075
+ * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
3076
+ *
3077
+ * **Note**: This option does not apply to the classic homepage.
3078
+ * To access the updated modular homepage, set
3079
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3080
+ *
3081
+ * Supported embed types: `AppEmbed`
3082
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3083
+ * @example
3084
+ * ```js
3085
+ * const embed = new AppEmbed('#tsEmbed', {
3086
+ * ... //other embed view config
3087
+ * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
3088
+ * })
3089
+ * ```
3090
+ */
3091
+ reorderedHomepageModules?: HomepageModule[];
3092
+ /**
3093
+ * homepageLeftNavItems : Show or hide the left navigation bar items.
3094
+ * There are 8 eight home navigation list items.
3095
+ * To hide these items, specify the string in the array.
3096
+ *
3097
+ * Supported embed types: `AppEmbed`
3098
+ * @example
3099
+ * ```js
3100
+ * const embed = new AppEmbed('#tsEmbed', {
3101
+ * ... //other embed view config
3102
+ * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
3103
+ * })
3104
+ * ```
3105
+ *
3106
+ * **Note**: This option does not apply to the classic homepage.
3107
+ * To access the updated modular homepage, set
3108
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3109
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3110
+ */
3111
+ hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3112
+ }
3113
+ /**
3114
+ * The configuration object for common Search and Liveboard embeds configs.
3115
+ */
3116
+ export interface SearchLiveboardCommonViewConfig {
3117
+ /**
3118
+ * The list of runtime filters to apply to a search Answer,
3119
+ * visualization, or Liveboard.
3120
+ *
3121
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
3122
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
3123
+ * @example
3124
+ * ```js
3125
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3126
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3127
+ * ... // other embed view config
3128
+ * runtimeFilters: [
3129
+ * {
3130
+ * columnName: 'value',
3131
+ * operator: RuntimeFilterOp.EQ,
3132
+ * values: ['string' | 123 | true],
3133
+ * },
3134
+ * ],
3135
+ * })
3136
+ * ```
3137
+ */
3138
+ runtimeFilters?: RuntimeFilter[];
3139
+ /**
3140
+ * The list of parameter override to apply to a search Answer,
3141
+ * visualization, or Liveboard.
3142
+ *
3143
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
3144
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3145
+ * @example
3146
+ * ```js
3147
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3148
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3149
+ * ... // other embed view config
3150
+ * runtimeParameters: [
3151
+ * {
3152
+ * name: 'value',
3153
+ * value: 'string' | 123 | true,
3154
+ * },
3155
+ * ]
3156
+ * })
3157
+ * ```
3158
+ */
3159
+ runtimeParameters?: RuntimeParameter[];
3160
+ /**
3161
+ * flag to set ContextMenu Trigger to either left or right click.
3162
+ *
3163
+ * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
3164
+ * @example
3165
+ * ```js
3166
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
3167
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3168
+ * ... // other embed view config
3169
+ * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
3170
+ * })
3171
+ * ```
3172
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3012
3173
  */
3013
- usePrerenderedIfAvailable?: boolean;
3174
+ contextMenuTrigger?: ContextMenuTriggerOptions;
3014
3175
  /**
3015
3176
  * Boolean to exclude runtimeFilters in the URL
3016
3177
  * By default it is true, this flag removes runtime filters from the URL
@@ -3023,241 +3184,230 @@ export interface ViewConfig {
3023
3184
  */
3024
3185
  excludeRuntimeFiltersfromURL?: boolean;
3025
3186
  /**
3026
- * The list of tab IDs to hide from the embedded.
3027
- * This Tabs will be hidden from their respective LBs.
3028
- * Use this to hide an tabID.
3029
- * @example
3030
- * ```js
3031
- * const embed = new LiveboardEmbed('#embed', {
3032
- * ... // other liveboard view config
3033
- * hiddenTabs: [
3034
- * '430496d6-6903-4601-937e-2c691821af3c',
3035
- * 'f547ec54-2a37-4516-a222-2b06719af726']
3036
- * });
3037
- * ```
3038
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3187
+ * Boolean to exclude runtimeParameters from the URL
3188
+ * when set to true, this flag removes runtime parameters from the URL.
3189
+ *
3190
+ * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
3191
+ * embedded view.
3192
+ * @default false
3193
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
3039
3194
  */
3040
- hiddenTabs?: string[];
3195
+ excludeRuntimeParametersfromURL?: boolean;
3041
3196
  /**
3042
- * Hide the home page modules
3043
- * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
3197
+ * To set the initial state of the search bar in case of saved Answers.
3044
3198
  *
3045
- * **Note**: This option does not apply to the classic homepage.
3046
- * To access the updated modular homepage, set
3047
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3048
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3199
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
3200
+ * @default true
3201
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3049
3202
  * @example
3050
3203
  * ```js
3051
- * const embed = new AppEmbed('#tsEmbed', {
3052
- * ... // other options
3053
- * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
3054
- * })
3055
- * ```
3204
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
3205
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3206
+ * ... // other embed view config
3207
+ * collapseSearchBar: true,
3208
+ * });
3056
3209
  */
3057
- hiddenHomepageModules?: HomepageModule[];
3210
+ collapseSearchBar?: boolean;
3058
3211
  /**
3059
- * reordering the home page modules
3060
- * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
3212
+ * Flag to control Data panel experience
3061
3213
  *
3062
- * **Note**: This option does not apply to the classic homepage.
3063
- * To access the updated modular homepage, set
3064
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3065
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3214
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3215
+ * @default false
3216
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3066
3217
  * @example
3067
3218
  * ```js
3068
- * const embed = new AppEmbed('#tsEmbed', {
3069
- * ... // other options
3070
- * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
3219
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
3220
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3221
+ * ... // other embed view config
3222
+ * dataPanelV2: true,
3071
3223
  * })
3072
3224
  * ```
3073
3225
  */
3074
- reorderedHomepageModules?: HomepageModule[];
3226
+ dataPanelV2?: boolean;
3075
3227
  /**
3076
- * The list of tab IDs to show in the embedded Liveboard.
3077
- * Only the tabs specified in the array will be shown in the Liveboard.
3228
+ * To enable custom column groups in data panel v2
3078
3229
  *
3079
- * Use either `visibleTabs` or `hiddenTabs`.
3080
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3230
+ * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3231
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3232
+ * @default false
3081
3233
  * @example
3082
3234
  * ```js
3083
- * const embed = new LiveboardEmbed('#embed-container', {
3084
- * ... // other options
3085
- * visibleTabs: [
3086
- * '430496d6-6903-4601-937e-2c691821af3c',
3087
- * 'f547ec54-2a37-4516-a222-2b06719af726'
3088
- * ]
3089
- * })
3235
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
3236
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3237
+ * ... // other embed view config
3238
+ * enableCustomColumnGroups: true,
3239
+ * });
3090
3240
  * ```
3091
3241
  */
3092
- visibleTabs?: string[];
3242
+ enableCustomColumnGroups?: boolean;
3243
+ }
3244
+ /**
3245
+ * The configuration object for common Liveboard and App embeds configs.
3246
+ */
3247
+ export interface LiveboardAppEmbedViewConfig {
3093
3248
  /**
3094
- * homepageLeftNavItems : Show or hide the left navigation bar items.
3095
- * There are 8 eight home navigation list items.
3096
- * To hide these items, specify the string in the array.
3249
+ * Show or hide Liveboard header
3250
+ *
3251
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3252
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3253
+ * @default false
3097
3254
  * @example
3098
3255
  * ```js
3099
- * const embed = new AppEmbed('#tsEmbed', {
3100
- * ... // other options
3101
- * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
3256
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3257
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3258
+ * ... // other embed view config
3259
+ * hideLiveboardHeader : true,
3102
3260
  * })
3103
3261
  * ```
3104
- *
3105
- * **Note**: This option does not apply to the classic homepage.
3106
- * To access the updated modular homepage, set
3107
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3108
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3109
3262
  */
3110
- hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3263
+ hideLiveboardHeader?: boolean;
3111
3264
  /**
3112
- * PreRender id to be used for PreRendering the embed.
3113
- * Use PreRender to render the embed in the background and then
3114
- * show or hide the rendered embed using showPreRender or hidePreRender respectively.
3265
+ * Show or hide Liveboard title
3266
+ *
3267
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3268
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3269
+ * @default false
3115
3270
  * @example
3116
3271
  * ```js
3117
- * const embed = new LiveboardEmbed('#embed', {
3118
- * ... // other liveboard view config
3119
- * preRenderId: "preRenderId-123"
3120
- * });
3121
- * embed.showPreRender();
3272
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3273
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3274
+ * ... // other embed view config
3275
+ * showLiveboardTitle:true,
3276
+ * })
3122
3277
  * ```
3123
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
3124
3278
  */
3125
- preRenderId?: string;
3279
+ showLiveboardTitle?: boolean;
3126
3280
  /**
3127
- * Determines if the PreRender component should dynamically track the size
3128
- * of its embedding element and adjust its own size accordingly.
3129
- * Enabling this option allows the PreRender component to automatically adapt
3130
- * its dimensions based on changes to the size of the embedding element.
3131
- * @type {boolean}
3281
+ * Show or hide Liveboard description
3282
+ *
3283
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3284
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3132
3285
  * @default false
3133
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
3134
3286
  * @example
3135
3287
  * ```js
3136
- * // Disable tracking PreRender size in the configuration
3137
- * const config = {
3138
- * doNotTrackPreRenderSize: true,
3139
- * };
3140
- *
3141
- * // Instantiate an object with the configuration
3142
- * const myComponent = new MyComponent(config);
3288
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3289
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3290
+ * ... // other embed view config
3291
+ * showLiveboardDescription:true,
3292
+ * })
3143
3293
  * ```
3144
3294
  */
3145
- doNotTrackPreRenderSize?: boolean;
3146
- /**
3147
- * For internal tracking of the embed component type.
3148
- * @hidden
3149
- */
3150
- embedComponentType?: string;
3295
+ showLiveboardDescription?: boolean;
3151
3296
  /**
3152
- * Boolean to exclude runtimeParameters from the URL
3153
- * when set to true, this flag removes runtime parameters from the URL.
3297
+ * Boolean to control if Liveboard header is sticky or not.
3154
3298
  *
3155
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
3156
- * embedded view.
3157
- * @default false
3158
- * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
3159
- */
3160
- excludeRuntimeParametersfromURL?: boolean;
3161
- /**
3162
- * Enable the V2 shell. This can provide performance benefits
3163
- * due to a lighterweight shell.
3299
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3164
3300
  * @example
3165
3301
  * ```js
3166
- * const embed = new LiveboardEmbed('#embed', {
3167
- * liveboardId: '123',
3168
- * enableV2Shell_experimental: true
3302
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3303
+ * const embed = new <EmbedComponent>('#embed', {
3304
+ * ... // other app view config
3305
+ * isLiveboardHeaderSticky: true,
3169
3306
  * });
3170
3307
  * ```
3171
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
3308
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3172
3309
  */
3173
- enableV2Shell_experimental?: boolean;
3310
+ isLiveboardHeaderSticky?: boolean;
3174
3311
  /**
3175
- * To set the initial state of the search bar in case of saved Answers.
3176
- * @default true
3177
- * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3312
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
3313
+ *
3314
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3315
+ * @type {boolean}
3316
+ * @default false
3317
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
3178
3318
  * @example
3179
3319
  * ```js
3180
- * const embed = new LiveboardEmbed('#embed', {
3181
- * liveboardId: '123',
3182
- * collapseSearchBar: true
3183
- * });
3320
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3321
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3322
+ * ... // other embed view config
3323
+ * enable2ColumnLayout: true,
3324
+ * })
3325
+ * ```
3184
3326
  */
3185
- collapseSearchBar?: boolean;
3327
+ enable2ColumnLayout?: boolean;
3186
3328
  /**
3187
- * This flag can be used to expose translation IDs on the embedded app.
3329
+ * This flag can be used to enable the compact header in Liveboard
3330
+ *
3331
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3332
+ * @type {boolean}
3188
3333
  * @default false
3189
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3190
- */
3191
- exposeTranslationIDs?: boolean;
3192
- /**
3193
- * This flag can be used to disable links inside the embedded app,
3194
- * and disable redirection of links in a new tab.
3334
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
3195
3335
  * @example
3196
3336
  * ```js
3197
- * const embed = new LiveboardEmbed('#embed', {
3198
- * disableRedirectionLinksInNewTab: true
3199
- * });
3337
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3338
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3339
+ * ... // other embed view config
3340
+ * isLiveboardCompactHeaderEnabled: true,
3341
+ * })
3200
3342
  * ```
3201
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
3202
3343
  */
3203
- disableRedirectionLinksInNewTab?: boolean;
3344
+ isLiveboardCompactHeaderEnabled?: boolean;
3204
3345
  /**
3205
- * Flag to control Data panel experience
3206
- * @default false
3207
- * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3346
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
3347
+ *
3348
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3349
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
3350
+ * @default true
3208
3351
  * @example
3209
3352
  * ```js
3210
- * const embed = new AppEmbed('#tsEmbed', {
3211
- * ... // other options
3212
- * dataPanelV2: true,
3353
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3354
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3355
+ * ... // other embed view config
3356
+ * showLiveboardVerifiedBadge: true,
3213
3357
  * })
3214
3358
  * ```
3215
3359
  */
3216
- dataPanelV2?: boolean;
3360
+ showLiveboardVerifiedBadge?: boolean;
3217
3361
  /**
3218
- * To enable custom column groups in data panel v2
3219
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3362
+ * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
3363
+ *
3364
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3365
+ * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
3220
3366
  * @default false
3221
3367
  * @example
3222
3368
  * ```js
3223
- * const embed = new SearchEmbed('#tsEmbed', {
3224
- * ... // other options
3225
- * enableCustomColumnGroups: true,
3226
- * });
3369
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3370
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3371
+ * ... // other embed view config
3372
+ * hideIrrelevantChipsInLiveboardTabs: true,
3373
+ * })
3227
3374
  * ```
3228
3375
  */
3229
- enableCustomColumnGroups?: boolean;
3376
+ hideIrrelevantChipsInLiveboardTabs?: boolean;
3230
3377
  /**
3231
- * Overrides an Org context for embedding application users.
3232
- * This parameter allows a user authenticated to one Org to view the
3233
- * objects from another Org.
3234
- * The `overrideOrgId` setting is honoured only if the
3235
- * Per Org URL feature is enabled on your ThoughtSpot instance.
3378
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
3379
+ *
3380
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3381
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
3382
+ * @default true
3236
3383
  * @example
3237
3384
  * ```js
3238
- * const embed = new LiveboardEmbed('#embed', {
3239
- * ... // other options
3240
- * overrideOrgId: 142536
3241
- * });
3385
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3386
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3387
+ * ... // other embed view config
3388
+ * showLiveboardReverifyBanner: true,
3389
+ * })
3242
3390
  * ```
3243
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3244
3391
  */
3245
- overrideOrgId?: number;
3392
+ showLiveboardReverifyBanner?: boolean;
3246
3393
  /**
3247
- * Hide list page columns
3248
- * For example: hiddenListColumns = [ListPageColumns.Author]
3394
+ * enable or disable ask sage
3249
3395
  *
3250
- * **Note**: This option is available only in full app embedding.
3251
- * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3396
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3397
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
3398
+ * @default false
3252
3399
  * @example
3253
3400
  * ```js
3254
- * const embed = new AppEmbed('#tsEmbed', {
3255
- * ... // other options
3256
- * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3401
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed
3402
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3403
+ * ... // other embed view config
3404
+ * enableAskSage:true,
3257
3405
  * })
3258
3406
  * ```
3259
3407
  */
3260
- hiddenListColumns?: ListPageColumns[];
3408
+ enableAskSage?: boolean;
3409
+ }
3410
+ export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
3261
3411
  }
3262
3412
  /**
3263
3413
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3650,7 +3800,7 @@ export enum EmbedEvent {
3650
3800
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
3651
3801
  * @example
3652
3802
  * ```js
3653
- * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
3803
+ * LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
3654
3804
  * console.log('VizPointDoubleClick', payload);
3655
3805
  * })
3656
3806
  * ```
@@ -4509,7 +4659,13 @@ export enum EmbedEvent {
4509
4659
  * Emitted when a user creates a Model.
4510
4660
  * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
4511
4661
  */
4512
- CreateModel = "createModel"
4662
+ CreateModel = "createModel",
4663
+ /**
4664
+ * @hidden
4665
+ * Emitted when a user exits present mode.
4666
+ * @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
4667
+ */
4668
+ ExitPresentMode = "exitPresentMode"
4513
4669
  }
4514
4670
  /**
4515
4671
  * Event types that can be triggered by the host application
@@ -5581,7 +5737,17 @@ export enum HostEvent {
5581
5737
  * ```
5582
5738
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5583
5739
  */
5584
- TransformTableVizData = "TransformTableVizData"
5740
+ TransformTableVizData = "TransformTableVizData",
5741
+ /**
5742
+ * @hidden
5743
+ * Trigger exit from presentation mode when user exits fullscreen.
5744
+ * This is automatically triggered by the SDK when fullscreen mode is exited.
5745
+ * ```js
5746
+ * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
5747
+ *```
5748
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5749
+ */
5750
+ ExitPresentMode = "exitPresentMode"
5585
5751
  }
5586
5752
  /**
5587
5753
  * The different visual modes that the data sources panel within
@@ -5713,7 +5879,8 @@ export enum Param {
5713
5879
  ShowSpotterLimitations = "showSpotterLimitations",
5714
5880
  CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5715
5881
  PrimaryAction = "primaryAction",
5716
- isSpotterAgentEmbed = "isSpotterAgentEmbed"
5882
+ isSpotterAgentEmbed = "isSpotterAgentEmbed",
5883
+ IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
5717
5884
  }
5718
5885
  /**
5719
5886
  * ThoughtSpot application pages include actions and menu commands
@@ -5724,8 +5891,8 @@ export enum Param {
5724
5891
  * or `hiddenActions` array.
5725
5892
  * @example
5726
5893
  * ```js
5727
- * const embed = new LiveboardEmbed('#embed-container', {
5728
- * ... // other options
5894
+ * const embed = new LiveboardEmbed('#tsEmbed', {
5895
+ * ... //other embed view config
5729
5896
  * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
5730
5897
  * disabledActions: [Action.Download],
5731
5898
  * //hiddenActions: [], // Set either this or visibleActions
@@ -5733,8 +5900,8 @@ export enum Param {
5733
5900
  * ```
5734
5901
  * @example
5735
5902
  * ```js
5736
- * const embed = new LiveboardEmbed('#embed-container', {
5737
- * ... // other options
5903
+ * const embed = new LiveboardEmbed('#tsEmbed', {
5904
+ * ... //other embed view config
5738
5905
  * //visibleActions: [],
5739
5906
  * disabledActions: [Action.Download],
5740
5907
  * hiddenActions: [Action.Edit, ActionAction.Explore],
@@ -7006,7 +7173,7 @@ export enum LogLevel {
7006
7173
  * @example
7007
7174
  * ```js
7008
7175
  * init({
7009
- * ... // other options,
7176
+ * ... //other embed view config,
7010
7177
  * logLevel: LogLevel.SILENT,
7011
7178
  * })
7012
7179
  * ```
@@ -7018,7 +7185,7 @@ export enum LogLevel {
7018
7185
  * @example
7019
7186
  * ```js
7020
7187
  * init({
7021
- * ... // other options,
7188
+ * ... //other embed view config,
7022
7189
  * logLevel: LogLevel.ERROR,
7023
7190
  * })
7024
7191
  * ```
@@ -7030,7 +7197,7 @@ export enum LogLevel {
7030
7197
  * @example
7031
7198
  * ```js
7032
7199
  * init({
7033
- * ... // other options,
7200
+ * ... //other embed view config,
7034
7201
  * logLevel: LogLevel.WARN,
7035
7202
  * })
7036
7203
  * ```
@@ -7043,7 +7210,7 @@ export enum LogLevel {
7043
7210
  * @example
7044
7211
  * ```js
7045
7212
  * init({
7046
- * ... // other options,
7213
+ * ... //other embed view config,
7047
7214
  * logLevel: LogLevel.INFO,
7048
7215
  * })
7049
7216
  * ```
@@ -7056,7 +7223,7 @@ export enum LogLevel {
7056
7223
  * @example
7057
7224
  * ```js
7058
7225
  * init({
7059
- * ... // other options,
7226
+ * ... //other embed view config,
7060
7227
  * logLevel: LogLevel.DEBUG,
7061
7228
  * })
7062
7229
  * ```
@@ -7068,7 +7235,7 @@ export enum LogLevel {
7068
7235
  * @example
7069
7236
  * ```js
7070
7237
  * init({
7071
- * ... // other options,
7238
+ * ... //other embed view config,
7072
7239
  * logLevel: LogLevel.TRACE,
7073
7240
  * })
7074
7241
  * ```
@@ -7508,9 +7675,11 @@ export interface SearchOptions {
7508
7675
  * The configuration attributes for the embedded Natural language search view. Based on
7509
7676
  * GPT and LLM.
7510
7677
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
7678
+ *
7679
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
7511
7680
  * @group Embed components
7512
7681
  */
7513
- export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
7682
+ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction' | 'runtimeFilters' | 'runtimeParameters' | 'excludeRuntimeFiltersfromURL' | 'excludeRuntimeParametersfromURL'> {
7514
7683
  /**
7515
7684
  * If set to true, a list of Liveboard and Answers related
7516
7685
  * to the natural language search will be shown below the
@@ -7568,7 +7737,16 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
7568
7737
  * Show or hide sample questions.
7569
7738
  * The sample questions are autogenerated based on the worksheet
7570
7739
  * selected for the search operation.
7740
+ *
7741
+ * Supported embed types: `SageEmbed`
7571
7742
  * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
7743
+ * @example
7744
+ * ```js
7745
+ * const embed = new SageEmbed('#tsEmbed', {
7746
+ * ... //other embed view config
7747
+ * hideSampleQuestions : true,
7748
+ * })
7749
+ * ```
7572
7750
  */
7573
7751
  hideSampleQuestions?: boolean;
7574
7752
  /**
@@ -7585,6 +7763,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
7585
7763
  * If it is executed, the focus is placed on the results.
7586
7764
  * If it’s not executed, the focus is placed at the end of
7587
7765
  * the token string in the search bar.
7766
+ *
7767
+ * Supported embed types: `SageEmbed`
7588
7768
  * @example
7589
7769
  * ```js
7590
7770
  * searchOptions: {
@@ -7599,6 +7779,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
7599
7779
  /**
7600
7780
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
7601
7781
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
7782
+ *
7783
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
7602
7784
  * @group Embed components
7603
7785
  */
7604
7786
  export class SageEmbed extends V1Embed {
@@ -7651,12 +7833,13 @@ export interface UnderlyingDataPoint {
7651
7833
  * directly from your application.
7652
7834
  *
7653
7835
  * You can use this service to:
7836
+ *
7654
7837
  * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
7655
7838
  * - Apply filters to Answers (`addFilter`)
7656
7839
  * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
7657
7840
  * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
7658
7841
  * - Run custom queries (`executeQuery`)
7659
- * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
7842
+ * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
7660
7843
  *
7661
7844
  * @example
7662
7845
  * ```js
@@ -8056,7 +8239,11 @@ export class TsEmbed {
8056
8239
  * @param {HTMLIFrameElement} iFrame HTMLIFrameElement
8057
8240
  */
8058
8241
  protected setIframeElement(iFrame: HTMLIFrameElement): void;
8059
- protected viewConfig: ViewConfig;
8242
+ protected viewConfig: ViewConfig & {
8243
+ visibleTabs?: string[];
8244
+ hiddenTabs?: string[];
8245
+ showAlerts?: boolean;
8246
+ };
8060
8247
  protected embedConfig: EmbedConfig;
8061
8248
  /**
8062
8249
  * The ThoughtSpot hostname or IP address