@thoughtspot/visual-embed-sdk 1.29.1 → 1.30.0-alpha.1

package/lib/src/types.js

@@ -2,12 +2,14 @@
  * Copyright (c) 2023
  *
  * TypeScript type definitions for ThoughtSpot Visual Embed SDK
+ *
  * @summary Type definitions for Embed SDK
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 /**
  * The authentication mechanism for allowing access to the
  * the embedded app
+ *
  * @group Authentication / Init
  */
 // eslint-disable-next-line no-shadow
@@ -16,6 +18,7 @@ export var AuthType;
     /**
      * No authentication on the SDK. Passthrough to the embedded App. Alias for
      * `Passthrough`.
+     *
      * @example
      * ```js
      * init({
@@ -33,6 +36,7 @@ export var AuthType;
      * To use this:
      * Your SAML or OpenID provider must allow iframe redirects.
      * For example, if you are using Okta as IdP, you can enable iframe embedding.
+     *
      * @example
      * ```js
      * init({
@@ -45,12 +49,14 @@ export var AuthType;
     AuthType["EmbeddedSSO"] = "EmbeddedSSO";
     /**
      * SSO using SAML
+     *
      * @deprecated Use {@link SAMLRedirect} instead
      * @hidden
      */
     AuthType["SSO"] = "SSO_SAML";
     /**
      * SSO using SAML
+     *
      * @deprecated Use {@link SAMLRedirect} instead
      * @hidden
      */
@@ -62,6 +68,7 @@ export var AuthType;
      *
      * This redirects the host application to the SAML IdP. The host application
      * will be redirected back to the ThoughtSpot app after authentication.
+     *
      * @example
      * ```js
      * init({
@@ -102,6 +109,7 @@ export var AuthType;
     AuthType["SAMLRedirect"] = "SSO_SAML";
     /**
      * SSO using OIDC
+     *
      * @hidden
      * @deprecated Use {@link OIDCRedirect} instead
      */
@@ -114,6 +122,7 @@ export var AuthType;
     AuthType["OIDCRedirect"] = "SSO_OIDC";
     /**
      * Trusted authentication server
+     *
      * @hidden
      * @deprecated Use {@link TrustedAuth} instead
      */
@@ -122,6 +131,7 @@ export var AuthType;
      * Trusted authentication server. Use your own authentication server
      * which returns a bearer token, generated using the `secret_key` obtained
      * from ThoughtSpot.
+     *
      * @example
      * ```js
      * init({
@@ -133,7 +143,6 @@ export var AuthType;
      *      .then((data) => data.token);
      *  }
      * });
-     * });
      * ```
      */
     AuthType["TrustedAuthToken"] = "AuthServer";
@@ -143,6 +152,7 @@ export var AuthType;
      * obtained from ThoughtSpot. This uses a cookieless authentication
      * approach, recommended to bypass the third-party cookie-blocking restriction
      * implemented by some browsers.
+     *
      * @example
      * ```js
      * init({
@@ -262,12 +272,17 @@ export var RuntimeFilterOp;
      * Is included in this list of values
      */
     RuntimeFilterOp["IN"] = "IN";
+    /**
+     * Is not included in this list of values
+     */
+    RuntimeFilterOp["NOT_IN"] = "NOT_IN";
 })(RuntimeFilterOp || (RuntimeFilterOp = {}));
 /**
  * Home page module that can be hidden.
  * **Note**: This option does not apply to the classic homepage.
  * To access the updated modular homepage, set
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+ *
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
  */
 // eslint-disable-next-line no-shadow
@@ -303,6 +318,7 @@ export var HomepageModule;
  *
  * To add an event listener use the corresponding
  * {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
+ *
  *  @example
  * ```js
  * import { EmbedEvent } from '@thoughtspot/visual-embed-sdk';
@@ -322,6 +338,7 @@ export var EmbedEvent;
 (function (EmbedEvent) {
     /**
      * Rendering has initialized.
+     *
      * @example
      *```js
      * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -335,7 +352,9 @@ export var EmbedEvent;
     EmbedEvent["Init"] = "init";
     /**
      * Authentication has either succeeded or failed.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+     *
      * @example
      *```js
      * appEmbed.on(EmbedEvent.AuthInit, payload => {
@@ -347,7 +366,9 @@ export var EmbedEvent;
     EmbedEvent["AuthInit"] = "authInit";
     /**
      * The embed object container has loaded.
+     *
      * @returns timestamp - The timestamp when the event was generated.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      *```js
@@ -361,7 +382,9 @@ export var EmbedEvent;
     EmbedEvent["Load"] = "load";
     /**
      * Data pertaining to answer or Liveboard is received
+     *
      * @return data - The answer or Liveboard data
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      *```js
@@ -374,11 +397,13 @@ export var EmbedEvent;
     EmbedEvent["Data"] = "data";
     /**
      * Search/Answer/Liveboard filters have been applied/updated by the user.
+     *
      * @hidden
      */
     EmbedEvent["FiltersChanged"] = "filtersChanged";
     /**
      * Search query has been updated by the user.
+     *
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
      * @example
      *```js
@@ -388,7 +413,9 @@ export var EmbedEvent;
     EmbedEvent["QueryChanged"] = "queryChanged";
     /**
      * A drill-down operation has been performed.
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+     *
      * @returns additionalFilters - Any additional filters applied
      * @returns drillDownColumns - The columns on which drill down was performed
      * @returns nonFilteredColumns - The columns that were not filtered
@@ -425,7 +452,9 @@ export var EmbedEvent;
     EmbedEvent["Drilldown"] = "drillDown";
     /**
      * One or more data sources have been selected.
+     *
      * @returns dataSourceIds - the list of data sources
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      * ```js
@@ -437,6 +466,7 @@ export var EmbedEvent;
     EmbedEvent["DataSourceSelected"] = "dataSourceSelected";
     /**
      * One or more data columns have been selected.
+     *
      * @returns columnIds - the list of columns
      * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      * @example
@@ -449,9 +479,11 @@ export var EmbedEvent;
     EmbedEvent["AddRemoveColumns"] = "addRemoveColumns";
     /**
      * A custom action has been triggered.
+     *
      * @returns actionId - ID of the custom action
      * @returns payload {@link CustomActionPayload} - Response payload with the
      * Answer or Liveboard data
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      * ```js
@@ -466,6 +498,7 @@ export var EmbedEvent;
     EmbedEvent["CustomAction"] = "customAction";
     /**
      * Listen to double click actions on a visualization.
+     *
      * @return ContextMenuInputPoints - Data point that is double-clicked
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @example
@@ -478,6 +511,7 @@ export var EmbedEvent;
     EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
     /**
      * Listen to clicks on a visualization in a Liveboard or Search result.
+     *
      * @return viz, clickedPoint - metadata about the point that is clicked
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @important
@@ -498,21 +532,17 @@ export var EmbedEvent;
     /**
      * An error has occurred. This event is fired for the following error types:
      *
-     * `API`: API call failure error.
+     *  `API` - API call failure error.
+     *  `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
+     *  `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
+     *  `NON_EXIST_FILTER` - Error due to a non-existent filter.
+     *  `INVALID_DATE_VALUE` - Invalid date value error.
+     *  `INVALID_OPERATOR` - Use of invalid operator during filter application.
      *
-     * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
-     * mode.
+     *  For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
      *
-     * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
-     *
-     * `NON_EXIST_FILTER`: Error due to a non-existent filter.
-     *
-     * `INVALID_DATE_VALUE`: Invalid date value error.
-     *
-     * `INVALID_OPERATOR`: Use of invalid operator during filter application.
-     *
-     * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
      * @returns error - An error object or message
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
      * ```js
@@ -537,8 +567,11 @@ export var EmbedEvent;
     EmbedEvent["Error"] = "Error";
     /**
      * The embedded object has sent an alert.
+     *
      * @returns alert - An alert object
+     *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.Alert)
@@ -547,7 +580,9 @@ export var EmbedEvent;
     EmbedEvent["Alert"] = "alert";
     /**
      * The ThoughtSpot auth session has expired.
+     *
      * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
+     *
      * @example
      *```js
      * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
@@ -560,22 +595,26 @@ export var EmbedEvent;
     EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
     /**
      * ThoughtSpot failed to validate the auth session.
+     *
      * @hidden
      */
     EmbedEvent["AuthFailure"] = "ThoughtspotAuthFailure";
     /**
      * ThoughtSpot failed to validate the auth session.
+     *
      * @hidden
      */
     EmbedEvent["AuthLogout"] = "ThoughtspotAuthLogout";
     /**
      * The height of the embedded Liveboard or visualization has been computed.
+     *
      * @returns data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
     /**
      * The center of visible iframe viewport is calculated.
+     *
      * @returns data - The center of the visible Iframe viewport.
      * @hidden
      */
@@ -583,6 +622,7 @@ export var EmbedEvent;
     /**
      * Emitted when the **Get Data** action is initiated.
      * Applicable to `SearchBarEmbed` only.
+     *
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      * @example
      *```js
@@ -595,6 +635,7 @@ export var EmbedEvent;
     EmbedEvent["GetDataClick"] = "getDataClick";
     /**
      * Detects the route change.
+     *
      * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -605,13 +646,15 @@ export var EmbedEvent;
     EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
     /**
      * The v1 event type for Data
+     *
      * @hidden
      */
     EmbedEvent["V1Data"] = "exportVizDataToParent";
     /**
      * Emitted when the embed does not have cookie access. This happens
      * when Safari and other Web browsers block third-party cookies
-     * are blocked by default.
+     * are blocked by default. `NoCookieAccess` can trigger
+     *
      * @example
      *```js
      * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -621,12 +664,14 @@ export var EmbedEvent;
     EmbedEvent["NoCookieAccess"] = "noCookieAccess";
     /**
      * Emitted when SAML is complete
+     *
      * @private
      * @hidden
      */
     EmbedEvent["SAMLComplete"] = "samlComplete";
     /**
      * Emitted when any modal is opened in the app
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      *```js
@@ -638,6 +683,7 @@ export var EmbedEvent;
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
      * Emitted when any modal is closed in the app
+     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      *```js
@@ -650,7 +696,8 @@ export var EmbedEvent;
     /**
      * Emitted when the Liveboard shell loads.
      * You can use this event as a hook to trigger
-     * actions on the rendered Liveboard.
+     * other events on the rendered Liveboard.
+     *
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -671,6 +718,7 @@ export var EmbedEvent;
     EmbedEvent["LiveboardRendered"] = "PinboardRendered";
     /**
      * Emits all events.
+     *
      * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -682,6 +730,7 @@ export var EmbedEvent;
     EmbedEvent["ALL"] = "*";
     /**
      * Emitted when an Answer is saved in the app
+     *
      * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -701,10 +750,11 @@ export var EmbedEvent;
     /**
      * Emitted when the download action is triggered on an answer
      *
-     * **Note**:  This event is deprecated in v1.21.0.
+     * **Note**: This event is deprecated in v1.21.0.
      * To fire an event when a download action is initiated on a chart or table,
      * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
      * or `EmbedEvent.DownloadAsXLSX`
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -716,6 +766,7 @@ export var EmbedEvent;
     EmbedEvent["Download"] = "download";
     /**
      * Emitted when the download action is triggered on an answer
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
      * @example
      *```js
@@ -730,6 +781,7 @@ export var EmbedEvent;
     EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
      * Emitted when the Download as PDF action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -744,6 +796,7 @@ export var EmbedEvent;
     EmbedEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
      * Emitted when the Download as CSV action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -758,6 +811,7 @@ export var EmbedEvent;
     EmbedEvent["DownloadAsCsv"] = "downloadAsCsv";
     /**
      * Emitted when the Download as XLSX action is triggered on an answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -772,13 +826,14 @@ export var EmbedEvent;
     EmbedEvent["DownloadAsXlsx"] = "downloadAsXlsx";
     /**
      * Emitted when an Answer is deleted in the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
      * //emit when action starts
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)}, {start: true })
-     * //emit when action is completed
+     * //trigger when action is completed
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
      *```
@@ -786,6 +841,7 @@ export var EmbedEvent;
     EmbedEvent["AnswerDelete"] = "answerDelete";
     /**
      * Emitted when an answer is pinned to a Liveboard
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -804,6 +860,7 @@ export var EmbedEvent;
     EmbedEvent["Pin"] = "pin";
     /**
      * Emitted when SpotIQ analysis is triggered
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -822,6 +879,7 @@ export var EmbedEvent;
     EmbedEvent["SpotIQAnalyze"] = "spotIQAnalyze";
     /**
      * Emitted when a user shares an object with another user or group
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -841,6 +899,7 @@ export var EmbedEvent;
     /**
      * Emitted when a user clicks the **Include** action to include a specific value or
      * data on a chart or table.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -853,6 +912,7 @@ export var EmbedEvent;
     /**
      * Emitted when a user clicks the **Exclude** action to exclude a specific value or
      * data on a chart or table
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -864,6 +924,7 @@ export var EmbedEvent;
     EmbedEvent["DrillExclude"] = "context-menu-item-exclude";
     /**
      * Emitted when a column value is copied in the embedded app.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -874,7 +935,9 @@ export var EmbedEvent;
      */
     EmbedEvent["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
     /**
-     * Emitted when a user clicks the **Update TML** action
+     * Emitted when a user clicks the **Update TML** action on
+     * embedded Liveboard.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -885,6 +948,8 @@ export var EmbedEvent;
     EmbedEvent["UpdateTML"] = "updateTSL";
     /**
      * Emitted when a user clicks the **Edit TML** action
+     * on an embedded Liveboard.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -897,6 +962,7 @@ export var EmbedEvent;
     /**
      * Emitted when the **Export TML** action is triggered on an
      * an embedded object in the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -911,6 +977,7 @@ export var EmbedEvent;
     EmbedEvent["ExportTML"] = "exportTSL";
     /**
      * Emitted when an Answer is saved as a View.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -922,6 +989,7 @@ export var EmbedEvent;
     EmbedEvent["SaveAsView"] = "saveAsView";
     /**
      * Emitted when the user creates a copy of an Answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -936,6 +1004,7 @@ export var EmbedEvent;
     EmbedEvent["CopyAEdit"] = "copyAEdit";
     /**
      * Emitted when a user clicks Show underlying data on an Answer
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -947,6 +1016,7 @@ export var EmbedEvent;
     EmbedEvent["ShowUnderlyingData"] = "showUnderlyingData";
     /**
      * Emitted when an answer is switched to a chart or table view.
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -958,11 +1028,13 @@ export var EmbedEvent;
     EmbedEvent["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
      * Internal event to communicate the initial settings back to the ThoughtSpot app
+     *
      * @hidden
      */
     EmbedEvent["APP_INIT"] = "appInit";
     /**
      * Emitted when a user clicks **Show Liveboard details** on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -974,6 +1046,7 @@ export var EmbedEvent;
     EmbedEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Emitted when a user clicks on the Favorite icon on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -985,6 +1058,7 @@ export var EmbedEvent;
     EmbedEvent["AddToFavorites"] = "addToFavorites";
     /**
      * Emitted when a user clicks **Schedule** on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -996,6 +1070,7 @@ export var EmbedEvent;
     EmbedEvent["Schedule"] = "subscription";
     /**
      * Emitted when a user clicks **Edit** on a Liveboard or visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1007,6 +1082,7 @@ export var EmbedEvent;
     EmbedEvent["Edit"] = "edit";
     /**
      * Emitted when a user clicks *Make a copy* on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1018,6 +1094,7 @@ export var EmbedEvent;
     EmbedEvent["MakeACopy"] = "makeACopy";
     /**
      * Emitted when a user clicks **Present** on a Liveboard or visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1033,6 +1110,7 @@ export var EmbedEvent;
     EmbedEvent["Present"] = "present";
     /**
      * Emitted when a user clicks **Delete** on a visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1043,6 +1121,7 @@ export var EmbedEvent;
     EmbedEvent["Delete"] = "delete";
     /**
      * Emitted when a user clicks Manage schedules on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1052,6 +1131,7 @@ export var EmbedEvent;
     EmbedEvent["SchedulesList"] = "schedule-list";
     /**
      * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1061,6 +1141,7 @@ export var EmbedEvent;
     EmbedEvent["Cancel"] = "cancel";
     /**
      * Emitted when a user clicks **Explore** on a visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1071,6 +1152,7 @@ export var EmbedEvent;
     EmbedEvent["Explore"] = "explore";
     /**
      * Emitted when a user clicks **Copy link** action on a visualization
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
@@ -1081,16 +1163,18 @@ export var EmbedEvent;
     EmbedEvent["CopyLink"] = "embedDocument";
     /**
      * Emitted when a user interacts with cross filters on a visualization or Liveboard
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
      *```js
-     * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
+     * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
      */
     EmbedEvent["CrossFilterChanged"] = "cross-filter-changed";
     /**
      * Emitted when a user right clicks on a visualization (chart or table)
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
      *```js
@@ -1102,6 +1186,7 @@ export var EmbedEvent;
     EmbedEvent["VizPointRightClick"] = "vizPointRightClick";
     /**
      * Emitted when a user clicks **Insert to slide** on a visualization
+     *
      * @hidden
      */
     EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
@@ -1109,6 +1194,7 @@ export var EmbedEvent;
      * Emitted when a user changes any filter on a Liveboard.
      * Returns filter type and name, column name and ID, and runtime
      * filter details.
+     *
      * @example
      *
      *```js
@@ -1117,38 +1203,36 @@ export var EmbedEvent;
      * })
      *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
-     * @example
-     *
-     *```js
-     * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
-     *    console.log('payload', payload);
-     * })
-     *```
      */
     EmbedEvent["FilterChanged"] = "filterChanged";
     /**
      *  Emitted when a user clicks the **Go** button on the Search page
+     *
      * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
     /**
      * Emitted when a user selects a data source.
+     *
      * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
      */
     EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
     /**
      * Emitted when a user updates a connection on the **Data** page
+     *
      * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["UpdateConnection"] = "updateConnection";
     /**
      * Emitted when a user updates a connection on the **Data** page
+     *
      * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
      */
     EmbedEvent["CreateConnection"] = "createConnection";
     /**
      * Emitted when name, status (private or public) or filter values of a
      * Personalised view is updated.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -1158,6 +1242,7 @@ export var EmbedEvent;
     EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
     /**
      * Emitted when a Personalised view is saved.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -1167,6 +1252,7 @@ export var EmbedEvent;
     EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
     /**
      * Emitted when a Liveboard is reset.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -1176,6 +1262,7 @@ export var EmbedEvent;
     EmbedEvent["ResetLiveboard"] = "resetLiveboard";
     /**
      * Emitted when a PersonalisedView is deleted.
+     *
      * @returns views: string[]
      * @returns liveboardId: string
      * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
@@ -1183,11 +1270,13 @@ export var EmbedEvent;
     EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
     /**
      * Emitted when a user creates a new worksheet
+     *
      * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
      */
     EmbedEvent["CreateWorksheet"] = "createWorksheet";
     /**
      * Emitted when Ask Sage is initialized.
+     *
      * @returns viewName: string
      * @returns viewId: string
      * @returns liveboardId: string
@@ -1197,6 +1286,7 @@ export var EmbedEvent;
     EmbedEvent["AskSageInit"] = "AskSageInit";
     /**
      * Emitted when a LB/viz is renamed
+     *
      * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
      */
     EmbedEvent["Rename"] = "rename";
@@ -1220,6 +1310,7 @@ export var EmbedEvent;
     EmbedEvent["OnBeforeGetVizDataIntercept"] = "onBeforeGetVizDataIntercept";
     /**
      * Emitted when runtime parameters changes
+     *
      * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
      */
     EmbedEvent["ParameterChanged"] = "ParameterChanged";
@@ -1231,6 +1322,7 @@ export var EmbedEvent;
  * To trigger an event use the corresponding
  * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
  * SearchEmbed.trigger} method.
+ *
  * @example
  * ```js
  * import { HostEvent } from '@thoughtspot/visual-embed-sdk';
@@ -1253,6 +1345,7 @@ export var HostEvent;
      * the search query string.
      * Supported in `AppEmbed` and `SearchEmbed` deployments.
      * Includes the following properties:
+     *
      * @param - `searchQuery` - query string with search tokens
      * @param - `dataSources` - Data source GUID to Search on
      *                        - Although an array, only a single source
@@ -1271,6 +1364,7 @@ export var HostEvent;
     /**
      * Triggers a drill on certain points of the specified column
      * Includes the following properties:
+     *
      * @param - points - an object containing selectedPoints/clickedPoints
      * to drill to. For example, { selectedPoints: []}
      * @param - columnGuid - Optional. GUID of the column to drill
@@ -1320,16 +1414,19 @@ export var HostEvent;
     HostEvent["DrillDown"] = "triggerDrillDown";
     /**
      * Apply filters
+     *
      * @hidden
      */
     HostEvent["Filter"] = "filter";
     /**
      * Reload the answer or visualization
+     *
      * @hidden
      */
     HostEvent["Reload"] = "reload";
     /**
      * Display specific visualizations on a Liveboard.
+     *
      * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
      *  in this parameter will be hidden.
      * @example
@@ -1343,6 +1440,7 @@ export var HostEvent;
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
     /**
      * Set a Liveboard tab as an active tab.
+     *
      * @param - tabId - string of id of Tab to show
      * @example
      * ```js
@@ -1363,16 +1461,17 @@ export var HostEvent;
      * _String_. The name of the column to filter on.
      *
      * `operator`
-     * Runtime filter operator to apply. For information,
-     * see [Developer Documentation](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+     *  Runtime filter operator to apply. For information,
+     *  see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
      *
      * `values`
-     * List of operands. Some operators such as EQ, LE allow a single value, whereas
-     * operators such as BW and IN accept multiple operands.
+     *  List of operands. Some operators such as EQ, LE allow a single value, whereas
+     *  operators such as BW and IN accept multiple operands.
+     *
+     *  **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
+     *  Search embedding (SearchEmbed) and Natural Language Search
+     *  embedding (SageEmbed).
      *
-     * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
-     * Search embedding (SearchEmbed) and Natural Language Search
-     * embedding (SageEmbed).
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
      * ```js
@@ -1388,6 +1487,7 @@ export var HostEvent;
     /**
      * Navigate to a specific page in the embedded ThoughtSpot application.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
+     *
      * @param - `path` - the path to navigate to to go forward or back. The path value can
      * be a number; for example, `1`, `-1`.
      * @example
@@ -1400,6 +1500,7 @@ export var HostEvent;
     /**
      * Open the filter panel for a particular column.
      * Works with Search and Liveboard embed.
+     *
      * @param - { columnId: string,
      *  name: string,
      *  type: INT64/CHAR/DATE,
@@ -1416,6 +1517,7 @@ export var HostEvent;
     HostEvent["OpenFilter"] = "openFilter";
     /**
      * Add columns to the current search query.
+     *
      * @param - { columnIds: string[] }
      * @example
      * ```js
@@ -1426,6 +1528,7 @@ export var HostEvent;
     HostEvent["AddColumns"] = "addColumns";
     /**
      * Remove a column from the current search query.
+     *
      * @param - { columnId: string }
      * @example
      * ```js
@@ -1440,6 +1543,7 @@ export var HostEvent;
      * Liveboard filters, runtime filters applied on visualizations on a
      * Liveboard, and Liveboard layout, changes to visualizations such as
      * sorting, toggling of legends, and data drill down.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
@@ -1450,6 +1554,7 @@ export var HostEvent;
     HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
     /**
      * Trigger the **Pin** action on an embedded object
+     *
      * @param - Liveboard embed takes the `vizId` as a
      * key. Can be left undefined when embedding Search, full app, or
      * a visualization.
@@ -1466,6 +1571,7 @@ export var HostEvent;
     /**
      * Trigger the **Show Liveboard details** action
      * on an embedded Liveboard.
+     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
@@ -1475,6 +1581,7 @@ export var HostEvent;
     HostEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Trigger the **Schedule** action on an embedded Liveboard.
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.Schedule)
@@ -1484,6 +1591,7 @@ export var HostEvent;
     HostEvent["Schedule"] = "subscription";
     /**
      * Trigger the **Manage schedule** action on an embedded Liveboard
+     *
      * @example
      * ```js
      *  liveboardEmbed.trigger(HostEvent.ScheduleList)
@@ -1492,16 +1600,22 @@ export var HostEvent;
      */
     HostEvent["SchedulesList"] = "schedule-list";
     /**
-     * Trigger the **Export TML** action on an embedded Liveboard.
+     * Trigger the **Export TML** action on an embedded Liveboard or
+     * Answer.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
      * ```
+     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["ExportTML"] = "exportTSL";
     /**
-     * Trigger the **Edit TML** action on an embedded Liveboard.
+     * Trigger the **Edit TML** action on an embedded Liveboard or
+     * saved Answers in the full application embedding.
+     *
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -1511,6 +1625,7 @@ export var HostEvent;
     HostEvent["EditTML"] = "editTSL";
     /**
      * Trigger the **Update TML** action on an embedded Liveboard.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateTML)
@@ -1519,7 +1634,12 @@ export var HostEvent;
      */
     HostEvent["UpdateTML"] = "updateTSL";
     /**
-     * Trigger the **Download PDF** action on an embedded Liveboard.
+     * Trigger the **Download PDF** action on an embedded Liveboard,
+     * visualization or Answer.
+     *
+     * **NOTE**: The **Download** > **PDF** action is available on
+     * visualizations and Answers if the data is in tabular format.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -1530,6 +1650,7 @@ export var HostEvent;
     /**
      * Trigger the **Make a copy** action on a Liveboard, Search, or
      * visualization page.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
@@ -1545,6 +1666,7 @@ export var HostEvent;
     HostEvent["MakeACopy"] = "makeACopy";
     /**
      * Trigger the **Delete** action for a Liveboard.
+     *
      * @example
      * ```js
      * appEmbed.trigger(HostEvent.Remove)
@@ -1554,6 +1676,7 @@ export var HostEvent;
     HostEvent["Remove"] = "delete";
     /**
      * Trigger the **Explore** action on a visualization.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -1564,6 +1687,7 @@ export var HostEvent;
     HostEvent["Explore"] = "explore";
     /**
      * Trigger the **Create alert** action on a visualization
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -1576,6 +1700,7 @@ export var HostEvent;
     HostEvent["CreateMonitor"] = "createMonitor";
     /**
      * Trigger the **Manage alerts** action on a visualization
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -1587,11 +1712,14 @@ export var HostEvent;
      */
     HostEvent["ManageMonitor"] = "manageMonitor";
     /**
-     * Trigger the **Edit** action on a Liveboard or visualization
+     * Trigger the **Edit** action on a Liveboard or a visualization
+     * on a Liveboard.
+     *
+     * This event is not supported in visualization embed and search embed.
+     *
      * @param - object - To trigger the action for a specific visualization
      * in Liveboard embed, pass in `vizId` as a key.
-     * Can be left undefined when embedding Search, full app, or
-     * a visualization.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
@@ -1600,14 +1728,12 @@ export var HostEvent;
      * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
-     * ```js
-     * vizEmbed.trigger((HostEvent.Edit)
-     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     HostEvent["Edit"] = "edit";
     /**
      * Trigger the **Copy link** action on a Liveboard or visualization
+     *
      * @param - object - to trigger the action for a
      * specific visualization in Liveboard embed, pass in `vizId` as a key
      * @example
@@ -1625,6 +1751,7 @@ export var HostEvent;
     HostEvent["CopyLink"] = "embedDocument";
     /**
      * Trigger the **Present** action on a Liveboard or visualization
+     *
      * @param - object - to trigger the action for a specific visualization
      *  in Liveboard embed, pass in `vizId` as a key
      * @example
@@ -1642,6 +1769,7 @@ export var HostEvent;
     HostEvent["Present"] = "present";
     /**
      * Get TML for the current search.
+     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
@@ -1656,6 +1784,7 @@ export var HostEvent;
     HostEvent["GetTML"] = "getTML";
     /**
      * Trigger the **Show underlying data** action on visualization or search
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -1675,6 +1804,7 @@ export var HostEvent;
      * Trigger the **Delete** action for a visualization
      * in an embedded Liveboard, or a chart or table
      * generated from Search.
+     *
      * @param - Liveboard embed takes an object with `vizId` as a key.
      * Can be left empty if embedding Search or visualization.
      * @example
@@ -1691,6 +1821,7 @@ export var HostEvent;
     /**
      * Trigger the **SpotIQ analyze** action on visualization
      * or search.
+     *
      * @param - Liveboard embed takes `vizId` as a
      * key. Can be left undefined when embedding Search or
      * visualization.
@@ -1711,6 +1842,7 @@ export var HostEvent;
     /**
      * Trigger the **Download** action on charts in
      * the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -1727,6 +1859,7 @@ export var HostEvent;
     /**
      * Trigger the **Download** > **PNG** action on
      * charts in the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -1742,6 +1875,7 @@ export var HostEvent;
     /**
      * Trigger the **Download** > **CSV**  action on tables in
      * the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -1759,6 +1893,7 @@ export var HostEvent;
     /**
      * Trigger the **Download** > **XLSX**  action on tables
      * in the embedded view.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -1776,6 +1911,7 @@ export var HostEvent;
     /**
      * Trigger the **Share** action on an embedded
      * Liveboard or Answer.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Share)
@@ -1789,6 +1925,7 @@ export var HostEvent;
     /**
      * Trigger the **Save**  action on a Liveboard or Answer.
      * Saves the changes.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
@@ -1802,6 +1939,7 @@ export var HostEvent;
     /**
      * Trigger the **Sync to Sheets** action on an embedded visualization or Answer
      * Sends data from an Answer or Liveboard visualization to a Google sheet.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -1818,6 +1956,7 @@ export var HostEvent;
      * Trigger the **Sync to Other Apps** action on an embedded visualization or Answer
      * Sends data from an Answer or Liveboard visualization to third-party apps such
      * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
+     *
      * @param - an object with vizId as a key
      * @example
      * ```js
@@ -1834,6 +1973,7 @@ export var HostEvent;
      * Trigger the **Manage pipelines** action on an embedded
      * visualization or Answer.
      * Allows users to manage ThoughtSpot Sync pipelines.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -1848,6 +1988,7 @@ export var HostEvent;
     HostEvent["ManagePipelines"] = "manage-pipeline";
     /**
      * Reset search operation on the Search or Answer page.
+     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.ResetSearch)
@@ -1859,17 +2000,21 @@ export var HostEvent;
      */
     HostEvent["ResetSearch"] = "resetSearch";
     /**
-     * Get details of the visible and runtime filters applied on Liveboard.
+     * Get details of filters applied on the Liveboard.
+     * Returns arrays containing Liveboard filter and runtime filter elements.
+     *
      * @example
      * ```js
      * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
      *     console.log('data', data);
      * ```
+     *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     HostEvent["GetFilters"] = "getFilters";
     /**
      * Update one or several filters applied on a Liveboard.
+     *
      * @param - `filter`: a single filter object containing column name,
      * filter operator, and values.
      * @param - `filters`: multiple filter objects with column name, filter operator,
@@ -1881,11 +2026,12 @@ export var HostEvent;
      *
      * `oper`  - Filter operator, for example, EQ, IN, CONTAINS.
      *  For information about the supported filter operators,
-     *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#rtOperator).
+     *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
      *
      * `values` - An array of one or several values. The value definition on the
      *  data type you choose to filter on. For a complete list of supported data types,
-     *  see [Developer Documentation](https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types).
+     *  see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
+     *
      * @example
      * ```js
      *
@@ -1897,6 +2043,7 @@ export var HostEvent;
      *        }
      *    });
      * ```
+     *
      * @example
      *
      * ```js
@@ -1918,11 +2065,13 @@ export var HostEvent;
      *    }]
      * });
      * ```
+     *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     HostEvent["UpdateFilters"] = "updateFilters";
     /**
      * Get tab details for the current Liveboard.
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
@@ -1936,6 +2085,7 @@ export var HostEvent;
     HostEvent["GetTabs"] = "getTabs";
     /**
      * Set the visible tabs on a Liveboard.
+     *
      * @param - an array of ids of tabs to show, the IDs not passed
      *          will be hidden.
      * @example
@@ -1949,6 +2099,7 @@ export var HostEvent;
     HostEvent["SetVisibleTabs"] = "SetPinboardVisibleTabs";
     /**
      * Set the hidden tabs on a Liveboard.
+     *
      * @param - an array of the IDs of the tabs to hide.
      * The IDs not passed will be shown.
      * @example
@@ -1962,6 +2113,7 @@ export var HostEvent;
     HostEvent["SetHiddenTabs"] = "SetPinboardHiddenTabs";
     /**
      * Updates the search query string for Natural Language Search operations.
+     *
      * @param - `queryString`: Text string in Natural Language format
      * @param - `executeSearch`: Boolean to execute search and update search query
      * @example
@@ -1976,6 +2128,7 @@ export var HostEvent;
     HostEvent["UpdateSageQuery"] = "updateSageQuery";
     /**
      * Get the answer session for a Search / Visualization.
+     *
      * @example
      * ```js
      * const {session} = await embed.trigger(
@@ -1988,6 +2141,7 @@ export var HostEvent;
     HostEvent["GetAnswerSession"] = "getAnswerSession";
     /**
      * Trigger Ask Sage for viz
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.AskSage,
@@ -1998,6 +2152,7 @@ export var HostEvent;
     HostEvent["AskSage"] = "AskSage";
     /**
      * Trigger UpdateCrossFilter for Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -2013,6 +2168,7 @@ export var HostEvent;
     HostEvent["UpdateCrossFilter"] = "UpdateCrossFilter";
     /**
      * Trigger ResetLiveboardPersonalisedView for Liveboard
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
@@ -2022,6 +2178,7 @@ export var HostEvent;
     HostEvent["ResetLiveboardPersonalisedView"] = "ResetLiveboardPersonalisedView";
     /**
      * Trigger CreateLiveboard for liveboard list page & Pin Modal
+     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.CreateLiveboard);
@@ -2167,6 +2324,7 @@ export var Param;
  * specific actions in the embedded view, define the Action
  * enumeration members in the `disabledActions`, `visibleActions`,
  * or `hiddenActions` array.
+ *
  * @example
  * ```js
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2192,6 +2350,7 @@ export var Action;
     /**
      * The **Save** action on an Answer or Liveboard.
      * Allows users to save the changes.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Save]
@@ -2208,7 +2367,9 @@ export var Action;
     Action["SaveUntitled"] = "saveUntitled";
     /**
      * The **Save as View** action on the Answer
-     * page. Saves an Answer as a View object.
+     * page. Saves an Answer as a View object in the full
+     * application embedding mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SaveAsView]
@@ -2222,6 +2383,7 @@ export var Action;
      * visualizations in the embedded Liveboard view.
      * In AppEmbed, the **Make a copy** action is available on both
      * Liveboards and visualizations.
+     *
      * @example
      * ```js
      * disabledActions: [Action.MakeACopy]
@@ -2231,6 +2393,7 @@ export var Action;
     /**
      * The **Copy and Edit** action on a Liveboard.
      * This action is now replaced with `Action.MakeACopy`.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditACopy]
@@ -2240,6 +2403,7 @@ export var Action;
     /**
      * The **Copy link** menu action on a Liveboard visualization.
      * Copies the visualization URL
+     *
      * @example
      * ```js
      * disabledActions: [Action.CopyLink]
@@ -2253,6 +2417,7 @@ export var Action;
     /**
      * The **Schedule** menu action on a Liveboard.
      * Allows scheduling a Liveboard notification.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Schedule]
@@ -2262,6 +2427,7 @@ export var Action;
     /**
      * The **Manage schedules** menu action on a Liveboard.
      * Allows users to manage scheduled Liveboard jobs.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SchedulesList]
@@ -2271,6 +2437,7 @@ export var Action;
     /**
      * The **Share** action on a Liveboard, Answer, or Worksheet.
      * Allows users to share an object with other users and groups.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Share]
@@ -2280,6 +2447,7 @@ export var Action;
     /**
      * The **Add filter** action on a Liveboard and Search page.
      * Allows adding filters to Answers and visualizations on a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddFilter]
@@ -2290,6 +2458,7 @@ export var Action;
      * The **Add Data Panel Objects** action on the data panel v2.
      * Allows to show action menu to add different objects (like
      * formulas, parameters) in data panel v2.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddDataPanelObjects]
@@ -2301,6 +2470,7 @@ export var Action;
      * Filter configuration options on a Liveboard and Search page.
      * Allows configuring filter options when adding filters to a
      * Liveboard or Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ConfigureFilter]
@@ -2311,6 +2481,7 @@ export var Action;
     /**
      * The **Choose sources** button on Search page.
      * Allows selecting data sources for search queries.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ChooseDataSources]
@@ -2320,6 +2491,7 @@ export var Action;
     /**
      * The **Create formula** action on a Search or Answer page.
      * Allows adding formulas to an Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddFormula]
@@ -2329,6 +2501,7 @@ export var Action;
     /**
      * The **Add parameter** action on a Liveboard or Answer.
      * Allows adding Parameters to a Liveboard or Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddParameter]
@@ -2338,6 +2511,7 @@ export var Action;
     /**
      * The **Add Column Set** action on a Answer.
      * Allows adding column sets to a Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddColumnSet]
@@ -2348,6 +2522,7 @@ export var Action;
     /**
      * The **Add Query Set** action on a Answer.
      * Allows adding query sets to a Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddQuerySet]
@@ -2362,6 +2537,7 @@ export var Action;
     /**
      * The **SpotIQ analyze** menu action on a visualization or
      * Answer page.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SpotIQAnalyze]
@@ -2384,6 +2560,7 @@ export var Action;
     /**
      * The **Show underlying data** menu action on a visualization or
      * Answer page.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ShowUnderlyingData]
@@ -2394,6 +2571,7 @@ export var Action;
      * The **Download** menu action on Liveboard visualizations
      * and Answers.
      * Allows downloading a visualization or Answer.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsPng]
@@ -2404,6 +2582,7 @@ export var Action;
      * The **Download** > **PNG** menu action for charts on a Liveboard
      * or Answer page.
      * Downloads a visualization or Answer as a PNG file.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsPng]
@@ -2412,11 +2591,13 @@ export var Action;
     Action["DownloadAsPng"] = "downloadAsPng";
     /**
      *
-     *The **Download PDF** action that downloads a Liveboard,
-     *visualization, or Answer as a PDF file.
+     * The **Download PDF** action that downloads a Liveboard,
+     * visualization, or Answer as a PDF file.
+     *
+     *
+     * **NOTE**: The **Download** > **PDF** action is available on
+     * visualizations and Answers if the data is in tabular format.
      *
-     ***NOTE**: The **Download** > **PDF** action is available on
-     *visualizations and Answers if the data is in tabular format.
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsPdf]
@@ -2427,6 +2608,7 @@ export var Action;
      * The **Download** > **CSV** menu action for tables on a Liveboard
      * or Answer page.
      * Downloads a visualization or Answer in the XLSX format.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsCsv]
@@ -2437,6 +2619,7 @@ export var Action;
      * The **Download** > **XLSX** menu action for tables on a Liveboard
      * or Answer page.
      * Downloads a visualization or Answer in the XLSX format.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DownloadAsXlsx]
@@ -2451,6 +2634,7 @@ export var Action;
      * The **Export TML** menu action on Liveboard, Answers
      * Worksheets and Data Connections page.
      * Exports an object as a TML file.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ExportTML]
@@ -2460,6 +2644,7 @@ export var Action;
     /**
      * The **Import TML** menu action for Liveboards and Answers.
      * Imports TML representation of ThoughtSpot objects.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ImportTML]
@@ -2469,6 +2654,7 @@ export var Action;
     /**
      * The **Update TML** menu action for Liveboards and Answers.
      * Update TML representation of ThoughtSpot objects.
+     *
      * @example
      * ```js
      * disabledActions: [Action.UpdateTML]
@@ -2478,6 +2664,7 @@ export var Action;
     /**
      * The **Edit TML** menu action for Liveboards and Answers.
      * Opens the TML editor.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditTML]
@@ -2488,6 +2675,7 @@ export var Action;
      * The **Present** menu action for Liveboards and Answers.
      * Allows presenting a Liveboard or visualization in
      * slideshow mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Present]
@@ -2497,6 +2685,7 @@ export var Action;
     /**
      * The tile resize options in the visualization menu.
      * Allows switching between different preset layouts.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ToggleSize]
@@ -2507,6 +2696,7 @@ export var Action;
      * The *Edit* action on the Liveboard page and in the
      * visualization menu.
      * Opens a Liveboard or visualization in edit mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Edit]
@@ -2515,6 +2705,7 @@ export var Action;
     Action["Edit"] = "edit";
     /**
      * The text edit option for Liveboard and visualization titles.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditTitle]
@@ -2524,6 +2715,7 @@ export var Action;
     /**
      * The **Delete** menu action on Liveboards and visualizations.
      * Deletes a Liveboard or a visualization from a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Remove]
@@ -2555,6 +2747,7 @@ export var Action;
      * Displays details such as the name, description, and
      * author of the Liveboard, and timestamp of Liveboard creation
      * and update.
+     *
      * @example
      * ```js
      * disabledActions: [Action.LiveboardInfo]
@@ -2572,6 +2765,7 @@ export var Action;
     /**
      * The **Pin** menu action on an Answer or
      * Search results page.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Pin]
@@ -2584,6 +2778,7 @@ export var Action;
     Action["AnalysisInfo"] = "analysisInfo";
     /**
      * The **Schedule** menu action on a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.Subscription]
@@ -2592,6 +2787,7 @@ export var Action;
     Action["Subscription"] = "subscription";
     /**
      * The **Explore** action on Liveboard visualizations
+     *
      * @example
      * ```js
      * disabledActions: [Action.Explore]
@@ -2601,6 +2797,7 @@ export var Action;
     /**
      * The action to include data points on a drilled-down Answer
      * or visualization
+     *
      * @example
      * ```js
      * disabledActions: [Action.DrillInclude]
@@ -2610,6 +2807,7 @@ export var Action;
     /**
      * The action to exclude data points on a drilled-down Answer
      * or visualization
+     *
      * @example
      * ```js
      * disabledActions: [Action.DrillInclude]
@@ -2620,6 +2818,7 @@ export var Action;
      * The **Copy to clipboard** menu action on tables in an Answer
      * or Liveboard.
      * Copies the selected data point.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CopyToClipboard]
@@ -2637,6 +2836,7 @@ export var Action;
      * The **Drill down** menu action on Answers and Liveboard
      * visualizations.
      * Allows drilling down to a specific data point on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.DrillDown]
@@ -2646,6 +2846,7 @@ export var Action;
     /**
      * The request access action on Liveboards.
      * Allows users with view permissions to request edit access to a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RequestAccess]
@@ -2655,6 +2856,7 @@ export var Action;
     /**
      * The **Query visualizer** and **Query SQL** buttons in Query details panel
      * of the Answer page
+     *
      * @example
      * ```js
      * disabledActions: [Action.QueryDetailsButtons]
@@ -2662,7 +2864,9 @@ export var Action;
      */
     Action["QueryDetailsButtons"] = "queryDetailsButtons";
     /**
-     * The **Delete** action for Answers.
+     * The **Delete** action for Answers in the full application
+     * embedding mode.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AnswerDelete]
@@ -2672,6 +2876,7 @@ export var Action;
     Action["AnswerDelete"] = "onDeleteAnswer";
     /**
      * The Chart switcher icon on Answer and visualization pages.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AnswerChartSwitcher]
@@ -2681,6 +2886,7 @@ export var Action;
     Action["AnswerChartSwitcher"] = "answerChartSwitcher";
     /**
      * Favorites icon (*) on Answers, Liveboard, and Data pages
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddToFavorites]
@@ -2690,6 +2896,7 @@ export var Action;
     Action["AddToFavorites"] = "addToFavorites";
     /**
      * The edit icon on Liveboards (Classic experience).
+     *
      * @example
      * ```js
      * disabledActions: [Action.EditDetails]
@@ -2699,6 +2906,7 @@ export var Action;
     Action["EditDetails"] = "editDetails";
     /**
      * The Create alert action on KPI charts.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CreateMonitor ]
@@ -2717,6 +2925,7 @@ export var Action;
     /**
      * The **Sync to sheets** action on Answers and Liveboard visualizations.
      * Allows sending data to a Google Sheet.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToSheets]
@@ -2728,6 +2937,7 @@ export var Action;
      * The **Sync to other apps** action on Answers and Liveboard visualizations.
      * Allows sending data to third-party apps like Slack, Salesforce,
      * Microsoft Teams, and so on.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToOtherApps]
@@ -2738,6 +2948,7 @@ export var Action;
     /**
      * The **Manage pipelines** action on Answers and Liveboard visualizations.
      * Allows users to manage data sync pipelines to third-party apps.
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToOtherApps]
@@ -2748,6 +2959,7 @@ export var Action;
     /**
      * The **Filter** action on Liveboard visualizations.
      * Allows users to apply cross-filters on a Liveboard.
+     *
      * @example
      * ```js
      * disabledActions: [Action.CrossFilter]
@@ -2758,6 +2970,7 @@ export var Action;
     /**
      * The **Sync to Slack** action on Liveboard visualizations.
      * Allows sending data to third-party apps Slack
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToSlack]
@@ -2768,6 +2981,7 @@ export var Action;
     /**
      * The **Sync to Teams** action on Liveboard visualizations.
      * Allows sending data to third-party apps Team
+     *
      * @example
      * ```js
      * disabledActions: [Action.SyncToTeams]
@@ -2779,6 +2993,7 @@ export var Action;
      * The **Remove** action that appears when cross filters are applied
      * on a Liveboard.
      * Removes filters applied o a visualization.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RemoveCrossFilter]
@@ -2790,6 +3005,7 @@ export var Action;
      * The **Aggregate** option in the chart axis or the
      * table column customization menu.
      * Provides aggregation options to analyze the data on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuAggregate]
@@ -2801,6 +3017,7 @@ export var Action;
      * The **Time bucket** option in the chart axis or table column
      * customization menu.
      * Allows defining time metric for date comparison.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuTimeBucket]
@@ -2811,6 +3028,7 @@ export var Action;
     /**
      * The **Filter** action in the chart axis or table column
      * customization menu.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuFilter]
@@ -2822,6 +3040,7 @@ export var Action;
      * The **Conditional formatting** action on chart or table.
      * Allows adding rules for conditional formatting of data
      * points on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2833,6 +3052,7 @@ export var Action;
      * The **Sort** menu action on a table or chart axis
      * Sorts data in ascending or descending order.
      * Allows adding, editing, or removing filters.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -2845,6 +3065,7 @@ export var Action;
      * customization menu.
      * Allows grouping data points if the axes use the same
      * unit of measurement and a similar scale.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuGroup]
@@ -2856,6 +3077,7 @@ export var Action;
      * The **Position** option in the axis customization menu.
      * Allows changing the position of the axis to the
      * left or right side of the chart.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuPosition]
@@ -2866,6 +3088,7 @@ export var Action;
     /**
      * The **Rename** option in the chart axis or table column customization menu.
      * Renames the axis label on a chart or the column header on a table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuRename]
@@ -2877,6 +3100,7 @@ export var Action;
      * The **Edit** action in the axis customization menu.
      * Allows editing the axis name, position, minimum and maximum values,
      * and format of a column.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuEdit]
@@ -2887,6 +3111,7 @@ export var Action;
     /**
      * The **Number format** action to customize the format of
      * the data labels on a chart or table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuNumberFormat]
@@ -2897,6 +3122,7 @@ export var Action;
     /**
      * The **Text wrapping** action on a table.
      * Wraps or clips column text on a table.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuTextWrapping]
@@ -2909,6 +3135,7 @@ export var Action;
      * customization menu.
      * Removes the data labels from a chart or the column of a
      * table visualization.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AxisMenuRemove]
@@ -2923,6 +3150,7 @@ export var Action;
     /**
      * The **Rename** menu action on Liveboards and visualizations.
      * Allows renaming a Liveboard or visualization.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RenameModalTitleDescription]
@@ -2966,6 +3194,7 @@ export var Action;
     /**
      * The **Move to Tab** menu action on visualizations in liveboard edit mode.
      * Allows moving a visualization to a different tab.
+     *
      * @example
      * ```js
      * disabledActions: [Action.MoveToTab]
@@ -2974,6 +3203,7 @@ export var Action;
     Action["MoveToTab"] = "onContainerMove";
     /**
      * The **Manage Alertsb** menu action on KPI visualizations.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ManageMonitor]
@@ -2982,6 +3212,7 @@ export var Action;
     Action["ManageMonitor"] = "ManageMonitor";
     /**
      * Action ID for Liveboard Personalised Views dropdown
+     *
      *  @example
      * ```js
      * disabledActions: [Action.PersonalisedViewsDropdown]
@@ -2991,6 +3222,7 @@ export var Action;
     Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
     /**
      * Action ID for Liveboard Users ( Recently Visited / social proof )
+     *
      *  @example
      * ```js
      * disabledActions: [Action.LiveboardUsers]
@@ -3002,6 +3234,7 @@ export var Action;
      * Action ID for the Parent TML action
      * The parent action **TML** must be included to access TML-related options
      * within the cascading menu (specific to the answer page)
+     *
      * @example
      * ```js
      * // to include specific TML actions
@@ -3013,11 +3246,13 @@ export var Action;
      * hiddenAction: [Action.TML] // hide all TML actions
      * disabledActions: [Action.TML] // to disable all TML actions
      * ```
+     *
      * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
      */
     Action["TML"] = "tml";
     /**
      * Action ID for to hide Verified Liveboard Banner
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.VerifiedLiveboard]
@@ -3027,6 +3262,7 @@ export var Action;
     Action["VerifiedLiveboard"] = "verifiedLiveboard";
     /**
      * Action ID for ask sage button
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.AskAi]
@@ -3036,6 +3272,7 @@ export var Action;
     Action["AskAi"] = "AskAi";
     /**
      * The **Add KPI to Watchlist** action on Home page watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddToWatchlist]
@@ -3045,6 +3282,7 @@ export var Action;
     Action["AddToWatchlist"] = "addToWatchlist";
     /**
      * The **Remove from watchlist** menu action on KPI watchlist.
+     *
      * @example
      * ```js
      * disabledActions: [Action.RemoveFromWatchlist]
@@ -3054,6 +3292,7 @@ export var Action;
     Action["RemoveFromWatchlist"] = "removeFromWatchlist";
     /**
      * The **Organise Favourites** action on Homepage Favourite Module.
+     *
      * @example
      * ```js
      * disabledActions: [Action.OrganiseFavourites]
@@ -3063,6 +3302,7 @@ export var Action;
     Action["OrganiseFavourites"] = "organiseFavourites";
     /**
      * Action ID for AI Highlights button
+     *
      *  @example
      * ```js
      * hiddenAction: [Action.AIHighlights]
@@ -3090,6 +3330,7 @@ export var LogLevel;
 (function (LogLevel) {
     /**
      * No logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3102,6 +3343,7 @@ export var LogLevel;
     LogLevel["SILENT"] = "SILENT";
     /**
      * Only ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3114,6 +3356,7 @@ export var LogLevel;
     LogLevel["ERROR"] = "ERROR";
     /**
      * Only WARN and ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3126,6 +3369,7 @@ export var LogLevel;
     LogLevel["WARN"] = "WARN";
     /**
      * Only INFO, WARN, and ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3138,6 +3382,7 @@ export var LogLevel;
     LogLevel["INFO"] = "INFO";
     /**
      * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({
@@ -3150,6 +3395,7 @@ export var LogLevel;
     LogLevel["DEBUG"] = "DEBUG";
     /**
      * All logs will be logged in the console.
+     *
      * @example
      * ```js
      * init({