Skip to content

SDK reference fixes for SCAL-251659, SCAL-297673, and SCAL-337086 #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShashiSubramanya wants to merge 2 commits into
base: main
Choose a base branch
from
+1,742 −172
Open

SDK reference fixes for SCAL-251659, SCAL-297673, and SCAL-337086 #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dfbb55b
SDK reference fixes for SCAL-251659, SCAL-297673, and SCAL-337086
ShashiSubramanya Oct 15, 2026
a2669de
CI error fix
ShashiSubramanya Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,6 @@ modules/**/generated/
!.idea/dictionaries/*.xml
.DS_store
*.swp

# Local report for the docs writers, written by scripts/Converter/index.ts
scripts/Converter/reports/
17 changes: 0 additions & 17 deletions modules/ROOT/pages/common/nav-embedding.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,23 +165,6 @@ Customize and integrate
Reference guides and changelog

* link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference]
include::generated/typedoc/CustomSideNav.adoc[]
** Custom styles
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomStyles[CustomStyles]#
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomisationsInterface[CustomisationsInterface]#
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_customCssInterface[customCssInterface]#
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomCssVariables[customCssVariables]#
** Runtime filters
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_RuntimeFilter[RuntimeFilter]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_RuntimeFilterOp[RuntimeFilterOp]#
** Others
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Action[Action]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_ContextMenuTriggerOptions[ContextMenuTriggerOptions]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_DataSourceVisualMode[DataSourceVisualMode]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Page[Page]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_PrefetchFeatures[PrefetchFeatures]#
*** [.typedoc-Function]#link:{{navprefix}}/Function_executeTML[executeTML]#
*** [.typedoc-Function]#link:{{navprefix}}/Function_exportTML[exportTML]#
* link:{{navprefix}}/embed-sdk-changelog[Changelog]
** link:{{navprefix}}/embed-sdk-changelog[Visual Embed SDK]
** link:{{navprefix}}/mobile-sdk-changelog[Mobile Embed SDK]
Expand Down
18 changes: 1 addition & 17 deletions modules/ROOT/pages/common/nav-in-product-help.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,23 +149,7 @@ Customize and integrate
Visual Embed SDK reference guide

* link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference]
include::generated/typedoc/CustomSideNav.adoc[]
** Custom styles
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomStyles[CustomStyles]#
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomisationsInterface[CustomisationsInterface]#
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_customCssInterface[customCssInterface]#
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_CustomCssVariables[customCssVariables]#
** Runtime filters
*** [.typedoc-Interface]#link:{{navprefix}}/Interface_RuntimeFilter[RuntimeFilter]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_RuntimeFilterOp[RuntimeFilterOp]#
** Others
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Action[Action]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_ContextMenuTriggerOptions[ContextMenuTriggerOptions]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_DataSourceVisualMode[DataSourceVisualMode]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_Page[Page]#
*** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_PrefetchFeatures[PrefetchFeatures]#
*** [.typedoc-Function]#link:{{navprefix}}/Function_executeTML[executeTML]#
*** [.typedoc-Function]#link:{{navprefix}}/Function_exportTML[exportTML]#
include::generated/typedoc/SdkReferenceNav.adoc[]


[.sidebar-title]
Expand Down
10 changes: 10 additions & 0 deletions modules/ROOT/pages/common/nav-sdk-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:page-pageid: nav-sdk-reference
:page-description: Visual Embed SDK reference navigation

[navSection]

[.sidebar-title]
SDK Reference Guide

* link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK]
include::generated/typedoc/SdkReferenceNav.adoc[]
15 changes: 1 addition & 14 deletions modules/ROOT/pages/embed-action-ref.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

ThoughtSpot application components such as Liveboards, Answers, visualizations, Search and Spotter interface, and application pages support several actions and menu commands for user-initiated operations. To allow developers to customize the menu options and feature availability for their embedded application users, Visual Embed SDK provides action IDs for the actions in the ThoughtSpot application interface. Developers can use these action IDs in the `visibleActions`, `disabledActions`, or `hiddenActions` arrays to show, disable, or hide specific actions in the embedded view.

The availability of these actions may vary based on user privileges and the SDK library used for embedding. For information about the action IDs available for embed components, browse through the lists in the following sections.
The availability of these actions may vary based on user privileges and the SDK library used for embedding. For information about the action IDs available for embed components, browse through the lists in the following sections. To see only the actions that apply to a specific embed type, such as `LiveboardEmbed` or `SpotterEmbed`, use the filter on the xref:Action.adoc[Action] page.

[#liveboardv2-action]
== Liveboard
Expand Down Expand Up @@ -100,14 +100,6 @@ Controls the visibility of the Liveboard style panel.
`AppEmbed` |The Liveboard verified banner text. +
Indicates the Liveboard is verified. +
See also, xref:LiveboardViewConfig.adoc#_showliveboardverifiedbadge[showLiveboardVerifiedBadge].
|xref:Action.adoc#_personalisedviewsdropdown[`Action.PersonalisedViewsDropdown`]| `LiveboardEmbed` +
`AppEmbed` | The Liveboard personalized views drop-down. +
Available if personalized views are saved on the Liveboard. +
Allows switching between the saved personalized views of a Liveboard. +
[NOTE]
====
This action is deprecated. Use `Action.PersonalizedViewsDropdown` instead.
====
|xref:Action.adoc#_personalizedviewsdropdown[`Action.PersonalizedViewsDropdown`]| `LiveboardEmbed` +
`AppEmbed` | The Liveboard personalized views drop-down. +
Allows switching between the saved personalized views of a Liveboard.
Expand Down Expand Up @@ -632,11 +624,6 @@ a|xref:Action.adoc#_addtowatchlist[`Action.AddToWatchlist`] a| `AppEmbed` | The
Adds a KPI chart to the watchlist on the Home page.
a|xref:Action.adoc#_removefromwatchlist[`Action.RemoveFromWatchlist`] a| `AppEmbed` | The *Remove from watchlist* menu action on KPI watchlist. +
Removes a KPI chart from the watchlist on the Home page.
a|xref:Action.adoc#_organisefavourites[`Action.OrganiseFavourites`] a| `AppEmbed` | The *Organize Favourites* action on Homepage Favorites module. +
[NOTE]
====
This action is deprecated. Use `Action.OrganizeFavorites` instead.
====
a|xref:Action.adoc#_organizefavorites[`Action.OrganizeFavorites`] a| `AppEmbed` | The *Organize Favorites* action on Homepage Favorites module.
|xref:Action.adoc#_copylink[`Action.CopyLink`] a|`AppEmbed`|*Copy link* +
Allows users to copy a link from the *Watchlist* on the Homepage.
Expand Down
Loading
Loading