@thoughtspot/visual-embed-sdk
Version:
ThoughtSpot Embed SDK
449 lines • 14.3 kB
TypeScript
/**
* Copyright (c) 2022
*
* Embed a ThoughtSpot Liveboard or visualization
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
* @summary Liveboard & visualization embed
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
*/
import { DOMSelector, HostEvent, ViewConfig } from '../types';
import { TsEmbed, V1Embed } from './ts-embed';
import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts';
/**
* The configuration for the embedded Liveboard or visualization page view.
* @group Embed components
*/
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
/**
* If set to true, the embedded object container dynamically resizes
* according to the height of the Liveboard.
*
* **Note**: Using fullHeight loads all visualizations on the
* Liveboard simultaneously, which results in multiple warehouse
* queries and potentially a longer wait for the topmost
* visualizations to display on the screen.
* Setting `fullHeight` to `false` fetches visualizations
* incrementally as users scroll the page to view the charts and tables.
*
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
* @example
* ```js
* const embed = new LiveboardEmbed('#embed', {
* ... // other liveboard view config
* fullHeight: true,
* });
* ```
*/
fullHeight?: boolean;
/**
* This is the minimum height(in pixels) for a full-height Liveboard.
* Setting this height helps resolve issues with empty Liveboards and
* other screens navigable from a Liveboard.
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
* @default 500
* @example
* ```js
* const embed = new LiveboardEmbed('#embed', {
* ... // other liveboard view config
* fullHeight: true,
* defaultHeight: 600,
* });
* ```
*/
defaultHeight?: number;
/**
* @Deprecated If set to true, the context menu in visualizations will be enabled.
* @example
* ```js
* const embed = new LiveboardEmbed('#tsEmbed', {
* ... // other options
* enableVizTransformations:true,
* })
* ```
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
*/
enableVizTransformations?: boolean;
/**
* The Liveboard to display in the embedded view.
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* liveboardId:id of liveboard,
* })
*/
liveboardId?: string;
/**
* To support backward compatibility
* @hidden
*/
pinboardId?: string;
/**
* The visualization within the Liveboard to display.
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* vizId:'430496d6-6903-4601-937e-2c691821af3c',
* })
* ```
*/
vizId?: string;
/**
* If set to true, all filter chips from a
* Liveboard page will be read-only (no X buttons)
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* preventLiveboardFilterRemoval:true,
* })
* ```
*/
preventLiveboardFilterRemoval?: boolean;
/**
* Array of visualization IDs which should be visible when the Liveboard
* renders. This can be changed by triggering the `SetVisibleVizs`
* event.
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* visibleVizs: [
* '430496d6-6903-4601-937e-2c691821af3c',
* 'f547ec54-2a37-4516-a222-2b06719af726'
* ]
* })
*/
visibleVizs?: string[];
/**
* To support backward compatibility
* @hidden
*/
preventPinboardFilterRemoval?: boolean;
/**
* Render embedded Liveboards and visualizations in the
* new Liveboard experience mode.
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* liveboardV2:true,
* })
* ```
*/
liveboardV2?: boolean;
/**
* Set a Liveboard tab as an active tab.
* Specify the tab ID.
* @example
* ```js
* const embed = new LiveboardEmbed('#tsEmbed', {
* ... // other options
* activeTabId:'id-1234',
* })
* ```
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
*/
activeTabId?: string;
/**
* Show or hide the tab panel of the embedded Liveboard.
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* hideTabPanel:true,
* })
* ```
*/
hideTabPanel?: boolean;
/**
* Show or hide the Liveboard header.
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
* @default false
* @example
* ```js
* const embed = new LiveboardEmbed('#embed', {
* ... // other liveboard view config
* hideLiveboardHeader:true,
* });
* ```
*/
hideLiveboardHeader?: boolean;
/**
* Show or hide the Liveboard title.
* @default false
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* showLiveboardTitle:true,
* })
* ```
*/
showLiveboardTitle?: boolean;
/**
* Show or hide the Liveboard description.
* @default false
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* showLiveboardDescription:true,
* })
* ```
*/
showLiveboardDescription?: boolean;
/**
* Control the position and visibility of
* the Liveboard header as the users scroll down the
* embedded Liveboard page.
* @example
* ```js
* const embed = new LiveboardEmbed('#embed', {
* ... // other Liveboard view config
* isLiveboardHeaderSticky: true,
* });
* ```
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
*/
isLiveboardHeaderSticky?: boolean;
/**
* enable or disable ask sage
* @default false
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
* @example
* ```js
* const embed = new SearchEmbed('#tsEmbed', {
* ... // other options
* enableAskSage:true,
* })
* ```
*/
enableAskSage?: boolean;
/**
* This flag is used to enable the 2 column layout on a Liveboard
* @type {boolean}
* @default false
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* enable2ColumnLayout: true,
* })
* ```
*/
enable2ColumnLayout?: boolean;
/**
* Show a preview image of the visualization before the visualization loads.
* Only works for visualizations embeds with a viz id.
*
* Also, viz snashot should be enabled in the ThoughtSpot instance.
* Contact ThoughtSpot support to enable this feature.
*
* Since, this will show preview images, be careful that it may show
* undesired data to the user when using row level security.
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* liveboardId: 'liveboard-id',
* vizId: 'viz-id',
* showPreviewLoader: true,
* });
* embed.render();
* ```
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
*/
showPreviewLoader?: boolean;
/**
* Enables or disables the compact header feature on a Liveboard.
* Compact Liveboard header is turned off by default on Liveboards in
* ThoughtSpot Embedded apps.
*
* @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 the 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 the 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;
/**
* This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
* @type {boolean}
* @default false
* @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* hideIrrelevantChipsInLiveboardTabs: true,
* })
* ```
*/
hideIrrelevantChipsInLiveboardTabs?: boolean;
/**
* The Liveboard to run on regular intervals to fetch the cdw token.
* @hidden
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* oAuthPollingInterval: value in milliseconds,
* })
*/
oAuthPollingInterval?: number;
/**
* The Liveboard is set to force a token fetch during the initial load.
* @hidden
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* isForceRedirect: false,
* })
*/
isForceRedirect?: boolean;
/**
* The source connection ID for authentication.
* @hidden
* @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* dataSourceId: '',
* })
*/
dataSourceId?: string;
/**
* This flag is for show/hide checkboxes for include or exclude
* cover and filter pages in the Liveboard PDF
* @type {boolean}
* @default true
* @version SDK: 1.38.0 | ThoughtSpot:10.8.0.cl
* @example
* ```js
* const embed = new LiveboardEmbed('#embed-container', {
* ... // other options
* coverAndFilterOptionInPDF: false,
* })
* ```
*/
coverAndFilterOptionInPDF?: boolean;
}
/**
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
* waits for the authentication to complete, so you need not wait for
* `AuthStatus.SUCCESS`.
* @example
* ```js
* import { .. } from '@thoughtspot/visual-embed-sdk';
* init({ ... });
* const embed = new LiveboardEmbed("#container", {
* liveboardId: <your-id-here>,
* // .. other params here.
* })
* ```
* @group Embed components
*/
export declare class LiveboardEmbed extends V1Embed {
protected viewConfig: LiveboardViewConfig;
private defaultHeight;
constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
/**
* Construct a map of params to be passed on to the
* embedded Liveboard or visualization.
*/
protected getEmbedParams(): string;
private getIframeSuffixSrc;
/**
* Construct the URL of the embedded ThoughtSpot Liveboard or visualization
* to be loaded within the iFrame.
*/
private getIFrameSrc;
/**
* Set the iframe height as per the computed height received
* from the ThoughtSpot app.
* @param data The event payload
*/
private updateIFrameHeight;
private embedIframeCenter;
private setIframeHeightForNonEmbedLiveboard;
private setActiveTab;
private showPreviewLoader;
protected beforePrerenderVisible(): void;
protected handleRenderForPrerender(): Promise<TsEmbed>;
/**
* Triggers an event to the embedded app
* @param {HostEvent} messageType The event type
* @param {any} data The payload to send with the message
* @returns A promise that resolves with the response from the embedded app
*/
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
/**
* Render an embedded ThoughtSpot Liveboard or visualization
* @param renderOptions An object specifying the Liveboard ID,
* visualization ID and the runtime filters.
*/
render(): Promise<LiveboardEmbed>;
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
/**
* Returns the full url of the Liveboard/visualization which can be used to open
* this Liveboard inside the full Thoughtspot application in a new tab.
* @returns url string
*/
getLiveboardUrl(): string;
}
/**
* @hidden
*/
export declare class PinboardEmbed extends LiveboardEmbed {
}
//# sourceMappingURL=liveboard.d.ts.map