@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
@@ -217,7 +217,7 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
217
217
  export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & React.RefAttributes<_SpotterEmbed>>;
218
218
  /**
219
219
  * React component for LLM based conversation BI.
220
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
220
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
221
221
  * Use {@link SpotterEmbed} instead
222
222
  * @example
223
223
  * ```tsx
@@ -320,7 +320,7 @@ export function useInit(config: EmbedConfig): React.MutableRefObject<AuthEventEm
320
320
  * @summary ThoughtSpot Visual Embed SDK
321
321
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
322
322
  */
323
- 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, };
323
+ 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, };
324
324
 
325
325
  export declare let loggedInStatus: boolean;
326
326
  export declare let samlAuthWindow: Window;
@@ -505,16 +505,18 @@ export declare const isAuthenticated: () => boolean;
505
505
  /**
506
506
  * @group Embed components
507
507
  */
508
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
508
+ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig {
509
509
  /**
510
510
  * The array of data source GUIDs to set on load.
511
511
  * Only a single data source is supported currently.
512
+ *
513
+ * Supported embed types: `SearchBarEmbed`
512
514
  * @deprecated Use `dataSource` instead
513
515
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
514
516
  * @example
515
517
  * ```js
516
518
  * const embed = new SearchBarEmbed('#tsEmbed', {
517
- * ... // other options
519
+ * ... //other embed view config
518
520
  * dataSources:['id-2345','id-2345'],
519
521
  * })
520
522
  * ```
@@ -522,11 +524,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
522
524
  dataSources?: string[];
523
525
  /**
524
526
  * Pass the ID of the source to be selected.
527
+ *
528
+ * Supported embed types: `SearchBarEmbed`
525
529
  * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
526
530
  * @example
527
531
  * ```js
528
532
  * const embed = new SearchBarEmbed('#tsEmbed', {
529
- * ... // other options
533
+ * ... //other embed view config
530
534
  * dataSource:'id-2345',
531
535
  * })
532
536
  * ```
@@ -534,11 +538,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
534
538
  dataSource?: string;
535
539
  /**
536
540
  * Boolean to define if the last selected data source should be used
541
+ *
542
+ * Supported embed types: `SearchBarEmbed`
537
543
  * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
538
544
  * @example
539
545
  * ```js
540
546
  * const embed = new SearchBarEmbed('#tsEmbed', {
541
- * ... // other options
547
+ * ... //other embed view config
542
548
  * useLastSelectedSources:false,
543
549
  * })
544
550
  * ```
@@ -554,11 +560,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
554
560
  * If it is executed, the focus is placed on the results.
555
561
  * If it’s not executed, the focus is placed at the end of
556
562
  * the token string in the search bar.
563
+ *
564
+ * Supported embed types: `SearchBarEmbed`
557
565
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
558
566
  * @example
559
567
  * ```js
560
568
  * const embed = new SearchBarEmbed('#tsEmbed', {
561
- * ... // other options
569
+ * ... //other embed view config
562
570
  * searchOptions: {
563
571
  * searchTokenString: '[quantity purchased] [region]',
564
572
  * executeSearch: true,
@@ -570,6 +578,8 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
570
578
  /**
571
579
  * Exclude the search token string from the URL.
572
580
  * If set to true, the search token string is not appended to the URL.
581
+ *
582
+ * Supported embed types: `SearchBarEmbed`
573
583
  * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
574
584
  * @example
575
585
  * ```js
@@ -636,9 +646,11 @@ export interface SearchOptions {
636
646
  * The configuration attributes for the embedded Natural language search view. Based on
637
647
  * GPT and LLM.
638
648
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
649
+ *
650
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
639
651
  * @group Embed components
640
652
  */
641
- export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
653
+ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction' | 'runtimeFilters' | 'runtimeParameters' | 'excludeRuntimeFiltersfromURL' | 'excludeRuntimeParametersfromURL'> {
642
654
  /**
643
655
  * If set to true, a list of Liveboard and Answers related
644
656
  * to the natural language search will be shown below the
@@ -696,7 +708,16 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
696
708
  * Show or hide sample questions.
697
709
  * The sample questions are autogenerated based on the worksheet
698
710
  * selected for the search operation.
711
+ *
712
+ * Supported embed types: `SageEmbed`
699
713
  * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
714
+ * @example
715
+ * ```js
716
+ * const embed = new SageEmbed('#tsEmbed', {
717
+ * ... //other embed view config
718
+ * hideSampleQuestions : true,
719
+ * })
720
+ * ```
700
721
  */
701
722
  hideSampleQuestions?: boolean;
702
723
  /**
@@ -713,6 +734,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
713
734
  * If it is executed, the focus is placed on the results.
714
735
  * If it’s not executed, the focus is placed at the end of
715
736
  * the token string in the search bar.
737
+ *
738
+ * Supported embed types: `SageEmbed`
716
739
  * @example
717
740
  * ```js
718
741
  * searchOptions: {
@@ -727,6 +750,8 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
727
750
  /**
728
751
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
729
752
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
753
+ *
754
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
730
755
  * @group Embed components
731
756
  */
732
757
  export declare class SageEmbed extends V1Embed {
@@ -801,15 +826,17 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
801
826
  * The configuration attributes for the embedded search view.
802
827
  * @group Embed components
803
828
  */
804
- export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
829
+ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction'> {
805
830
  /**
806
831
  * If set to true, the data sources panel is collapsed on load,
807
832
  * but can be expanded manually.
833
+ *
834
+ * Supported embed types: `SearchEmbed`
808
835
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
809
836
  * @example
810
837
  * ```js
811
838
  * const embed = new SearchEmbed('#tsEmbed', {
812
- * ... // other options
839
+ * ... // other embed view config
813
840
  * collapseDataSources:true,
814
841
  * })
815
842
  * ```
@@ -818,11 +845,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
818
845
  /**
819
846
  * If set to true, the data panel is collapsed on load,
820
847
  * but can be expanded manually.
848
+ *
849
+ * Supported embed types: `SearchEmbed`
821
850
  * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
822
851
  * @example
823
852
  * ```js
824
853
  * const embed = new SearchEmbed('#tsEmbed', {
825
- * ... // other options
854
+ * ... // other embed view config
826
855
  * collapseDataPanel:true,
827
856
  * })
828
857
  * ```
@@ -830,11 +859,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
830
859
  collapseDataPanel?: boolean;
831
860
  /**
832
861
  * Show or hide the data sources panel.
862
+ *
863
+ * Supported embed types: `SearchEmbed`
833
864
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
834
865
  * @example
835
866
  * ```js
836
867
  * const embed = new SearchEmbed('#tsEmbed', {
837
- * ... // other options
868
+ * ... // other embed view config
838
869
  * hideDataSources:true,
839
870
  * })
840
871
  * ```
@@ -844,11 +875,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
844
875
  * Show or hide the charts and tables in search answers.
845
876
  * This attribute can be used to create a custom visualization
846
877
  * using raw answer data.
878
+ *
879
+ * Supported embed types: `SearchEmbed`
847
880
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
848
881
  * @example
849
882
  * ```js
850
883
  * const embed = new SearchEmbed('#tsEmbed', {
851
- * ... // other options
884
+ * ... // other embed view config
852
885
  * hideResults:true,
853
886
  * })
854
887
  * ```
@@ -856,11 +889,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
856
889
  hideResults?: boolean;
857
890
  /**
858
891
  * If set to true, the Search Assist feature is enabled.
892
+ *
893
+ * Supported embed types: `SearchEmbed`
859
894
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
860
895
  * @example
861
896
  * ```js
862
897
  * const embed = new SearchEmbed('#tsEmbed', {
863
- * ... // other options
898
+ * ... // other embed view config
864
899
  * enableSearchAssist:true,
865
900
  * })
866
901
  * ```
@@ -869,11 +904,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
869
904
  /**
870
905
  * If set to true, the tabular view is set as the default
871
906
  * format for presenting search data.
907
+ *
908
+ * Supported embed types: `SearchEmbed`
872
909
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
873
910
  * @example
874
911
  * ```js
875
912
  * const embed = new SearchEmbed('#tsEmbed', {
876
- * ... // other options
913
+ * ... // other embed view config
877
914
  * forceTable:true,
878
915
  * })
879
916
  */
@@ -882,10 +919,12 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
882
919
  * The array of data source GUIDs to set on load.
883
920
  * Only a single data source is supported currently.
884
921
  * @deprecated Use `dataSource` instead.
922
+ *
923
+ * Supported embed types: `SearchEmbed`
885
924
  * @example
886
925
  * ```js
887
926
  * const embed = new SearchEmbed('#tsEmbed', {
888
- * ... // other options
927
+ * ... // other embed view config
889
928
  * dataSources:['id-234','id-456'],
890
929
  * })
891
930
  * ```
@@ -893,11 +932,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
893
932
  dataSources?: string[];
894
933
  /**
895
934
  * The array of data source GUIDs to set on load.
935
+ *
936
+ * Supported embed types: `SearchEmbed`
896
937
  * @version: SDK: 1.19.0
897
938
  * @example
898
939
  * ```js
899
940
  * const embed = new SearchEmbed('#tsEmbed', {
900
- * ... // other options
941
+ * ... // other embed view config
901
942
  * dataSource:'id-234',
902
943
  * })
903
944
  * ```
@@ -920,6 +961,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
920
961
  * If it is executed, the focus is placed on the results.
921
962
  * If it’s not executed, the focus is placed at the end of
922
963
  * the token string in the search bar.
964
+ *
965
+ * Supported embed types: `SearchEmbed`
923
966
  * @example
924
967
  * ```js
925
968
  * searchOptions: {
@@ -932,6 +975,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
932
975
  /**
933
976
  * Exclude the search token string from the URL.
934
977
  * If set to true, the search token string is not appended to the URL.
978
+ *
979
+ * Supported embed types: `SearchEmbed`
935
980
  * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
936
981
  * @example
937
982
  * ```js
@@ -947,11 +992,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
947
992
  excludeSearchTokenStringFromURL?: boolean;
948
993
  /**
949
994
  * The GUID of a saved answer to load initially.
995
+ *
996
+ * Supported embed types: `SearchEmbed`
950
997
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
951
998
  * @example
952
999
  * ```js
953
1000
  * const embed = new SearchEmbed('#tsEmbed', {
954
- * ... // other options
1001
+ * ... // other embed view config
955
1002
  * answerId:'sed-1234',
956
1003
  * })
957
1004
  * ```
@@ -960,11 +1007,13 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
960
1007
  /**
961
1008
  * If set to true, the search page will render without the Search Bar
962
1009
  * The chart/table should still be visible.
1010
+ *
1011
+ * Supported embed types: `SearchEmbed`
963
1012
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
964
1013
  * @example
965
1014
  * ```js
966
1015
  * const embed = new SearchEmbed('#tsEmbed', {
967
- * ... // other options
1016
+ * ... // other embed view config
968
1017
  * hideSearchBar:true,
969
1018
  * })
970
1019
  * ```
@@ -972,6 +1021,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
972
1021
  hideSearchBar?: boolean;
973
1022
  /**
974
1023
  * Flag to set if last selected dataSource should be used
1024
+ *
1025
+ * Supported embed types: `SearchEmbed`
975
1026
  * @version: SDK: 1.24.0
976
1027
  */
977
1028
  useLastSelectedSources?: boolean;
@@ -984,6 +1035,8 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
984
1035
  collapseSearchBarInitially?: boolean;
985
1036
  /**
986
1037
  * Flag to enable onBeforeSearchExecute Embed Event
1038
+ *
1039
+ * Supported embed types: `SearchEmbed`
987
1040
  * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
988
1041
  */
989
1042
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
@@ -994,12 +1047,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
994
1047
  * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
995
1048
  * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
996
1049
  * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
1050
+ *
1051
+ * Supported embed types: `SearchEmbed`
997
1052
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
998
1053
  * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
999
1054
  * @example
1000
1055
  * ```js
1001
1056
  * const embed = new SearchEmbed('#tsEmbed', {
1002
- * ... // other options
1057
+ * ... // other embed view config
1003
1058
  * dataPanelCustomGroupsAccordionInitialState:
1004
1059
  * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
1005
1060
  * });
@@ -1009,12 +1064,14 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1009
1064
  /**
1010
1065
  * Flag to remove focus from search bar initially when user
1011
1066
  * lands on search embed page.
1067
+ *
1068
+ * Supported embed types: `SearchEmbed`
1012
1069
  * @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
1013
1070
  * @default true
1014
1071
  * @example
1015
1072
  * ```js
1016
1073
  * const embed = new SearchEmbed('#tsEmbed', {
1017
- * ... // other options
1074
+ * ... // other embed view config
1018
1075
  * focusSearchBarOnRender: false,
1019
1076
  * });
1020
1077
  * ```
@@ -1126,7 +1183,7 @@ export declare enum HomePageSearchBarMode {
1126
1183
  }
1127
1184
  /**
1128
1185
  * Define the version of the primary navbar
1129
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1186
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1130
1187
  */
1131
1188
  export declare enum PrimaryNavbarVersion {
1132
1189
  /**
@@ -1138,7 +1195,7 @@ export declare enum PrimaryNavbarVersion {
1138
1195
  }
1139
1196
  /**
1140
1197
  * Define the version of the home page
1141
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1198
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1142
1199
  */
1143
1200
  export declare enum HomePage {
1144
1201
  /**
@@ -1149,7 +1206,7 @@ export declare enum HomePage {
1149
1206
  }
1150
1207
  /**
1151
1208
  * Define the discovery experience
1152
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1209
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1153
1210
  */
1154
1211
  export interface DiscoveryExperience {
1155
1212
  /**
@@ -1165,17 +1222,19 @@ export interface DiscoveryExperience {
1165
1222
  * The view configuration for full app embedding.
1166
1223
  * @group Embed components
1167
1224
  */
1168
- export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1225
+ export interface AppViewConfig extends AllEmbedViewConfig {
1169
1226
  /**
1170
1227
  * If true, the top navigation bar within the ThoughtSpot app
1171
1228
  * is displayed. By default, the navigation bar is hidden.
1172
1229
  * This flag also controls the homepage left navigation bar.
1230
+ *
1231
+ * Supported embed types: `AppEmbed`
1173
1232
  * @default true
1174
1233
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
1175
1234
  * @example
1176
1235
  * ```js
1177
1236
  * const embed = new AppEmbed('#tsEmbed', {
1178
- * ... // other options
1237
+ * ... // other embed view config
1179
1238
  * showPrimaryNavbar:true,
1180
1239
  * })
1181
1240
  * ```
@@ -1190,12 +1249,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1190
1249
  * **Note**: This option does not apply to the classic homepage.
1191
1250
  * To access the updated modular homepage, set
1192
1251
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1252
+ *
1253
+ * Supported embed types: `AppEmbed`
1193
1254
  * @default false
1194
1255
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
1195
1256
  * @example
1196
1257
  * ```js
1197
1258
  * const embed = new AppEmbed('#tsEmbed', {
1198
- * ... // other options
1259
+ * ... // other embed view config
1199
1260
  * hideHomepageLeftNav : true,
1200
1261
  * })
1201
1262
  * ```
@@ -1204,12 +1265,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1204
1265
  /**
1205
1266
  * Control the visibility of the help (?) and profile buttons on the
1206
1267
  * Global nav-bar. By default, these buttons are visible on the nav-bar.
1268
+ *
1269
+ * Supported embed types: `AppEmbed`
1207
1270
  * @default false
1208
1271
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
1209
1272
  * @example
1210
1273
  * ```js
1211
1274
  * const embed = new AppEmbed('#tsEmbed', {
1212
- * ... // other options
1275
+ * ... // other embed view config
1213
1276
  * disableProfileAndHelp: true,
1214
1277
  * })
1215
1278
  * ```
@@ -1220,10 +1283,12 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1220
1283
  * @default true
1221
1284
  * Whether the help menu in the top nav bar should be served
1222
1285
  * from Pendo or ThoughtSpot's internal help items.
1286
+ *
1287
+ * Supported embed types: `AppEmbed`
1223
1288
  * @example
1224
1289
  * ```js
1225
1290
  * const embed = new AppEmbed('#tsEmbed', {
1226
- * ... // other options
1291
+ * ... // other embed view config
1227
1292
  * enablePendoHelp: false,
1228
1293
  * });
1229
1294
  * ```
@@ -1233,12 +1298,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1233
1298
  * Control the visibility of the hamburger icon on the top nav bar
1234
1299
  * available when new navigation V3 is enabled.
1235
1300
  *
1301
+ * Supported embed types: `AppEmbed`
1236
1302
  * @default false
1237
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1303
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1238
1304
  * @example
1239
1305
  * ```js
1240
1306
  * const embed = new AppEmbed('#tsEmbed', {
1241
- * ... // other options
1307
+ * ... // other embed view config
1242
1308
  * hideHamburger : true,
1243
1309
  * })
1244
1310
  * ```
@@ -1248,12 +1314,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1248
1314
  * Control the visibility of the Eureka search on the top nav bar
1249
1315
  * this will control for both new V2 and new navigation V3.
1250
1316
  *
1317
+ * Supported embed types: `AppEmbed`
1251
1318
  * @default true
1252
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1319
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1253
1320
  * @example
1254
1321
  * ```js
1255
1322
  * const embed = new AppEmbed('#tsEmbed', {
1256
- * ... // other options
1323
+ * ... // other embed view config
1257
1324
  * hideObjectSearch: false,
1258
1325
  * })
1259
1326
  * ```
@@ -1263,12 +1330,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1263
1330
  * Control the visibility of the notification on the top nav bar V3,
1264
1331
  * available when new navigation V3 is enabled.
1265
1332
  *
1333
+ * Supported embed types: `AppEmbed`
1266
1334
  * @default true
1267
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1335
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1268
1336
  * @example
1269
1337
  * ```js
1270
1338
  * const embed = new AppEmbed('#tsEmbed', {
1271
- * ... // other options
1339
+ * ... // other embed view config
1272
1340
  * hideNotification: false,
1273
1341
  * })
1274
1342
  * ```
@@ -1281,12 +1349,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1281
1349
  * **Note**: This option does not apply to the classic homepage.
1282
1350
  * To access the updated modular homepage, set
1283
1351
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1352
+ *
1353
+ * Supported embed types: `AppEmbed`
1284
1354
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
1285
1355
  * @default false
1286
1356
  * @example
1287
1357
  * ```js
1288
1358
  * const embed = new AppEmbed('#tsEmbed', {
1289
- * ... // other options
1359
+ * ... // other embed view config
1290
1360
  * hideApplicationSwitcher : true,
1291
1361
  * })
1292
1362
  * ```
@@ -1299,12 +1369,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1299
1369
  * **Note**: This option does not apply to the classic homepage.
1300
1370
  * To access the updated modular homepage, set
1301
1371
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1372
+ *
1373
+ * Supported embed types: `AppEmbed`
1302
1374
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
1303
1375
  * @default true
1304
1376
  * @example
1305
1377
  * ```js
1306
1378
  * const embed = new AppEmbed('#tsEmbed', {
1307
- * ... // other options
1379
+ * ... // other embed view config
1308
1380
  * hideOrgSwitcher : true,
1309
1381
  * })
1310
1382
  * ```
@@ -1318,12 +1390,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1318
1390
  *
1319
1391
  * For eg, if you want the component to open to a specific Liveboard
1320
1392
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
1393
+ *
1394
+ * Supported embed types: `AppEmbed`
1321
1395
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
1322
1396
  * @example
1323
1397
  * ```js
1324
1398
  * const embed = new AppEmbed('#tsEmbed', {
1325
- * ... // other options
1326
- * path:"pinboard/1234/tab/7464"
1399
+ * ... // other embed view config
1400
+ * path:"pinboard/1234/tab/7464",
1327
1401
  * })
1328
1402
  * ```
1329
1403
  */
@@ -1334,12 +1408,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1334
1408
  *
1335
1409
  * Use this to open to particular page in the app. To open to a specific
1336
1410
  * path within the app, use the `path` attribute which is more flexible.
1411
+ *
1412
+ * Supported embed types: `AppEmbed`
1337
1413
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
1338
1414
  * @example
1339
1415
  * ```js
1340
1416
  * const embed = new AppEmbed('#tsEmbed', {
1341
- * ... // other options
1342
- * pageId : Page.Answers | Page.Data
1417
+ * ... // other embed view config
1418
+ * pageId : Page.Answers | Page.Data,
1343
1419
  * })
1344
1420
  * ```
1345
1421
  */
@@ -1348,11 +1424,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1348
1424
  * This puts a filter tag on the application. All metadata lists in the
1349
1425
  * application, such as Liveboards and answers, would be filtered by this
1350
1426
  * tag.
1427
+ *
1428
+ * Supported embed types: `AppEmbed`
1351
1429
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
1352
1430
  * @example
1353
1431
  * ```js
1354
1432
  * const embed = new AppEmbed('#tsEmbed', {
1355
- * ... // other options
1433
+ * ... // other embed view config
1356
1434
  * tag:'value',
1357
1435
  * })
1358
1436
  * ```
@@ -1360,11 +1438,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1360
1438
  tag?: string;
1361
1439
  /**
1362
1440
  * The array of GUIDs to be hidden
1441
+ *
1442
+ * Supported embed types: `AppEmbed`
1363
1443
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1364
1444
  * @example
1365
1445
  * ```js
1366
1446
  * const embed = new AppEmbed('#tsEmbed', {
1367
- * ... // other options
1447
+ * ... // other embed view config
1368
1448
  * hideObjects: [
1369
1449
  * '430496d6-6903-4601-937e-2c691821af3c',
1370
1450
  * 'f547ec54-2a37-4516-a222-2b06719af726'
@@ -1376,18 +1456,22 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1376
1456
  /**
1377
1457
  * Render liveboards using the new v2 rendering mode
1378
1458
  * This is a transient flag which is primarily meant for internal use
1459
+ *
1460
+ * Supported embed types: `AppEmbed`
1379
1461
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
1380
1462
  * @hidden
1381
1463
  */
1382
1464
  liveboardV2?: boolean;
1383
1465
  /**
1384
1466
  * If set to true, the Search Assist feature is enabled.
1467
+ *
1468
+ * Supported embed types: `AppEmbed`
1385
1469
  * @default true
1386
1470
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1387
1471
  * @example
1388
1472
  * ```js
1389
1473
  * const embed = new AppEmbed('#tsEmbed', {
1390
- * ... // other options
1474
+ * ... // other embed view config
1391
1475
  * enableSearchAssist: true,
1392
1476
  * })
1393
1477
  * ```
@@ -1405,63 +1489,27 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1405
1489
  * `false` fetches visualizations incrementally as
1406
1490
  * users scroll the page to view the charts and tables.
1407
1491
  *
1492
+ * Supported embed types: `AppEmbed`
1408
1493
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
1409
1494
  * @example
1410
1495
  * ```js
1411
1496
  * const embed = new AppEmbed('#tsEmbed', {
1412
- * ... // other options
1497
+ * ... // other embed view config
1413
1498
  * fullHeight: true,
1414
1499
  * })
1415
1500
  * ```
1416
1501
  */
1417
1502
  fullHeight?: boolean;
1418
- /**
1419
- * Show or hide Liveboard header
1420
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1421
- * @default false
1422
- * @example
1423
- * ```js
1424
- * const embed = new AppEmbed('#tsEmbed', {
1425
- * ... // other options
1426
- * hideLiveboardHeader : true,
1427
- * })
1428
- * ```
1429
- */
1430
- hideLiveboardHeader?: boolean;
1431
- /**
1432
- * Show or hide Liveboard title
1433
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1434
- * @default false
1435
- * @example
1436
- * ```js
1437
- * const embed = new AppEmbed('#tsEmbed', {
1438
- * ... // other options
1439
- * showLiveboardTitle:true,
1440
- * })
1441
- * ```
1442
- */
1443
- showLiveboardTitle?: boolean;
1444
- /**
1445
- * Show or hide Liveboard description
1446
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1447
- * @default false
1448
- * @example
1449
- * ```js
1450
- * const embed = new AppEmbed('#tsEmbed', {
1451
- * ... // other options
1452
- * showLiveboardDescription:true,
1453
- * })
1454
- * ```
1455
- */
1456
- showLiveboardDescription?: boolean;
1457
1503
  /**
1458
1504
  * Flag to control new Modular Home experience.
1505
+ *
1506
+ * Supported embed types: `AppEmbed`
1459
1507
  * @default false
1460
1508
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
1461
1509
  * @example
1462
1510
  * ```js
1463
1511
  * const embed = new AppEmbed('#tsEmbed', {
1464
- * ... // other options
1512
+ * ... // other embed view config
1465
1513
  * modularHomeExperience : true,
1466
1514
  * })
1467
1515
  * ```
@@ -1470,38 +1518,21 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1470
1518
  /**
1471
1519
  * To configure the top-left navigation and home page experience
1472
1520
  *
1521
+ * Supported embed types: `AppEmbed`
1473
1522
  * @default false
1474
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1523
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1475
1524
  * @example
1476
1525
  * ```js
1477
1526
  * const embed = new AppEmbed('#tsEmbed', {
1478
- * ... // other options
1527
+ * ... // other embed view config
1479
1528
  * discoveryExperience : {
1480
1529
  * primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
1481
- * homePage: HompePage.Modular,
1530
+ * homePage: HomePage.Modular,
1482
1531
  * },
1483
1532
  * })
1484
1533
  * ```
1485
1534
  */
1486
1535
  discoveryExperience?: DiscoveryExperience;
1487
- /**
1488
- * Boolean to control if Liveboard header is sticky or not.
1489
- * @example
1490
- * ```js
1491
- * const embed = new AppEmbed('#embed', {
1492
- * ... // other app view config
1493
- * isLiveboardHeaderSticky: true,
1494
- * });
1495
- * ```
1496
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1497
- */
1498
- isLiveboardHeaderSticky?: boolean;
1499
- /**
1500
- * enable or disable ask sage
1501
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
1502
- * @default false
1503
- */
1504
- enableAskSage?: boolean;
1505
1536
  /**
1506
1537
  * To set the initial state of the search bar in case of saved-answers.
1507
1538
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
@@ -1516,6 +1547,8 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1516
1547
  * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
1517
1548
  * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
1518
1549
  * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
1550
+ *
1551
+ * Supported embed types: `AppEmbed`
1519
1552
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1520
1553
  * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
1521
1554
  * @example
@@ -1528,20 +1561,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1528
1561
  * ```
1529
1562
  */
1530
1563
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
1531
- /**
1532
- * This attribute can be used to enable the two-column layout on an embedded Liveboard
1533
- * @type {boolean}
1534
- * @default false
1535
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1536
- * @example
1537
- * ```js
1538
- * const embed = new LiveboardEmbed('#embed-container', {
1539
- * ... // other options
1540
- * enable2ColumnLayout: true,
1541
- * })
1542
- * ```
1543
- */
1544
- enable2ColumnLayout?: boolean;
1545
1564
  /**
1546
1565
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
1547
1566
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
@@ -1549,79 +1568,57 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1549
1568
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
1550
1569
  /**
1551
1570
  * Flag to use home page search bar mode
1571
+ *
1572
+ * Supported embed types: `AppEmbed`
1552
1573
  * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
1553
1574
  */
1554
1575
  homePageSearchBarMode?: HomePageSearchBarMode;
1555
1576
  /**
1556
- * This flag can be used to enable the compact header in Liveboard
1557
- * @type {boolean}
1558
- * @default false
1559
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1560
- * @example
1561
- * ```js
1562
- * const embed = new AppEmbed('#embed-container', {
1563
- * ... // other options
1564
- * isLiveboardCompactHeaderEnabled: true,
1565
- * })
1566
- * ```
1567
- */
1568
- isLiveboardCompactHeaderEnabled?: boolean;
1569
- /**
1570
- * This flag can be used to show or hide the Liveboard verified icon in the compact header.
1571
- * @type {boolean}
1577
+ * This flag is used to enable unified search experience for full app embed.
1578
+ *
1579
+ * Supported embed types: `AppEmbed`
1580
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
1572
1581
  * @default true
1573
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1574
- * @example
1575
- * ```js
1576
- * const embed = new AppEmbed('#embed-container', {
1577
- * ... // other options
1578
- * showLiveboardVerifiedBadge: true,
1579
- * })
1580
- * ```
1581
- */
1582
- showLiveboardVerifiedBadge?: boolean;
1583
- /**
1584
- * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
1585
- * @type {boolean}
1586
- * @default false
1587
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
1588
1582
  * @example
1589
1583
  * ```js
1590
- * const embed = new AppEmbed('#embed-container', {
1591
- * ... // other options
1592
- * hideIrrelevantChipsInLiveboardTabs: true,
1584
+ * const embed = new AppEmbed('#tsEmbed', {
1585
+ * ... // other embed view config
1586
+ * isUnifiedSearchExperienceEnabled: true,
1593
1587
  * })
1594
1588
  * ```
1595
1589
  */
1596
- hideIrrelevantChipsInLiveboardTabs?: boolean;
1590
+ isUnifiedSearchExperienceEnabled?: boolean;
1597
1591
  /**
1598
- * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
1599
- * @type {boolean}
1600
- * @default true
1601
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1602
- * @example
1603
- * ```js
1604
- * const embed = new AppEmbed('#embed-container', {
1605
- * ... // other options
1606
- * showLiveboardReverifyBanner: true,
1607
- * })
1608
- * ```
1609
- */
1610
- showLiveboardReverifyBanner?: boolean;
1592
+ * Show alert messages and toast messages in the embedded
1593
+ * view in full app embed.
1594
+ *
1595
+ * Supported embed types: `AppEmbed`
1596
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
1597
+ * @example
1598
+ * ```js
1599
+ * const embed = new AppEmbed('#tsEmbed', {
1600
+ * ... // other embed view config
1601
+ * showAlerts:true,
1602
+ * })
1603
+ * ```
1604
+ */
1605
+ showAlerts?: boolean;
1611
1606
  /**
1612
- * This flag is used to enable unified search experience for full app embed.
1607
+ * This flag is used to enable/disable the styling and grouping in a Liveboard
1608
+ *
1609
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
1613
1610
  * @type {boolean}
1614
- * @default true
1615
- * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
1611
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1616
1612
  * @example
1617
1613
  * ```js
1618
- * const embed = new AppEmbed('#embed-container', {
1619
- * ... // other options
1620
- * isUnifiedSearchExperienceEnabled: true,
1614
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
1615
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1616
+ * ... // other embed view config
1617
+ * isLiveboardStylingAndGroupingEnabled: true,
1621
1618
  * })
1622
1619
  * ```
1623
1620
  */
1624
- isUnifiedSearchExperienceEnabled?: boolean;
1621
+ isLiveboardStylingAndGroupingEnabled?: boolean;
1625
1622
  }
1626
1623
  /**
1627
1624
  * Embeds full ThoughtSpot experience in a host application.
@@ -1679,7 +1676,7 @@ export declare class AppEmbed extends V1Embed {
1679
1676
  * The configuration for the embedded Liveboard or visualization page view.
1680
1677
  * @group Embed components
1681
1678
  */
1682
- export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
1679
+ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewConfig, LiveboardAppEmbedViewConfig {
1683
1680
  /**
1684
1681
  * If set to true, the embedded object container dynamically resizes
1685
1682
  * according to the height of the Liveboard.
@@ -1692,6 +1689,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1692
1689
  * incrementally as users scroll the page to view the charts and tables.
1693
1690
  *
1694
1691
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
1692
+ *
1693
+ * Supported embed types: `LiveboardEmbed`
1695
1694
  * @example
1696
1695
  * ```js
1697
1696
  * const embed = new LiveboardEmbed('#embed', {
@@ -1705,6 +1704,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1705
1704
  * This is the minimum height(in pixels) for a full-height Liveboard.
1706
1705
  * Setting this height helps resolve issues with empty Liveboards and
1707
1706
  * other screens navigable from a Liveboard.
1707
+ *
1708
+ * Supported embed types: `LiveboardEmbed`
1708
1709
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
1709
1710
  * @default 500
1710
1711
  * @example
@@ -1722,7 +1723,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1722
1723
  * @example
1723
1724
  * ```js
1724
1725
  * const embed = new LiveboardEmbed('#tsEmbed', {
1725
- * ... // other options
1726
+ * ... //other embed view config
1726
1727
  * enableVizTransformations:true,
1727
1728
  * })
1728
1729
  * ```
@@ -1732,11 +1733,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1732
1733
  /**
1733
1734
  * The Liveboard to display in the embedded view.
1734
1735
  * Use either liveboardId or pinboardId to reference the Liveboard to embed.
1736
+ *
1737
+ * Supported embed types: `LiveboardEmbed`
1735
1738
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
1736
1739
  * @example
1737
1740
  * ```js
1738
- * const embed = new LiveboardEmbed('#embed-container', {
1739
- * ... // other options
1741
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1742
+ * ... //other embed view config
1740
1743
  * liveboardId:id of liveboard,
1741
1744
  * })
1742
1745
  */
@@ -1748,11 +1751,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1748
1751
  pinboardId?: string;
1749
1752
  /**
1750
1753
  * The visualization within the Liveboard to display.
1754
+ *
1755
+ * Supported embed types: `LiveboardEmbed`
1751
1756
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1752
1757
  * @example
1753
1758
  * ```js
1754
- * const embed = new LiveboardEmbed('#embed-container', {
1755
- * ... // other options
1759
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1760
+ * ... //other embed view config
1756
1761
  * vizId:'430496d6-6903-4601-937e-2c691821af3c',
1757
1762
  * })
1758
1763
  * ```
@@ -1761,11 +1766,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1761
1766
  /**
1762
1767
  * If set to true, all filter chips from a
1763
1768
  * Liveboard page will be read-only (no X buttons)
1769
+ *
1770
+ * Supported embed types: `LiveboardEmbed`
1764
1771
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
1765
1772
  * @example
1766
1773
  * ```js
1767
- * const embed = new LiveboardEmbed('#embed-container', {
1768
- * ... // other options
1774
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1775
+ * ... //other embed view config
1769
1776
  * preventLiveboardFilterRemoval:true,
1770
1777
  * })
1771
1778
  * ```
@@ -1775,11 +1782,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1775
1782
  * Array of visualization IDs which should be visible when the Liveboard
1776
1783
  * renders. This can be changed by triggering the `SetVisibleVizs`
1777
1784
  * event.
1785
+ *
1786
+ * Supported embed types: `LiveboardEmbed`
1778
1787
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
1779
1788
  * @example
1780
1789
  * ```js
1781
- * const embed = new LiveboardEmbed('#embed-container', {
1782
- * ... // other options
1790
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1791
+ * ... //other embed view config
1783
1792
  * visibleVizs: [
1784
1793
  * '430496d6-6903-4601-937e-2c691821af3c',
1785
1794
  * 'f547ec54-2a37-4516-a222-2b06719af726'
@@ -1795,11 +1804,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1795
1804
  /**
1796
1805
  * Render embedded Liveboards and visualizations in the
1797
1806
  * new Liveboard experience mode.
1807
+ *
1808
+ * Supported embed types: `LiveboardEmbed`
1798
1809
  * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
1799
1810
  * @example
1800
1811
  * ```js
1801
- * const embed = new LiveboardEmbed('#embed-container', {
1802
- * ... // other options
1812
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1813
+ * ... //other embed view config
1803
1814
  * liveboardV2:true,
1804
1815
  * })
1805
1816
  * ```
@@ -1808,10 +1819,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1808
1819
  /**
1809
1820
  * Set a Liveboard tab as an active tab.
1810
1821
  * Specify the tab ID.
1822
+ *
1823
+ * Supported embed types: `LiveboardEmbed`
1811
1824
  * @example
1812
1825
  * ```js
1813
1826
  * const embed = new LiveboardEmbed('#tsEmbed', {
1814
- * ... // other options
1827
+ * ... //other embed view config
1815
1828
  * activeTabId:'id-1234',
1816
1829
  * })
1817
1830
  * ```
@@ -1820,228 +1833,155 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1820
1833
  activeTabId?: string;
1821
1834
  /**
1822
1835
  * Show or hide the tab panel of the embedded Liveboard.
1836
+ *
1837
+ * Supported embed types: `LiveboardEmbed`
1823
1838
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
1824
1839
  * @example
1825
1840
  * ```js
1826
- * const embed = new LiveboardEmbed('#embed-container', {
1827
- * ... // other options
1841
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1842
+ * ... //other embed view config
1828
1843
  * hideTabPanel:true,
1829
1844
  * })
1830
1845
  * ```
1831
1846
  */
1832
1847
  hideTabPanel?: boolean;
1833
1848
  /**
1834
- * Show or hide the Liveboard header.
1835
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1836
- * @default false
1849
+ * Show a preview image of the visualization before the visualization loads.
1850
+ * Only works for visualizations embeds with a viz id.
1851
+ *
1852
+ * Also, viz snashot should be enabled in the ThoughtSpot instance.
1853
+ * Contact ThoughtSpot support to enable this feature.
1854
+ *
1855
+ * Since, this will show preview images, be careful that it may show
1856
+ * undesired data to the user when using row level security.
1857
+ *
1858
+ * Supported embed types: `LiveboardEmbed`
1837
1859
  * @example
1838
1860
  * ```js
1839
- * const embed = new LiveboardEmbed('#embed', {
1840
- * ... // other liveboard view config
1841
- * hideLiveboardHeader:true,
1861
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1862
+ * liveboardId: 'liveboard-id',
1863
+ * vizId: 'viz-id',
1864
+ * showPreviewLoader: true,
1842
1865
  * });
1866
+ * embed.render();
1843
1867
  * ```
1868
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
1844
1869
  */
1845
- hideLiveboardHeader?: boolean;
1870
+ showPreviewLoader?: boolean;
1846
1871
  /**
1847
- * Show or hide the Liveboard title.
1848
- * @default false
1849
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1872
+ * The Liveboard to run on regular intervals to fetch the cdw token.
1873
+ *
1874
+ * Supported embed types: `LiveboardEmbed`
1875
+ * @hidden
1876
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1850
1877
  * @example
1851
1878
  * ```js
1852
- * const embed = new LiveboardEmbed('#embed-container', {
1853
- * ... // other options
1854
- * showLiveboardTitle:true,
1879
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1880
+ * ... //other embed view config
1881
+ * oAuthPollingInterval: value in milliseconds,
1855
1882
  * })
1856
- * ```
1857
1883
  */
1858
- showLiveboardTitle?: boolean;
1884
+ oAuthPollingInterval?: number;
1859
1885
  /**
1860
- * Show or hide the Liveboard description.
1861
- * @default false
1862
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1886
+ * The Liveboard is set to force a token fetch during the initial load.
1887
+ *
1888
+ * Supported embed types: `LiveboardEmbed`
1889
+ * @hidden
1890
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1863
1891
  * @example
1864
1892
  * ```js
1865
- * const embed = new LiveboardEmbed('#embed-container', {
1866
- * ... // other options
1867
- * showLiveboardDescription:true,
1893
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1894
+ * ... //other embed view config
1895
+ * isForceRedirect: false,
1868
1896
  * })
1869
- * ```
1870
1897
  */
1871
- showLiveboardDescription?: boolean;
1898
+ isForceRedirect?: boolean;
1872
1899
  /**
1873
- * Control the position and visibility of
1874
- * the Liveboard header as the users scroll down the
1875
- * embedded Liveboard page.
1900
+ * The source connection ID for authentication.
1901
+ * @hidden
1902
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1903
+ *
1904
+ * Supported embed types: `LiveboardEmbed`
1876
1905
  * @example
1877
1906
  * ```js
1878
- * const embed = new LiveboardEmbed('#embed', {
1879
- * ... // other Liveboard view config
1880
- * isLiveboardHeaderSticky: true,
1881
- * });
1882
- * ```
1883
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1907
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1908
+ * ... //other embed view config
1909
+ * dataSourceId: '',
1910
+ * })
1884
1911
  */
1885
- isLiveboardHeaderSticky?: boolean;
1912
+ dataSourceId?: string;
1886
1913
  /**
1887
- * enable or disable ask sage
1888
- * @default false
1889
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
1914
+ * This flag is for show/hide checkboxes for include or exclude
1915
+ * cover page and filters in the Liveboard PDF.
1916
+ *
1917
+ * Supported embed types: `LiveboardEmbed`
1918
+ * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
1919
+ * @default true
1920
+ * Supported embed types: `LiveboardEmbed`
1890
1921
  * @example
1891
1922
  * ```js
1892
- * const embed = new SearchEmbed('#tsEmbed', {
1893
- * ... // other options
1894
- * enableAskSage:true,
1923
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1924
+ * ... //other embed view config
1925
+ * coverAndFilterOptionInPDF: false,
1895
1926
  * })
1896
1927
  * ```
1897
1928
  */
1898
- enableAskSage?: boolean;
1929
+ coverAndFilterOptionInPDF?: boolean;
1899
1930
  /**
1900
- * This flag is used to enable the 2 column layout on a Liveboard
1901
- * @type {boolean}
1902
- * @default false
1903
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1904
- * @example
1905
- * ```js
1906
- * const embed = new LiveboardEmbed('#embed-container', {
1907
- * ... // other options
1908
- * enable2ColumnLayout: true,
1909
- * })
1910
- * ```
1911
- */
1912
- enable2ColumnLayout?: boolean;
1913
- /**
1914
- * Show a preview image of the visualization before the visualization loads.
1915
- * Only works for visualizations embeds with a viz id.
1916
- *
1917
- * Also, viz snashot should be enabled in the ThoughtSpot instance.
1918
- * Contact ThoughtSpot support to enable this feature.
1931
+ * The list of tab IDs to hide from the embedded.
1932
+ * This Tabs will be hidden from their respective LBs.
1933
+ * Use this to hide an tabID.
1919
1934
  *
1920
- * Since, this will show preview images, be careful that it may show
1921
- * undesired data to the user when using row level security.
1935
+ * Supported embed types: `LiveboardEmbed`
1922
1936
  * @example
1923
1937
  * ```js
1924
- * const embed = new LiveboardEmbed('#embed-container', {
1925
- * liveboardId: 'liveboard-id',
1926
- * vizId: 'viz-id',
1927
- * showPreviewLoader: true,
1938
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1939
+ * ... // other embed view config
1940
+ * hiddenTabs: [
1941
+ * '430496d6-6903-4601-937e-2c691821af3c',
1942
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
1943
+ * ]
1928
1944
  * });
1929
- * embed.render();
1930
1945
  * ```
1931
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
1946
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
1932
1947
  */
1933
- showPreviewLoader?: boolean;
1948
+ hiddenTabs?: string[];
1934
1949
  /**
1935
- * Enables or disables the compact header feature on a Liveboard.
1936
- * Compact Liveboard header is turned off by default on Liveboards in
1937
- * ThoughtSpot Embedded apps.
1950
+ * The list of tab IDs to show in the embedded Liveboard.
1951
+ * Only the tabs specified in the array will be shown in the Liveboard.
1938
1952
  *
1939
- * @type {boolean}
1940
- * @default false
1941
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
1942
- * @example
1943
- * ```js
1944
- * const embed = new LiveboardEmbed('#embed-container', {
1945
- * ... // other options
1946
- * isLiveboardCompactHeaderEnabled: true,
1947
- * })
1948
- * ```
1949
- */
1950
- isLiveboardCompactHeaderEnabled?: boolean;
1951
- /**
1952
- * This flag is used to show/hide verified icon in the Liveboard compact header
1953
- * @type {boolean}
1954
- * @default true
1955
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1956
- * @example
1957
- * ```js
1958
- * const embed = new LiveboardEmbed('#embed-container', {
1959
- * ... // other options
1960
- * showLiveboardVerifiedBadge: true,
1961
- * })
1962
- * ```
1963
- */
1964
- showLiveboardVerifiedBadge?: boolean;
1965
- /**
1966
- * This flag is used to show/hide the re-verify banner
1967
- * in Liveboard compact header
1968
- * @type {boolean}
1969
- * @default true
1970
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
1971
- * @example
1972
- * ```js
1973
- * const embed = new LiveboardEmbed('#embed-container', {
1974
- * ... // other options
1975
- * showLiveboardReverifyBanner: true,
1976
- * })
1977
- * ```
1978
- */
1979
- showLiveboardReverifyBanner?: boolean;
1980
- /**
1981
- * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
1982
- * @type {boolean}
1983
- * @default false
1984
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
1953
+ * Use either `visibleTabs` or `hiddenTabs`.
1954
+ *
1955
+ * Supported embed types: `LiveboardEmbed`
1956
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
1985
1957
  * @example
1986
1958
  * ```js
1987
- * const embed = new LiveboardEmbed('#embed-container', {
1988
- * ... // other options
1989
- * hideIrrelevantChipsInLiveboardTabs: true,
1959
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1960
+ * ... // other embed view config
1961
+ * visibleTabs: [
1962
+ * '430496d6-6903-4601-937e-2c691821af3c',
1963
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
1964
+ * ]
1990
1965
  * })
1991
1966
  * ```
1992
1967
  */
1993
- hideIrrelevantChipsInLiveboardTabs?: boolean;
1994
- /**
1995
- * The Liveboard to run on regular intervals to fetch the cdw token.
1996
- * @hidden
1997
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1998
- * @example
1999
- * ```js
2000
- * const embed = new LiveboardEmbed('#embed-container', {
2001
- * ... // other options
2002
- * oAuthPollingInterval: value in milliseconds,
2003
- * })
2004
- */
2005
- oAuthPollingInterval?: number;
2006
- /**
2007
- * The Liveboard is set to force a token fetch during the initial load.
2008
- * @hidden
2009
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
2010
- * @example
2011
- * ```js
2012
- * const embed = new LiveboardEmbed('#embed-container', {
2013
- * ... // other options
2014
- * isForceRedirect: false,
2015
- * })
2016
- */
2017
- isForceRedirect?: boolean;
2018
- /**
2019
- * The source connection ID for authentication.
2020
- * @hidden
2021
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
2022
- * @example
2023
- * ```js
2024
- * const embed = new LiveboardEmbed('#embed-container', {
2025
- * ... // other options
2026
- * dataSourceId: '',
2027
- * })
2028
- */
2029
- dataSourceId?: string;
1968
+ visibleTabs?: string[];
2030
1969
  /**
2031
- * This flag is for show/hide checkboxes for include or exclude
2032
- * cover page and filters in the Liveboard PDF.
1970
+ * This flag is used to enable/disable the styling and grouping in a Liveboard
1971
+ *
1972
+ * Supported embed types: `LiveboardEmbed`, `AppEmbed`
2033
1973
  * @type {boolean}
2034
- * @default true
2035
- * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
1974
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2036
1975
  * @example
2037
1976
  * ```js
2038
- * const embed = new LiveboardEmbed('#embed-container', {
2039
- * ... // other options
2040
- * coverAndFilterOptionInPDF: false,
1977
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
1978
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1979
+ * ... // other embed view config
1980
+ * isLiveboardStylingAndGroupingEnabled: true,
2041
1981
  * })
2042
1982
  * ```
2043
1983
  */
2044
- coverAndFilterOptionInPDF?: boolean;
1984
+ isLiveboardStylingAndGroupingEnabled?: boolean;
2045
1985
  }
2046
1986
  /**
2047
1987
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -2099,7 +2039,7 @@ export declare class PinboardEmbed extends LiveboardEmbed {
2099
2039
  * Configuration for bodyless conversation options.
2100
2040
  * @group Embed components
2101
2041
  */
2102
- export interface SpotterAgentEmbedViewConfig extends ViewConfig {
2042
+ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
2103
2043
  /**
2104
2044
  * The ID of the worksheet to use for the conversation.
2105
2045
  */
@@ -2111,7 +2051,7 @@ export interface SpotterAgentEmbedViewConfig extends ViewConfig {
2111
2051
  }
2112
2052
  /**
2113
2053
  * Configuration for conversation options.
2114
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
2054
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2115
2055
  * Use {@link SpotterAgentEmbedViewConfig} instead
2116
2056
  * @group Embed components
2117
2057
  */
@@ -2163,7 +2103,7 @@ export declare class SpotterAgentEmbed {
2163
2103
  /**
2164
2104
  * Create a conversation embed, which can be integrated inside
2165
2105
  * chatbots or other conversational interfaces.
2166
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
2106
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2167
2107
  * Use {@link SpotterAgentEmbed} instead
2168
2108
  * @example
2169
2109
  * ```js
@@ -2264,7 +2204,7 @@ export declare enum AuthType {
2264
2204
  * // ...
2265
2205
  * authType: AuthType.SAMLRedirect,
2266
2206
  * authTriggerText: 'Login with SAML',
2267
- * authTriggerContainer: '#embed-container',
2207
+ * authTriggerContainer: '#tsEmbed',
2268
2208
  * inPopup: true,
2269
2209
  * });
2270
2210
  * ```
@@ -2389,13 +2329,13 @@ export declare enum HomeLeftNavItem {
2389
2329
  /**
2390
2330
  * Create new options in the insights left navigation,
2391
2331
  * available when new navigation V3 is enabled.
2392
- * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2332
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2393
2333
  */
2394
2334
  Create = "create",
2395
2335
  /**
2396
2336
  * Spotter option in the insights left navigation,
2397
2337
  * available when new navigation V3 is enabled.
2398
- * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2338
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2399
2339
  */
2400
2340
  Spotter = "spotter"
2401
2341
  }
@@ -2803,6 +2743,20 @@ export interface EmbedConfig {
2803
2743
  */
2804
2744
  customVariablesForThirdPartyTools?: Record<string, any>;
2805
2745
  disablePreauthCache?: boolean;
2746
+ /**
2747
+ * Disable fullscreen presentation mode functionality. When enabled, prevents entering
2748
+ * and exiting fullscreen mode for embedded visualizations during presentations.
2749
+ * @default true (feature is disabled by default)
2750
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2751
+ * @example
2752
+ * ```js
2753
+ * init({
2754
+ * ... // other embed config options
2755
+ * disableFullscreenPresentation: false, // enables the feature
2756
+ * })
2757
+ * ```
2758
+ */
2759
+ disableFullscreenPresentation?: boolean;
2806
2760
  }
2807
2761
  export interface LayoutConfig {
2808
2762
  }
@@ -2832,9 +2786,9 @@ export interface FrameParams {
2832
2786
  [key: string]: string | number | boolean | undefined;
2833
2787
  }
2834
2788
  /**
2835
- * The configuration object for an embedded view.
2789
+ * The common configuration object for an embedded view.
2836
2790
  */
2837
- export interface ViewConfig {
2791
+ export interface BaseViewConfig {
2838
2792
  /**
2839
2793
  * @hidden
2840
2794
  */
@@ -2842,16 +2796,19 @@ export interface ViewConfig {
2842
2796
  /**
2843
2797
  * The width and height dimensions to render an embedded
2844
2798
  * object inside your app. Specify the values in pixels or percentage.
2799
+ *
2800
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2845
2801
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
2846
2802
  * @example
2847
2803
  * ```js
2848
- * const embed = new LiveboardEmbed('#embed', {
2849
- * ... // other liveboard view config
2850
- * frameParams: {
2851
- * width: '500px' | '50%',
2852
- * height: '400px' | '60%',
2853
- * },
2854
- * });
2804
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2805
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2806
+ * ... // other embed view config
2807
+ * frameParams: {
2808
+ * width: '500px' | '50%',
2809
+ * height: '400px' | '60%',
2810
+ * },
2811
+ * })
2855
2812
  * ```
2856
2813
  */
2857
2814
  frameParams?: FrameParams;
@@ -2868,38 +2825,31 @@ export interface ViewConfig {
2868
2825
  * (...), and the contextual menu. These actions will be disabled
2869
2826
  * for the user.
2870
2827
  * Use this to disable actions.
2828
+ *
2829
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2871
2830
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2872
2831
  * @example
2873
2832
  * ```js
2874
- * const embed = new LiveboardEmbed('#embed', {
2875
- * ... // other liveboard view config
2876
- * disabledActions: [Action.Download, Action.Save]
2833
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2834
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2835
+ * ... // other embed view config
2836
+ * disabledActions: [Action.Download, Action.Save],
2877
2837
  * });
2878
2838
  * ```
2879
2839
  */
2880
2840
  disabledActions?: Action[];
2881
- /**
2882
- * The primary action to display on top of the viz for Liveboard and App Embed.
2883
- * Use this to set the primary action.
2884
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2885
- * @example
2886
- * ```js
2887
- * const embed = new LiveboardEmbed('#embed', {
2888
- * ... // other liveboard view config
2889
- * primaryAction: Action.Download
2890
- * });
2891
- * ```
2892
- */
2893
- primaryAction?: Action | string;
2894
2841
  /**
2895
2842
  * The tooltip to display for disabled actions.
2843
+ *
2844
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2896
2845
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2897
2846
  * @example
2898
2847
  * ```js
2899
- * const embed = new LiveboardEmbed('#embed', {
2900
- * ... // other liveboard view config
2901
- * disabledActions: [Action.Download, Action.Save]
2902
- * disabledActionReason: "Reason for disabling",
2848
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2849
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2850
+ * ... // other embed view config
2851
+ * disabledActions: [Action.Download, Action.Save],
2852
+ * disabledActionReason: "Reason for disabling",
2903
2853
  * });
2904
2854
  * ```
2905
2855
  */
@@ -2908,12 +2858,15 @@ export interface ViewConfig {
2908
2858
  * The list of actions to hide from the embedded.
2909
2859
  * This actions will be hidden from the user.
2910
2860
  * Use this to hide an action.
2861
+ *
2862
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2911
2863
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2912
2864
  * @example
2913
2865
  * ```js
2914
- * const embed = new LiveboardEmbed('#embed', {
2915
- * ... // other liveboard view config
2916
- * hiddenActions: [Action.Download, Action.Export]
2866
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2867
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2868
+ * ... // other embed view config
2869
+ * hiddenActions: [Action.Download, Action.Export],
2917
2870
  * });
2918
2871
  * ```
2919
2872
  * @important
@@ -2926,74 +2879,30 @@ export interface ViewConfig {
2926
2879
  * Use this to hide all actions except the ones you want to show.
2927
2880
  *
2928
2881
  * Use either this or hiddenActions.
2882
+ *
2883
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2929
2884
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2930
2885
  * @important
2931
2886
  * @example
2932
2887
  * ```js
2933
- * const embed = new LiveboardEmbed('#embed', {
2934
- * ... // other liveboard view config
2935
- * visibleActions: [Action.Download, Action.Export]
2888
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2889
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2890
+ * ... // other embed view config
2891
+ * visibleActions: [Action.Download, Action.Export],
2936
2892
  * });
2937
2893
  * ```
2938
2894
  */
2939
2895
  visibleActions?: Action[];
2940
- /**
2941
- * Show alert messages and toast messages in the embedded
2942
- * view in full app embed.
2943
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2944
- * @example
2945
- * ```js
2946
- * const embed = new AppEmbed('#embed-container', {
2947
- * ... // other options
2948
- * showAlerts:true,
2949
- * })
2950
- * ```
2951
- */
2952
- showAlerts?: boolean;
2953
- /**
2954
- * The list of runtime filters to apply to a search Answer,
2955
- * visualization, or Liveboard.
2956
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2957
- * @example
2958
- * ```js
2959
- * const embed = new LiveboardEmbed('#embed-container', {
2960
- * ... // other options
2961
- * runtimeFilters: [
2962
- * {
2963
- * columnName: 'value',
2964
- * operator: RuntimeFilterOp.EQ,
2965
- * values: ['string' | 123 | true],
2966
- * },
2967
- * ],
2968
- * })
2969
- * ```
2970
- */
2971
- runtimeFilters?: RuntimeFilter[];
2972
- /**
2973
- * The list of parameter override to apply to a search Answer,
2974
- * visualization, or Liveboard.
2975
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2976
- * @example
2977
- * ```js
2978
- * const embed = new LiveboardEmbed('#embed-container', {
2979
- * ... // other options
2980
- * runtimeParameters: [
2981
- * {
2982
- * name: 'value',
2983
- * value: 'string' | 123 | true,
2984
- * },
2985
- * ],
2986
- * })
2987
- * ```
2988
- */
2989
- runtimeParameters?: RuntimeParameter[];
2990
2896
  /**
2991
2897
  * The locale settings to apply to the embedded view.
2898
+ *
2899
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2992
2900
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2993
2901
  * @example
2994
2902
  * ```js
2995
- * const embed = new LiveboardEmbed('#embed-container', {
2996
- * ... // other options
2903
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2904
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2905
+ * ... // other embed view config
2997
2906
  * locale:'en',
2998
2907
  * })
2999
2908
  * ```
@@ -3007,14 +2916,17 @@ export interface ViewConfig {
3007
2916
  * Warning: This option is for advanced use only and is used internally
3008
2917
  * to control embed behavior in non-regular ways. We do not publish the
3009
2918
  * list of supported keys and values associated with each.
2919
+ *
2920
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3010
2921
  * @example
3011
2922
  * ```js
3012
- * const embed = new LiveboardEmbed('#embed', {
3013
- * ... // other liveboard view config
2923
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2924
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2925
+ * ... // other embed view config
3014
2926
  * additionalFlags: {
3015
2927
  * flag1: 'value1',
3016
2928
  * flag2: 'value2'
3017
- * }
2929
+ * },
3018
2930
  * });
3019
2931
  * ```
3020
2932
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
@@ -3032,55 +2944,308 @@ export interface ViewConfig {
3032
2944
  /**
3033
2945
  * Insert as a sibling of the target container, instead of appending to a
3034
2946
  * child inside it.
2947
+ *
2948
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3035
2949
  * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
3036
2950
  * @example
3037
2951
  * ```js
3038
- * const embed = new LiveboardEmbed('#embed-container', {
3039
- * ... // other options
2952
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2953
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2954
+ * ... // other embed view config
3040
2955
  * insertAsSibling:true,
3041
2956
  * })
3042
2957
  * ```
3043
2958
  */
3044
2959
  insertAsSibling?: boolean;
3045
2960
  /**
3046
- * flag to set ContextMenu Trigger to either left or right click.
2961
+ * Use a pre-rendered iframe from a pool of pre-rendered iframes
2962
+ * if available and matches the configuration.
2963
+ * @version SDK: 1.22.0
2964
+ * @hidden
2965
+ *
2966
+ * See [docs]() on how to create a prerender pool.
2967
+ */
2968
+ usePrerenderedIfAvailable?: boolean;
2969
+ /**
2970
+ * PreRender id to be used for PreRendering the embed.
2971
+ * Use PreRender to render the embed in the background and then
2972
+ * show or hide the rendered embed using showPreRender or hidePreRender respectively.
2973
+ *
2974
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3047
2975
  * @example
3048
2976
  * ```js
3049
- * const embed = new LiveboardEmbed('#tsEmbed', {
3050
- * ... // other options
3051
- * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
3052
- * })
2977
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2978
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2979
+ * ... // other embed view config
2980
+ * preRenderId: "preRenderId-123",
2981
+ * });
2982
+ * embed.showPreRender();
3053
2983
  * ```
3054
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2984
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
3055
2985
  */
3056
- contextMenuTrigger?: ContextMenuTriggerOptions;
2986
+ preRenderId?: string;
2987
+ /**
2988
+ * Determines if the PreRender component should dynamically track the size
2989
+ * of its embedding element and adjust its own size accordingly.
2990
+ * Enabling this option allows the PreRender component to automatically adapt
2991
+ * its dimensions based on changes to the size of the embedding element.
2992
+ * @type {boolean}
2993
+ * @default false
2994
+ * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
2995
+ * @example
2996
+ * ```js
2997
+ * // Disable tracking PreRender size in the configuration
2998
+ * const config = {
2999
+ * doNotTrackPreRenderSize: true,
3000
+ * };
3001
+ *
3002
+ * // Instantiate an object with the configuration
3003
+ * const myComponent = new MyComponent(config);
3004
+ * ```
3005
+ */
3006
+ doNotTrackPreRenderSize?: boolean;
3007
+ /**
3008
+ * Enable the V2 shell. This can provide performance benefits
3009
+ * due to a lighterweight shell.
3010
+ *
3011
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3012
+ * @example
3013
+ * ```js
3014
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3015
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3016
+ * ... // other embed view config
3017
+ * enableV2Shell_experimental: true,
3018
+ * });
3019
+ * ```
3020
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
3021
+ */
3022
+ enableV2Shell_experimental?: boolean;
3023
+ /**
3024
+ * For internal tracking of the embed component type.
3025
+ * @hidden
3026
+ */
3027
+ embedComponentType?: string;
3028
+ /**
3029
+ * This flag can be used to expose translation IDs on the embedded app.
3030
+ * @default false
3031
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3032
+ */
3033
+ exposeTranslationIDs?: boolean;
3034
+ /**
3035
+ * This flag can be used to disable links inside the embedded app,
3036
+ * and disable redirection of links in a new tab.
3037
+ *
3038
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3039
+ * @example
3040
+ * ```js
3041
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3042
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3043
+ * ... // other embed view config
3044
+ * disableRedirectionLinksInNewTab: true,
3045
+ * });
3046
+ * ```
3047
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
3048
+ */
3049
+ disableRedirectionLinksInNewTab?: boolean;
3050
+ /**
3051
+ * Overrides an Org context for embedding application users.
3052
+ * This parameter allows a user authenticated to one Org to view the
3053
+ * objects from another Org.
3054
+ * The `overrideOrgId` setting is honoured only if the
3055
+ * Per Org URL feature is enabled on your ThoughtSpot instance.
3056
+ *
3057
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3058
+ * @example
3059
+ * ```js
3060
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3061
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3062
+ * ... // other embed view config
3063
+ * overrideOrgId: 142536,
3064
+ * });
3065
+ * ```
3066
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3067
+ */
3068
+ overrideOrgId?: number;
3057
3069
  /**
3058
3070
  * Flag to override the *Open Link in New Tab* context menu option.
3071
+ *
3072
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3059
3073
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3060
3074
  * @example
3061
3075
  * ```js
3062
- * const embed = new LiveboardEmbed('#embed-container', {
3063
- * ... // other options
3076
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3077
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3078
+ * ... // other embed view config
3064
3079
  * linkOverride:false,
3065
3080
  * })
3066
3081
  * ```
3067
3082
  */
3068
3083
  linkOverride?: boolean;
3084
+ /**
3085
+ * The primary action to display on top of the viz for Liveboard and App Embed.
3086
+ * Use this to set the primary action.
3087
+ *
3088
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3089
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
3090
+ * @example
3091
+ * ```js
3092
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3093
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3094
+ * ... // other embed view config
3095
+ * primaryAction: Action.Download
3096
+ * });
3097
+ * ```
3098
+ */
3099
+ primaryAction?: Action | string;
3069
3100
  /**
3070
3101
  * flag to enable insert into slides action
3071
3102
  * @hidden
3072
3103
  * @private
3073
3104
  */
3074
3105
  insertInToSlide?: boolean;
3106
+ }
3107
+ /**
3108
+ * The configuration object for Home page embeds configs.
3109
+ */
3110
+ export interface HomePageConfig {
3075
3111
  /**
3076
- * Use a pre-rendered iframe from a pool of pre-rendered iframes
3077
- * if available and matches the configuration.
3078
- * @version SDK: 1.22.0
3079
- * @hidden
3112
+ * Hide list page columns
3113
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3080
3114
  *
3081
- * See [docs]() on how to create a prerender pool.
3115
+ * **Note**: This option is available only in full app embedding.
3116
+ *
3117
+ * Supported embed types: `AppEmbed`
3118
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3119
+ * @example
3120
+ * ```js
3121
+ * const embed = new AppEmbed('#tsEmbed', {
3122
+ * ... //other embed view config
3123
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3124
+ * })
3125
+ * ```
3126
+ */
3127
+ hiddenListColumns?: ListPageColumns[];
3128
+ /**
3129
+ * Hide the home page modules
3130
+ * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
3131
+ *
3132
+ * **Note**: This option does not apply to the classic homepage.
3133
+ * To access the updated modular homepage, set
3134
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3135
+ *
3136
+ * Supported embed types: `AppEmbed`
3137
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3138
+ * @example
3139
+ * ```js
3140
+ * const embed = new AppEmbed('#tsEmbed', {
3141
+ * ... //other embed view config
3142
+ * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
3143
+ * })
3144
+ * ```
3145
+ */
3146
+ hiddenHomepageModules?: HomepageModule[];
3147
+ /**
3148
+ * reordering the home page modules
3149
+ * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
3150
+ *
3151
+ * **Note**: This option does not apply to the classic homepage.
3152
+ * To access the updated modular homepage, set
3153
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3154
+ *
3155
+ * Supported embed types: `AppEmbed`
3156
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3157
+ * @example
3158
+ * ```js
3159
+ * const embed = new AppEmbed('#tsEmbed', {
3160
+ * ... //other embed view config
3161
+ * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
3162
+ * })
3163
+ * ```
3164
+ */
3165
+ reorderedHomepageModules?: HomepageModule[];
3166
+ /**
3167
+ * homepageLeftNavItems : Show or hide the left navigation bar items.
3168
+ * There are 8 eight home navigation list items.
3169
+ * To hide these items, specify the string in the array.
3170
+ *
3171
+ * Supported embed types: `AppEmbed`
3172
+ * @example
3173
+ * ```js
3174
+ * const embed = new AppEmbed('#tsEmbed', {
3175
+ * ... //other embed view config
3176
+ * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
3177
+ * })
3178
+ * ```
3179
+ *
3180
+ * **Note**: This option does not apply to the classic homepage.
3181
+ * To access the updated modular homepage, set
3182
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3183
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3184
+ */
3185
+ hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3186
+ }
3187
+ /**
3188
+ * The configuration object for common Search and Liveboard embeds configs.
3189
+ */
3190
+ export interface SearchLiveboardCommonViewConfig {
3191
+ /**
3192
+ * The list of runtime filters to apply to a search Answer,
3193
+ * visualization, or Liveboard.
3194
+ *
3195
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
3196
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
3197
+ * @example
3198
+ * ```js
3199
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3200
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3201
+ * ... // other embed view config
3202
+ * runtimeFilters: [
3203
+ * {
3204
+ * columnName: 'value',
3205
+ * operator: RuntimeFilterOp.EQ,
3206
+ * values: ['string' | 123 | true],
3207
+ * },
3208
+ * ],
3209
+ * })
3210
+ * ```
3211
+ */
3212
+ runtimeFilters?: RuntimeFilter[];
3213
+ /**
3214
+ * The list of parameter override to apply to a search Answer,
3215
+ * visualization, or Liveboard.
3216
+ *
3217
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
3218
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3219
+ * @example
3220
+ * ```js
3221
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3222
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3223
+ * ... // other embed view config
3224
+ * runtimeParameters: [
3225
+ * {
3226
+ * name: 'value',
3227
+ * value: 'string' | 123 | true,
3228
+ * },
3229
+ * ]
3230
+ * })
3231
+ * ```
3232
+ */
3233
+ runtimeParameters?: RuntimeParameter[];
3234
+ /**
3235
+ * flag to set ContextMenu Trigger to either left or right click.
3236
+ *
3237
+ * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
3238
+ * @example
3239
+ * ```js
3240
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
3241
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3242
+ * ... // other embed view config
3243
+ * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
3244
+ * })
3245
+ * ```
3246
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3082
3247
  */
3083
- usePrerenderedIfAvailable?: boolean;
3248
+ contextMenuTrigger?: ContextMenuTriggerOptions;
3084
3249
  /**
3085
3250
  * Boolean to exclude runtimeFilters in the URL
3086
3251
  * By default it is true, this flag removes runtime filters from the URL
@@ -3093,241 +3258,230 @@ export interface ViewConfig {
3093
3258
  */
3094
3259
  excludeRuntimeFiltersfromURL?: boolean;
3095
3260
  /**
3096
- * The list of tab IDs to hide from the embedded.
3097
- * This Tabs will be hidden from their respective LBs.
3098
- * Use this to hide an tabID.
3099
- * @example
3100
- * ```js
3101
- * const embed = new LiveboardEmbed('#embed', {
3102
- * ... // other liveboard view config
3103
- * hiddenTabs: [
3104
- * '430496d6-6903-4601-937e-2c691821af3c',
3105
- * 'f547ec54-2a37-4516-a222-2b06719af726']
3106
- * });
3107
- * ```
3108
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3261
+ * Boolean to exclude runtimeParameters from the URL
3262
+ * when set to true, this flag removes runtime parameters from the URL.
3263
+ *
3264
+ * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
3265
+ * embedded view.
3266
+ * @default false
3267
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
3109
3268
  */
3110
- hiddenTabs?: string[];
3269
+ excludeRuntimeParametersfromURL?: boolean;
3111
3270
  /**
3112
- * Hide the home page modules
3113
- * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
3271
+ * To set the initial state of the search bar in case of saved Answers.
3114
3272
  *
3115
- * **Note**: This option does not apply to the classic homepage.
3116
- * To access the updated modular homepage, set
3117
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3118
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3273
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
3274
+ * @default true
3275
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3119
3276
  * @example
3120
3277
  * ```js
3121
- * const embed = new AppEmbed('#tsEmbed', {
3122
- * ... // other options
3123
- * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
3124
- * })
3125
- * ```
3278
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
3279
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3280
+ * ... // other embed view config
3281
+ * collapseSearchBar: true,
3282
+ * });
3126
3283
  */
3127
- hiddenHomepageModules?: HomepageModule[];
3284
+ collapseSearchBar?: boolean;
3128
3285
  /**
3129
- * reordering the home page modules
3130
- * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
3286
+ * Flag to control Data panel experience
3131
3287
  *
3132
- * **Note**: This option does not apply to the classic homepage.
3133
- * To access the updated modular homepage, set
3134
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3135
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3288
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3289
+ * @default false
3290
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3136
3291
  * @example
3137
3292
  * ```js
3138
- * const embed = new AppEmbed('#tsEmbed', {
3139
- * ... // other options
3140
- * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
3293
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
3294
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3295
+ * ... // other embed view config
3296
+ * dataPanelV2: true,
3141
3297
  * })
3142
3298
  * ```
3143
3299
  */
3144
- reorderedHomepageModules?: HomepageModule[];
3300
+ dataPanelV2?: boolean;
3145
3301
  /**
3146
- * The list of tab IDs to show in the embedded Liveboard.
3147
- * Only the tabs specified in the array will be shown in the Liveboard.
3302
+ * To enable custom column groups in data panel v2
3148
3303
  *
3149
- * Use either `visibleTabs` or `hiddenTabs`.
3150
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3304
+ * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3305
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3306
+ * @default false
3151
3307
  * @example
3152
3308
  * ```js
3153
- * const embed = new LiveboardEmbed('#embed-container', {
3154
- * ... // other options
3155
- * visibleTabs: [
3156
- * '430496d6-6903-4601-937e-2c691821af3c',
3157
- * 'f547ec54-2a37-4516-a222-2b06719af726'
3158
- * ]
3159
- * })
3309
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
3310
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3311
+ * ... // other embed view config
3312
+ * enableCustomColumnGroups: true,
3313
+ * });
3160
3314
  * ```
3161
3315
  */
3162
- visibleTabs?: string[];
3316
+ enableCustomColumnGroups?: boolean;
3317
+ }
3318
+ /**
3319
+ * The configuration object for common Liveboard and App embeds configs.
3320
+ */
3321
+ export interface LiveboardAppEmbedViewConfig {
3163
3322
  /**
3164
- * homepageLeftNavItems : Show or hide the left navigation bar items.
3165
- * There are 8 eight home navigation list items.
3166
- * To hide these items, specify the string in the array.
3323
+ * Show or hide Liveboard header
3324
+ *
3325
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3326
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3327
+ * @default false
3167
3328
  * @example
3168
3329
  * ```js
3169
- * const embed = new AppEmbed('#tsEmbed', {
3170
- * ... // other options
3171
- * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
3330
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3331
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3332
+ * ... // other embed view config
3333
+ * hideLiveboardHeader : true,
3172
3334
  * })
3173
3335
  * ```
3174
- *
3175
- * **Note**: This option does not apply to the classic homepage.
3176
- * To access the updated modular homepage, set
3177
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3178
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3179
3336
  */
3180
- hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3337
+ hideLiveboardHeader?: boolean;
3181
3338
  /**
3182
- * PreRender id to be used for PreRendering the embed.
3183
- * Use PreRender to render the embed in the background and then
3184
- * show or hide the rendered embed using showPreRender or hidePreRender respectively.
3339
+ * Show or hide Liveboard title
3340
+ *
3341
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3342
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3343
+ * @default false
3185
3344
  * @example
3186
3345
  * ```js
3187
- * const embed = new LiveboardEmbed('#embed', {
3188
- * ... // other liveboard view config
3189
- * preRenderId: "preRenderId-123"
3190
- * });
3191
- * embed.showPreRender();
3346
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3347
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3348
+ * ... // other embed view config
3349
+ * showLiveboardTitle:true,
3350
+ * })
3192
3351
  * ```
3193
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
3194
3352
  */
3195
- preRenderId?: string;
3353
+ showLiveboardTitle?: boolean;
3196
3354
  /**
3197
- * Determines if the PreRender component should dynamically track the size
3198
- * of its embedding element and adjust its own size accordingly.
3199
- * Enabling this option allows the PreRender component to automatically adapt
3200
- * its dimensions based on changes to the size of the embedding element.
3201
- * @type {boolean}
3355
+ * Show or hide Liveboard description
3356
+ *
3357
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3358
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3202
3359
  * @default false
3203
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
3204
3360
  * @example
3205
3361
  * ```js
3206
- * // Disable tracking PreRender size in the configuration
3207
- * const config = {
3208
- * doNotTrackPreRenderSize: true,
3209
- * };
3210
- *
3211
- * // Instantiate an object with the configuration
3212
- * const myComponent = new MyComponent(config);
3362
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3363
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3364
+ * ... // other embed view config
3365
+ * showLiveboardDescription:true,
3366
+ * })
3213
3367
  * ```
3214
3368
  */
3215
- doNotTrackPreRenderSize?: boolean;
3216
- /**
3217
- * For internal tracking of the embed component type.
3218
- * @hidden
3219
- */
3220
- embedComponentType?: string;
3369
+ showLiveboardDescription?: boolean;
3221
3370
  /**
3222
- * Boolean to exclude runtimeParameters from the URL
3223
- * when set to true, this flag removes runtime parameters from the URL.
3371
+ * Boolean to control if Liveboard header is sticky or not.
3224
3372
  *
3225
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
3226
- * embedded view.
3227
- * @default false
3228
- * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
3229
- */
3230
- excludeRuntimeParametersfromURL?: boolean;
3231
- /**
3232
- * Enable the V2 shell. This can provide performance benefits
3233
- * due to a lighterweight shell.
3373
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3234
3374
  * @example
3235
3375
  * ```js
3236
- * const embed = new LiveboardEmbed('#embed', {
3237
- * liveboardId: '123',
3238
- * enableV2Shell_experimental: true
3376
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3377
+ * const embed = new <EmbedComponent>('#embed', {
3378
+ * ... // other app view config
3379
+ * isLiveboardHeaderSticky: true,
3239
3380
  * });
3240
3381
  * ```
3241
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
3382
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3242
3383
  */
3243
- enableV2Shell_experimental?: boolean;
3384
+ isLiveboardHeaderSticky?: boolean;
3244
3385
  /**
3245
- * To set the initial state of the search bar in case of saved Answers.
3246
- * @default true
3247
- * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3386
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
3387
+ *
3388
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3389
+ * @type {boolean}
3390
+ * @default false
3391
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
3248
3392
  * @example
3249
3393
  * ```js
3250
- * const embed = new LiveboardEmbed('#embed', {
3251
- * liveboardId: '123',
3252
- * collapseSearchBar: true
3253
- * });
3394
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3395
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3396
+ * ... // other embed view config
3397
+ * enable2ColumnLayout: true,
3398
+ * })
3399
+ * ```
3254
3400
  */
3255
- collapseSearchBar?: boolean;
3401
+ enable2ColumnLayout?: boolean;
3256
3402
  /**
3257
- * This flag can be used to expose translation IDs on the embedded app.
3403
+ * This flag can be used to enable the compact header in Liveboard
3404
+ *
3405
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3406
+ * @type {boolean}
3258
3407
  * @default false
3259
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3260
- */
3261
- exposeTranslationIDs?: boolean;
3262
- /**
3263
- * This flag can be used to disable links inside the embedded app,
3264
- * and disable redirection of links in a new tab.
3408
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
3265
3409
  * @example
3266
3410
  * ```js
3267
- * const embed = new LiveboardEmbed('#embed', {
3268
- * disableRedirectionLinksInNewTab: true
3269
- * });
3411
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3412
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3413
+ * ... // other embed view config
3414
+ * isLiveboardCompactHeaderEnabled: true,
3415
+ * })
3270
3416
  * ```
3271
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
3272
3417
  */
3273
- disableRedirectionLinksInNewTab?: boolean;
3418
+ isLiveboardCompactHeaderEnabled?: boolean;
3274
3419
  /**
3275
- * Flag to control Data panel experience
3276
- * @default false
3277
- * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3420
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
3421
+ *
3422
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3423
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
3424
+ * @default true
3278
3425
  * @example
3279
3426
  * ```js
3280
- * const embed = new AppEmbed('#tsEmbed', {
3281
- * ... // other options
3282
- * dataPanelV2: true,
3427
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3428
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3429
+ * ... // other embed view config
3430
+ * showLiveboardVerifiedBadge: true,
3283
3431
  * })
3284
3432
  * ```
3285
3433
  */
3286
- dataPanelV2?: boolean;
3434
+ showLiveboardVerifiedBadge?: boolean;
3287
3435
  /**
3288
- * To enable custom column groups in data panel v2
3289
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3436
+ * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
3437
+ *
3438
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3439
+ * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
3290
3440
  * @default false
3291
3441
  * @example
3292
3442
  * ```js
3293
- * const embed = new SearchEmbed('#tsEmbed', {
3294
- * ... // other options
3295
- * enableCustomColumnGroups: true,
3296
- * });
3443
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3444
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3445
+ * ... // other embed view config
3446
+ * hideIrrelevantChipsInLiveboardTabs: true,
3447
+ * })
3297
3448
  * ```
3298
3449
  */
3299
- enableCustomColumnGroups?: boolean;
3450
+ hideIrrelevantChipsInLiveboardTabs?: boolean;
3300
3451
  /**
3301
- * Overrides an Org context for embedding application users.
3302
- * This parameter allows a user authenticated to one Org to view the
3303
- * objects from another Org.
3304
- * The `overrideOrgId` setting is honoured only if the
3305
- * Per Org URL feature is enabled on your ThoughtSpot instance.
3452
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
3453
+ *
3454
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3455
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
3456
+ * @default true
3306
3457
  * @example
3307
3458
  * ```js
3308
- * const embed = new LiveboardEmbed('#embed', {
3309
- * ... // other options
3310
- * overrideOrgId: 142536
3311
- * });
3459
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3460
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3461
+ * ... // other embed view config
3462
+ * showLiveboardReverifyBanner: true,
3463
+ * })
3312
3464
  * ```
3313
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3314
3465
  */
3315
- overrideOrgId?: number;
3466
+ showLiveboardReverifyBanner?: boolean;
3316
3467
  /**
3317
- * Hide list page columns
3318
- * For example: hiddenListColumns = [ListPageColumns.Author]
3468
+ * enable or disable ask sage
3319
3469
  *
3320
- * **Note**: This option is available only in full app embedding.
3321
- * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3470
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3471
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
3472
+ * @default false
3322
3473
  * @example
3323
3474
  * ```js
3324
- * const embed = new AppEmbed('#tsEmbed', {
3325
- * ... // other options
3326
- * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3475
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed
3476
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3477
+ * ... // other embed view config
3478
+ * enableAskSage:true,
3327
3479
  * })
3328
3480
  * ```
3329
3481
  */
3330
- hiddenListColumns?: ListPageColumns[];
3482
+ enableAskSage?: boolean;
3483
+ }
3484
+ export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
3331
3485
  }
3332
3486
  /**
3333
3487
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3720,7 +3874,7 @@ export declare enum EmbedEvent {
3720
3874
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
3721
3875
  * @example
3722
3876
  * ```js
3723
- * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
3877
+ * LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
3724
3878
  * console.log('VizPointDoubleClick', payload);
3725
3879
  * })
3726
3880
  * ```
@@ -4579,7 +4733,13 @@ export declare enum EmbedEvent {
4579
4733
  * Emitted when a user creates a Model.
4580
4734
  * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
4581
4735
  */
4582
- CreateModel = "createModel"
4736
+ CreateModel = "createModel",
4737
+ /**
4738
+ * @hidden
4739
+ * Emitted when a user exits present mode.
4740
+ * @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
4741
+ */
4742
+ ExitPresentMode = "exitPresentMode"
4583
4743
  }
4584
4744
  /**
4585
4745
  * Event types that can be triggered by the host application
@@ -5651,7 +5811,17 @@ export declare enum HostEvent {
5651
5811
  * ```
5652
5812
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5653
5813
  */
5654
- TransformTableVizData = "TransformTableVizData"
5814
+ TransformTableVizData = "TransformTableVizData",
5815
+ /**
5816
+ * @hidden
5817
+ * Trigger exit from presentation mode when user exits fullscreen.
5818
+ * This is automatically triggered by the SDK when fullscreen mode is exited.
5819
+ * ```js
5820
+ * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
5821
+ *```
5822
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5823
+ */
5824
+ ExitPresentMode = "exitPresentMode"
5655
5825
  }
5656
5826
  /**
5657
5827
  * The different visual modes that the data sources panel within
@@ -5783,7 +5953,8 @@ export declare enum Param {
5783
5953
  ShowSpotterLimitations = "showSpotterLimitations",
5784
5954
  CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5785
5955
  PrimaryAction = "primaryAction",
5786
- isSpotterAgentEmbed = "isSpotterAgentEmbed"
5956
+ isSpotterAgentEmbed = "isSpotterAgentEmbed",
5957
+ IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
5787
5958
  }
5788
5959
  /**
5789
5960
  * ThoughtSpot application pages include actions and menu commands
@@ -5794,8 +5965,8 @@ export declare enum Param {
5794
5965
  * or `hiddenActions` array.
5795
5966
  * @example
5796
5967
  * ```js
5797
- * const embed = new LiveboardEmbed('#embed-container', {
5798
- * ... // other options
5968
+ * const embed = new LiveboardEmbed('#tsEmbed', {
5969
+ * ... //other embed view config
5799
5970
  * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
5800
5971
  * disabledActions: [Action.Download],
5801
5972
  * //hiddenActions: [], // Set either this or visibleActions
@@ -5803,8 +5974,8 @@ export declare enum Param {
5803
5974
  * ```
5804
5975
  * @example
5805
5976
  * ```js
5806
- * const embed = new LiveboardEmbed('#embed-container', {
5807
- * ... // other options
5977
+ * const embed = new LiveboardEmbed('#tsEmbed', {
5978
+ * ... //other embed view config
5808
5979
  * //visibleActions: [],
5809
5980
  * disabledActions: [Action.Download],
5810
5981
  * hiddenActions: [Action.Edit, ActionAction.Explore],
@@ -7076,7 +7247,7 @@ export declare enum LogLevel {
7076
7247
  * @example
7077
7248
  * ```js
7078
7249
  * init({
7079
- * ... // other options,
7250
+ * ... //other embed view config,
7080
7251
  * logLevel: LogLevel.SILENT,
7081
7252
  * })
7082
7253
  * ```
@@ -7088,7 +7259,7 @@ export declare enum LogLevel {
7088
7259
  * @example
7089
7260
  * ```js
7090
7261
  * init({
7091
- * ... // other options,
7262
+ * ... //other embed view config,
7092
7263
  * logLevel: LogLevel.ERROR,
7093
7264
  * })
7094
7265
  * ```
@@ -7100,7 +7271,7 @@ export declare enum LogLevel {
7100
7271
  * @example
7101
7272
  * ```js
7102
7273
  * init({
7103
- * ... // other options,
7274
+ * ... //other embed view config,
7104
7275
  * logLevel: LogLevel.WARN,
7105
7276
  * })
7106
7277
  * ```
@@ -7113,7 +7284,7 @@ export declare enum LogLevel {
7113
7284
  * @example
7114
7285
  * ```js
7115
7286
  * init({
7116
- * ... // other options,
7287
+ * ... //other embed view config,
7117
7288
  * logLevel: LogLevel.INFO,
7118
7289
  * })
7119
7290
  * ```
@@ -7126,7 +7297,7 @@ export declare enum LogLevel {
7126
7297
  * @example
7127
7298
  * ```js
7128
7299
  * init({
7129
- * ... // other options,
7300
+ * ... //other embed view config,
7130
7301
  * logLevel: LogLevel.DEBUG,
7131
7302
  * })
7132
7303
  * ```
@@ -7138,7 +7309,7 @@ export declare enum LogLevel {
7138
7309
  * @example
7139
7310
  * ```js
7140
7311
  * init({
7141
- * ... // other options,
7312
+ * ... //other embed view config,
7142
7313
  * logLevel: LogLevel.TRACE,
7143
7314
  * })
7144
7315
  * ```
@@ -7159,14 +7330,16 @@ export interface DefaultAppInitData {
7159
7330
  hiddenListColumns: ListPageColumns[];
7160
7331
  }
7161
7332
 
7333
+ interface EmbedViewConfig extends AllEmbedViewConfig, EmbedEventHandlers {
7334
+ }
7162
7335
  export type EmbedEventHandlers = {
7163
7336
  [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
7164
7337
  };
7165
- export interface EmbedProps extends ViewConfig, EmbedEventHandlers {
7338
+ export interface EmbedProps extends EmbedViewConfig {
7166
7339
  className?: string;
7167
7340
  style?: React.CSSProperties;
7168
7341
  }
7169
- export interface ViewConfigAndListeners<T extends ViewConfig> {
7342
+ export interface ViewConfigAndListeners<T extends EmbedViewConfig> {
7170
7343
  viewConfig: T;
7171
7344
  listeners: {
7172
7345
  [key in EmbedEvent]?: MessageCallback;
@@ -7176,7 +7349,8 @@ export interface ViewConfigAndListeners<T extends ViewConfig> {
7176
7349
  *
7177
7350
  * @param props
7178
7351
  */
7179
- export function getViewPropsAndListeners<T extends EmbedProps, U extends ViewConfig>(props: T): ViewConfigAndListeners<U>;
7352
+ export function getViewPropsAndListeners<T extends EmbedProps, U extends EmbedViewConfig>(props: T): ViewConfigAndListeners<U>;
7353
+ export {};
7180
7354
 
7181
7355
  /**
7182
7356
  * Configuration for search options
@@ -7191,9 +7365,9 @@ export interface SearchOptions {
7191
7365
  * The configuration for the embedded spotterEmbed options.
7192
7366
  * @group Embed components
7193
7367
  */
7194
- export interface SpotterEmbedViewConfig extends ViewConfig {
7368
+ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
7195
7369
  /**
7196
- * The ID of the worksheet to use for the conversation.
7370
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
7197
7371
  */
7198
7372
  worksheetId: string;
7199
7373
  /**
@@ -7203,10 +7377,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7203
7377
  /**
7204
7378
  * disableSourceSelection : Disables data source selection
7205
7379
  * but still display the selected data source.
7380
+ *
7381
+ * Supported embed types: `SpotterEmbed`
7206
7382
  * @example
7207
7383
  * ```js
7208
7384
  * const embed = new SpotterEmbed('#tsEmbed', {
7209
- * ... // other options
7385
+ * ... //other embed view config
7210
7386
  * disableSourceSelection : true,
7211
7387
  * })
7212
7388
  * ```
@@ -7215,10 +7391,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7215
7391
  disableSourceSelection?: boolean;
7216
7392
  /**
7217
7393
  * hideSourceSelection : Hide data source selection
7394
+ *
7395
+ * Supported embed types: `SpotterEmbed`
7218
7396
  * @example
7219
7397
  * ```js
7220
7398
  * const embed = new SpotterEmbed('#tsEmbed', {
7221
- * ... // other options
7399
+ * ... //other embed view config
7222
7400
  * hideSourceSelection : true,
7223
7401
  * })
7224
7402
  * ```
@@ -7227,12 +7405,15 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7227
7405
  hideSourceSelection?: boolean;
7228
7406
  /**
7229
7407
  * Flag to control Data panel experience
7408
+ *
7409
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
7230
7410
  * @default false
7231
7411
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
7232
7412
  * @example
7233
7413
  * ```js
7234
- * const embed = new AppEmbed('#tsEmbed', {
7235
- * ... // other options
7414
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
7415
+ * const embed = new <EmbedComponent>('#tsEmbed', {
7416
+ * ... // other embed view config
7236
7417
  * dataPanelV2: true,
7237
7418
  * })
7238
7419
  * ```
@@ -7242,10 +7423,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7242
7423
  * showSpotterLimitations : show limitation text
7243
7424
  * of the spotter underneath the chat input.
7244
7425
  * default is false.
7426
+ *
7427
+ * Supported embed types: `SpotterEmbed`
7245
7428
  * @example
7246
7429
  * ```js
7247
7430
  * const embed = new SpotterEmbed('#tsEmbed', {
7248
- * ... // other options
7431
+ * ... //other embed view config
7249
7432
  * showSpotterLimitations : true,
7250
7433
  * })
7251
7434
  * ```
@@ -7255,10 +7438,12 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7255
7438
  /**
7256
7439
  * hideSampleQuestions : Hide sample questions on
7257
7440
  * the initial screen of the conversation.
7441
+ *
7442
+ * Supported embed types: `SpotterEmbed`
7258
7443
  * @example
7259
7444
  * ```js
7260
7445
  * const embed = new SpotterEmbed('#tsEmbed', {
7261
- * ... // other options
7446
+ * ... //other embed view config
7262
7447
  * hideSampleQuestions : true,
7263
7448
  * })
7264
7449
  * ```
@@ -7268,7 +7453,7 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7268
7453
  }
7269
7454
  /**
7270
7455
  * The configuration for the embedded spotterEmbed options.
7271
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
7456
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
7272
7457
  * Use {@link SpotterEmbedViewConfig} instead
7273
7458
  * @group Embed components
7274
7459
  */
@@ -7297,7 +7482,7 @@ export declare class SpotterEmbed extends TsEmbed {
7297
7482
  }
7298
7483
  /**
7299
7484
  * Embed ThoughtSpot AI Conversation.
7300
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
7485
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
7301
7486
  * Use {@link SpotterEmbed} instead
7302
7487
  * @group Embed components
7303
7488
  * @example
@@ -7978,12 +8163,13 @@ export interface UnderlyingDataPoint {
7978
8163
  * directly from your application.
7979
8164
  *
7980
8165
  * You can use this service to:
8166
+ *
7981
8167
  * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
7982
8168
  * - Apply filters to Answers (`addFilter`)
7983
8169
  * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
7984
8170
  * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
7985
8171
  * - Run custom queries (`executeQuery`)
7986
- * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
8172
+ * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
7987
8173
  *
7988
8174
  * @example
7989
8175
  * ```js
@@ -8383,7 +8569,11 @@ export declare class TsEmbed {
8383
8569
  * @param {HTMLIFrameElement} iFrame HTMLIFrameElement
8384
8570
  */
8385
8571
  protected setIframeElement(iFrame: HTMLIFrameElement): void;
8386
- protected viewConfig: ViewConfig;
8572
+ protected viewConfig: ViewConfig & {
8573
+ visibleTabs?: string[];
8574
+ hiddenTabs?: string[];
8575
+ showAlerts?: boolean;
8576
+ };
8387
8577
  protected embedConfig: EmbedConfig;
8388
8578
  /**
8389
8579
  * The ThoughtSpot hostname or IP address