import { .. } from '@thoughtspot/visual-embed-sdk';
init({ ... });
const embed = new LiveboardEmbed("#container", {
liveboardId: <your-id-here>,
// .. other params here.
})LiveboardEmbed
Table of Contents
Embed a ThoughtSpot Liveboard or visualization. When rendered it already
waits for the authentication to complete, so you need not wait for
AuthStatus.SUCCESS.
Index🔗
Constructors🔗
new LiveboardEmbed(domSelector: DOMSelector , viewConfig: LiveboardViewConfig ) : LiveboardEmbed
Function Parameters
- domSelector
-
-
domSelector: DOMSelector
-
- viewConfig
-
-
viewConfig: LiveboardViewConfig
-
Returns
Defined in : embed/liveboard.ts
Overrides V1Embed.constructor
Methods🔗
destroy🔗
destroy() : void
Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
Returns
void
Version : SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
Defined in : embed/liveboard.ts
Overrides V1Embed.destroy
getAnswerService🔗
getAnswerService(vizId?: string ) : Promise< AnswerService >
Returns the answerService which can be used to make arbitrary graphql calls on top session.
Function Parameters
- vizId
-
Optional
-
vizId: string
-
to get for a specific viz in case of a Liveboard.
Returns
Promise< AnswerService >
Version : SDK: 1.25.0 / ThoughtSpot 9.10.0
Defined in : embed/ts-embed.ts
Inherited from V1Embed.getAnswerService
getIframeSrc 🔗
getIframeSrc() : string
Returns
string
Defined in : embed/ts-embed.ts
Inherited from V1Embed.getIframeSrc
getLiveboardUrl🔗
getLiveboardUrl() : string
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
string
Defined in : embed/liveboard.ts
getPreRenderIds🔗
getPreRenderIds() : {child?: string = …​, wrapper?: string = …​}
Retrieves unique HTML element IDs for PreRender-related elements. These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'.
Returns
{child?: string = …​, wrapper?: string = …​}
property : {string} wrapper - The HTML element ID for the PreRender wrapper.
property : {string} child - The HTML element ID for the PreRender child.
Defined in : embed/ts-embed.ts
Inherited from V1Embed.getPreRenderIds
getThoughtSpotPostUrlParams🔗
getThoughtSpotPostUrlParams(additionalParams?: {[key: string ] : string | number} = {}) : string
Get the Post Url Params for THOUGHTSPOT from the current host app URL. THOUGHTSPOT URL params starts with a prefix "ts-"
Function Parameters
- additionalParams
-
-
additionalParams: {[key: string ] : string | number} = {}
-
Index Signature Parameters
Returns
string
Version : SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
Defined in : embed/ts-embed.ts
Inherited from V1Embed.getThoughtSpotPostUrlParams
getUnderlyingFrameElement🔗
getUnderlyingFrameElement() : HTMLIFrameElement
Returns
HTMLIFrameElement
Defined in : embed/ts-embed.ts
Inherited from V1Embed.getUnderlyingFrameElement
hidePreRender🔗
hidePreRender() : void
Hides the PreRender component if it is available. If the component is not preRendered, it issues a warning.
Returns
void
Defined in : embed/ts-embed.ts
Inherited from V1Embed.hidePreRender
navigateToLiveboard🔗
navigateToLiveboard(liveboardId: string , vizId?: string , activeTabId?: string ) : void
Function Parameters
- liveboardId
-
-
liveboardId: string
-
- vizId
-
Optional
-
vizId: string
-
- activeTabId
-
Optional
-
activeTabId: string
-
Returns
void
Defined in : embed/liveboard.ts
off🔗
off(messageType: EmbedEvent , callback: MessageCallback ) : TsEmbed
Removes an event listener for a particular event type.
Function Parameters
- messageType
-
-
messageType: EmbedEvent
-
The message type
- callback
-
-
callback: MessageCallback
-
The callback to remove
Returns
TsEmbed
const errorHandler = (data) => { console.error(data); };
tsEmbed.on(EmbedEvent.Error, errorHandler);
tsEmbed.off(EmbedEvent.Error, errorHandler);Defined in : embed/ts-embed.ts
Inherited from V1Embed.off
on🔗
on(messageType: EmbedEvent , callback: MessageCallback , options?: MessageOptions = …​) : TsEmbed
Function Parameters
- messageType
-
-
messageType: EmbedEvent
-
- callback
-
-
callback: MessageCallback
-
- options
-
-
options: MessageOptions = …​
-
Returns
TsEmbed
tsEmbed.on(EmbedEvent.Error, (data) => {
console.error(data);
});tsEmbed.on(EmbedEvent.Save, (data) => {
console.log("Answer save clicked", data);
}, {
start: true // This will trigger the callback on start of save
});Defined in : embed/ts-embed.ts
Inherited from V1Embed.on
preRender🔗
preRender(showPreRenderByDefault?: boolean = false, replaceExistingPreRender?: boolean = false) : Promise< TsEmbed >
Creates the preRender shell
Function Parameters
- showPreRenderByDefault
-
-
showPreRenderByDefault: boolean = false
-
Show the preRender after render, hidden by default
- replaceExistingPreRender
-
-
replaceExistingPreRender: boolean = false
-
Returns
Promise< TsEmbed >
Defined in : embed/ts-embed.ts
Inherited from V1Embed.preRender
prerenderGeneric🔗
prerenderGeneric() : Promise< any >
Prerenders a generic instance of the TS component. This means without the path but with the flags already applied. This is useful for prerendering the component in the background.
Returns
Promise< any >
Version : SDK: 1.22.0
Defined in : embed/ts-embed.ts
Inherited from V1Embed.prerenderGeneric
render🔗
render() : Promise< LiveboardEmbed >
Render an embedded ThoughtSpot Liveboard or visualization
Returns
Promise< LiveboardEmbed >
Defined in : embed/liveboard.ts
Overrides V1Embed.render
showPreRender🔗
showPreRender() : Promise< TsEmbed >
Displays the PreRender component. If the component is not preRendered, it attempts to create and render it. Also, synchronizes the style of the PreRender component with the embedding element.
Returns
Promise< TsEmbed >
Defined in : embed/ts-embed.ts
Inherited from V1Embed.showPreRender
syncPreRenderStyle🔗
syncPreRenderStyle() : void
Synchronizes the style properties of the PreRender component with the embedding element. This function adjusts the position, width, and height of the PreRender component to match the dimensions and position of the embedding element.
Returns
void
throws : {Error} Throws an error if the embedding element (passed as domSelector)
is not defined or not found.
Defined in : embed/ts-embed.ts
Inherited from V1Embed.syncPreRenderStyle
trigger🔗
trigger(messageType: HostEventT , data?: TriggerPayload< PayloadT, HostEventT > = …​) : Promise< TriggerResponse< PayloadT, HostEventT > >
Triggers an event to the embedded app
Function Parameters
- messageType
-
-
messageType: HostEventT
-
The event type
- data
-
-
data: TriggerPayload< PayloadT, HostEventT > = …​
-
The payload to send with the message
Returns
Promise< TriggerResponse< PayloadT, HostEventT > >
Defined in : embed/liveboard.ts
Overrides V1Embed.trigger
triggerUIPassThrough🔗
triggerUIPassThrough(apiName: UIPassthroughEventT , parameters: UIPassthroughRequest< UIPassthroughEventT > ) : Promise< UIPassthroughArrayResponse< UIPassthroughEventT > >
Triggers an event to the embedded app, skipping the UI flow.
Function Parameters
- apiName
-
-
apiName: UIPassthroughEventT
-
The name of the API to be triggered.
- parameters
-
-
parameters: UIPassthroughRequest< UIPassthroughEventT >
-
The parameters to be passed to the API.
Returns
Promise< UIPassthroughArrayResponse< UIPassthroughEventT > >
Defined in : embed/ts-embed.ts
Inherited from V1Embed.triggerUIPassThrough