Skip to content

Commit afd34bf

Browse files
Merge pull request #333 from thoughtspot/main
10-11-0 doc publication
2 parents a44e58c + e97a41a commit afd34bf

25 files changed

Lines changed: 4417 additions & 261 deletions

modules/ROOT/pages/api-changelog.adoc

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,85 @@
88

99
This changelog lists only the changes introduced in the Visual Embed SDK. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New].
1010

11+
== Version 1.40.0, July 2025
12+
13+
[width="100%" cols="1,4"]
14+
|====
15+
|[tag greenBackground]#NEW FEATURE# a| *Fullscreen presentation mode controls for embedded Liveboards and visualizations* +
16+
Developers can now control whether a visualization or Liveboard can be presented in full screen mode using the `disableFullscreenPresentation` attribute. By default, the full screen mode is disabled on embedded Liveboards and visualizations.
17+
|[tag greenBackground]#NEW FEATURE# a| *PDF download settings* +
18+
Developers can now control the display of *Include cover page* and *Include filter page(s)* options on the Download PDF dialog for Liveboards. The *Include cover page* and *Include filter page(s)* options are disabled by default on ThoughtSpot instances. When this feature is enabled, developers can use the `coverAndFilterOptionInPDF` attribute to show or hide these options for the Liveboard users in their embedding app.
19+
20+
|[tag greenBackground]#NEW FEATURE# a| *Parameter for overriding a default primary action* +
21+
22+
If Spotter is enabled on your instance, the *Spotter* button appears by default as the primary action on embedded Liveboard charts; if Spotter is not enabled, the *Explore* button is set as the primary action. If you want to replace the primary action with a different action, you can now use the `primaryAction` attribute.
23+
24+
For more information, see xref:embed-actions.adoc#_override_default_primary_actions[Override default primary action].
25+
26+
|[tag greenBackground]#NEW FEATURE# a| *Full application embed experience enhancements* +
27+
28+
The SDK now includes the `hideObjectSearch` property, which allows developers to hide the object search button in the navigation bar when embedding the full application.
29+
30+
|[tag greenBackground]#NEW FEATURE# a| *Host events* +
31+
32+
In this version, the SDK introduces the following host event handlers:
33+
34+
- `HostEvent.ExitPresentMode` +
35+
Triggers the exit action that allows users to exit the Liveboard or visualization present mode.
36+
- `HostEvent.SpotterSearch` +
37+
Triggers a search operation for the specified query string Spotter embed.
38+
- `HostEvent.PreviewSpotterData` +
39+
Triggers the *Preview data* action that shows the data used for Spotter conversations.
40+
- `HostEvent.ResetSpotterConversation` +
41+
Triggers the *Reset* action to reset a Spotter conversation.
42+
- `HostEvent.EditLastPrompt` +
43+
Triggers the edit prompt action.
44+
- `HostEvent.DeleteLastPrompt` +
45+
Triggers the delete prompt action.
46+
47+
For more information, see xref:HostEvent.adoc[HostEvent].
48+
49+
|[tag greenBackground]#NEW FEATURE# a|*Events support for Spotter embed*
50+
51+
You can now use the following host events in Spotter embed:
52+
53+
- `HostEvent.DownloadAsCsv`
54+
- `HostEvent.DownloadAsPng`
55+
- `HostEvent.DownloadAsXlsx`
56+
- `HostEvent.Edit`
57+
//- `HostEvent.GetParameters`
58+
//- `HostEvent.GetTML`
59+
- `HostEvent.MakeACopy`
60+
- `HostEvent.Pin`
61+
- `HostEvent.Save`
62+
63+
For more information, see xref:HostEvent.adoc[HostEvent].
64+
65+
|[tag greenBackground]#NEW FEATURE# a| *Lazy loading with full height*
66+
67+
The SDK introduces `lazyLoadingForFullHeight` parameter, which enables progressive loading of visualizations on an embedded Liveboard.
68+
This parameter works in conjunction with the `fullHeight` attribute. When both these attributes are enabled, only the visualizations in the current viewport are loaded initially, while the other visualizations load as the user scrolls the Liveboard page.
69+
70+
[NOTE]
71+
====
72+
To use these attributes effectively in embedded applications, your ThoughtSpot instance must be upgraded to version 10.12.0.cl or later.
73+
====
74+
|====
75+
76+
////
77+
78+
TBD 10.12 events
79+
80+
- `HostEvent.AnswerChartSwitcher`
81+
- `HostEvent.AskSpotter`
82+
- `HostEvent.DeleteLastPrompt`
83+
- `HostEvent.EditLastPrompt`
84+
- `HostEvent.PreviewSpotterData`
85+
- `HostEvent.ResetSpotterConversation`
86+
- `HostEvent.SpotterSearch`
87+
88+
////
89+
1190
== Version 1.39.0, July 2025
1291

1392
[width="100%" cols="1,4"]
@@ -31,6 +110,54 @@ For ThoughtSpot instances that have the new Spotter feedback and coaching workfl
31110
[NOTE]
32111
The **Add to Coaching** feature is currently in beta and is turned off by default on embed deployments. To enable this feature on your instance, contact ThoughtSpot Support.
33112

113+
|[tag greenBackground]#NEW FEATURE# a|*Events support for Spotter embed*
114+
115+
New embed events::
116+
117+
- `EmbedEvent.ExitPresentMode` +
118+
Emits when a user exits the Liveboard or visualization presentation mode.
119+
- `EmbedEvent.LastPromptDeleted` +
120+
Emits when a query prompt in Spotter embed is deleted.
121+
- `EmbedEvent.LastPromptEdited` +
122+
Emits when a query prompt in Spotter embed is edited.
123+
- `EmbedEvent.ResetSpotterConversation` +
124+
Emits when a Spotter query is reset.
125+
- `EmbedEvent.PreviewSpotterData` +
126+
Emits when a user clicks the Preview data button in the Spotter conversation panel.
127+
- `EmbedEvent.SpotterQueryTriggered`
128+
Emits when a Spotter query is triggered.
129+
130+
The following embed events are also supported in Spotter embed:
131+
132+
- `EmbedEvent.AddRemoveColumns`
133+
- `EmbedEvent.AnswerChartSwitcher`
134+
- `EmbedEvent.AuthExpire`
135+
- `EmbedEvent.AuthInit`
136+
- `EmbedEvent.CopyToClipboard`
137+
- `EmbedEvent.CustomAction`
138+
- `EmbedEvent.Data`
139+
- `EmbedEvent.DataSourceSelected`
140+
- `EmbedEvent.DialogClose`
141+
- `EmbedEvent.DialogOpen`
142+
- `EmbedEvent.Download`
143+
- `EmbedEvent.DownloadAsCsv`
144+
- `EmbedEvent.DownloadAsPng`
145+
- `EmbedEvent.DownloadAsXlsx`
146+
- `EmbedEvent.DrillDown`
147+
- `EmbedEvent.DrillExclude`
148+
- `EmbedEvent.DrillInclude`
149+
- `EmbedEvent.Edit`
150+
- `EmbedEvent.Error`
151+
- `EmbedEvent.Load`
152+
- `EmbedEvent.Pin`
153+
- `EmbedEvent.Save`
154+
- `EmbedEvent.TableVizRendered`
155+
- `EmbedEvent.VizPointClick`
156+
- `EmbedEvent.VizPointDoubleClick`
157+
- `EmbedEvent.VizPointRightClick`
158+
159+
For more information, see xref:EmbedEvent.adoc[EmbedEvent].
160+
34161
|====
35162

36163
== Version 1.38.0, June 2025

modules/ROOT/pages/common/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
*** Embed analytics
6363
**** link:{{navprefix}}/embed-liveboard[Embed a Liveboard]
6464
**** link:{{navprefix}}/embed-a-viz[Embed a visualization]
65-
*** Embed natural language search
65+
*** Embed AI Search and Analytics
6666
**** link:{{navprefix}}/embed-spotter[Embed Spotter]
6767
**** link:{{navprefix}}/tutorials/spotter/integrate-into-chatbot[Integrate Spotter interface into a Chatbot]
6868
**** link:{{navprefix}}/embed-nls[Embed Natural Language Search (legacy interface)]

modules/ROOT/pages/developer-playground.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ searchOptions: {
165165
}
166166
----
167167

168-
a|**Hide Sage Answer header**
168+
a|**Hide AI-Answer header**
169169

170170
Hides the Answer header container.
171171

modules/ROOT/pages/development-and-deployment.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ xref:orgs.adoc[Orgs] are fully separated tenants on a single ThoughtSpot instanc
2121

2222
Once your environments are configured, you can xref:version_control.adoc#moving-tml-changes-between-environments[move data models and content] from the initial "dev environment" to any other environment using the xref:git-rest-api-guide.adoc[Git integration REST APIs].
2323

24+
[NOTE]
25+
====
26+
ThoughtSpot does not recommend TML export and import across different versions of ThoughtSpot application because the TML syntax, supported features, and object schemas can vary between releases and can sometimes lead to compatibility issues and validation errors.
27+
====
28+
2429
////
2530
If you have used ThoughtSpot for a long time and are enabling Orgs for the first time, please see xref:moving-to-orgs.adoc[moving to Orgs from single-tenant ThoughtSpot instance].
2631
////

0 commit comments

Comments
 (0)