@thoughtspot/visual-embed-sdk 1.33.0-alpha.2 → 1.33.0

package/dist/visual-embed-sdk.d.ts

@@ -54,7 +54,11 @@ export enum Page {
         /**
             * SpotIQ listing page
             */
-        SpotIQ = "insights"
+        SpotIQ = "insights",
+        /**
+            *  Monitor Alerts Page
+            */
+        Monitor = "monitor"
 }
 /**
     * Define the initial state os column custom group accordions
@@ -265,19 +269,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * ```
             */
         fullHeight?: boolean;
-        /**
-            * Flag to control Data panel experience
-            * @default true
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @example
-            * ```js
-            * const embed = new AppEmbed('#tsEmbed', {
-            *    ... // other options
-            *    dataPanelV2: true,
-            * })
-            * ```
-            */
-        dataPanelV2?: boolean;
         /**
             * Show or hide Liveboard header
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
@@ -355,19 +346,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
-        /**
-            * To enable custom column groups in data panel v2.
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
-            * @default false
-            * @example
-            * ```js
-            * const embed = new AppEmbed('#embed', {
-            *   ... // other app view config
-            *   enableCustomColumnGroups: true,
-            * });
-            * ```
-            */
-        enableCustomColumnGroups?: boolean;
         /**
             * This controls the initial behaviour of custom column groups accordion.
             * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
@@ -411,6 +389,48 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
             */
         homePageSearchBarMode?: HomePageSearchBarMode;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -532,22 +552,23 @@ export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) =
 /**
     * Imports TML representation of the metadata objects into ThoughtSpot.
     * @param data
+    * @returns imports TML data into ThoughtSpot
     * @example
     * ```js
-    *   executeTML({
-    * //Array of metadata Tmls
-        metadata_tmls: [
-            "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
-            \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
-        ],
-        import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
-        create_new: false, // If selected, creates TML objects with new GUIDs.
-    }).then(result => {
-        console.log(result);
-    }).catch(error => {
-        console.error(error);
-    });
-    *
+    *  executeTML({
+    * //Array of metadata Tmls in string format
+    *      metadata_tmls: [
+    *          "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
+    *          \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
+    *      ],
+    *      import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
+    *      create_new: false, // If selected, creates TML objects with new GUIDs.
+    *  }).then(result => {
+    *      console.log(result);
+    *  }).catch(error => {
+    *      console.error(error);
+    *  });
+    *```
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
     * @group Global methods
     */
@@ -556,27 +577,28 @@ export const executeTML: (data: executeTMLInput) => Promise<any>;
     * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
     * format.
     * @param data
+    * @returns exports TML data
     * @example
     * ```js
-    exportTML({
-        metadata: [
-            {
-                type: "LIVEBOARD", //Metadata Type
-                identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
-            }
-        ],
-        export_associated: false,//indicates whether to export associated metadata objects
-        export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
-                                             //exporting a Liveboard and its associated objects, the API
-                                             //returns the Liveboard TML data with the FQNs of the referenced
-                                             //worksheet. If the exported TML data includes FQNs, you don't need
-                                             //to manually add FQNs of the referenced objects during TML import.
-        edoc_format: "JSON" //It takes JSON or YAML value
-    }).then(result => {
-        console.log(result);
-    }).catch(error => {
-        console.error(error);
-    });
+    * exportTML({
+    *   metadata: [
+    *     {
+    *       type: "LIVEBOARD", //Metadata Type
+    *       identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
+    *     }
+    *   ],
+    *   export_associated: false,//indicates whether to export associated metadata objects
+    *   export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
+    *                      //exporting a Liveboard and its associated objects, the API
+    *                      //returns the Liveboard TML data with the FQNs of the referenced
+    *                      //worksheet. If the exported TML data includes FQNs, you don't need
+    *                      //to manually add FQNs of the referenced objects during TML import.
+    *   edoc_format: "JSON" //It takes JSON or YAML value
+    * }).then(result => {
+    *   console.log(result);
+    * }).catch(error => {
+    *   console.error(error);
+    * });
     * ```
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
     * @group Global methods
@@ -852,6 +874,48 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
             */
         showPreviewLoader?: boolean;
+        /**
+            * This flag is used to enable the compact header in liveboard
+            * @type {boolean}
+            * @default false
+            * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    isLiveboardCompactHeaderEnabled: true,
+            * })
+            * ```
+            */
+        isLiveboardCompactHeaderEnabled?: boolean;
+        /**
+            * This flag is used to show/hide verified Icon in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardVerifiedBadge: true,
+            * })
+            * ```
+            */
+        showLiveboardVerifiedBadge?: boolean;
+        /**
+            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * @type {boolean}
+            * @default true
+            * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+            * @example
+            * ```js
+            * const embed = new LiveboardEmbed('#embed-container', {
+            *    ... // other options
+            *    showLiveboardReverifyBanner: true,
+            * })
+            * ```
+            */
+        showLiveboardReverifyBanner?: boolean;
 }
 /**
     * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1097,19 +1161,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * ```
             */
         hideSearchBar?: boolean;
-        /**
-            * Flag to control Data panel experience
-            * @default true
-            * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @example
-            * ```js
-            * const embed = new SearchEmbed('#tsEmbed', {
-            *    ... // other options
-            *    dataPanelV2:false,
-            * })
-            * ```
-            */
-        dataPanelV2?: boolean;
         /**
             * Flag to set if last selected dataSource should be used
             * @version: SDK: 1.24.0
@@ -1122,19 +1173,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
             * @deprecated Use {@link collapseSearchBar} instead
             */
         collapseSearchBarInitially?: boolean;
-        /**
-            * To enable custom column groups in data panel v2
-            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
-            * @default false
-            * @example
-            * ```js
-            * const embed = new SearchEmbed('#tsEmbed', {
-            *   ... // other options
-            *   enableCustomColumnGroups: true,
-            * });
-            * ```
-            */
-        enableCustomColumnGroups?: boolean;
         /**
             * Flag to enable onBeforeSearchExecute Embed Event
             * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
@@ -1946,13 +1984,6 @@ export interface EmbedConfig {
             * @default false
             */
         queueMultiRenders?: boolean;
-        /**
-            * Dynamic CSS URL to be injected in the loaded application.
-            * You would also need to set `style-src` in the CSP settings.
-            * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
-            * @default ''
-            */
-        customCssUrl?: string;
         /**
             * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
             * additional call. This is slower and should be avoided. Listen to the
@@ -2081,6 +2112,12 @@ export interface EmbedConfig {
             * @version SDK: 1.28.5 | Thoughtspot: *
             */
         disableTokenVerification?: boolean;
+        /**
+            * This flag is used to disable showing the login failure page in the embedded app.
+            *
+            * @version SDK 1.32.3 | Thoughtspot: *
+            */
+        disableLoginFailurePage?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -2203,11 +2240,12 @@ export interface ViewConfig {
             */
         visibleActions?: Action[];
         /**
-            * Show alert messages and toast messages in the embedded view.
+            * Show alert messages and toast messages in the embedded
+            * view in full app embed.
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             * ```js
-            * const embed = new LiveboardEmbed('#embed-container', {
+            * const embed = new AppEmbed('#embed-container', {
             *    ... // other options
             *    showAlerts:true,
             * })
@@ -2528,6 +2566,32 @@ export interface ViewConfig {
             * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
             */
         disableRedirectionLinksInNewTab?: boolean;
+        /**
+            * Flag to control Data panel experience
+            * @default true
+            * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+            * @example
+            * ```js
+            * const embed = new AppEmbed('#tsEmbed', {
+            *    ... // other options
+            *    dataPanelV2: true,
+            * })
+            * ```
+            */
+        dataPanelV2?: boolean;
+        /**
+            * To enable custom column groups in data panel v2
+            * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+            * @default false
+            * @example
+            * ```js
+            * const embed = new SearchEmbed('#tsEmbed', {
+            *   ... // other options
+            *   enableCustomColumnGroups: true,
+            * });
+            * ```
+            */
+        enableCustomColumnGroups?: boolean;
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2724,6 +2788,28 @@ export interface RuntimeParameter {
     *   console.log('Drilldown event', drilldown);
     * }));
     * ```
+    *
+    * If you are using React components for embedding, you can register to any
+    * events from the `EmbedEvent` list by using the `on<EventName>` convention.
+    * For example,`onAlert`, `onCopyToClipboard` and so on.
+    *
+    *  @example
+    * ```js
+    * // ...
+    * const MyComponent = ({ dataSources }) => {
+    *      const onLoad = () => {
+    *      console.log(EmbedEvent.Load, {});
+    *      };
+    *
+    *      return (
+    *          <SearchEmbed
+    *              dataSources={dataSources}
+    *              onLoad = {logEvent("Load")}
+    *          />
+    *     );
+    * };
+    * ```
+    *
     * @group Events
     */
 export enum EmbedEvent {
@@ -3592,21 +3678,61 @@ export enum EmbedEvent {
             */
         Rename = "rename",
         /**
-            * Emitted when user wants to intercept the search execution
+            * Emitted if the user wants to intercept the search execution
+            * and implement logic to decide whether to run the search or not
+            *
+            * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+            * for this embed event to get emitted.
+            *
+            * @param: payload
+            * @param: responder
+            * Contains elements that lets developers define whether ThoughtSpot
+            * will run the search or not, and if not, which error message to provide.
             *
-            * Set IsOnBeforeGetVizDataInterceptEnabled : true to use
-            * this embed event
+            * execute: When execute returns true, the search will be run.
+            * When execute returns false, the search will not be executed.
+            *
+            * error: Developers can customize the user facing message when execute is
+            * set to false using the error parameter in responder
+            *
+            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
             *
+            * @example
             *```js
-            * searchEmbed.on(EmbedEvent.OnBeforeGetVizDataIntercept,
+            * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
             * (payload, responder) => {
             *  responder({
             *      data: {
-            *          execute: true,
-            *   }})
+            *          execute:false,
+            *          error: {
+            *          //Provide a custom error message to explain to your end user
+            *          //why their search did not run
+            *          errorText: "This search query cannot be run.
+            *          Please contact your administrator for more details."
+            *          }
+            *  }})
+            * })
+            * ```
+            *
+            *```js
+            * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
+            * (payload, responder) => {
+            * const query = payload.data.data.answer.search_query
+            * responder({
+            *  data: {
+            *      // returns true as long as the query does not include
+            *      // both the 'sales' AND the 'county' column
+            *      execute: !(query.includes("sales")&&query.includes("county")),
+            *      error: {
+            *      //Provide a custom error message to explain to your end user
+            *      // why their search did not run, and which searches are accepted by your custom logic.
+            *      errorText: "You can't use this query :" + query + ".
+            *      The 'sales' measures can never be used at the 'county' level.
+            *      Please try another measure, or remove 'county' from your search."
+            *      }
+            *  }})
             * })
             *```
-            * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
             */
         OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
         /**
@@ -3624,7 +3750,7 @@ export enum EmbedEvent {
 }
 /**
     * Event types that can be triggered by the host application
-    * to the embedded ThoughtSpot app
+    * to the embedded ThoughtSpot app.
     *
     * To trigger an event use the corresponding
     * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link
@@ -3641,6 +3767,40 @@ export enum EmbedEvent {
     *   { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
     * ]);
     * ```
+    * @example
+    * If using React components to embed, use the format shown in this example:
+    *
+    * ```js
+    *  const selectVizs = () => {
+    *      embedRef.current.trigger(HostEvent.SetVisibleVizs, [
+    *         "715e4613-c891-4884-be44-aa8d13701c06",
+    *         "3f84d633-e325-44b2-be25-c6650e5a49cf"
+    *      ]);
+    *    };
+    * ```
+    *
+    *
+    * You can also attach an Embed event to a Host event to trigger
+    * a specific action as shown in this example:
+    *
+    * @example
+    * ```js
+    *  const EmbeddedComponent = () => {
+    *       const embedRef = useRef(null); // import { useRef } from react
+    *       const onLiveboardRendered = () => {
+    *          embedRef.current.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
+    *      };
+    *
+    *      return (
+    *          <LiveboardEmbed
+    *              ref={embedRef}
+    *              liveboardId="<liveboard-guid>"
+    *              onLiveboardRendered={onLiveboardRendered}
+    *          />
+    *      );
+    *  }
+    * ```
+    *
     * @group Events
     */
 export enum HostEvent {
@@ -3724,6 +3884,15 @@ export enum HostEvent {
             * @hidden
             */
         Reload = "reload",
+        /**
+            * Get current iframe src
+            * @example
+            * ```js
+            * const frameUrl = AppEmbed.trigger(HostEvent.GetIframeUrl)
+            * ```
+            * @version SDK: 1.35.0 | Thoughtspot: 10.4.0.cl
+            */
+        GetIframeUrl = "GetIframeUrl",
         /**
             * Display specific visualizations on a Liveboard.
             * @param - An array of GUIDs of the visualization to show. The visualization IDs not passed
@@ -4325,11 +4494,24 @@ export enum HostEvent {
             *     filter: {
             *         column: "item type",
             *         oper: "IN",
-            *         values: ["bags","shirts"],
+            *         values: ["bags","shirts"]
             *        }
             *    });
             * ```
             * @example
+            * ```js
+            *
+            * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
+            *     filter: {
+            *         column: "date",
+            *         oper: "EQ",
+            *         values: ["JULY","2023"],
+            *         type: "MONTH_YEAR"
+            *        }
+            *    });
+            * ```
+            *
+            * @example
             *
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
@@ -4346,7 +4528,8 @@ export enum HostEvent {
             *    {
             *      column: "Date",
             *      oper: 'EQ',
-            *      values: ["1656680400"]
+            *      values: ["2023-07-31"],
+            *      types: "EXACT_DATE"
             *    }]
             * });
             * ```
@@ -4532,7 +4715,6 @@ export enum Param {
         ViewPortHeight = "viewPortHeight",
         ViewPortWidth = "viewPortWidth",
         VisibleActions = "visibleAction",
-        CustomCSSUrl = "customCssUrl",
         DisableLoginRedirect = "disableLoginRedirect",
         visibleVizs = "pinboardVisibleVizs",
         LiveboardV2Enabled = "isPinboardV2Enabled",
@@ -4589,7 +4771,10 @@ export enum Param {
         IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
         FocusSearchBarOnRender = "focusSearchBarOnRender",
         DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
-        HomePageSearchBarMode = "homePageSearchBarMode"
+        HomePageSearchBarMode = "homePageSearchBarMode",
+        ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
+        ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
+        LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -5511,7 +5696,7 @@ export enum Action {
             *
             * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
             */
-        CreateLiveboard = "CreateLiveboard",
+        CreateLiveboard = "createLiveboard",
         /**
             * Action ID for to hide Verified Liveboard Banner
             *  @example
@@ -5602,6 +5787,16 @@ export enum Action {
             *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
             */
         UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
+        /**
+            * The **Manage Tags** action on Homepage Favourite Module.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ManageTags]
+            * ```
+            * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
+            */
+        ManageTags = "manageTags",
         /**
             * Action ID for delete schedule action on schedule on homepage
             * @example
@@ -5775,9 +5970,12 @@ export interface CustomCssVariables {
             */
         '--ts-var-root-text-transform'?: string;
         /**
-            * application color, it replaces #2770EF which is rd-color(blue,base) and
-            * its similar colors like rd-color(blue,60), rd-color(accent, base) and
-            * rd-color(text, accent) in the app.
+            * Font color of the text on toggle buttons such as
+            * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
+            * the text color of the chart and table tiles on Home page (New modular Homepage experience),
+            * and title text on the AI-generated charts and tables.
+            * The default color code is #2770EF.
+            *
             */
         '--ts-var-application-color'?: string;
         /**
@@ -5888,6 +6086,10 @@ export interface CustomCssVariables {
             * Background color of the primary buttons on hover.
             */
         '--ts-var-button--primary--hover-background'?: string;
+        /**
+            * Backgroud color of the primary buttons when active.
+            */
+        '--ts-var-button--primary--active-background'?: string;
         /**
             * Font color of the text on the secondary buttons.
             */
@@ -5904,6 +6106,10 @@ export interface CustomCssVariables {
             * Background color of the secondary button on hover.
             */
         '--ts-var-button--secondary--hover-background'?: string;
+        /**
+            * Backgroud color of the secondary buttons when active.
+            */
+        '--ts-var-button--secondary--active-background'?: string;
         /**
             * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset*
             * buttons on the *Search* page.
@@ -5917,6 +6123,10 @@ export interface CustomCssVariables {
             * Background color of the tertiary button when a user hovers over these buttons.
             */
         '--ts-var-button--tertiary--hover-background'?: string;
+        /**
+            * Backgroud color of the tertiary buttons when active.
+            */
+        '--ts-var-button--tertiary--active-background'?: string;
         /**
             * Font color of the title text of a visualization or Answer.
             */
@@ -6092,6 +6302,34 @@ export interface CustomCssVariables {
             * Background for favorite carousel find your favorites card in modular home.
             */
         '--ts-var-home-favorite-suggestion-card-background'?: string;
+        /**
+            * Border color of checkbox in error state.
+            */
+        '--ts-var-checkbox-error-border'?: string;
+        /**
+            * Border color of checkbox.
+            */
+        '--ts-var-checkbox-border-color'?: string;
+        /**
+            * Border color of checkbox in hover state.
+            */
+        '--ts-var-checkbox-hover-border'?: string;
+        /**
+            * Border and font color of checkbox in active state.
+            */
+        '--ts-var-checkbox-active-color'?: string;
+        /**
+            * Border color and font color of checkbox in checked state.
+            */
+        '--ts-var-checkbox-checked-color'?: string;
+        /**
+            * Border and font color of checkbox in disabled state.
+            */
+        '--ts-var-checkbox-checked-disabled'?: string;
+        /**
+            * Background color of checkbox.
+            */
+        '--ts-var-checkbox-background-color'?: string;
 }
 
 /**
@@ -6333,6 +6571,7 @@ export class AnswerService {
             * @returns
             */
         addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter['values']): Promise<any>;
+        getSQLQuery(): Promise<string>;
         /**
             * Fetch data from the answer.
             * @param offset
@@ -6351,6 +6590,15 @@ export class AnswerService {
             * @returns Response
             */
         fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise<Response>;
+        /**
+            * Fetch the data for the answer as a PNG blob. This might be
+            * quicker for larger data.
+            * @param userLocale
+            * @param omitBackground Omit the background in the PNG
+            * @param deviceScaleFactor The scale factor for the PNG
+            * @return Response
+            */
+        fetchPNGBlob(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): Promise<Response>;
         /**
             * Just get the internal URL for this answer's data
             * as a CSV blob.
@@ -6359,6 +6607,11 @@ export class AnswerService {
             * @returns
             */
         getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string;
+        /**
+            * Just get the internal URL for this answer's data
+            * as a PNG blob.
+            */
+        getFetchPNGBlobUrl(userLocale?: string, omitBackground?: boolean, deviceScaleFactor?: number): string;
         /**
             * Get underlying data given a point and the output column names.
             * In case of a context menu action, the selectedPoints are
@@ -6411,6 +6664,10 @@ export const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
 export const EndPoints: {
         CONFIG: string;
 };
+/**
+    * Enum of mixpanel events
+    * @hidden
+    */
 export const MIXPANEL_EVENT: {
         VISUAL_SDK_RENDER_START: string;
         VISUAL_SDK_CALLED_INIT: string;
@@ -6751,7 +7008,6 @@ export class V1Embed extends TsEmbed {
         on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
         /**
             * Only for testing purposes.
-            *
             * @hidden
             */
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;