From b418ba093793731182ab885925578f6d5cce9da1 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 16 Oct 2025 15:51:23 +0530 Subject: [PATCH 01/23] fixed spotter documentation --- src/types.ts | 161 +++++++----- static/typedoc/typedoc.json | 486 ++++++++++++++++++------------------ 2 files changed, 340 insertions(+), 307 deletions(-) diff --git a/src/types.ts b/src/types.ts index 5af6ccf0..72f7e9ae 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1835,7 +1835,7 @@ export enum EmbedEvent { */ Load = 'load', /** - * Data pertaining to an Answer or Liveboard is received. + * Data pertaining to an Answer, Liveboard or Spotter visualization is received. * The event payload includes the raw data of the object. * @return data - Answer of Liveboard data * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw @@ -3209,7 +3209,7 @@ export enum HostEvent { * the following parameters: * * @param - * `vizId`- GUID of the saved Answer or visualization to pin to a Liveboard. + * `vizId`- GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard. * Optional when pinning a new chart or table generated from a Search query. * **Required** in Spotter Embed. * @param @@ -3261,10 +3261,16 @@ export enum HostEvent { * ``` * @example * ```js - * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, { - * vizId:'730496d6-6903-4601-937e-2c691821af3c' - * }); - * ``` + + * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId }); + * ``` + * * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw */ Pin = 'pin', @@ -3339,10 +3345,15 @@ export enum HostEvent { * ``` * @example * ```js - * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { - * vizId:'730496d6-6903-4601-937e-2c691821af3c' - * }); - * ``` + + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId }); + * ``` * * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw */ @@ -3369,10 +3380,14 @@ export enum HostEvent { * ``` * @example * ```js - * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, { - * vizId:'730496d6-6903-4601-937e-2c691821af3c' - * }); - * ``` + * // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId }); + * ``` * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw */ MakeACopy = 'makeACopy', @@ -3457,15 +3472,7 @@ export enum HostEvent { * ``` * @example * ```js - * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, { - * vizId:'730496d6-6903-4601-937e-2c691821af3c' - * }); - * ``` - * @example - * ```js - * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, { - * vizId:'730496d6-6903-4601-937e-2c691821af3c' - * }); + * spotterEmbed.trigger(HostEvent.Edit); * ``` * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw */ @@ -3514,16 +3521,23 @@ export enum HostEvent { * ); * }) * ``` - * @example + * * @example * ```js - * spotterEmbed.trigger(HostEvent.GetTML, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c' + + * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.GetTML, { + * vizId: latestSpotterVizId * }).then((tml) => { * console.log( * tml.answer.search_query // TML representation of the search query * ); * }) - * ``` + * ``` * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw * @important */ @@ -3587,7 +3601,7 @@ export enum HostEvent { /** * Trigger the **Download** action on charts in * the embedded view. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. * @example * ```js * liveboardEmbed.trigger(HostEvent.Download, {vizId: @@ -3597,10 +3611,14 @@ export enum HostEvent { * embed.trigger(HostEvent.Download) * ``` * ```js - * spotterEmbed.trigger(HostEvent.Download, { - * vizId:'730496d6-6903-4601-937e-2c691821af3c' - * }); - * ``` + * // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId }); + * ``` * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw * Use {@link DownloadAsPng} * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw @@ -3618,9 +3636,13 @@ export enum HostEvent { * * searchEmbed.trigger(HostEvent.DownloadAsPng) * - * spotterEmbed.trigger(HostEvent.DownloadAsPng, { - * vizId:"730496d6-6903-4601-937e-2c691821af3c" - * }) + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId }); * ``` * * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw @@ -3629,7 +3651,7 @@ export enum HostEvent { /** * Trigger the **Download** > **CSV** action on tables in * the embedded view. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. * @example * ```js * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: @@ -3642,9 +3664,13 @@ export enum HostEvent { * searchEmbed.trigger(HostEvent.DownloadAsCsv) * ``` * ```js - * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { - * vizId:"730496d6-6903-4601-937e-2c691821af3c" - * }) + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId }); * ``` * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw */ @@ -3652,7 +3678,7 @@ export enum HostEvent { /** * Trigger the **Download** > **XLSX** action on tables * in the embedded view. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. * @example * ```js * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: @@ -3665,9 +3691,13 @@ export enum HostEvent { * searchEmbed.trigger(HostEvent.DownloadAsXlsx) * ``` * ```js - * spotterEmbed.trigger(HostEvent.downloadAsXLSX, { - * vizId:"730496d6-6903-4601-937e-2c691821af3c" - * }) + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId }); * ``` * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw */ @@ -3704,7 +3734,7 @@ export enum HostEvent { * ``` * * ```js - * // Save an Answer in Spotter (requires vizId) + * // Save a Visualization in Spotter (requires vizId) * spotterEmbed.trigger(HostEvent.Save, { * vizId: "730496d6-6903-4601-937e-2c691821af3c" * }) @@ -4026,11 +4056,13 @@ export enum HostEvent { * }); *``` *```js - * spotterEmbed.trigger(HostEvent.GetParameters, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c' - * }).then((parameter) => { - * console.log('parameters', parameter); - * }); + * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId }); *``` * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw */ @@ -4073,11 +4105,13 @@ export enum HostEvent { * ``` * @example * ```js - * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c', - * name: "Sales by states", - * description: "Total sales by states in MidWest" + * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; * }); + * + * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId }); * ``` * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl */ @@ -4161,12 +4195,15 @@ export enum HostEvent { DeleteLastPrompt = 'DeleteLastPrompt', /** * Toggle the visualization to chart or table view. - * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed. + * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required. * @example * ```js - * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { - * vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e' + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; * }); + * + * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId }); *``` * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl */ @@ -4195,12 +4232,16 @@ export enum HostEvent { */ VisibleEmbedCoordinates = 'visibleEmbedCoordinates', /** - * Trigger the *Ask Spotter* action for visualizations - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required. * @example * ```js - * spotterEmbed.trigger(HostEvent.AskSpotter, - * {vizId:'730496d6-6903-4601-937e-2c691821af3c'}) + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId }); * ``` * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl */ diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 2ab1d747..5f033137 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -48,7 +48,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5435, + "line": 5476, "character": 4 } ], @@ -76,7 +76,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4581, + "line": 4622, "character": 4 } ], @@ -104,7 +104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4510, + "line": 4551, "character": 4 } ], @@ -128,7 +128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4499, + "line": 4540, "character": 4 } ], @@ -152,7 +152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4562, + "line": 4603, "character": 4 } ], @@ -176,7 +176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4571, + "line": 4612, "character": 4 } ], @@ -204,7 +204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4591, + "line": 4632, "character": 4 } ], @@ -232,7 +232,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5229, + "line": 5270, "character": 4 } ], @@ -260,7 +260,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4951, + "line": 4992, "character": 4 } ], @@ -288,7 +288,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5402, + "line": 5443, "character": 4 } ], @@ -316,7 +316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4939, + "line": 4980, "character": 4 } ], @@ -344,7 +344,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4927, + "line": 4968, "character": 4 } ], @@ -373,7 +373,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5391, + "line": 5432, "character": 4 } ], @@ -401,7 +401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5064, + "line": 5105, "character": 4 } ], @@ -429,7 +429,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5098, + "line": 5139, "character": 4 } ], @@ -457,7 +457,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5153, + "line": 5194, "character": 4 } ], @@ -485,7 +485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5087, + "line": 5128, "character": 4 } ], @@ -513,7 +513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5121, + "line": 5162, "character": 4 } ], @@ -541,7 +541,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5163, + "line": 5204, "character": 4 } ], @@ -569,7 +569,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5132, + "line": 5173, "character": 4 } ], @@ -597,7 +597,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5185, + "line": 5226, "character": 4 } ], @@ -625,7 +625,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5142, + "line": 5183, "character": 4 } ], @@ -653,7 +653,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5109, + "line": 5150, "character": 4 } ], @@ -681,7 +681,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5173, + "line": 5214, "character": 4 } ], @@ -709,7 +709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5075, + "line": 5116, "character": 4 } ], @@ -737,7 +737,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5533, + "line": 5574, "character": 4 } ], @@ -761,7 +761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4553, + "line": 4594, "character": 4 } ], @@ -789,7 +789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4544, + "line": 4585, "character": 4 } ], @@ -817,7 +817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4532, + "line": 4573, "character": 4 } ], @@ -845,7 +845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5609, + "line": 5650, "character": 4 } ], @@ -869,7 +869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4521, + "line": 4562, "character": 4 } ], @@ -884,7 +884,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4878, + "line": 4919, "character": 4 } ], @@ -908,7 +908,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4458, + "line": 4499, "character": 4 } ], @@ -932,7 +932,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4877, + "line": 4918, "character": 4 } ], @@ -960,7 +960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5619, + "line": 5660, "character": 4 } ], @@ -988,7 +988,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5366, + "line": 5407, "character": 4 } ], @@ -1016,7 +1016,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4971, + "line": 5012, "character": 4 } ], @@ -1044,7 +1044,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5022, + "line": 5063, "character": 4 } ], @@ -1072,7 +1072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5590, + "line": 5631, "character": 4 } ], @@ -1100,7 +1100,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5502, + "line": 5543, "character": 4 } ], @@ -1128,7 +1128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5521, + "line": 5562, "character": 4 } ], @@ -1152,7 +1152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4641, + "line": 4682, "character": 4 } ], @@ -1176,7 +1176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4674, + "line": 4715, "character": 4 } ], @@ -1201,7 +1201,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4664, + "line": 4705, "character": 4 } ], @@ -1225,7 +1225,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4651, + "line": 4692, "character": 4 } ], @@ -1249,7 +1249,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4684, + "line": 4725, "character": 4 } ], @@ -1273,7 +1273,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4894, + "line": 4935, "character": 4 } ], @@ -1297,7 +1297,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4867, + "line": 4908, "character": 4 } ], @@ -1321,7 +1321,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4858, + "line": 4899, "character": 4 } ], @@ -1345,7 +1345,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4760, + "line": 4801, "character": 4 } ], @@ -1369,7 +1369,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4449, + "line": 4490, "character": 4 } ], @@ -1397,7 +1397,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4960, + "line": 5001, "character": 4 } ], @@ -1412,7 +1412,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4883, + "line": 4924, "character": 4 } ], @@ -1440,7 +1440,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5579, + "line": 5620, "character": 4 } ], @@ -1468,7 +1468,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5273, + "line": 5314, "character": 4 } ], @@ -1496,7 +1496,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5448, + "line": 5489, "character": 4 } ], @@ -1520,7 +1520,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4728, + "line": 4769, "character": 4 } ], @@ -1544,7 +1544,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4768, + "line": 4809, "character": 4 } ], @@ -1572,7 +1572,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5600, + "line": 5641, "character": 4 } ], @@ -1600,7 +1600,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5239, + "line": 5280, "character": 4 } ], @@ -1628,7 +1628,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5250, + "line": 5291, "character": 4 } ], @@ -1652,7 +1652,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4847, + "line": 4888, "character": 4 } ], @@ -1677,7 +1677,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4700, + "line": 4741, "character": 4 } ], @@ -1701,7 +1701,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4710, + "line": 4751, "character": 4 } ], @@ -1729,7 +1729,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5635, + "line": 5676, "character": 4 } ], @@ -1757,7 +1757,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5512, + "line": 5553, "character": 4 } ], @@ -1781,7 +1781,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4809, + "line": 4850, "character": 4 } ], @@ -1809,7 +1809,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5334, + "line": 5375, "character": 4 } ], @@ -1833,7 +1833,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4440, + "line": 4481, "character": 4 } ], @@ -1857,7 +1857,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5314, + "line": 5355, "character": 4 } ], @@ -1885,7 +1885,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5012, + "line": 5053, "character": 4 } ], @@ -1913,7 +1913,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5491, + "line": 5532, "character": 4 } ], @@ -1941,7 +1941,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5219, + "line": 5260, "character": 4 } ], @@ -1968,7 +1968,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5294, + "line": 5335, "character": 4 } ], @@ -1992,7 +1992,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5303, + "line": 5344, "character": 4 } ], @@ -2020,7 +2020,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5424, + "line": 5465, "character": 4 } ], @@ -2048,7 +2048,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5459, + "line": 5500, "character": 4 } ], @@ -2076,7 +2076,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5324, + "line": 5365, "character": 4 } ], @@ -2100,7 +2100,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4826, + "line": 4867, "character": 4 } ], @@ -2124,7 +2124,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5679, + "line": 5720, "character": 4 } ], @@ -2148,7 +2148,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4738, + "line": 4779, "character": 4 } ], @@ -2176,7 +2176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5545, + "line": 5586, "character": 4 } ], @@ -2201,7 +2201,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4917, + "line": 4958, "character": 4 } ], @@ -2225,7 +2225,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4778, + "line": 4819, "character": 4 } ], @@ -2253,7 +2253,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5691, + "line": 5732, "character": 4 } ], @@ -2281,7 +2281,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5053, + "line": 5094, "character": 4 } ], @@ -2309,7 +2309,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5413, + "line": 5454, "character": 4 } ], @@ -2337,7 +2337,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5199, + "line": 5240, "character": 4 } ], @@ -2368,7 +2368,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4981, + "line": 5022, "character": 4 } ], @@ -2392,7 +2392,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4903, + "line": 4944, "character": 4 } ], @@ -2420,7 +2420,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5209, + "line": 5250, "character": 4 } ], @@ -2448,7 +2448,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5557, + "line": 5598, "character": 4 } ], @@ -2476,7 +2476,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5285, + "line": 5326, "character": 4 } ], @@ -2500,7 +2500,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4409, + "line": 4450, "character": 4 } ], @@ -2524,7 +2524,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4427, + "line": 4468, "character": 4 } ], @@ -2548,7 +2548,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4472, + "line": 4513, "character": 4 } ], @@ -2572,7 +2572,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4481, + "line": 4522, "character": 4 } ], @@ -2587,7 +2587,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4884, + "line": 4925, "character": 4 } ], @@ -2611,7 +2611,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4490, + "line": 4531, "character": 4 } ], @@ -2629,7 +2629,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4616, + "line": 4657, "character": 4 } ], @@ -2657,7 +2657,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5260, + "line": 5301, "character": 4 } ], @@ -2681,7 +2681,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4631, + "line": 4672, "character": 4 } ], @@ -2705,7 +2705,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4604, + "line": 4645, "character": 4 } ], @@ -2733,7 +2733,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5568, + "line": 5609, "character": 4 } ], @@ -2761,7 +2761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5668, + "line": 5709, "character": 4 } ], @@ -2789,7 +2789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5646, + "line": 5687, "character": 4 } ], @@ -2817,7 +2817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5657, + "line": 5698, "character": 4 } ], @@ -2841,7 +2841,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4839, + "line": 4880, "character": 4 } ], @@ -2869,7 +2869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5002, + "line": 5043, "character": 4 } ], @@ -2897,7 +2897,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4991, + "line": 5032, "character": 4 } ], @@ -2925,7 +2925,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5032, + "line": 5073, "character": 4 } ], @@ -2953,7 +2953,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5042, + "line": 5083, "character": 4 } ], @@ -2985,7 +2985,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5353, + "line": 5394, "character": 4 } ], @@ -3009,7 +3009,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4750, + "line": 4791, "character": 4 } ], @@ -3037,7 +3037,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5481, + "line": 5522, "character": 4 } ], @@ -3061,7 +3061,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4719, + "line": 4760, "character": 4 } ], @@ -3089,7 +3089,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5377, + "line": 5418, "character": 4 } ], @@ -3117,7 +3117,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5470, + "line": 5511, "character": 4 } ], @@ -3253,7 +3253,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4400, + "line": 4441, "character": 12 } ] @@ -3826,7 +3826,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5712, + "line": 5753, "character": 4 } ], @@ -3841,7 +3841,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5710, + "line": 5751, "character": 4 } ], @@ -3856,7 +3856,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5711, + "line": 5752, "character": 4 } ], @@ -3877,7 +3877,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5709, + "line": 5750, "character": 12 } ] @@ -3901,7 +3901,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5797, + "line": 5838, "character": 4 } ], @@ -3916,7 +3916,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5795, + "line": 5836, "character": 4 } ], @@ -3931,7 +3931,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5798, + "line": 5839, "character": 4 } ], @@ -3946,7 +3946,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5796, + "line": 5837, "character": 4 } ], @@ -3968,7 +3968,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5794, + "line": 5835, "character": 12 } ] @@ -3992,7 +3992,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5788, + "line": 5829, "character": 4 } ], @@ -4007,7 +4007,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5787, + "line": 5828, "character": 4 } ], @@ -4022,7 +4022,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5786, + "line": 5827, "character": 4 } ], @@ -4043,7 +4043,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5785, + "line": 5826, "character": 12 } ] @@ -4154,7 +4154,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4234, + "line": 4275, "character": 4 } ], @@ -4172,7 +4172,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4238, + "line": 4279, "character": 4 } ], @@ -4190,7 +4190,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4230, + "line": 4271, "character": 4 } ], @@ -4211,7 +4211,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4226, + "line": 4267, "character": 12 } ] @@ -4797,7 +4797,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Data pertaining to an Answer or Liveboard is received.\nThe event payload includes the raw data of the object.", + "shortText": "Data pertaining to an Answer, Liveboard or Spotter visualization is received.\nThe event payload includes the raw data of the object.", "tags": [ { "tag": "returns", @@ -7287,12 +7287,12 @@ "tags": [ { "tag": "param", - "text": "`vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.", + "text": "`vizId ` refers to the Visualization ID in Spotter embed and is required.", "param": "-" }, { "tag": "example", - "text": "\n```js\nspotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {\n vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'\n});\n```" + "text": "\n```js\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId });\n```" }, { "tag": "version", @@ -7303,7 +7303,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4173, + "line": 4210, "character": 4 } ], @@ -7331,7 +7331,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3980, + "line": 4010, "character": 4 } ], @@ -7344,16 +7344,16 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Trigger the *Ask Spotter* action for visualizations", + "shortText": "Trigger the *Spotter* action for visualizations present on the liveboard's vizzes.", "tags": [ { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.", + "text": "`vizId` refers to the Visualization ID in Spotter embed and is required.", "param": "-" }, { "tag": "example", - "text": "\n```js\nspotterEmbed.trigger(HostEvent.AskSpotter,\n{vizId:'730496d6-6903-4601-937e-2c691821af3c'})\n```" + "text": "\n```js\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId });\n```" }, { "tag": "version", @@ -7364,7 +7364,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4207, + "line": 4248, "character": 4 } ], @@ -7397,7 +7397,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3489, + "line": 3496, "character": 4 } ], @@ -7434,7 +7434,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3419, + "line": 3434, "character": 4 } ], @@ -7467,7 +7467,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3566, + "line": 3580, "character": 4 } ], @@ -7495,7 +7495,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4161, + "line": 4195, "character": 4 } ], @@ -7512,12 +7512,12 @@ "tags": [ { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.", + "text": "`vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.", "param": "-" }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.Download, {vizId:\n'730496d6-6903-4601-937e-2c691821af3c'})\n```\n```js\nembed.trigger(HostEvent.Download)\n```\n```js\nspotterEmbed.trigger(HostEvent.Download, {\n vizId:'730496d6-6903-4601-937e-2c691821af3c'\n });\n```" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.Download, {vizId:\n'730496d6-6903-4601-937e-2c691821af3c'})\n```\n```js\nembed.trigger(HostEvent.Download)\n```\n```js\n// You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId });\n```" }, { "tag": "deprecated", @@ -7532,7 +7532,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3608, + "line": 3626, "character": 4 } ], @@ -7549,12 +7549,12 @@ "tags": [ { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.", + "text": "`vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.", "param": "-" }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:\n'730496d6-6903-4601-937e-2c691821af3c'})\n```\n```js\nvizEmbed.trigger(HostEvent.DownloadAsCsv)\n```\n```js\nsearchEmbed.trigger(HostEvent.DownloadAsCsv)\n```\n```js\nspotterEmbed.trigger(HostEvent.DownloadAsCsv, {\n vizId:\"730496d6-6903-4601-937e-2c691821af3c\"\n})\n```" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:\n'730496d6-6903-4601-937e-2c691821af3c'})\n```\n```js\nvizEmbed.trigger(HostEvent.DownloadAsCsv)\n```\n```js\nsearchEmbed.trigger(HostEvent.DownloadAsCsv)\n```\n```js\n// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });\n```" }, { "tag": "version", @@ -7565,7 +7565,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3651, + "line": 3677, "character": 4 } ], @@ -7591,7 +7591,7 @@ }, { "tag": "example", - "text": "\n```js\nspotterEmbed.trigger(HostEvent.DownloadAsPdf, {\n vizId:'730496d6-6903-4601-937e-2c691821af3c'\n });\n```\n" + "text": "\n```js\n\n// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });\n```\n" }, { "tag": "version", @@ -7602,7 +7602,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3349, + "line": 3360, "character": 4 } ], @@ -7619,7 +7619,7 @@ "tags": [ { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.DownloadAsPng,\n{vizId:'730496d6-6903-4601-937e-2c691821af3c'})\n\nvizEmbed.trigger(HostEvent.DownloadAsPng)\n\nsearchEmbed.trigger(HostEvent.DownloadAsPng)\n\nspotterEmbed.trigger(HostEvent.DownloadAsPng, {\n vizId:\"730496d6-6903-4601-937e-2c691821af3c\"\n})\n```\n" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.DownloadAsPng,\n{vizId:'730496d6-6903-4601-937e-2c691821af3c'})\n\nvizEmbed.trigger(HostEvent.DownloadAsPng)\n\nsearchEmbed.trigger(HostEvent.DownloadAsPng)\n\n// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });\n```\n" }, { "tag": "version", @@ -7630,7 +7630,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3628, + "line": 3650, "character": 4 } ], @@ -7647,12 +7647,12 @@ "tags": [ { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.", + "text": "`vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed.", "param": "-" }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:\n'730496d6-6903-4601-937e-2c691821af3c'})\n```\n```js\nvizEmbed.trigger(HostEvent.DownloadAsXlsx)\n```\n```js\nsearchEmbed.trigger(HostEvent.DownloadAsXlsx)\n```\n```js\nspotterEmbed.trigger(HostEvent.downloadAsXLSX, {\n vizId:\"730496d6-6903-4601-937e-2c691821af3c\"\n})\n```" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:\n'730496d6-6903-4601-937e-2c691821af3c'})\n```\n```js\nvizEmbed.trigger(HostEvent.DownloadAsXlsx)\n```\n```js\nsearchEmbed.trigger(HostEvent.DownloadAsXlsx)\n```\n```js\n// You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });\n```" }, { "tag": "version", @@ -7663,7 +7663,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3674, + "line": 3704, "character": 4 } ], @@ -7752,11 +7752,7 @@ }, { "tag": "example", - "text": "\n```js\nconst pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {\n vizId:'730496d6-6903-4601-937e-2c691821af3c'\n });\n```" - }, - { - "tag": "example", - "text": "\n```js\nconst editResponse = await spotterEmbed.trigger(HostEvent.Edit, {\n vizId:'730496d6-6903-4601-937e-2c691821af3c'\n });\n```" + "text": "\n```js\nspotterEmbed.trigger(HostEvent.Edit);\n```" }, { "tag": "version", @@ -7767,7 +7763,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3472, + "line": 3479, "character": 4 } ], @@ -7800,7 +7796,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4134, + "line": 4168, "character": 4 } ], @@ -7828,7 +7824,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3318, + "line": 3324, "character": 4 } ], @@ -7861,7 +7857,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3402, + "line": 3417, "character": 4 } ], @@ -7889,7 +7885,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3308, + "line": 3314, "character": 4 } ], @@ -7922,7 +7918,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3970, + "line": 4000, "character": 4 } ], @@ -7950,7 +7946,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3797, + "line": 3827, "character": 4 } ], @@ -7995,7 +7991,7 @@ "tags": [ { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.\n```js\nliveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {\n console.log('parameters', parameter);\n});\n```\n```js\nspotterEmbed.trigger(HostEvent.GetParameters, {\n vizId: '730496d6-6903-4601-937e-2c691821af3c'\n}).then((parameter) => {\n console.log('parameters', parameter);\n});\n```", + "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.\n```js\nliveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {\n console.log('parameters', parameter);\n});\n```\n```js\n// You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });\n```", "param": "-" }, { @@ -8007,7 +8003,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4037, + "line": 4069, "character": 4 } ], @@ -8024,11 +8020,7 @@ "tags": [ { "tag": "example", - "text": "\n```js\nsearchEmbed.trigger(HostEvent.GetTML).then((tml) => {\n console.log(\n tml.answer.search_query // TML representation of the search query\n );\n})\n```" - }, - { - "tag": "example", - "text": "\n```js\nspotterEmbed.trigger(HostEvent.GetTML, {\n vizId: '730496d6-6903-4601-937e-2c691821af3c'\n}).then((tml) => {\n console.log(\n tml.answer.search_query // TML representation of the search query\n );\n})\n```" + "text": "\n```js\nsearchEmbed.trigger(HostEvent.GetTML).then((tml) => {\n console.log(\n tml.answer.search_query // TML representation of the search query\n );\n})\n```\n* @example\n```js\n\n// You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.GetTML, {\n vizId: latestSpotterVizId\n}).then((tml) => {\n console.log(\n tml.answer.search_query // TML representation of the search query\n );\n})\n```" }, { "tag": "version", @@ -8043,7 +8035,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3530, + "line": 3544, "character": 4 } ], @@ -8071,7 +8063,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3900, + "line": 3930, "character": 4 } ], @@ -8099,7 +8091,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3280, + "line": 3286, "character": 4 } ], @@ -8132,7 +8124,7 @@ }, { "tag": "example", - "text": "\n```js\nconst pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {\n vizId:'730496d6-6903-4601-937e-2c691821af3c'\n });\n```" + "text": "\n```js\n// You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });\n```" }, { "tag": "version", @@ -8143,7 +8135,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3378, + "line": 3393, "character": 4 } ], @@ -8184,7 +8176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3440, + "line": 3455, "character": 4 } ], @@ -8217,7 +8209,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3774, + "line": 3804, "character": 4 } ], @@ -8304,7 +8296,7 @@ "tags": [ { "tag": "param", - "text": "\n`vizId`- GUID of the saved Answer or visualization to pin to a Liveboard.\n Optional when pinning a new chart or table generated from a Search query.\n **Required** in Spotter Embed." + "text": "\n`vizId`- GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.\n Optional when pinning a new chart or table generated from a Search query.\n **Required** in Spotter Embed." }, { "tag": "param", @@ -8344,7 +8336,7 @@ }, { "tag": "example", - "text": "\n```js\nconst pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {\n vizId:'730496d6-6903-4601-937e-2c691821af3c'\n });\n```" + "text": "\n```js\n\n// You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });\n```\n" }, { "tag": "version", @@ -8355,7 +8347,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3270, + "line": 3276, "character": 4 } ], @@ -8388,7 +8380,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3506, + "line": 3513, "character": 4 } ], @@ -8416,7 +8408,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4143, + "line": 4177, "character": 4 } ], @@ -8448,7 +8440,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3392, + "line": 3407, "character": 4 } ], @@ -8509,7 +8501,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4005, + "line": 4035, "character": 4 } ], @@ -8537,7 +8529,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3786, + "line": 3816, "character": 4 } ], @@ -8565,7 +8557,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4152, + "line": 4186, "character": 4 } ], @@ -8587,7 +8579,7 @@ }, { "tag": "example", - "text": "\n```js\n// Save changes in a Liveboard\nliveboardEmbed.trigger(HostEvent.Save)\n```\n\n```js\n// Save the current Answer in Search embed\nsearchEmbed.trigger(HostEvent.Save)\n```\n\n```js\n// Save an Answer in Spotter (requires vizId)\nspotterEmbed.trigger(HostEvent.Save, {\n vizId: \"730496d6-6903-4601-937e-2c691821af3c\"\n})\n```\n\n```js\n// How to get the vizId in Spotter?\n\n// You can use the Data event dispatched on each answer creation to get the vizId.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });\n```\n" + "text": "\n```js\n// Save changes in a Liveboard\nliveboardEmbed.trigger(HostEvent.Save)\n```\n\n```js\n// Save the current Answer in Search embed\nsearchEmbed.trigger(HostEvent.Save)\n```\n\n```js\n// Save a Visualization in Spotter (requires vizId)\nspotterEmbed.trigger(HostEvent.Save, {\n vizId: \"730496d6-6903-4601-937e-2c691821af3c\"\n})\n```\n\n```js\n// How to get the vizId in Spotter?\n\n// You can use the Data event dispatched on each answer creation to get the vizId.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });\n```\n" }, { "tag": "version", @@ -8598,7 +8590,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3727, + "line": 3757, "character": 4 } ], @@ -8629,7 +8621,7 @@ }, { "tag": "example", - "text": "\n```js\nconst saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {\n vizId: '730496d6-6903-4601-937e-2c691821af3c',\n name: \"Sales by states\",\n description: \"Total sales by states in MidWest\"\n});\n```" + "text": "\n```js\n// You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event.\nlet latestSpotterVizId = '';\nspotterEmbed.on(EmbedEvent.Data, (payload) => {\n latestSpotterVizId = payload.data.id;\n});\n\nspotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });\n```" }, { "tag": "version", @@ -8640,7 +8632,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4084, + "line": 4118, "character": 4 } ], @@ -8668,7 +8660,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3289, + "line": 3295, "character": 4 } ], @@ -8696,7 +8688,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3298, + "line": 3304, "character": 4 } ], @@ -8801,7 +8793,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3926, + "line": 3956, "character": 4 } ], @@ -8834,7 +8826,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3913, + "line": 3943, "character": 4 } ], @@ -8895,7 +8887,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3687, + "line": 3717, "character": 4 } ], @@ -8928,7 +8920,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3549, + "line": 3563, "character": 4 } ], @@ -8961,7 +8953,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3586, + "line": 3600, "character": 4 } ], @@ -8999,7 +8991,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4124, + "line": 4158, "character": 4 } ], @@ -9032,7 +9024,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3758, + "line": 3788, "character": 4 } ], @@ -9065,7 +9057,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3742, + "line": 3772, "character": 4 } ], @@ -9098,7 +9090,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4109, + "line": 4143, "character": 4 } ], @@ -9126,7 +9118,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3996, + "line": 4026, "character": 4 } ], @@ -9176,7 +9168,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3887, + "line": 3917, "character": 4 } ], @@ -9200,7 +9192,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4019, + "line": 4049, "character": 4 } ], @@ -9224,7 +9216,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4045, + "line": 4077, "character": 4 } ], @@ -9300,7 +9292,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3940, + "line": 3970, "character": 4 } ], @@ -9328,7 +9320,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3327, + "line": 3333, "character": 4 } ], @@ -9673,7 +9665,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5872, + "line": 5913, "character": 4 } ], @@ -9701,7 +9693,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5833, + "line": 5874, "character": 4 } ], @@ -9729,7 +9721,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5858, + "line": 5899, "character": 4 } ], @@ -9757,7 +9749,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5821, + "line": 5862, "character": 4 } ], @@ -9785,7 +9777,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5884, + "line": 5925, "character": 4 } ], @@ -9813,7 +9805,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5845, + "line": 5886, "character": 4 } ], @@ -9837,7 +9829,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5808, + "line": 5849, "character": 12 } ] @@ -10018,7 +10010,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5699, + "line": 5740, "character": 4 } ], @@ -10033,7 +10025,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5701, + "line": 5742, "character": 4 } ], @@ -10048,7 +10040,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5700, + "line": 5741, "character": 4 } ], @@ -10063,7 +10055,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5702, + "line": 5743, "character": 4 } ], @@ -10085,7 +10077,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5698, + "line": 5739, "character": 12 } ] @@ -27466,7 +27458,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5743, + "line": 5784, "character": 4 } ], @@ -27488,7 +27480,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5744, + "line": 5785, "character": 8 } ], @@ -27507,7 +27499,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5745, + "line": 5786, "character": 8 } ], @@ -27543,7 +27535,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5747, + "line": 5788, "character": 4 } ], @@ -27565,7 +27557,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5755, + "line": 5796, "character": 8 } ], @@ -27586,7 +27578,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5756, + "line": 5797, "character": 8 } ], @@ -27607,7 +27599,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5749, + "line": 5790, "character": 8 } ], @@ -27625,7 +27617,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5748, + "line": 5789, "character": 8 } ], @@ -27643,7 +27635,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5750, + "line": 5791, "character": 8 } ], @@ -27665,7 +27657,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5751, + "line": 5792, "character": 12 } ], @@ -27687,7 +27679,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5752, + "line": 5793, "character": 16 } ], @@ -27771,7 +27763,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5759, + "line": 5800, "character": 4 } ], @@ -27792,7 +27784,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5760, + "line": 5801, "character": 4 } ], @@ -27817,7 +27809,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5742, + "line": 5783, "character": 17 } ] @@ -43151,7 +43143,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5735, + "line": 5776, "character": 4 } ], @@ -43172,7 +43164,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5736, + "line": 5777, "character": 4 } ], @@ -43198,7 +43190,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5734, + "line": 5775, "character": 17 } ] From 4fd38890db2e13a13c676a813d985f89d967292e Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Sun, 2 Nov 2025 01:02:41 +0530 Subject: [PATCH 02/23] added context --- src/embed/hostEventClient/host-event-client.ts | 10 +++++++--- src/embed/ts-embed.ts | 3 ++- src/utils/processTrigger.ts | 7 +++++-- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/src/embed/hostEventClient/host-event-client.ts b/src/embed/hostEventClient/host-event-client.ts index a98812ea..b7188c0d 100644 --- a/src/embed/hostEventClient/host-event-client.ts +++ b/src/embed/hostEventClient/host-event-client.ts @@ -23,7 +23,7 @@ export class HostEventClient { * @param {any} data Data to send with the host event * @returns {Promise} - the response from the process trigger */ - protected async processTrigger(message: HostEvent, data: any): Promise { + protected async processTrigger(message: HostEvent, data: any, context?: any): Promise { if (!this.iFrame) { throw new Error('Iframe element is not set'); } @@ -34,6 +34,7 @@ export class HostEventClient { message, thoughtspotHost, data, + context, ); } @@ -65,8 +66,9 @@ export class HostEventClient { public async hostEventFallback( hostEvent: HostEvent, data: any, + context?: any, ): Promise { - return this.processTrigger(hostEvent, data); + return this.processTrigger(hostEvent, data, context); } /** @@ -132,9 +134,11 @@ export class HostEventClient { public async triggerHostEvent< HostEventT extends HostEvent, PayloadT, + ContextT, >( hostEvent: HostEventT, payload?: TriggerPayload, + context?: ContextT, ): Promise> { switch (hostEvent) { case HostEvent.Pin: @@ -144,7 +148,7 @@ export class HostEventClient { payload as HostEventRequest, ) as any; default: - return this.hostEventFallback(hostEvent, payload); + return this.hostEventFallback(hostEvent, payload, context as any); } } } diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index 2d380e0a..012ba874 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -1271,6 +1271,7 @@ export class TsEmbed { public async trigger( messageType: HostEventT, data: TriggerPayload = {} as any, + context: any = {}, ): Promise> { uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`); @@ -1294,7 +1295,7 @@ export class TsEmbed { } // send an empty object, this is needed for liveboard default handlers - return this.hostEventClient.triggerHostEvent(messageType, data); + return this.hostEventClient.triggerHostEvent(messageType, data, context); } /** diff --git a/src/utils/processTrigger.ts b/src/utils/processTrigger.ts index ae907dfa..8f766279 100644 --- a/src/utils/processTrigger.ts +++ b/src/utils/processTrigger.ts @@ -22,12 +22,13 @@ export const reload = (iFrame: HTMLIFrameElement) => { * @param message * @param message.type * @param message.data + * @param message.context * @param thoughtSpotHost * @param channel */ function postIframeMessage( iFrame: HTMLIFrameElement, - message: { type: HostEvent; data: any }, + message: { type: HostEvent; data: any, context?: any }, thoughtSpotHost: string, channel?: MessageChannel, ) { @@ -42,12 +43,14 @@ export const TRIGGER_TIMEOUT = 30000; * @param messageType * @param thoughtSpotHost * @param data + * @param context */ export function processTrigger( iFrame: HTMLIFrameElement, messageType: HostEvent, thoughtSpotHost: string, data: any, + context?: any, ): Promise { return new Promise((res, rej) => { if (messageType === HostEvent.Reload) { @@ -83,6 +86,6 @@ export function processTrigger( res(new Error(ERROR_MESSAGE.TRIGGER_TIMED_OUT)); }, TRIGGER_TIMEOUT); - return postIframeMessage(iFrame, { type: messageType, data }, thoughtSpotHost, channel); + return postIframeMessage(iFrame, { type: messageType, data, context }, thoughtSpotHost, channel); }); } From f1268dc0aad904abe3a9d459b73be720bef4d18c Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Wed, 12 Nov 2025 15:47:00 +0530 Subject: [PATCH 03/23] get current page context fix --- package-lock.json | 4 +- package.json | 4 +- src/embed/conversation.ts | 7 + src/embed/hostEventClient/contracts.ts | 19 +- .../hostEventClient/host-event-client.ts | 13 +- src/embed/liveboard.ts | 15 +- src/embed/sage.ts | 6 + src/embed/search-bar.tsx | 6 + src/embed/search.ts | 7 + src/embed/ts-embed.ts | 16 +- src/types.ts | 10 + src/utils/processTrigger.ts | 3 +- visual-embed-sdk.d.ts | 9631 +++++++++++++++++ 13 files changed, 9720 insertions(+), 21 deletions(-) create mode 100644 visual-embed-sdk.d.ts diff --git a/package-lock.json b/package-lock.json index 9673e28a..e6b1e8b0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@thoughtspot/visual-embed-sdk", - "version": "1.42.1", + "version": "1.42.1-HE2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@thoughtspot/visual-embed-sdk", - "version": "1.42.1", + "version": "1.42.1-HE2", "license": "ThoughtSpot Development Tools End User License Agreement", "dependencies": { "classnames": "^2.3.1", diff --git a/package.json b/package.json index c205d9fd..cbc2bab7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@thoughtspot/visual-embed-sdk", - "version": "1.42.1", + "version": "1.42.1-HE2.0.2", "description": "ThoughtSpot Embed SDK", "module": "lib/src/index.js", "main": "dist/tsembed.js", @@ -57,7 +57,7 @@ "test": "npm run test-sdk", "posttest": "cat ./coverage/sdk/lcov.info | npx coveralls-next", "is-publish-allowed": "node scripts/is-publish-allowed.js", - "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build", + "prepublishOnly": "npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build", "check-size": "npm run build && size-limit", "publish-dev": "npm publish --tag dev", "publish-prod": "npm publish --tag latest", diff --git a/src/embed/conversation.ts b/src/embed/conversation.ts index 139ba205..0340916a 100644 --- a/src/embed/conversation.ts +++ b/src/embed/conversation.ts @@ -3,6 +3,8 @@ import { ERROR_MESSAGE } from '../errors'; import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter } from '../types'; import { TsEmbed } from './ts-embed'; import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils'; +import { ContextType } from './hostEventClient/contracts'; +import { PageContextOptions } from 'visual-embed-sdk'; /** * Configuration for search options @@ -280,6 +282,11 @@ export class SpotterEmbed extends TsEmbed { await this.renderIFrame(src); return this; } + + public async getCurrentContext(): Promise { + const context = await super.getCurrentContext(); + return context; + } } /** diff --git a/src/embed/hostEventClient/contracts.ts b/src/embed/hostEventClient/contracts.ts index f82077b7..f6f096a4 100644 --- a/src/embed/hostEventClient/contracts.ts +++ b/src/embed/hostEventClient/contracts.ts @@ -93,7 +93,7 @@ export type HostEventRequest = ? UIPassthroughRequest : any; -export type HostEventResponse = +export type HostEventResponse = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse : any; @@ -101,5 +101,18 @@ export type HostEventResponse = // trigger response and request export type TriggerPayload = PayloadT | HostEventRequest; -export type TriggerResponse = - PayloadT extends HostEventRequest ? HostEventResponse : any; +export type TriggerResponse = + PayloadT extends HostEventRequest ? HostEventResponse : any; + + export enum ContextType { + Search = 'search', + Liveboard = 'liveboard', + Answer = 'answer', + Spotter = 'spotter', + Default = 'default', + } + + export enum PageType { + PAGE = 'page', + DIALOG = 'dialog', + } \ No newline at end of file diff --git a/src/embed/hostEventClient/host-event-client.ts b/src/embed/hostEventClient/host-event-client.ts index b7188c0d..c2478ed5 100644 --- a/src/embed/hostEventClient/host-event-client.ts +++ b/src/embed/hostEventClient/host-event-client.ts @@ -8,6 +8,7 @@ import { UIPassthroughResponse, TriggerPayload, TriggerResponse, + ContextType, } from './contracts'; export class HostEventClient { @@ -23,7 +24,7 @@ export class HostEventClient { * @param {any} data Data to send with the host event * @returns {Promise} - the response from the process trigger */ - protected async processTrigger(message: HostEvent, data: any, context?: any): Promise { + protected async processTrigger(message: HostEvent, data: any, context?: ContextType): Promise { if (!this.iFrame) { throw new Error('Iframe element is not set'); } @@ -66,7 +67,7 @@ export class HostEventClient { public async hostEventFallback( hostEvent: HostEvent, data: any, - context?: any, + context?: ContextType, ): Promise { return this.processTrigger(hostEvent, data, context); } @@ -93,7 +94,7 @@ export class HostEventClient { protected async handlePinEvent( payload: HostEventRequest, - ): Promise> { + ): Promise> { if (!payload || !('newVizName' in payload)) { return this.hostEventFallback(HostEvent.Pin, payload); } @@ -134,12 +135,12 @@ export class HostEventClient { public async triggerHostEvent< HostEventT extends HostEvent, PayloadT, - ContextT, + ContextT extends ContextType, >( hostEvent: HostEventT, payload?: TriggerPayload, context?: ContextT, - ): Promise> { + ): Promise> { switch (hostEvent) { case HostEvent.Pin: return this.handlePinEvent(payload as HostEventRequest) as any; @@ -148,7 +149,7 @@ export class HostEventClient { payload as HostEventRequest, ) as any; default: - return this.hostEventFallback(hostEvent, payload, context as any); + return this.hostEventFallback(hostEvent, payload, context); } } } diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index e374f2da..8483fe02 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -25,8 +25,9 @@ import { calculateVisibleElementData, getQueryParamString, isUndefined } from '. import { getAuthPromise } from './base'; import { TsEmbed, V1Embed } from './ts-embed'; import { addPreviewStylesIfNotPresent } from '../utils/global-styles'; -import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts'; +import { ContextType, TriggerPayload, TriggerResponse } from './hostEventClient/contracts'; import { logger } from '../utils/logger'; +import { PageContextOptions } from 'visual-embed-sdk'; /** @@ -738,10 +739,11 @@ export class LiveboardEmbed extends V1Embed { * @param {any} data The payload to send with the message * @returns A promise that resolves with the response from the embedded app */ - public trigger( + public trigger( messageType: HostEventT, data: TriggerPayload = ({} as any), - ): Promise> { + context?: ContextT, + ): Promise> { const dataWithVizId: any = data; if (messageType === HostEvent.SetActiveTab) { this.setActiveTab(data as { tabId: string }); @@ -750,7 +752,7 @@ export class LiveboardEmbed extends V1Embed { if (typeof dataWithVizId === 'object' && this.viewConfig.vizId) { dataWithVizId.vizId = this.viewConfig.vizId; } - return super.trigger(messageType, dataWithVizId); + return super.trigger(messageType, dataWithVizId, context); } /** * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. @@ -827,6 +829,11 @@ export class LiveboardEmbed extends V1Embed { return url; } + + public async getCurrentContext(): Promise { + const context = await super.getCurrentContext(); + return context; + } } /** diff --git a/src/embed/sage.ts b/src/embed/sage.ts index 8d4a582c..857c90e0 100644 --- a/src/embed/sage.ts +++ b/src/embed/sage.ts @@ -6,6 +6,7 @@ * @author Mourya Balabhadra */ +import { PageContextOptions } from 'visual-embed-sdk'; import { DOMSelector, Param, BaseViewConfig, SearchLiveboardCommonViewConfig } from '../types'; import { getQueryParamString } from '../utils'; import { V1Embed } from './ts-embed'; @@ -229,4 +230,9 @@ export class SageEmbed extends V1Embed { return this; } + + public async getCurrentContext(): Promise { + const context = await super.getCurrentContext(); + return context; + } } diff --git a/src/embed/search-bar.tsx b/src/embed/search-bar.tsx index bc5f0262..7b034523 100644 --- a/src/embed/search-bar.tsx +++ b/src/embed/search-bar.tsx @@ -2,6 +2,7 @@ import { SearchLiveboardCommonViewConfig, BaseViewConfig, DefaultAppInitData, Pa import { getQueryParamString } from '../utils'; import { TsEmbed } from './ts-embed'; import { SearchOptions } from './search'; +import { PageContextOptions } from 'visual-embed-sdk'; /** * @group Embed components @@ -198,4 +199,9 @@ export class SearchBarEmbed extends TsEmbed { const defaultAppInitData = await super.getAppInitData(); return { ...defaultAppInitData, ...this.getSearchInitData() }; } + + public async getCurrentContext(): Promise { + const context = await super.getCurrentContext(); + return context; + } } diff --git a/src/embed/search.ts b/src/embed/search.ts index 534db212..aae9fe66 100644 --- a/src/embed/search.ts +++ b/src/embed/search.ts @@ -26,6 +26,8 @@ import { ERROR_MESSAGE } from '../errors'; import { getAuthPromise } from './base'; import { getReleaseVersion } from '../auth'; import { getEmbedConfig } from './embedConfig'; +import { PageContextOptions } from 'visual-embed-sdk'; +import { ContextType, PageType } from './hostEventClient/contracts'; /** * Configuration for search options. @@ -536,4 +538,9 @@ export class SearchEmbed extends TsEmbed { }); return this; } + + public async getCurrentContext(): Promise { + const context = await super.getCurrentContext(); + return context; + } } diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index 012ba874..e9b23454 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -10,11 +10,13 @@ import isEqual from 'lodash/isEqual'; import isEmpty from 'lodash/isEmpty'; import isObject from 'lodash/isObject'; import { + ContextType, TriggerPayload, TriggerResponse, UIPassthroughArrayResponse, UIPassthroughEvent, UIPassthroughRequest, + PageType, } from './hostEventClient/contracts'; import { logger } from '../utils/logger'; import { getAuthenticationToken } from '../authToken'; @@ -71,6 +73,7 @@ import { getEmbedConfig } from './embedConfig'; import { ERROR_MESSAGE } from '../errors'; import { getPreauthInfo } from '../utils/sessionInfoService'; import { HostEventClient } from './hostEventClient/host-event-client'; +import { PageContextOptions } from '../../visual-embed-sdk'; const { version } = pkgInfo; @@ -1268,11 +1271,11 @@ export class TsEmbed { * @param {any} data The payload to send with the message * @returns A promise that resolves with the response from the embedded app */ - public async trigger( + public async trigger( messageType: HostEventT, data: TriggerPayload = {} as any, - context: any = {}, - ): Promise> { + context?: ContextT, + ): Promise> { uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`); if (!this.isRendered) { @@ -1337,6 +1340,13 @@ export class TsEmbed { return this.render(); } + public async getCurrentContext(): Promise { + this.executeAfterEmbedContainerLoaded(async () => { + const context = await this.trigger(HostEvent.GetPageContext, {}); + return context; + }); + } + /** * Creates the preRender shell * @param showPreRenderByDefault - Show the preRender after render, hidden by default diff --git a/src/types.ts b/src/types.ts index 72f7e9ae..69e3bcf9 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4257,6 +4257,16 @@ export enum HostEvent { * ``` */ UpdateEmbedParams = 'updateEmbedParams', + + /** + * @hidden + * Triggers the get of the page context. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.GetPageContext); + * ``` + */ + GetPageContext = 'GetPageContext', } /** diff --git a/src/utils/processTrigger.ts b/src/utils/processTrigger.ts index 8f766279..d27b3acf 100644 --- a/src/utils/processTrigger.ts +++ b/src/utils/processTrigger.ts @@ -3,6 +3,7 @@ import { HostEvent, MessagePayload } from '../types'; import { logger } from '../utils/logger'; import { handlePresentEvent } from '../utils'; import { getEmbedConfig } from '../embed/embedConfig'; +import { ContextType } from 'src/embed/hostEventClient/contracts'; /** * Reloads the ThoughtSpot iframe. @@ -50,7 +51,7 @@ export function processTrigger( messageType: HostEvent, thoughtSpotHost: string, data: any, - context?: any, + context?: ContextType, ): Promise { return new Promise((res, rej) => { if (messageType === HostEvent.Reload) { diff --git a/visual-embed-sdk.d.ts b/visual-embed-sdk.d.ts new file mode 100644 index 00000000..0b16b91b --- /dev/null +++ b/visual-embed-sdk.d.ts @@ -0,0 +1,9631 @@ +// Generated by dts-bundle-generator v9.5.1 + +/** + * The list of customization css variables. These + * are the only allowed variables possible. + */ +export interface CustomCssVariables { + /** + * Background color of the Liveboard, visualization, Search, and Answer pages. + */ + "--ts-var-root-background"?: string; + /** + * Color of the text on application pages. + */ + "--ts-var-root-color"?: string; + /** + * Font type for the text on application pages. + */ + "--ts-var-root-font-family"?: string; + /** + * Text transformation specification for UI elements in the app. + */ + "--ts-var-root-text-transform"?: string; + /** + * 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), title text on the AI-generated charts and tables, and object titles on + * list pages such as *Liveboards* and *Answers*. + * The default color code is #2770EF. + * + */ + "--ts-var-application-color"?: string; + /** + * Background color of the top navigation panel. + */ + "--ts-var-nav-background"?: string; + /** + * Font color of the top navigation panel. + */ + "--ts-var-nav-color"?: string; + /** + * Background color of the *Search data* button. + */ + "--ts-var-search-data-button-background"?: string; + /** + * Color of the text on the *Search data* button. + */ + "--ts-var-search-data-button-font-color"?: string; + /** + * Font of the text on the *Search data* button. + */ + "--ts-var-search-data-button-font-family"?: string; + /** + * Font color of the text in the Search bar. + */ + "--ts-var-search-bar-text-font-color"?: string; + /** + * Font of the text in the Search bar. + */ + "--ts-var-search-bar-text-font-family"?: string; + /** + * Font style of the text in the Search bar. + */ + "--ts-var-search-bar-text-font-style"?: string; + /** + * Background color of the search bar. + */ + "--ts-var-search-bar-background"?: string; + /** + * Background color of the search suggestions panel. + */ + "--ts-var-search-auto-complete-background"?: string; + /** + * Background color of the navigation panel that allows you to undo, redo, and reset + * search operations. + */ + "--ts-var-search-navigation-button-background"?: string; + /** + * Background color of the navigation help text that appears at the bottom of the + * search suggestions panel. + */ + "--ts-var-search-bar-navigation-help-text-background"?: string; + /** + * Background color of the search suggestion block on hover. + */ + "--ts-var-search-bar-auto-complete-hover-background"?: string; + /** + * Font color of the text in the search suggestion panel. + */ + "--ts-var-search-auto-complete-font-color"?: string; + /** + * Font color of the sub-text that appears below the keyword in the search suggestion + * panel. + */ + "--ts-var-search-auto-complete-subtext-font-color"?: string; + /** + * Background color of the input box in the Spotter page. + */ + "--ts-var-spotter-input-background"?: string; + /** + * Background color of the previously asked prompt message in the Spotter page. + */ + "--ts-var-spotter-prompt-background"?: string; + /** + * Background color of the data panel. + */ + "--ts-var-answer-data-panel-background-color"?: string; + /** + * Background color of the vertical panel on the right side of the Answer page, which + * includes the options to edit charts and tables. + */ + "--ts-var-answer-edit-panel-background-color"?: string; + /** + * Background color of the chart switcher on search results and Answer pages. + */ + "--ts-var-answer-view-table-chart-switcher-background"?: string; + /** + * Background color of the currently selected chart type in the chart switcher. + */ + "--ts-var-answer-view-table-chart-switcher-active-background"?: string; + /** + * Border-radius of main buttons. + * For example, the *Search data* button in the top navigation panel. + */ + "--ts-var-button-border-radius"?: string; + /** + * Border-radius of small buttons such as secondary buttons. + * For example, share and favorite buttons. + */ + "--ts-var-button--icon-border-radius"?: string; + /** + * Font color of the text on primary buttons. For example, the primary buttons on + * Liveboard*, Answer, *Data* workspace, *SpotIQ*, or *Home* page. + */ + "--ts-var-button--primary-color"?: string; + /** + * Font family specification for the text on primary buttons. + */ + "--ts-var-button--primary--font-family"?: string; + /** + * Background color of the primary buttons. For example, the primary buttons such as + * Pin* and *Save*. + */ + "--ts-var-button--primary-background"?: string; + /** + * 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. + */ + "--ts-var-button--secondary-color"?: string; + /** + * Font family specification for the text on the secondary buttons. + */ + "--ts-var-button--secondary--font-family"?: string; + /** + * Background color of the secondary buttons. + */ + "--ts-var-button--secondary-background"?: string; + /** + * 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. + */ + "--ts-var-button--tertiary-color"?: string; + /** + * Background color of the tertiary button. + */ + "--ts-var-button--tertiary-background"?: string; + /** + * 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. + */ + "--ts-var-viz-title-color"?: string; + /** + * Font family specification for the title text of a visualization/Answer. + */ + "--ts-var-viz-title-font-family"?: string; + /** + * Text transformation specification for visualization and Answer titles. + */ + "--ts-var-viz-title-text-transform"?: string; + /** + * Font color of the description text and subtitle of a visualization or Answer. + */ + "--ts-var-viz-description-color"?: string; + /** + * Font family specification of description text and subtitle of a visualization or + * Answer. + */ + "--ts-var-viz-description-font-family"?: string; + /** + * Text transformation specification for description text and subtitle of a + * visualization or Answer. + */ + "--ts-var-viz-description-text-transform"?: string; + /** + * Border-radius for the visualization tiles and header panel on a Liveboard. + */ + "--ts-var-viz-border-radius"?: string; + /** + * Box shadow property for the visualization tiles and header panel on a Liveboard. + */ + "--ts-var-viz-box-shadow"?: string; + /** + * Background color of the visualization tiles and header panel on a Liveboard. + */ + "--ts-var-viz-background"?: string; + /** + * Background color of the legend on a visualization or Answer. + */ + "--ts-var-viz-legend-hover-background"?: string; + /** + * Background color of the selected chart type on the chart selection widget. + */ + "--ts-var-answer-chart-select-background"?: string; + /** + * Background color of the chart type element when a user hovers over a chart type on + * the chart selection widget. + */ + "--ts-var-answer-chart-hover-background"?: string; + /** + * Border-radius of filter chips. + */ + "--ts-var-chip-border-radius"?: string; + /** + * Shadow effect for filter chips. + */ + "--ts-var-chip-box-shadow"?: string; + /** + * Background color of filter chips. + */ + "--ts-var-chip-background"?: string; + /** + * Font color of the filter label when a filter chip is selected + */ + "--ts-var-chip--active-color"?: string; + /** + * Background color of the filter chips when selected. + */ + "--ts-var-chip--active-background"?: string; + /** + * Font color of the text on filter chips when hovered over. + */ + "--ts-var-chip--hover-color"?: string; + /** + * Background color of filter chips on hover. + */ + "--ts-var-chip--hover-background"?: string; + /** + * Font color of the text on filter chips. + */ + "--ts-var-chip-color"?: string; + /** + * Font family specification for the text on filter chips. + */ + "--ts-var-chip-title-font-family"?: string; + /** + * Font color of axis title on charts. + */ + "--ts-var-axis-title-color"?: string; + /** + * Font family specification for the X and Y axis title text. + */ + "--ts-var-axis-title-font-family"?: string; + /** + * Font color of the X and Y axis labels. + */ + "--ts-var-axis-data-label-color"?: string; + /** + * Font family specification for X and Y axis labels. + */ + "--ts-var-axis-data-label-font-family"?: string; + /** + * Font color of the menu items. + */ + "--ts-var-menu-color"?: string; + /** + * Background color of menu panels. + */ + "--ts-var-menu-background"?: string; + /** + * Font family specification for the menu items. + */ + "--ts-var-menu-font-family"?: string; + /** + * Text capitalization specification for the menu items. + */ + "--ts-var-menu-text-transform"?: string; + /** + * Background color for menu items on hover. + */ + "--ts-var-menu--hover-background"?: string; + /** + * Text color for selected menu items. + */ + "--ts-var-menu-selected-text-color"?: string; + /** + * Background color of the dialogs. + */ + "--ts-var-dialog-body-background"?: string; + /** + * Font color of the body text displayed on dialogs. + */ + "--ts-var-dialog-body-color"?: string; + /** + * Background color of the header text on dialogs. + */ + "--ts-var-dialog-header-background"?: string; + /** + * Font color of the header text on dialogs. + */ + "--ts-var-dialog-header-color"?: string; + /** + * Background color of the footer area on dialogs. + */ + "--ts-var-dialog-footer-background"?: string; + /** + * Background for selected state in list + */ + "--ts-var-list-selected-background"?: string; + /** + * Background for hover state in list + */ + "--ts-var-list-hover-background"?: string; + /** + * Background for hover state in segment control. + */ + "--ts-var-segment-control-hover-background"?: string; + /** + * Text color for slected item in modular home's watchlist. + */ + "--ts-var-home-watchlist-selected-text-color"?: string; + /** + * Text color for favorite carousel find your favorites card in modular home. + */ + "--ts-var-home-favorite-suggestion-card-text-color"?: string; + /** + * Icon color for favorite carousel find your favorites card in modular home. + */ + "--ts-var-home-favorite-suggestion-card-icon-color"?: string; + /** + * 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; + /** + * Height of the tiles in the Liveboard. + */ + "--ts-var-viz-tile-height"?: string; + /** + * Background color of the layout in the Liveboard. + */ + "--ts-var-liveboard-layout-background"?: string; + /** + * Font color of the title of the layout in the Liveboard. + */ + "--ts-var-liveboard-layout-title-color"?: string; + /** + * Font size of the title of the layout in the Liveboard. + */ + "--ts-var-liveboard-layout-title-fontsize"?: string; + /** + * Background color of the header in the Liveboard. + */ + "--ts-var-liveboard-header-background"?: string; + /** + * Font size of the header in the Liveboard. + */ + "--ts-var-liveboard-header-fontsize"?: string; + /** + * Font color of the header in the Liveboard. + */ + "--ts-var-liveboard-header-font-color"?: string; + /** + * Border color of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-border-color"?: string; + /** + * Background color of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-background"?: string; + /** + * Border radius of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-border-radius"?: string; + /** + * Padding of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-padding"?: string; + /** + * Background color of the table header in the Liveboard. + */ + "--ts-var-liveboard-tile-table-header-background"?: string; + /** + * Padding of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-padding"?: string; + /** + * Padding of the title of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-title-padding"?: string; + /** + * Font size of the title of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-title-font-size"?: string; + /** + * Font weight of the title of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-title-font-weight"?: string; + /** + * Font size of the title of the tiles inside the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-title-font-size"?: string; + /** + * Font weight of the title of the tiles inside the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-title-font-weight"?: string; + /** + * Font size of the description of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-description-font-size"?: string; + /** + * Font weight of the description of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-description-font-weight"?: string; + /** + * Border of the group tiles in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-border"?: string; + /** + * Padding of the group tiles in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-padding"?: string; + /** + * Padding of the answer viz in the Liveboard. + */ + "--ts-var-liveboard-answer-viz-padding"?: string; + /** + * Background color of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-background"?: string; + /** + * Border color of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-border-color"?: string; + /** + * Font color of the heading of the note title in the Liveboard. + */ + "--ts-var-liveboard-notetitle-heading-font-color"?: string; + /** + * Font color of the body of the note title in the Liveboard. + */ + "--ts-var-liveboard-notetitle-body-font-color"?: string; + /** + * Font color of the title of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-title-font-color"?: string; + /** + * Font color of the description of the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-description-font-color"?: string; + /** + * Font color of the title of the tiles inside the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-title-font-color"?: string; + /** + * Font color of the description of the tiles inside the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-description-font-color"?: string; + /** + * Background color of the tiles inside the groups in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-group-tile-background"?: string; + /** + * Background color of the filter chips in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-chip-background"?: string; + /** + * Font color of the filter chips in the Liveboard. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-chip-color"?: string; + /** + * Background color of the filter chips in the Liveboard on hover. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-chip--hover-background"?: string; + /** + * Background color of the filter chips in the Liveboard on active. + * + * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. + */ + "--ts-var-liveboard-chip--active-background"?: string; + /** + * Width of the side panel in the Liveboard. + */ + "--ts-var-side-panel-width"?: string; + /** + * Background color of the edit bar in the Liveboard. + */ + "--ts-var-liveboard-edit-bar-background"?: string; + /** + * Breakpoint for the dual column layout in the Liveboard. + */ + "--ts-var-liveboard-dual-column-breakpoint"?: string; + /** + * Breakpoint for the single column layout in the Liveboard. + */ + "--ts-var-liveboard-single-column-breakpoint"?: string; + /** + * Background color of the cross filter layout in the Liveboard. + */ + "--ts-var-liveboard-cross-filter-layout-background"?: string; + /** + * Border color of the active tab in the Liveboard. + */ + "--ts-var-liveboard-tab-active-border-color"?: string; + /** + * Font color of the hover tab in the Liveboard. + */ + "--ts-var-liveboard-tab-hover-color"?: string; + /** + * Font size of the title of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-title-fontsize"?: string; + /** + * Font weight of the title of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-title-fontweight"?: string; + /** + * Font weight of the description of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-description-font-weight"?: string; + /** + * Opacity of the description of the tiles in the Liveboard. + */ + "--ts-var-liveboard-tile-description-opacity"?: string; + /** + * Background color of the parameter chips in the Liveboard. + */ + "--ts-var-parameter-chip-background"?: string; + /** + * Font color of the parameter chips in the Liveboard. + */ + "--ts-var-parameter-chip-text-color"?: string; + /** + * Background color of the parameter chips in the Liveboard on hover. + */ + "--ts-var-parameter-chip-hover-background"?: string; + /** + * Font color of the parameter chips in the Liveboard on hover. + */ + "--ts-var-parameter-chip-hover-text-color"?: string; + /** + * Background color of the parameter chips in the Liveboard on active. + */ + "--ts-var-parameter-chip-active-background"?: string; + /** + * Font color of the parameter chips in the Liveboard on active. + */ + "--ts-var-parameter-chip-active-text-color"?: string; + /** + * Background color of the action button in the Liveboard header. + */ + "--ts-var-liveboard-header-action-button-background"?: string; + /** + * Font color of the action button in the Liveboard header. + */ + "--ts-var-liveboard-header-action-button-font-color"?: string; + /** + * Font color of the action button in the Liveboard header on hover. + */ + "--ts-var-liveboard-header-action-button-hover-color"?: string; + /** + * Font color of the action button in the Liveboard header on active. + */ + "--ts-var-liveboard-header-action-button-active-color"?: string; + /** + * Background color of the badge in the Liveboard header. + */ + "--ts-var-liveboard-header-badge-background"?: string; + /** + * Font color of the badge in the Liveboard header. + */ + "--ts-var-liveboard-header-badge-font-color"?: string; + /** + * Background color of the modified badge in the Liveboard header. + */ + "--ts-var-liveboard-header-badge-modified-background"?: string; + /** + * Font color of the modified badge in the Liveboard header. + */ + "--ts-var-liveboard-header-badge-modified-font-color"?: string; + /** + * Font color of the badge in the Liveboard header on hover. + */ + "--ts-var-liveboard-header-badge-hover-color"?: string; + /** + * Font color of the badge in the Liveboard header on active. + */ + "--ts-var-liveboard-header-badge-active-color"?: string; + /** + * Font color of the hero text in the KPI widget. + */ + "--ts-var-kpi-hero-color"?: string; + /** + * Font color of the comparison text in the KPI widget. + */ + "--ts-var-kpi-comparison-color"?: string; + /** + * Font color of the analyze text in the KPI widget. + */ + "--ts-var-kpi-analyze-text-color"?: string; + /** + * Font color of the legend title in the heatmap chart. + */ + "--ts-var-chart-heatmap-legend-title-color"?: string; + /** + * Font color of the legend label in the heatmap chart. + */ + "--ts-var-chart-heatmap-legend-label-color"?: string; + /** + * Font color of the legend title in the treemap chart. + */ + "--ts-var-chart-treemap-legend-title-color"?: string; + /** + * Font color of the legend label in the treemap chart. + */ + "--ts-var-chart-treemap-legend-label-color"?: string; + /** + * Color of the positive change in the KPI. + */ + "--ts-var-kpi-positive-change-color"?: string; + /** + * Color of the negative change in the KPI. + */ + "--ts-var-kpi-negative-change-color"?: string; + /** + * Background color of the change analysis insights. + */ + "--ts-var-change-analysis-insights-background"?: string; + /** + * Background color of the forecasting card in the SpotIQ analyze. + */ + "--ts-var-spotiq-analyze-forecasting-card-background"?: string; + /** + * Background color of the outlier card in the SpotIQ analyze. + */ + "--ts-var-spotiq-analyze-outlier-card-background"?: string; + /** + * Background color of the trend card in the SpotIQ analyze. + */ + "--ts-var-spotiq-analyze-trend-card-background"?: string; + /** + * Background color of the crosscorrelation card in the SpotIQ analyze. + */ + "--ts-var-spotiq-analyze-crosscorrelation-card-background"?: string; + /** + * Background color of the summary header in the CCA modal. + */ + "--ts-var-cca-modal-summary-header-background"?: string; +} +export interface SessionInterface { + sessionId: string; + genNo: number; + acSession: { + sessionId: string; + genNo: number; + }; +} +export interface UnderlyingDataPoint { + columnId: string; + dataValue: any; +} +/** + * AnswerService provides a simple way to work with ThoughtSpot Answers. + * + * This service allows you to interact with ThoughtSpot Answers programmatically, + * making it easy to customize visualizations, filter data, and extract insights + * directly from your application. + * + * You can use this service to: + * + * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`) + * - Apply filters to Answers (`addFilter`) + * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`) + * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`) + * - Run custom queries (`executeQuery`) + * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`) + * + * @example + * ```js + * // Get the answer service + * embed.on(EmbedEvent.Data, async (e) => { + * const service = await embed.getAnswerService(); + * + * // Add columns to the answer + * await service.addColumnsByName(["Sales", "Region"]); + * + * // Get the data + * const data = await service.fetchData(); + * console.log(data); + * }); + * ``` + * + * @example + * ```js + * // Get data for a point in a visualization + * embed.on(EmbedEvent.CustomAction, async (e) => { + * const underlying = await e.answerService.getUnderlyingDataForPoint([ + * 'Product Name', + * 'Sales Amount' + * ]); + * + * const data = await underlying.fetchData(0, 100); + * console.log(data); + * }); + * ``` + * + * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl + * @group Events + */ +export declare class AnswerService { + private session; + private thoughtSpotHost; + private selectedPoints?; + private answer; + private tmlOverride; + /** + * Should not need to be called directly. + * @param session + * @param answer + * @param thoughtSpotHost + * @param selectedPoints + */ + constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]); + /** + * Get the details about the source used in the answer. + * This can be used to get the list of all columns in the data source for example. + */ + getSourceDetail(): Promise; + /** + * Remove columnIds and return updated answer session. + * @param columnIds + * @returns + */ + removeColumns(columnIds: string[]): Promise; + /** + * Add columnIds and return updated answer session. + * @param columnIds + * @returns + */ + addColumns(columnIds: string[]): Promise; + /** + * Add columns by names and return updated answer session. + * @param columnNames + * @returns + * @example + * ```js + * embed.on(EmbedEvent.Data, async (e) => { + * const service = await embed.getAnswerService(); + * await service.addColumnsByName([ + * "col name 1", + * "col name 2" + * ]); + * console.log(await service.fetchData()); + * }); + */ + addColumnsByName(columnNames: string[]): Promise; + /** + * Add a filter to the answer. + * @param columnName + * @param operator + * @param values + * @returns + */ + addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter["values"]): Promise; + getSQLQuery(): Promise; + /** + * Fetch data from the answer. + * @param offset + * @param size + * @returns + */ + fetchData(offset?: number, size?: number): Promise<{ + columns: any; + data: any; + }>; + /** + * Fetch the data for the answer as a CSV blob. This might be + * quicker for larger data. + * @param userLocale + * @param includeInfo Include the CSV header in the output + * @returns Response + */ + fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise; + /** + * Fetch the data for the answer as a PNG blob. This might be + * quicker for larger data. + * @param userLocale + * @param includeInfo + * @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; + /** + * Just get the internal URL for this answer's data + * as a CSV blob. + * @param userLocale + * @param includeInfo + * @returns + */ + getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string; + /** + * Just get the internal URL for this answer's data + * as a PNG blob. + * @param userLocale + * @param omitBackground + * @param deviceScaleFactor + */ + 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 + * automatically passed. + * @param outputColumnNames + * @param selectedPoints + * @example + * ```js + * embed.on(EmbedEvent.CustomAction, e => { + * const underlying = await e.answerService.getUnderlyingDataForPoint([ + * 'col name 1' // The column should exist in the data source. + * ]); + * const data = await underlying.fetchData(0, 100); + * }) + * ``` + * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl + */ + getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise; + /** + * Execute a custom graphql query in the context of the answer. + * @param query graphql query + * @param variables graphql variables + * @returns + */ + executeQuery(query: string, variables: any): Promise; + /** + * Get the internal session details for the answer. + * @returns + */ + getSession(): SessionInterface; + getAnswer(): Promise; + getTML(): Promise; + addDisplayedVizToLiveboard(liveboardId: string): Promise; + setTMLOverride(override: any): void; +} +/** + * The authentication mechanism for allowing access to the + * the embedded app + * @group Authentication / Init + */ +export declare enum AuthType { + /** + * No authentication on the SDK. Pass-through to the embedded App. Alias for + * `Passthrough`. + * @example + * ```js + * init({ + * // ... + * authType: AuthType.None, + * }); + * ``` + */ + None = "None", + /** + * Passthrough SSO to the embedded application within the iframe. Requires least + * configuration, but may not be supported by all IDPs. This will behave like `None` + * if SSO is not configured on ThoughtSpot. + * + * 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({ + * // ... + * authType: AuthType.EmbeddedSSO, + * }); + * ``` + * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl + */ + EmbeddedSSO = "EmbeddedSSO", + /** + * SSO using SAML + * @deprecated Use {@link SAMLRedirect} instead + * @hidden + */ + SSO = "SSO_SAML", + /** + * SSO using SAML + * @deprecated Use {@link SAMLRedirect} instead + * @hidden + */ + SAML = "SSO_SAML", + /** + * SSO using SAML + * Makes the host application redirect to the SAML IdP. Use this + * if your IdP does not allow itself to be embedded. + * + * 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({ + * // ... + * authType: AuthType.SAMLRedirect, + * }); + * ``` + * + * This opens the SAML IdP in a popup window. The popup is triggered + * when the user clicks the trigger button. The popup window will be + * closed automatically after authentication. + * @example + * ```js + * init({ + * // ... + * authType: AuthType.SAMLRedirect, + * authTriggerText: 'Login with SAML', + * authTriggerContainer: '#tsEmbed', + * inPopup: true, + * }); + * ``` + * + * Can also use the event to trigger the popup flow. Works the same + * as the above example. + * @example + * ```js + * const authEE = init({ + * // ... + * authType: AuthType.SAMLRedirect, + * inPopup: true, + * }); + * + * someButtonOnYourPage.addEventListener('click', () => { + * authEE.emit(AuthEvent.TRIGGER_SSO_POPUP); + * }); + * ``` + */ + SAMLRedirect = "SSO_SAML", + /** + * SSO using OIDC + * @hidden + * @deprecated Use {@link OIDCRedirect} instead + */ + OIDC = "SSO_OIDC", + /** + * SSO using OIDC + * Will make the host application redirect to the OIDC IdP. + * See code samples in {@link SAMLRedirect}. + */ + OIDCRedirect = "SSO_OIDC", + /** + * Trusted authentication server + * @hidden + * @deprecated Use {@link TrustedAuth} instead + */ + AuthServer = "AuthServer", + /** + * Trusted authentication server. Use your own authentication server + * which returns a bearer token, generated using the `secret_key` obtained + * from ThoughtSpot. + * @example + * ```js + * init({ + * // ... + * authType: AuthType.TrustedAuthToken, + * getAuthToken: () => { + * return fetch('https://my-backend.app/ts-token') + * .then((response) => response.json()) + * .then((data) => data.token); + * } + * }); + * ``` + */ + TrustedAuthToken = "AuthServer", + /** + * Trusted authentication server Cookieless, Use your own authentication + * server which returns a bearer token, generated using the `secret_key` + * 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({ + * // ... + * authType: AuthType.TrustedAuthTokenCookieless, + * getAuthToken: () => { + * return fetch('https://my-backend.app/ts-token') + * .then((response) => response.json()) + * .then((data) => data.token); + * } + * ``` + * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw + */ + TrustedAuthTokenCookieless = "AuthServerCookieless", + /** + * Use the ThoughtSpot login API to authenticate to the cluster directly. + * + * Warning: This feature is primarily intended for developer testing. It is + * strongly advised not to use this authentication method in production. + */ + Basic = "Basic" +} +/** + * + * This option does not apply to the classic homepage experience. + * To access the updated modular homepage, + * set `modularHomeExperience` to `true` + * (available as Early Access feature in 9.12.5.cl). + * + */ +export declare enum HomeLeftNavItem { + /** + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl + */ + SearchData = "search-data", + /** + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl + */ + Home = "insights-home", + /** + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl + */ + Liveboards = "liveboards", + /** + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl + */ + Answers = "answers", + /** + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl + */ + MonitorSubscription = "monitor-alerts", + /** + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl + */ + SpotIQAnalysis = "spotiq-analysis", + /** + * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl + */ + LiveboardSchedules = "liveboard-schedules", + /** + * Create new options in the insights left navigation, + * available when new navigation V3 is enabled. + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + Create = "create", + /** + * Spotter option in the insights left navigation, + * available when new navigation V3 is enabled. + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + Spotter = "spotter", + /** + * Favorites option in the insights left navigation, + * available when new navigation V3 is enabled. + * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl + */ + Favorites = "favorites" +} +export type DOMSelector = string | HTMLElement; +/** + * inline customCSS within the {@link CustomisationsInterface}. + * Use {@link CustomCssVariables} or css rules. + */ +export interface customCssInterface { + /** + * The custom css variables, which can be set. + * The variables are available in the {@link CustomCssVariables} + * interface. For more information, see + * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference]. + */ + variables?: CustomCssVariables; + /** + * Can be used to define a custom font face + * like: + * @example + * ```js + * rules_UNSTABLE?: { + * "@font-face": { + * "font-family": "custom-font", + * "src": url("/path/") + * }; + * }; + * ``` + * + * Also, custom css rules outside of variables. + * @example + * ```js + * rules_UNSTABLE?: { + * ".thoughtspot_class_name": { + * "border-radius": "10px", + * margin: "20px" + * }; + * }; + * ``` + */ + rules_UNSTABLE?: { + [selector: string]: { + [declaration: string]: string; + }; + }; +} +/** + * Styles within the {@link CustomisationsInterface}. + */ +export interface CustomStyles { + customCSSUrl?: string; + customCSS?: customCssInterface; +} +/** + * Configuration to define the customization on the Embedded + * ThoughtSpot components. + * You can customize styles, text strings, and icons. + * For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework]. + * @example + * ```js + * init({ + * // ... + * customizations: { + * style: { + * customCSS: { + * variables: {}, + * rules_UNSTABLE: {} + * } + * }, + * content: { + * strings: { + * 'LIVEBOARDS': 'Dashboards', + * 'ANSWERS': 'Visualizations', + * 'Edit': 'Modify', + * 'Show underlying data': 'Show source data', + * 'SpotIQ': 'Insights', + * 'Monitor': 'Alerts', + * } + * }, + * iconSpriteUrl: 'https://my-custom-icon-sprite.svg' + * } + * }) + * ``` + */ +export interface CustomisationsInterface { + style?: CustomStyles; + content?: { + /** + * @version SDK: 1.26.0 | 9.7.0.cl + */ + strings?: Record; + stringIDs?: Record; + stringIDsUrl?: string; + [key: string]: any; + }; + iconSpriteUrl?: string; +} +/** + * The configuration object for embedding ThoughtSpot content. + * It includes the ThoughtSpot hostname or IP address, + * the type of authentication, and the authentication endpoint + * if a trusted authentication server is used. + * @group Authentication / Init + */ +export interface EmbedConfig { + /** + * The ThoughtSpot cluster hostname or IP address. + */ + thoughtSpotHost: string; + /** + * The authentication mechanism to use. + */ + authType: AuthType; + /** + * [AuthServer] The trusted authentication endpoint to use to get the + * authentication token. A `GET` request is made to the + * authentication API endpoint, which returns the token + * as a plaintext response. For trusted authentication, + * the `authEndpoint` or `getAuthToken` attribute is required. + */ + authEndpoint?: string; + /** + * [AuthServer] A function that invokes the trusted authentication endpoint + * and returns a Promise that resolves to the `auth token` string. + * For trusted authentication, the `authEndpoint` or `getAuthToken` + * attribute is required. + * + * It is advisable to fetch a new token inside this method and not + * reuse the old issued token. When auth expires this method is + * called again and if it is called with an older token, the authentication + * will not succeed. + */ + getAuthToken?: () => Promise; + /** + * [AuthServer / Basic] The user name of the ThoughtSpot user. This + * attribute is required for trusted authentication. + */ + username?: string; + /** + * [Basic] The ThoughtSpot login password corresponding to the username + * + * Warning: This feature is primarily intended for developer testing. It is + * strongly advised not to use this authentication method in production. + */ + password?: string; + /** + * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will + * open the SAML auth flow in a popup, instead of redirecting the browser in + * place. + * @default false + * @deprecated + */ + noRedirect?: boolean; + /** + * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open + * the SAML auth flow in a popup, instead of redirecting the browser in place. + * + * Need to use this with `authTriggerContainer`. Or manually trigger + * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction. + * @default false + * @version SDK: 1.18.0 + */ + inPopup?: boolean; + /** + * [SSO] For SSO Authentication, one can supply an optional path param; + * This will be the path on the host origin where the SAML flow will be + * terminated. + * + * Eg: "/dashboard", "#/foo" [Do not include the host] + * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw + */ + redirectPath?: string; + /** @internal */ + basepath?: string; + /** + * Boolean to define if the query parameters in the ThoughtSpot URL + * should be encoded in base64. This provides additional security to + * ThoughtSpot clusters against cross-site scripting attacks. + * @default false + */ + shouldEncodeUrlQueryParams?: boolean; + /** + * Suppress cookie access alert when third-party cookies are blocked by the + * user's browser. Third-party cookie blocking is the default behaviour on + * some web browsers like Safari. If you set this attribute to `true`, + * you are encouraged to handle `noCookieAccess` event, to show your own treatment + * in this case. + * @default false + */ + suppressNoCookieAccessAlert?: boolean; + /** + * Ignore the cookie access alert when third-party cookies are blocked by the + * user's browser. If you set this to `true`, the embedded iframe behaviour + * persists even in the case of a non-logged-in user. + * @default false + */ + ignoreNoCookieAccess?: boolean; + /** + * Re-login a user with the previous login options + * when a user session expires. + * @default false + */ + autoLogin?: boolean; + /** + * Disable redirection to the login page when the embedded session expires + * This flag is typically used alongside the combination of authentication modes such + * as {@link AuthType.AuthServer} and auto-login behavior {@link + * EmbedConfig.autoLogin} + * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + * @default false + */ + disableLoginRedirect?: boolean; + /** + * This message is displayed in the embedded view when a user login fails. + * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw + */ + loginFailedMessage?: string; + /** + * Calls the prefetch method internally when set to `true` + * @default false + */ + callPrefetch?: boolean; + /** + * When there are multiple objects embedded, queue the rendering of embedded objects + * to start after the previous embed's render is complete. This helps improve + * performance by decreasing the load on the browser. + * @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1 + * @default false + */ + queueMultiRenders?: boolean; + /** + * [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 + * `NO_COOKIE_ACCESS` event to handle the situation. + * + * This is slightly slower than letting the browser handle the cookie check, as it + * involves an extra network call. + * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw + */ + detectCookieAccessSlow?: boolean; + /** + * Hide the `beta` alert warning message for SearchEmbed. + * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw* + */ + suppressSearchEmbedBetaWarning?: boolean; + /** + * Hide `beta` alert warning message for SageEmbed. + * + */ + suppressSageEmbedBetaWarning?: boolean; + /** + * Custom style params for embed Config. + * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw + */ + customizations?: CustomisationsInterface; + /** + * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a + * button that the user can click to trigger the flow. + * This attribute sets a containing element for that button. + * @example + * ```js + * init({ + * authType: AuthType.SAMLRedirect, + * inPopup: true, + * authTriggerContainer: '#auth-trigger-container' + * }) + * ``` + * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw + */ + authTriggerContainer?: string | HTMLElement; + /** + * Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger + * SAML popup. This is useful when you want to trigger the popup on a custom user + * action. + * + */ + useEventForSAMLPopup?: boolean; + /** + * Text to show in the button which triggers the popup auth flow. + * Default: `Authorize`. + * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw + */ + authTriggerText?: string; + /** + * Prevent users from accessing the full application or ThoughtSpot application pages + * access to the embedded application users + * outside of the iframe. + * @default true + * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw + */ + blockNonEmbedFullAppAccess?: boolean; + /** + * Host config in case embedded app is inside TS app itself + * @hidden + */ + hostConfig?: { + hostUserGuid: string; + hostClusterId: string; + hostClusterName: string; + }; + /** + * Pendo API key to enable Pendo tracking to your own subscription, the key + * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document]. + * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl + */ + pendoTrackingKey?: string; + /** + * If passed as true all alerts will be suppressed in the embedded app. + * @version SDK: 1.26.2 | ThoughtSpot: * + */ + suppressErrorAlerts?: boolean; + /** + * Suppress or show specific types of logs in the console output. + * For example, `LogLevel.ERROR` shows only Visual Embed SDK and + * ThoughtSpot application errors and suppresses + * other logs such as warnings, information alerts, + * and debug messages in the console output. + * + * @default LogLevel.ERROR + * @example + * ```js + * init({ + * ...embedConfig, + * logLevel: LogLevel.SILENT + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl + */ + logLevel?: LogLevel; + /** + * Disables the Mixpanel tracking from the SDK. + * @version SDK: 1.27.9 + */ + disableSDKTracking?: boolean; + /** + * Overrides default/user preferred locale for date formatting + * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw + */ + dateFormatLocale?: string; + /** + * Overrides default/user preferred locale for number formatting + * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw + */ + numberFormatLocale?: string; + /** + * Format to be used for currency when currency format is set to infer from browser + * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw + */ + currencyFormat?: string; + /** + * This flag is used to disable the token verification in the SDK. + * Enabling this flag will also disable the caching of the token. + * @hidden + * @example + * ```js + * init({ + * ...embedConfig, + * disableTokenVerification : true + * }) + * ``` + * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw + */ + disableTokenVerification?: boolean; + /** + * This flag is used to disable showing the login failure page in the embedded app. + * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw + */ + disableLoginFailurePage?: boolean; + /** + * This is an object (key/val) of override flags which will be applied + * to the internal embedded object. This can be used to add any + * URL flag. + * Warning: This option is for advanced use only and is used internally + * to control embed behavior in non-regular ways. We do not publish the + * list of supported keys and values associated with each. + * @example + * ```js + * const embed = new LiveboardEmbed('#embed', { + * ... // other liveboard view config + * additionalFlags: { + * flag1: 'value1', + * flag2: 'value2' + * } + * }); + * ``` + * @version SDK: 1.33.5 | ThoughtSpot: * + */ + additionalFlags?: { + [key: string]: string | number | boolean; + }; + /** + * This is an object (key/val) for customVariables being + * used by the third party tool's script. + * @example + * ```js + * const embed = new LiveboardEmbed('#embed', { + * ... // other liveboard view config + * customVariablesForThirdPartyTools: { + * key1: 'value1', + * key2: 'value2' + * } + * }); + * ``` + * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl + */ + customVariablesForThirdPartyTools?: Record; + disablePreauthCache?: boolean; + /** + * Disable fullscreen presentation mode functionality. When enabled, prevents entering + * and exiting fullscreen mode for embedded visualizations during presentations. + * @default true (feature is disabled by default) + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * init({ + * ... // other embed config options + * disableFullscreenPresentation: false, // enables the feature + * }) + * ``` + */ + disableFullscreenPresentation?: boolean; + /** + * Custom Actions allows users to define interactive UI actions (like buttons or menu + * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These + * actions enable users to trigger custom workflows — such as navigating to an + * external app, calling an API, or opening a modal — based on the data context of + * what they clicked can be used to trigger custom logic when the action is clicked. + * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl + * @example + * ```js + * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk'; + * init({ + * ... // other embed config options + * customActions: [ + * { + * name: 'customAction', + * id: 'customAction', + * target: CustomActionTarget.VISUALIZATION, + * position: CustomActionPosition.PRIMARY, + * } + * } + * ] + * }) + * ``` + */ + customActions?: CustomAction[]; +} +export interface LayoutConfig { +} +/** + * Embedded iframe configuration + * @group Embed components + */ +export interface FrameParams { + /** + * The width of the iframe (unit is pixels if numeric). + */ + width?: number | string; + /** + * The height of the iframe (unit is pixels if numeric). + */ + height?: number | string; + /** + * Set to 'lazy' to enable lazy loading of the embedded TS frame. + * This will defer loading of the frame until it comes into the + * viewport. This is useful for performance optimization. + */ + loading?: "lazy" | "eager" | "auto"; + /** + * This parameters will be passed on the iframe + * as is. + */ + [key: string]: string | number | boolean | undefined; +} +/** + * The common configuration object for an embedded view. + */ +export interface BaseViewConfig { + /** + * @hidden + */ + layoutConfig?: LayoutConfig; + /** + * The width and height dimensions to render an embedded + * object inside your app. Specify the values in pixels or percentage. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1 + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * frameParams: { + * width: '500px' | '50%', + * height: '400px' | '60%', + * }, + * }) + * ``` + */ + frameParams?: FrameParams; + /** + * @hidden + */ + theme?: string; + /** + * @hidden + */ + styleSheet__unstable?: string; + /** + * The list of actions to disable from the primary menu, more menu + * (...), and the contextual menu. These actions will be disabled + * for the user. + * Use this to disable actions. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * disabledActions: [Action.Download, Action.Save], + * }); + * ``` + */ + disabledActions?: Action[]; + /** + * The tooltip to display for disabled actions. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * disabledActions: [Action.Download, Action.Save], + * disabledActionReason: "Reason for disabling", + * }); + * ``` + */ + disabledActionReason?: string; + /** + * The list of actions to hide from the embedded. + * This actions will be hidden from the user. + * Use this to hide an action. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * hiddenActions: [Action.Download, Action.Export], + * }); + * ``` + * @important + */ + hiddenActions?: Action[]; + /** + * The list of actions to display from the primary menu, more menu + * (...), and the contextual menu. These will be only actions that + * are visible to the user. + * Use this to hide all actions except the ones you want to show. + * + * Use either this or hiddenActions. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw + * @important + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * visibleActions: [Action.Download, Action.Export], + * }); + * ``` + */ + visibleActions?: Action[]; + /** + * The locale settings to apply to the embedded view. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * locale:'en', + * }) + * ``` + */ + locale?: string; + /** + * This is an object (key/val) of override flags which will be applied + * to the internal embedded object. This can be used to add any + * URL flag. + * If the same flags are passed in init, they will be overriden by the values here. + * Warning: This option is for advanced use only and is used internally + * to control embed behavior in non-regular ways. We do not publish the + * list of supported keys and values associated with each. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * additionalFlags: { + * flag1: 'value1', + * flag2: 'value2' + * }, + * }); + * ``` + * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + */ + additionalFlags?: { + [key: string]: string | number | boolean; + }; + /** + * Dynamic CSSUrl and customCSS to be injected in the loaded application. + * You would also need to set `style-src` in the CSP settings. + * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl + * @default '' + */ + customizations?: CustomisationsInterface; + /** + * Insert as a sibling of the target container, instead of appending to a + * child inside it. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * insertAsSibling:true, + * }) + * ``` + */ + insertAsSibling?: boolean; + /** + * Use a pre-rendered iframe from a pool of pre-rendered iframes + * if available and matches the configuration. + * @version SDK: 1.22.0 + * @hidden + * + * See [docs]() on how to create a prerender pool. + */ + usePrerenderedIfAvailable?: boolean; + /** + * PreRender id to be used for PreRendering the embed. + * Use PreRender to render the embed in the background and then + * show or hide the rendered embed using showPreRender or hidePreRender respectively. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * preRenderId: "preRenderId-123", + * }); + * embed.showPreRender(); + * ``` + * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw + */ + preRenderId?: string; + /** + * Determines if the PreRender component should dynamically track the size + * of its embedding element and adjust its own size accordingly. + * Enabling this option allows the PreRender component to automatically adapt + * its dimensions based on changes to the size of the embedding element. + * @type {boolean} + * @default false + * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw + * @example + * ```js + * // Disable tracking PreRender size in the configuration + * const config = { + * doNotTrackPreRenderSize: true, + * }; + * + * // Instantiate an object with the configuration + * const myComponent = new MyComponent(config); + * ``` + */ + doNotTrackPreRenderSize?: boolean; + /** + * Enable the V2 shell. This can provide performance benefits + * due to a lighterweight shell. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * enableV2Shell_experimental: true, + * }); + * ``` + * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl + */ + enableV2Shell_experimental?: boolean; + /** + * For internal tracking of the embed component type. + * @hidden + */ + embedComponentType?: string; + /** + * This flag can be used to expose translation IDs on the embedded app. + * @default false + * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl + */ + exposeTranslationIDs?: boolean; + /** + * This flag can be used to disable links inside the embedded app, + * and disable redirection of links in a new tab. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * disableRedirectionLinksInNewTab: true, + * }); + * ``` + * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl + */ + disableRedirectionLinksInNewTab?: boolean; + /** + * Overrides an Org context for embedding application users. + * This parameter allows a user authenticated to one Org to view the + * objects from another Org. + * The `overrideOrgId` setting is honoured only if the + * Per Org URL feature is enabled on your ThoughtSpot instance. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * overrideOrgId: 142536, + * }); + * ``` + * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl + */ + overrideOrgId?: number; + /** + * Flag to override the *Open Link in New Tab* context menu option. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * linkOverride:false, + * }) + * ``` + */ + linkOverride?: boolean; + /** + * The primary action to display on top of the viz for Liveboard and App Embed. + * Use this to set the primary action. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * primaryAction: Action.Download + * }); + * ``` + */ + primaryAction?: Action | string; + /** + * flag to enable insert into slides action + * @hidden + * @private + */ + insertInToSlide?: boolean; + /** + * Show alert messages and toast messages in the embed. + * Supported embed in all embed types. + * + * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * showAlerts:true, + * }) + * ``` + */ + showAlerts?: boolean; + /** + * Custom Actions allows users to define interactive UI actions (like buttons or menu + * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These + * actions enable users to trigger custom workflows — such as navigating to an + * external app, calling an API, or opening a modal — based on the data context of + * what they clicked can be used to trigger custom logic when the action is clicked. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed` + * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl + * @example + * ```js + * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk'; + * // Use supported embed types such as AppEmbed or LiveboardEmbed + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... // other embed config options + * customActions: [ + * { + * name: 'customAction', + * id: 'customAction', + * target: CustomActionTarget.VISUALIZATION, + * position: CustomActionPosition.PRIMARY, + * } + * } + * ] + * }) + * ``` + */ + customActions?: CustomAction[]; +} +/** + * The configuration object for Home page embeds configs. + */ +export interface HomePageConfig { + /** + * Hide list page columns + * For example: hiddenListColumns = [ListPageColumns.Author] + * + * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum. + * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl + * @example + * ```js + * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk'; + * + * const embed = new AppEmbed('#tsEmbed', { + * ... //other embed view config + * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author], + * }) + * ``` + */ + hiddenListColumns?: ListPageColumns[]; + /** + * Hide the home page modules + * For example: hiddenHomepageModules = [HomepageModule.MyLibrary] + * + * **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). + * To use it, you need to import `HomepageModule` enum. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw + * @example + * ```js + * import { HomepageModule } from '@thoughtspot/visual-embed-sdk'; + * + * const embed = new AppEmbed('#tsEmbed', { + * ... //other embed view config + * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning], + * }) + * ``` + */ + hiddenHomepageModules?: HomepageModule[]; + /** + * reordering the home page modules + * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist] + * + * **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). + * To use it, you need to import `HomepageModule` enum. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw + * @example + * ```js + * import { HomepageModule } from '@thoughtspot/visual-embed-sdk'; + * + * const embed = new AppEmbed('#tsEmbed', { + * ... //other embed view config + * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary], + * }) + * ``` + */ + reorderedHomepageModules?: HomepageModule[]; + /** + * homepageLeftNavItems : Show or hide the left navigation bar items. + * There are 8 eight home navigation list items. + * To hide these items, specify the string in the array. + * + * Supported embed types: `AppEmbed` + * @example + * ```js + * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk'; + * + * const embed = new AppEmbed('#tsEmbed', { + * ... //other embed view config + * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers], + * }) + * ``` + * + * **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). + * To use it, you need to import `HomeLeftNavItem` enum. + * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw + */ + hiddenHomeLeftNavItems?: HomeLeftNavItem[]; +} +/** + * The configuration object for common Search and Liveboard embeds configs. + */ +export interface SearchLiveboardCommonViewConfig { + /** + * The list of runtime filters to apply to a search Answer, + * visualization, or Liveboard. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed` + * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * runtimeFilters: [ + * { + * columnName: 'value', + * operator: RuntimeFilterOp.EQ, + * values: ['string' | 123 | true], + * }, + * ], + * }) + * ``` + */ + runtimeFilters?: RuntimeFilter[]; + /** + * The list of parameter override to apply to a search Answer, + * visualization, or Liveboard. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed` + * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * runtimeParameters: [ + * { + * name: 'value', + * value: 'string' | 123 | true, + * }, + * ] + * }) + * ``` + */ + runtimeParameters?: RuntimeParameter[]; + /** + * flag to set ContextMenu Trigger to either left or right click. + * + * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK, + * }) + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl + */ + contextMenuTrigger?: ContextMenuTriggerOptions; + /** + * Boolean to exclude runtimeFilters in the URL + * By default it is true, this flag removes runtime filters from the URL + * when set to false, runtime filters will be included in the URL. + * + * Irrespective of this flag, runtime filters ( if passed ) will be applied to the + * embedded view. + * @default false + * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl + */ + excludeRuntimeFiltersfromURL?: boolean; + /** + * Boolean to exclude runtimeParameters from the URL + * when set to true, this flag removes runtime parameters from the URL. + * + * Irrespective of this flag, runtime filters ( if passed ) will be applied to the + * embedded view. + * @default false + * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl + */ + excludeRuntimeParametersfromURL?: boolean; + /** + * To set the initial state of the search bar in case of saved Answers. + * + * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed` + * @default true + * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl + * @example + * ```js + * // Replace with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * collapseSearchBar: true, + * }); + */ + collapseSearchBar?: boolean; + /** + * Flag to control Data panel experience + * + * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed` + * @default true + * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl + * @example + * ```js + * // Replace with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * dataPanelV2: true, + * }) + * ``` + */ + dataPanelV2?: boolean; + /** + * To enable custom column groups in data panel v2 + * + * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw + * @default false + * @example + * ```js + * // Replace with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * enableCustomColumnGroups: true, + * }); + * ``` + */ + enableCustomColumnGroups?: boolean; +} +/** + * The configuration object for common Liveboard and App embeds configs. + */ +export interface LiveboardAppEmbedViewConfig { + /** + * Show or hide Liveboard header + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl + * @default false + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * hideLiveboardHeader : true, + * }) + * ``` + */ + hideLiveboardHeader?: boolean; + /** + * Show or hide Liveboard title + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl + * @default false + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * showLiveboardTitle:true, + * }) + * ``` + */ + showLiveboardTitle?: boolean; + /** + * Show or hide Liveboard description + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl + * @default false + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * showLiveboardDescription:true, + * }) + * ``` + */ + showLiveboardDescription?: boolean; + /** + * Boolean to control if Liveboard header is sticky or not. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#embed', { + * ... // other app view config + * isLiveboardHeaderSticky: true, + * }); + * ``` + * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl + */ + isLiveboardHeaderSticky?: boolean; + /** + * This attribute can be used to enable the two-column layout on an embedded Liveboard + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @type {boolean} + * @default false + * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * enable2ColumnLayout: true, + * }) + * ``` + */ + enable2ColumnLayout?: boolean; + /** + * This flag can be used to enable the compact header in Liveboard + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @type {boolean} + * @default false + * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * isLiveboardCompactHeaderEnabled: true, + * }) + * ``` + */ + isLiveboardCompactHeaderEnabled?: boolean; + /** + * This flag can be used to show or hide the Liveboard verified icon in the compact + * header. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl + * @default true + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * showLiveboardVerifiedBadge: true, + * }) + * ``` + */ + showLiveboardVerifiedBadge?: boolean; + /** + * This flag is used to enable/disable hide irrelevant filters in Liveboard tab + * + * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl + * @default false + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * hideIrrelevantChipsInLiveboardTabs: true, + * isLiveboardCompactHeaderEnabled: true, + * }) + * ``` + */ + hideIrrelevantChipsInLiveboardTabs?: boolean; + /** + * This flag can be used to show or hide the re-verify banner on the Liveboard + * compact header + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl + * @default true + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * showLiveboardReverifyBanner: true, + * }) + * ``` + */ + showLiveboardReverifyBanner?: boolean; + /** + * enable or disable ask sage + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl + * @default false + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * enableAskSage:true, + * }) + * ``` + */ + enableAskSage?: boolean; + /** + * This flag is used to show or hide checkboxes for including or excluding + * the cover and filters pages in the Liveboard PDF. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * coverAndFilterOptionInPDF: false, + * }) + * ``` + */ + coverAndFilterOptionInPDF?: boolean; + /** + * This flag is used to enable or disable the XLSX/CSV download option for Liveboards. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * liveboardXLSXCSVDownload: true, + * }) + * ``` + */ + liveboardXLSXCSVDownload?: boolean; + /** + * This flag is used to enable or disable the link parameters in liveboard. + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * isLinkParametersEnabled: true, + * }) + * ``` + */ + isLinkParametersEnabled?: boolean; +} +export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { +} +/** + * MessagePayload: Embed event payload: message type, data and status (start/end) + * @group Events + */ +export type MessagePayload = { + type: string; + data: any; + status?: string; +}; +/** + * MessageOptions: By providing options, getting specific event start / end based on + * option + * @group Events + */ +export type MessageOptions = { + /** + * A boolean value indicating that start status events of this type + * will be dispatched. + */ + start?: boolean; +}; +/** + * MessageCallback: Embed event message callback + * @group Events + */ +export type MessageCallback = (payload: MessagePayload, +/** + * responder: Message callback function triggered when embed event + * initiated + */ +responder?: (data: any) => void) => void; +/** + * A map of the supported runtime filter operations + */ +export declare enum RuntimeFilterOp { + /** + * Equals + */ + EQ = "EQ", + /** + * Does not equal + */ + NE = "NE", + /** + * Less than + */ + LT = "LT", + /** + * Less than or equal to + */ + LE = "LE", + /** + * Greater than + */ + GT = "GT", + /** + * Greater than or equal to + */ + GE = "GE", + /** + * Contains + */ + CONTAINS = "CONTAINS", + /** + * Begins with + */ + BEGINS_WITH = "BEGINS_WITH", + /** + * Ends with + */ + ENDS_WITH = "ENDS_WITH", + /** + * Between, inclusive of higher value + */ + BW_INC_MAX = "BW_INC_MAX", + /** + * Between, inclusive of lower value + */ + BW_INC_MIN = "BW_INC_MIN", + /** + * Between, inclusive of both higher and lower value + */ + BW_INC = "BW_INC", + /** + * Between, non-inclusive + */ + BW = "BW", + /** + * Is included in this list of values + */ + IN = "IN", + /** + * Is not included in this list of values + */ + NOT_IN = "NOT_IN" +} +/** + * 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, 10.1.0.sw + */ +export declare enum HomepageModule { + /** + * Search bar + */ + Search = "SEARCH", + /** + * kPI watchlist module + */ + Watchlist = "WATCHLIST", + /** + * favorite objects + */ + Favorite = "FAVORITE", + /** + * List of answers and Liveboards + */ + MyLibrary = "MY_LIBRARY", + /** + * Trending list + */ + Trending = "TRENDING", + /** + * Learning videos + */ + Learning = "LEARNING" +} +/** + * List page columns that can be hidden. + * **Note**: This option is applicable to full app embedding only. + * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl + */ +export declare enum ListPageColumns { + /** + * Favourite + */ + Favourite = "FAVOURITE", + /** + * Tags + */ + Tags = "TAGS", + /** + * Author + */ + Author = "AUTHOR", + /** + * Last viewed/Last modified + */ + DateSort = "DATE_SORT", + /** + * Share + */ + Share = "SHARE" +} +/** + * A filter that can be applied to ThoughtSpot answers, Liveboards, or + * visualizations at runtime. + */ +export interface RuntimeFilter { + /** + * The name of the column to filter on (case-sensitive) + */ + columnName: string; + /** + * The operator to apply + */ + operator: RuntimeFilterOp; + /** + * The list of operands. Some operators like EQ, LE accept + * a single operand, whereas other operators like BW and IN accept multiple + * operands. + */ + values: (number | boolean | string | bigint)[]; +} +/** + * A filter that can be applied to ThoughtSpot Answers, Liveboards, or + * visualizations at runtime. + */ +export interface RuntimeParameter { + /** + * The name of the runtime parameter to filter on (case-sensitive) + */ + name: string; + /** + * Values + */ + value: number | boolean | string; +} +/** + * Event types emitted by the embedded ThoughtSpot application. + * + * 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'; + * // Or + * // const { EmbedEvent } = window.tsembed; + * + * // create the liveboard embed. + * + * liveboardEmbed.on(EmbedEvent.Drilldown, (drilldown) => { + * 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` convention. + * For example,`onAlert`, `onCopyToClipboard` and so on. + * @example + * ```js + * // ... + * const MyComponent = ({ dataSources }) => { + * const onLoad = () => { + * console.log(EmbedEvent.Load, {}); + * }; + * + * return ( + * + * ); + * }; + * ``` + * @group Events + */ +export declare enum EmbedEvent { + /** + * Rendering has initialized. + * @example + *```js + * liveboardEmbed.on(EmbedEvent.Init, showLoader) + * //show a loader + * function showLoader() { + * document.getElementById("loader"); + * } + *``` + * @returns timestamp - The timestamp when the event was generated. + */ + 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 => { + * console.log('AuthInit', payload); + * }) + *``` + * @returns isLoggedIn - A Boolean specifying whether authentication was successful. + */ + 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 + * liveboardEmbed.on(EmbedEvent.Load, hideLoader) + * //hide loader + * function hideLoader() { + * document.getElementById("loader"); + * } + *``` + */ + Load = "load", + /** + * Data pertaining to an Answer, Liveboard or Spotter visualization is received. + * The event payload includes the raw data of the object. + * @return data - Answer of Liveboard data + * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw + * @example + *```js + * liveboardEmbed.on(EmbedEvent.Data, payload => { + * console.log('data', payload); + * }) + *``` + * @important + */ + Data = "data", + /** + * Search query has been updated by the user. + * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw + * @example + *```js + * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload)) + *``` + */ + 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 + * @example + *```js + * searchEmbed.on(EmbedEvent.DrillDown, { + * points: { + * clickedPoint, + * selectedPoints: selectedPoint + * }, + * autoDrillDown: true, + * }) + *``` + * In this example, `VizPointDoubleClick` event is used for + * triggering the `DrillDown` event when an area or specific + * data point on a table or chart is double-clicked. + * @example + *```js + * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => { + * console.log(payload); + * const clickedPoint = payload.data.clickedPoint; + * const selectedPoint = payload.data.selectedPoints; + * console.log('>>> called', clickedPoint); + * embed.trigger(HostEvent.DrillDown, { + * points: { + * clickedPoint, + * selectedPoints: selectedPoint + * }, + * autoDrillDown: true, + * }) + * }) + *``` + */ + 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 + * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => { + * console.log('DataSourceSelected', payload); + * }) + * ``` + */ + 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 + * ```js + * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => { + * console.log('AddRemoveColumns', payload); + * }) + * ``` + */ + 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 + * appEmbed.on(EmbedEvent.customAction, payload => { + * const data = payload.data; + * if (data.id === 'insert Custom Action ID here') { + * console.log('Custom Action event:', data.embedAnswerData); + * } + * }) + * ``` + */ + 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 + * ```js + * LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => { + * console.log('VizPointDoubleClick', payload); + * }) + * ``` + */ + 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 + * @example + * ```js + * embed.on(EmbedEvent.VizPointClick, ({data}) => { + * console.log( + * data.vizId, // viz id + * data.clickedPoint.selectedAttributes[0].value, + * data.clickedPoint.selectedAttributes[0].column.name, + * data.clickedPoint.selectedMeasures[0].value, + * data.clickedPoint.selectedMeasures[0].column.name, + * ) + * }); + * ``` + */ + VizPointClick = "vizPointClick", + /** + * An error has occurred. This event is fired for the following error types: + * + * `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. + * + * 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 + * // API error + * SearchEmbed.on(EmbedEvent.Error, (error) => { + * console.log(error); + * // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } } + * }); + * ``` + * @example + * ```js + * // Fullscreen error (Errors during presenting of a liveboard) + * LiveboardEmbed.on(EmbedEvent.Error, (error) => { + * console.log(error); + * // { type: "Error", data: { errorType: "FULLSCREEN", error: { + * // message: "Fullscreen API is not enabled", + * // stack: "..." + * // } }} + * }) + * ``` + */ + 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) + * ``` + */ + Alert = "alert", + /** + * The ThoughtSpot authentication session has expired. + * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw + * @example + *```js + * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired) + * //show auth expired banner + * function showAuthExpired() { + * document.getElementById("authExpiredBanner"); + * } + *``` + */ + AuthExpire = "ThoughtspotAuthExpired", + /** + * ThoughtSpot failed to validate the auth session. + * @hidden + */ + AuthFailure = "ThoughtspotAuthFailure", + /** + * ThoughtSpot failed to re validate the auth session. + * @hidden + */ + IdleSessionTimeout = "IdleSessionTimeout", + /** + * ThoughtSpot failed to validate the auth session. + * @hidden + */ + AuthLogout = "ThoughtspotAuthLogout", + /** + * The height of the embedded Liveboard or visualization has been computed. + * @returns data - The height of the embedded Liveboard or visualization + * @hidden + */ + EmbedHeight = "EMBED_HEIGHT", + /** + * The center of visible iframe viewport is calculated. + * @returns data - The center of the visible Iframe viewport. + * @hidden + */ + EmbedIframeCenter = "EmbedIframeCenter", + /** + * 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 + * searchbarEmbed.on(EmbedEvent.GetDataClick) + * .then(data => { + * console.log('Answer Data:', data); + * }) + *``` + */ + GetDataClick = "getDataClick", + /** + * Detects the route change. + * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw + * @example + *```js + * searchEmbed.on(EmbedEvent.RouteChange, payload => + * console.log('data', payload)) + *``` + */ + RouteChange = "ROUTE_CHANGE", + /** + * The v1 event type for Data + * @hidden + */ + 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. `NoCookieAccess` can trigger. + * @example + *```js + * appEmbed.on(EmbedEvent.NoCookieAccess) + *``` + * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw + */ + NoCookieAccess = "noCookieAccess", + /** + * Emitted when SAML is complete + * @private + * @hidden + */ + 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 + * appEmbed.on(EmbedEvent.DialogOpen, payload => { + * console.log('dialog open', payload); + * }) + *``` + */ + 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 + * appEmbed.on(EmbedEvent.DialogClose, payload => { + * console.log('dialog close', payload); + * }) + *``` + */ + DialogClose = "dialog-close", + /** + * Emitted when the Liveboard shell loads. + * You can use this event as a hook to trigger + * other events on the rendered Liveboard. + * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + * @example + *```js + * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => { + console.log('Liveboard is rendered', payload); + }) + *``` + * The following example shows how to trigger + * `SetVisibleVizs` event using LiveboardRendered embed event: + * @example + *```js + * const embedRef = useEmbedRef(); + * const onLiveboardRendered = () => { + * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']); + * }; + *``` + */ + LiveboardRendered = "PinboardRendered", + /** + * Emits all events. + * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw + * @example + *```js + * appEmbed.on(EmbedEvent.ALL, payload => { + * console.log('Embed Events', payload) + * }) + *``` + */ + 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 + * //Emit when action starts + * searchEmbed.on(EmbedEvent.Save, payload => { + * console.log('Save', payload) + * }, { + * start: true + * }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.Save, payload => { + * console.log('Save', payload) + * }) + *``` + */ + Save = "save", + /** + * Emitted when the download action is triggered on an Answer. + * + * **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 + * liveboardEmbed.on(EmbedEvent.Download, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c' + * }) + *``` + */ + 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 + * //emit when action starts + * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => { + * console.log('download PNG', payload)}, {start: true }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => { + * console.log('download PNG', payload)}) + *``` + */ + 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 + * //emit when action starts + * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => { + * console.log('download PDF', payload)}, {start: true }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => { + * console.log('download PDF', payload)}) + *``` + */ + 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 + * //emit when action starts + * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => { + * console.log('download CSV', payload)}, {start: true }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => { + * console.log('download CSV', payload)}) + *``` + */ + 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 + * //emit when action starts + * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => { + * console.log('download Xlsx', payload)}, { start: true }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => { + * console.log('download Xlsx', payload)}) + *``` + */ + 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 }) + * //trigger when action is completed + * appEmbed.on(EmbedEvent.AnswerDelete, payload => { + * console.log('delete answer', payload)}) + *``` + */ + AnswerDelete = "answerDelete", + /** + * Emitted when a user initiates the Pin action to + * add an Answer to a Liveboard. + * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw + * @example + *```js + * //emit when action starts + * searchEmbed.on(EmbedEvent.Pin, payload => { + * console.log('pin', payload) + * }, { + * start: true + * }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.Pin, payload => { + * console.log('pin', payload) + * }) + *``` + */ + Pin = "pin", + /** + * Emitted when SpotIQ analysis is triggered + * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw + * @example + *```js + * //emit when action starts + * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => { + * console.log('SpotIQAnalyze', payload) + * }, { + * start: true + * }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => { + * console.log('SpotIQ analyze', payload) + * }) + *``` + */ + 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 + * //emit when action starts + * searchEmbed.on(EmbedEvent.Share, payload => { + * console.log('Share', payload) + * }, { + * start: true + * }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.Share, payload => { + * console.log('Share', payload) + * }) + *``` + */ + Share = "share", + /** + * 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 + * appEmbed.on(EmbedEvent.DrillInclude, payload => { + * console.log('Drill include', payload); + * }) + *``` + */ + DrillInclude = "context-menu-item-include", + /** + * 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 + * appEmbed.on(EmbedEvent.DrillExclude, payload => { + * console.log('Drill exclude', payload); + * }) + *``` + */ + 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 + * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => { + * console.log('copy to clipboard', payload); + * }) + *``` + */ + CopyToClipboard = "context-menu-item-copy-to-clipboard", + /** + * 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 + * liveboardEmbed.on(EmbedEvent.UpdateTML) + * }) + *``` + */ + 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 + * appEmbed.on(EmbedEvent.EditTML, payload => { + * console.log('Edit TML', payload); + * }) + *``` + */ + EditTML = "editTSL", + /** + * 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 + * //emit when action starts + * searchEmbed.on(EmbedEvent.ExportTML, payload => { + * console.log('Export TML', payload)}, { start: true }) + * //emit when action ends + * searchEmbed.on(EmbedEvent.ExportTML, payload => { + * console.log('Export TML', payload)}) + *``` + */ + 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 + * appEmbed.on(EmbedEvent.SaveAsView, payload => { + * console.log('View', payload); + * }) + *``` + */ + 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 + * //emit when action starts + * appEmbed.on(EmbedEvent.CopyAEdit, payload => { + * console.log('Copy and edit', payload)}, {start: true }) + * //emit when action ends + * appEmbed.on(EmbedEvent.CopyAEdit, payload => { + * console.log('Copy and edit', payload)}) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => { + * console.log('show data', payload); + * }) + *``` + */ + 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 + * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => { + * console.log('switch view', payload); + * }) + *``` + */ + AnswerChartSwitcher = "answerChartSwitcher", + /** + * Internal event to communicate the initial settings back to the ThoughtSpot app + * @hidden + */ + APP_INIT = "appInit", + /** + * Internal event to clear the cached info + * @hidden + */ + CLEAR_INFO_CACHE = "clearInfoCache", + /** + * 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 + * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => { + * console.log('Liveboard details', payload); + * }) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => { + * console.log('favorites', payload); + * }) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.Schedule, payload => { + * console.log(`Liveboard schedule', payload); + * }) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.Edit, payload => { + * console.log(`Liveboard edit', payload); + * }) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => { + * console.log(`Copy', payload); + * }) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.Present) + *``` + * @example + *```js + * liveboardEmbed.on(EmbedEvent.Present, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + * }) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.Delete, + * {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.SchedulesList) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.Cancel) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.Explore, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + *``` + */ + 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 + * liveboardEmbed.on(EmbedEvent.CopyLink, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + *``` + */ + 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, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + *``` + */ + 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 + * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => { + * console.log('VizPointClick', payload) + * }) + *``` + */ + VizPointRightClick = "vizPointRightClick", + /** + * Emitted when a user clicks **Insert to slide** on a visualization + * @hidden + */ + InsertIntoSlide = "insertInToSlide", + /** + * 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 + * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => { + * console.log('payload', payload); + * }) + * + * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw + */ + FilterChanged = "filterChanged", + /** + * Emitted when a user clicks the **Go** button to initiate + * a Natural Language Search query + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + SageEmbedQuery = "sageEmbedQuery", + /** + * Emitted when a user selects a data source on the embedded + * Natural Language Search interface. + * + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + 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 + */ + 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 + */ + 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 + * @returns isPublic: boolean + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + UpdatePersonalisedView = "updatePersonalisedView", + /** + * Emitted when a Personalised view is saved. + * @returns viewName: string + * @returns viewId: string + * @returns liveboardId: string + * @returns isPublic: boolean + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + SavePersonalisedView = "savePersonalisedView", + /** + * Emitted when a Liveboard is reset. + * @returns viewName: string + * @returns viewId: string + * @returns liveboardId: string + * @returns isPublic: boolean + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + 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 + */ + DeletePersonalisedView = "deletePersonalisedView", + /** + * Emitted when a user creates a Worksheet. + * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + */ + CreateWorksheet = "createWorksheet", + /** + * Emitted when the *Ask Sage* is initialized. + * @returns viewName: string + * @returns viewId: string + * @returns liveboardId: string + * @returns isPublic: boolean + * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl + */ + AskSageInit = "AskSageInit", + /** + * Emitted when a Liveboard or visualization is renamed. + * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw + */ + Rename = "rename", + /** + * + * This event can be emitted to intercept search execution initiated by + * the users and implement the logic to allow or restrict search execution. + * You can can also show custom error text if the search query must be + * restricted due to your application or business requirements. + + * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true` + * for this embed event to get emitted. + * @param: payload + * @param: responder + * Contains elements that lets developers define whether ThoughtSpot + * should run the search, and if not, what error message + * should be shown to the user. + * + * 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 error message text when `execute` + * returns `false` using the error parameter in responder. + * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl + * @example + *```js + * .on(EmbedEvent.OnBeforeGetVizDataIntercept, + * (payload, responder) => { + * responder({ + * data: { + * 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." + * } + * }}) + * }) + *``` + */ + OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept", + /** + * Emitted when parameter changes in an Answer + * or Liveboard. + * ```js + * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl + */ + ParameterChanged = "parameterChanged", + /** + * Emits when a table visualization is rendered in + * the ThoughtSpot embedded app. + * + * You can also use this event as a hook to trigger host events + * such as `HostEvent.TransformTableVizData` on the table visualization. + * The event payload contains the data used in the rendered table. + * You can extract the relevant data from the payload + * stored in `payload.data.data.columnDataLite`. + * + * `columnDataLite` is a multidimensional array that contains + * data values for each column, which was used in the query to + * generate the table visualization. To find and modify specific cell data, + * you can either loop through the array or directly access a cell if + * you know its position and data index. + * + * In the following code sample, the first cell in the first column + * (`columnDataLite[0].dataValue[0]`) is set to `new fob`. + * Note that any changes made to the data in the payload will only update the + * visual presentation and do not affect the underlying data. + * To persist data value modifications after a reload or during chart + * interactions such as drill down, ensure that the modified + * payload in the `columnDataLite` is passed on to + * `HostEvent.TransformTableVizData` and trigger an update to + * the table visualization. + * + * If the Row-Level Security (RLS) rules are applied on the + * Worksheet or Model, exercise caution when changing column + * or table cell values to maintain data security. + * + * @example + * ```js + * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => { + * console.log(payload); + * const columnDataLite = payload.data.data.columnDataLite; + * columnDataLite[0].dataValue[0]="new fob"; + * console.log('>>> new Data', columnDataLite); + * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite); + * }) + * ``` + * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl + */ + TableVizRendered = "TableVizRendered", + /** + * Emitted when the liveboard is created from pin modal or Liveboard list page. + * You can use this event as a hook to trigger + * other events on liveboard creation. + * + * ```js + * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl + */ + CreateLiveboard = "createLiveboard", + /** + * Emitted when a user creates a Model. + * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl + */ + CreateModel = "createModel", + /** + * @hidden + * Emitted when a user exits present mode. + * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + ExitPresentMode = "exitPresentMode", + /** + * Emitted when a user requests the full height lazy load data. + * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl + * @hidden + */ + RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates", + /** + * Emitted when Spotter response is text data + * @example + * ```js + * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + SpotterData = "SpotterData", + /** + * Emitted when user opens up the worksheet preview modal in Spotter embed. + * @example + * ```js + * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + PreviewSpotterData = "PreviewSpotterData", + /** + * Emitted when the Spotter query is triggered in Spotter embed. + * @example + * ```js + * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + SpotterQueryTriggered = "SpotterQueryTriggered", + /** + * Emitted when the last Spotter query is edited in Spotter embed. + * @example + * ```js + * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + LastPromptEdited = "LastPromptEdited", + /** + * Emitted when the last Spotter query is deleted in Spotter embed. + * @example + * ```js + * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + LastPromptDeleted = "LastPromptDeleted", + /** + * Emitted when the coversation is reset in spotter embed. + * @example + * ```js + * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + ResetSpotterConversation = "ResetSpotterConversation", + /** + * Emitted when the *Spotter* is initialized. + * @example + * ```js + * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => { + * console.log('payload', payload); + * }) + *``` + * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl + */ + SpotterInit = "spotterInit", + /** + * @hidden + * Triggers when the embed listener is ready to receive events. + * This is used to trigger events after the embed container is loaded. + * @example + * ```js + * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => { + * console.log('EmbedListenerReady'); + * }) + * ``` + */ + EmbedListenerReady = "EmbedListenerReady", + /** + * Emitted when the organization is switched. + * @example + * ```js + * appEmbed.on(EmbedEvent.OrgSwitched, (payload) => { + * console.log('payload', payload); + * }) + * ``` + * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl + */ + OrgSwitched = "orgSwitched" +} +/** + * Event types that can be triggered by the host application + * to the embedded ThoughtSpot app. + * + * 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'; + * // Or + * // const { HostEvent } = window.tsembed; + * + * // create the liveboard embed. + * + * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [ + * { 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 ( + * + * ); + * } + * ``` + * @group Events + */ +export declare enum HostEvent { + /** + * Triggers a search operation with the search tokens specified in + * 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 + * is supported. + * @param - `execute` - executes search and updates the existing query + * @example + * ```js + * searchembed.trigger(HostEvent.Search, { + searchQuery: "[sales] by [item type]", + dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"], + execute: true + }); + * ``` + */ + Search = "search", + /** + * 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 + * by. If not provided it will auto drill by the configured + * column. + * @param - autoDrillDown - Optional. If true, the drill down will be + * done automatically on the most popular column. + * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill + * in case of a Liveboard. + * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * @example + * ```js + * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => { + * console.log(payload); + * const clickedPoint = payload.data.clickedPoint; + * const selectedPoint = payload.data.selectedPoints; + * console.log('>>> called', clickedPoint); + * searchEmbed.trigger(HostEvent.DrillDown, { + * points: { + * clickedPoint, + * selectedPoints: selectedPoint + * }, + * autoDrillDown: true, + * }); + * }) + * ``` + * @example + * ```js + * // Works with TS 9.8.0 and above + * + * liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => { + * console.log(payload); + * const clickedPoint = payload.data.clickedPoint; + * const selectedPoint = payload.data.selectedPoints; + * console.log('>>> called', clickedPoint); + * liveboardEmbed.trigger(HostEvent.DrillDown, { + * points: { + * clickedPoint, + * selectedPoints: selectedPoint + * }, + * columnGuid: "", + * vizId: payload.data.vizId + * }); + * }) + * ``` + * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1 + */ + DrillDown = "triggerDrillDown", + /** + * Apply filters + * @hidden + */ + Filter = "filter", + /** + * Reload the Answer or visualization + * @hidden + */ + Reload = "reload", + /** + * Get iframe URL for the current embed view on the playground. + * Developers can use this URL to embed a ThoughtSpot object + * in apps like Salesforce or Sharepoint. + * @example + * ```js + * const url = embed.trigger(HostEvent.GetIframeUrl); + * console.log("iFrameURL",url); + * ``` + * @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 + * in this parameter will be hidden. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [ + * '730496d6-6903-4601-937e-2c691821af3c', + * 'd547ec54-2a37-4516-a222-2b06719af726']) + * ``` + * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw + */ + SetVisibleVizs = "SetPinboardVisibleVizs", + /** + * Set a Liveboard tab as an active tab. + * @param - tabId - string of id of Tab to show + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.SetActiveTab,{ + * tabId:'730496d6-6903-4601-937e-2c691821af3c' + * }) + * ``` + * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw + */ + SetActiveTab = "SetActiveTab", + /** + * Updates the runtime filters applied on a Liveboard. The filter + * attributes passed with this event are appended to the existing runtime + * filters applied on a Liveboard. + * + * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed` + * and `AppEmbed` only. In full application embedding, this event updates + * the runtime filters applied on the Liveboard and saved Answer objects. + * + * @param - Pass an array of {@link RuntimeFilter} with the following attributes: + * `columnName` - _String_. The name of the column to filter on. + * + * `operator` - {@link RuntimeFilterOp} to apply. For more information, + * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation]. + * + * `values` - List of operands. Some operators such as EQ and LE allow a + * single value, whereas BW and IN accept multiple values. + * + * **Note**: Updating runtime filters resets the ThoughtSpot + * object to its original state and applies new filter conditions. + * Any user changes (like drilling into a visualization) + * will be cleared, restoring the original visualization + * with the updated filters. + * + + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [ + * {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]}, + * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]} + * ]) + * ``` + * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + * @important + */ + UpdateRuntimeFilters = "UpdateRuntimeFilters", + /** + * 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 + * ```js + * appEmbed.navigateToPage(-1) + * ``` + * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw + */ + Navigate = "Navigate", + /** + * Open the filter panel for a particular column. + * Works with Search and Liveboard embed. + * @param - { columnId: string, + * name: string, + * type: ATTRIBUTE/MEASURE, + * dataType: INT64/CHAR/DATE } + * @example + * ```js + * searchEmbed.trigger(HostEvent.OpenFilter, + * {column: { columnId: '', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}}) + * ``` + * @example + * ```js + * LiveboardEmbed.trigger(HostEvent.OpenFilter, + * { column: {columnId: ''}}) + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl + */ + OpenFilter = "openFilter", + /** + * Add columns to the current search query. + * @param - { columnIds: string[] } + * @example + * ```js + * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['',''] }) + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl + */ + AddColumns = "addColumns", + /** + * Remove a column from the current search query. + * @param - { columnId: string } + * @example + * ```js + * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '' }) + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl + */ + RemoveColumn = "removeColumn", + /** + * Get the transient state of a Liveboard as encoded content. + * This includes unsaved and ad hoc changes such as + * 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. + * For more information, see + * link:https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#transient-lb-content[Liveboard data with unsaved changes]. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then( + * data=>console.log(data)) + * ``` + * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw + */ + getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard", + /** + * Trigger **Pin** action on an embedded object. + * If no parameters are defined, the pin action is triggered + * for the Answer that the user is currently on + * and a modal opens for Liveboard selection. + * To add an Answer or visualization to a Liveboard programmatically without + * showing requiring additional user input via *Pin to Liveboard* modal, define + * the following parameters: + * + * @param + * `vizId`- GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard. + * Optional when pinning a new chart or table generated from a Search query. + * **Required** in Spotter Embed. + * @param + * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard, + * specify the `newLiveboardName` parameter to create a new Liveboard. + * @param + * `tabId` - GUID of the Liveboard tab. Adds the Answer to the Liveboard tab + * specified in the code. + * @param + * `newVizName` - Name string for the Answer or visualization. If defined, + * this parameter adds a new visualization object or creates a copy of the + * Answer or visualization specified in `vizId`. + * Required attribute. + * @param + * `newLiveboardName` - Name string for the Liveboard. + * Creates a new Liveboard object with the specified name. + * @param + * `newTabName` - Name of the tab. Adds a new tab Liveboard specified + * in the code. + * + * @example + * ```js + * const pinResponse = await appEmbed.trigger(HostEvent.Pin, { + * vizId: "123", + * newVizName: "Sales by region", + * liveboardId: "123", + * tabId: "123" + * }); + * ``` + * @example + * ```js + * const pinResponse = await appEmbed.trigger(HostEvent.Pin, { + * newVizName: "Total sales of Jackets", + * liveboardId: "123" + * }); + * ``` + * + * @example + * ```js + * const pinResponse = await searchEmbed.trigger(HostEvent.Pin, { + * newVizName: "Sales by state", + * newLiveboardName: "Sales", + * newTabName: "Products" + * }); + * ``` + * @example + * ```js + * appEmbed.trigger(HostEvent.Pin) + * ``` + * @example + * ```js + + * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId }); + * ``` + * + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + Pin = "pin", + /** + * Trigger the **Show Liveboard details** action + * on an embedded Liveboard. + * @example + *```js + * liveboardEmbed.trigger(HostEvent.LiveboardInfo) + *``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + LiveboardInfo = "pinboardInfo", + /** + * Trigger the **Schedule** action on an embedded Liveboard. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.Schedule) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + Schedule = "subscription", + /** + * Trigger the **Manage schedule** action on an embedded Liveboard + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.ScheduleList) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + SchedulesList = "schedule-list", + /** + * 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 + */ + ExportTML = "exportTSL", + /** + * Trigger the **Edit TML** action on an embedded Liveboard or + * saved Answers in the full application embedding. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.EditTML) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + EditTML = "editTSL", + /** + * Trigger the **Update TML** action on an embedded Liveboard. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.UpdateTML) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + UpdateTML = "updateTSL", + /** + * Trigger the **Download PDF** action on an embedded Liveboard, + * visualization or Answer. + * + * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * + * **NOTE**: The **Download** > **PDF** action is available on + * visualizations and Answers if the data is in tabular format. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.DownloadAsPdf) + * ``` + * @example + * ```js + + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId }); + * ``` + * + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + DownloadAsPdf = "downloadAsPdf", + /** + * Trigger the **Make a copy** action on a Liveboard, + * visualization, or Answer page. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.MakeACopy) + * ``` + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.MakeACopy, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * @example + * ```js + * vizEmbed.trigger(HostEvent.MakeACopy) + * ``` + * @example + * ```js + * searchEmbed.trigger(HostEvent.MakeACopy) + * ``` + * @example + * ```js + * // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId }); + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + MakeACopy = "makeACopy", + /** + * Trigger the **Delete** action for a Liveboard. + * @example + * ```js + * appEmbed.trigger(HostEvent.Remove) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + * * @example + * ```js + * liveboardEmbed.trigger(HostEvent.Remove) + * ``` + * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw + */ + Remove = "delete", + /** + * Trigger the **Explore** action on a visualization. + * @param - an object with `vizId` as a key + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + Explore = "explore", + /** + * Trigger the **Create alert** action on a KPI chart + * in a Liveboard or saved Answer. + * @param - an object with `vizId` as a key + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.CreateMonitor, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c' + * }) + * ``` + * @example + * ```js + * searchEmbed.trigger(HostEvent.CreateMonitor) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + CreateMonitor = "createMonitor", + /** + * Trigger the **Manage alerts** action on a KPI chart + * in a visualization or saved Answer. + * @param - an object with `vizId` as a key + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.ManageMonitor, { + * vizId: '730496d6-6903-4601-937e-2c691821af3c' + * }) + * ``` + * @example + * ```js + * searchEmbed.trigger(HostEvent.ManageMonitor) + * ``` + * @example + * ```js + * vizEmbed.trigger(HostEvent.ManageMonitor) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + ManageMonitor = "manageMonitor", + /** + * 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. + * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.Edit) + * ``` + * ```js + * liveboardEmbed.trigger(HostEvent.Edit, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * @example + * ```js + * spotterEmbed.trigger(HostEvent.Edit); + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + 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 + * ```js + * liveboardEmbed.trigger(HostEvent.CopyLink) + * ``` + * ```js + * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger((HostEvent.CopyLink) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + 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 + * ```js + * liveboardEmbed.trigger(HostEvent.Present) + * ``` + * ```js + * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger((HostEvent.Present) + * ``` + * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw + */ + Present = "present", + /** + * Get TML for the current search. + * @example + * ```js + * searchEmbed.trigger(HostEvent.GetTML).then((tml) => { + * console.log( + * tml.answer.search_query // TML representation of the search query + * ); + * }) + * ``` + * * @example + * ```js + + * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.GetTML, { + * vizId: latestSpotterVizId + * }).then((tml) => { + * console.log( + * tml.answer.search_query // TML representation of the search query + * ); + * }) + * ``` + * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw + * @important + */ + GetTML = "getTML", + /** + * Trigger the **Show underlying data** action on a + * chart or table. + * + * @param - an object with vizId as a key + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.ShowUnderlyingData) + * ``` + * ```js + * searchEmbed.trigger(HostEvent.ShowUnderlyingData) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + ShowUnderlyingData = "showUnderlyingData", + /** + * 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 + * ```js + * liveboardEmbed.trigger(HostEvent.Delete, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * searchEmbed.trigger(HostEvent.Delete) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + Delete = "onDeleteAnswer", + /** + * Trigger the **SpotIQ analyze** action on a + * chart or table. + * @param - Liveboard embed takes `vizId` as a + * key. Can be left undefined when embedding Search or + * visualization. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.SpotIQAnalyze) + * ``` + * ```js + * searchEmbed.trigger(HostEvent.SpotIQAnalyze) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + SpotIQAnalyze = "spotIQAnalyze", + /** + * Trigger the **Download** action on charts in + * the embedded view. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.Download, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * embed.trigger(HostEvent.Download) + * ``` + * ```js + * // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId }); + * ``` + * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw + * Use {@link DownloadAsPng} + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + Download = "downloadAsPng", + /** + * Trigger the **Download** > **PNG** action on + * charts in the embedded view. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.DownloadAsPng, + * {vizId:'730496d6-6903-4601-937e-2c691821af3c'}) + * + * vizEmbed.trigger(HostEvent.DownloadAsPng) + * + * searchEmbed.trigger(HostEvent.DownloadAsPng) + * + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId }); + * ``` + * + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw + */ + DownloadAsPng = "downloadAsPng", + /** + * Trigger the **Download** > **CSV** action on tables in + * the embedded view. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.DownloadAsCsv) + * ``` + * ```js + * searchEmbed.trigger(HostEvent.DownloadAsCsv) + * ``` + * ```js + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId }); + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + DownloadAsCsv = "downloadAsCSV", + /** + * Trigger the **Download** > **XLSX** action on tables + * in the embedded view. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.DownloadAsXlsx) + * ``` + * ```js + * searchEmbed.trigger(HostEvent.DownloadAsXlsx) + * ``` + * ```js + * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId }); + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + DownloadAsXlsx = "downloadAsXLSX", + /** + * Trigger the **Share** action on an embedded + * Liveboard or Answer. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.Share) + * ``` + * ```js + * searchEmbed.trigger(HostEvent.Share) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + Share = "share", + /** + * Trigger the **Save** action on a Liveboard, Answer, or Spotter. + * Saves the changes. + * + * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed. + * It is required and can be retrieved from the data embed event. + * + * @example + * ```js + * // Save changes in a Liveboard + * liveboardEmbed.trigger(HostEvent.Save) + * ``` + * + * ```js + * // Save the current Answer in Search embed + * searchEmbed.trigger(HostEvent.Save) + * ``` + * + * ```js + * // Save a Visualization in Spotter (requires vizId) + * spotterEmbed.trigger(HostEvent.Save, { + * vizId: "730496d6-6903-4601-937e-2c691821af3c" + * }) + * ``` + * + * ```js + * // How to get the vizId in Spotter? + * + * // You can use the Data event dispatched on each answer creation to get the vizId. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId }); + * ``` + * + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + Save = "save", + /** + * 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 + * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.SyncToSheets) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + SyncToSheets = "sync-to-sheets", + /** + * 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 + * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.SyncToOtherApps) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + SyncToOtherApps = "sync-to-other-apps", + /** + * 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 + * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: + * '730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * ```js + * vizEmbed.trigger(HostEvent.ManagePipelines) + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw + */ + ManagePipelines = "manage-pipeline", + /** + * Reset search operation on the Search or Answer page. + * @example + * ```js + * searchEmbed.trigger(HostEvent.ResetSearch) + * ``` + * ```js + * appEmbed.trigger(HostEvent.ResetSearch) + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw + */ + ResetSearch = "resetSearch", + /** + * 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 + */ + 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, + * and values for each. + * + * Each filter object must include the following attributes: + * + * `column` - Name of the column to filter on. + * + * `oper` - Filter operator, for example, EQ, IN, CONTAINS. + * For information about the supported filter operators, + * 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 + * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported + * data types]. + * + * `type` - To update filters for date time, specify the date format type. + * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters]. + * @example + * ```js + * + * liveboardEmbed.trigger(HostEvent.UpdateFilters, { + * filter: { + * column: "item type", + * oper: "IN", + * 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, { + * filters: [{ + * column: "Item Type", + * oper: 'IN', + * values: ["bags","shirts"] + * }, + * { + * column: "Region", + * oper: 'IN', + * values: ["West","Midwest"] + * }, + * { + * column: "Date", + * oper: 'EQ', + * values: ["2023-07-31"], + * type: "EXACT_DATE" + * }] + * }); + * ``` + * If there are multiple columns with the same name, consider + * using `WORKSHEET_NAME::COLUMN_NAME` format. + * + * @example + * + * ```js + * liveboardEmbed.trigger(HostEvent.UpdateFilters, { + * filters: [{ + * column: "(Sample) Retail - Apparel::city", + * oper: 'IN', + * values: ["atlanta"] + * }, + * { + * column: "(Sample) Retail - Apparel::Region", + * oper: 'IN', + * values: ["West","Midwest"] + * }] + * }); + * ``` + * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl + */ + UpdateFilters = "updateFilters", + /** + * Get tab details for the current Liveboard. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => { + * console.log( + * tabDetails // TabDetails of current Liveboard + * ); + * }) + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl + */ + 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 + * ```js + * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [ + * '430496d6-6903-4601-937e-2c691821af3c', + * 'f547ec54-2a37-4516-a222-2b06719af726']) + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + 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 + * ```js + * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [ + * '630496d6-6903-4601-937e-2c691821af3c', + * 'i547ec54-2a37-4516-a222-2b06719af726']) + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + 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 + * ```js + * sageEmbed.trigger(HostEvent.UpdateSageQuery, { + * queryString: 'revenue per year', + * executeSearch: true, + * }) + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + */ + UpdateSageQuery = "updateSageQuery", + /** + * Get the Answer session for a Search or + * Liveboard visualization. + * + * Note: This event is not typically used directly. Instead, use the + * `getAnswerService()` method on the embed instance to get an AnswerService + * object that provides a more convenient interface for working with answers. + * + * @example + * ```js + * // Preferred way to get an AnswerService + * const service = await embed.getAnswerService(); + * + * // Alternative direct usage (not recommended) + * const {session} = await embed.trigger( + * HostEvent.GetAnswerSession, { + * vizId: '123', // For Liveboard Visualization. + * }) + * ``` + * @example + * ```js + * // Preferred way to get an AnswerService + * const service = await embed.getAnswerService(); + * + * // Alternative direct usage (not recommended) + * const {session} = await embed.trigger( HostEvent.GetAnswerSession ) + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw + */ + GetAnswerSession = "getAnswerSession", + /** + * Trigger the *Ask Sage* action for visualizations + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.AskSage, + * {vizId:'730496d6-6903-4601-937e-2c691821af3c'}) + * ``` + * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl + */ + AskSage = "AskSage", + /** + * Trigger cross filter update action on a Liveboard. + * + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, { + * vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e', + * conditions: [ + * { columnName: 'Category', values: ['mfgr#12','mfgr#14'] }, + * { columnName: 'color', values: ['mint','hot'] }, + * ], + * }); + * ``` + * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw + */ + UpdateCrossFilter = "UpdateCrossFilter", + /** + * Trigger reset action for a personalized Liveboard view. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView); + * ``` + * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw + */ + ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView", + /** + * Triggers an action to update Parameter values on embedded + * Answers, Liveboard and Spotter answer in Edit mode. + * + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{ + * name: "Color", + * value: "almond" + * }]) + * + * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw + */ + UpdateParameters = "UpdateParameters", + /** + * Triggers GetParameters to fetch the runtime Parameters. + * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * ```js + * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => { + * console.log('parameters', parameter); + * }); + *``` + *```js + * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId }); + *``` + * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw + */ + GetParameters = "GetParameters", + /** + * Triggers an event to update a personalized view of a Liveboard. + * ```js + * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'}) + * ``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl + */ + UpdatePersonalisedView = "UpdatePersonalisedView", + /** + * @hidden + * Notify when info call is completed successfully + * ```js + * liveboardEmbed.trigger(HostEvent.InfoSuccess, data); + *``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl + */ + InfoSuccess = "InfoSuccess", + /** + * Trigger the save action for an Answer. + * To programmatically save an answer without opening the + * *Describe your Answer* modal, define the `name` and `description` + * properties. + * If no parameters are specified, the save action is + * triggered with a modal to prompt users to + * add a name and description for the Answer. + * @param - optional attributes to set Answer properties. + * `name` - Name string for the Answer. + * `description` - Description text for the Answer. + * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. + * @example + * ```js + * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, { + * name: "Sales by states", + * description: "Total sales by states in MidWest" + * }); + * ``` + * @example + * ```js + * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event. + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId }); + * ``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl + */ + SaveAnswer = "saveAnswer", + /** + * EmbedApi + * @hidden + */ + UIPassthrough = "UiPassthrough", + /** + * Triggers the table visualization re-render with the updated data. + * Includes the following properties: + * @param - `columnDataLite` - an array of object containing the + * data value modifications retrieved from the `EmbedEvent.TableVizRendered` + * payload.For example, { columnDataLite: []}`. + * + * @example + * ```js + * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => { + * console.log(payload); + * const columnDataLite = payload.data.data.columnDataLite; + * columnDataLite[0].dataValue[0]="new fob"; + * console.log('>>> new Data', columnDataLite); + * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite); + * }) + * ``` + * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl + */ + TransformTableVizData = "TransformTableVizData", + /** + * Triggers a search operation with the search tokens specified in + * the search query string in spotter embed. + * @param - `query`: Text string in Natural Language format + * @param - `executeSearch`: Boolean to execute search and update search query + * @example + * ```js + * spotterEmbed.trigger(HostEvent.SpotterSearch, { + * query: 'revenue per year', + * executeSearch: true, + * }) + * ``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + SpotterSearch = "SpotterSearch", + /** + * Edits the last prompt in spotter embed. + * @param - `query`: Text string + * @example + * ```js + * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year"); + * ``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + EditLastPrompt = "EditLastPrompt", + /** + * Opens the Worksheet preview modal in Spotter Embed. + * @example + * ```js + * spotterEmbed.trigger(HostEvent.PreviewSpotterData); + * ``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + PreviewSpotterData = "PreviewSpotterData", + /** + * Resets the Spotter Embed Conversation. + * @example + * ```js + * spotterEmbed.trigger(HostEvent.ResetSpotterConversation); + * ``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + ResetSpotterConversation = "ResetSpotterConversation", + /** + * Deletes the last prompt in spotter embed. + * @example + * ```js + * spotterEmbed.trigger(HostEvent.DeleteLastPrompt); + * ``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + DeleteLastPrompt = "DeleteLastPrompt", + /** + * Toggle the visualization to chart or table view. + * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required. + * @example + * ```js + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId }); + *``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + AnswerChartSwitcher = "answerChartSwitcher", + /** + * @hidden + * Trigger exit from presentation mode when user exits fullscreen. + * This is automatically triggered by the SDK when fullscreen mode is exited. + * ```js + * liveboardEmbed.trigger(HostEvent.ExitPresentMode); + *``` + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ + ExitPresentMode = "exitPresentMode", + /** + * Triggers the full height lazy load data. + * @example + * ```js + * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => { + * console.log(payload); + * }); + * ``` + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + * + * @hidden + */ + VisibleEmbedCoordinates = "visibleEmbedCoordinates", + /** + * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes. + * @param - `vizId` refers to the Visualization ID in Spotter embed and is required. + * @example + * ```js + * let latestSpotterVizId = ''; + * spotterEmbed.on(EmbedEvent.Data, (payload) => { + * latestSpotterVizId = payload.data.id; + * }); + * + * spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId }); + * ``` + * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl + */ + AskSpotter = "AskSpotter", + /** + * @hidden + * Triggers the update of the embed params. + * + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig); + * ``` + */ + UpdateEmbedParams = "updateEmbedParams", + /** + * @hidden + * Triggers the get of the page context. + * @example + * ```js + * liveboardEmbed.trigger(HostEvent.GetPageContext); + * ``` + */ + GetPageContext = "GetPageContext" +} +/** + * The different visual modes that the data sources panel within + * search could appear in, such as hidden, collapsed, or expanded. + */ +export declare enum DataSourceVisualMode { + /** + * The data source panel is hidden. + */ + Hidden = "hide", + /** + * The data source panel is collapsed, but the user can manually expand it. + */ + Collapsed = "collapse", + /** + * The data source panel is expanded, but the user can manually collapse it. + */ + Expanded = "expand" +} +/** + * ThoughtSpot application pages include actions and menu commands + * for various user-initiated operations. These actions are represented + * as enumeration members in the SDK. To show, hide, or disable + * specific actions in the embedded view, define the Action + * enumeration members in the `disabledActions`, `visibleActions`, + * or `hiddenActions` array. + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore], + * disabledActions: [Action.Download], + * //hiddenActions: [], // Set either this or visibleActions + * }) + * ``` + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * //visibleActions: [], + * disabledActions: [Action.Download], + * hiddenActions: [Action.Edit, ActionAction.Explore], + * }) + * ``` + * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK] + */ +export declare enum Action { + /** + * The **Save** action on an Answer or Liveboard. + * Allows users to save the changes. + * @example + * ```js + * disabledActions: [Action.Save] + * ``` + */ + Save = "save", + /** + * @hidden + */ + Update = "update", + /** + * @hidden + */ + SaveUntitled = "saveUntitled", + /** + * The **Save as View** action on the Answer + * page. Saves an Answer as a View object in the full + * application embedding mode. + * @example + * ```js + * disabledActions: [Action.SaveAsView] + * ``` + */ + SaveAsView = "saveAsView", + /** + * The **Make a copy** action on a Liveboard or Answer + * page. Creates a copy of the Liveboard. + * In LiveboardEmbed, the **Make a copy** action is not available for + * 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] + * ``` + */ + MakeACopy = "makeACopy", + /** + * The **Copy and Edit** action on a Liveboard. + * This action is now replaced with `Action.MakeACopy`. + * @example + * ```js + * disabledActions: [Action.EditACopy] + * ``` + */ + EditACopy = "editACopy", + /** + * The **Copy link** menu action on a Liveboard visualization. + * Copies the visualization URL + * @example + * ```js + * disabledActions: [Action.CopyLink] + * ``` + */ + CopyLink = "embedDocument", + /** + * @hidden + */ + ResetLayout = "resetLayout", + /** + * The **Schedule** menu action on a Liveboard. + * Allows scheduling a Liveboard job, for example, + * sending periodic notifications. + * @example + * ```js + * disabledActions: [Action.Schedule] + * ``` + */ + Schedule = "subscription", + /** + * The **Manage schedules** menu action on a Liveboard. + * Allows users to manage scheduled Liveboard jobs. + * @example + * ```js + * disabledActions: [Action.SchedulesList] + * ``` + */ + SchedulesList = "schedule-list", + /** + * 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] + * ``` + */ + Share = "share", + /** + * The **Add filter** action on a Liveboard page. + * Allows adding filters to visualizations on a Liveboard. + * @example + * ```js + * disabledActions: [Action.AddFilter] + * ``` + */ + AddFilter = "addFilter", + /** + * The **Add Data Panel Objects** action on the data panel v2. + * Allows to show action menu to add different objects (such as + * formulas, Parameters) in data panel new experience. + * @example + * ```js + * disabledActions: [Action.AddDataPanelObjects] + * ``` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw + */ + AddDataPanelObjects = "addDataPanelObjects", + /** + * The filter configuration options for a Liveboard. + * The configuration options are available when adding + * filters on a Liveboard. + * + * @example + * ```js + * disabledActions: [Action.ConfigureFilter] + * ``` + */ + ConfigureFilter = "configureFilter", + /** + * The **Collapse data sources** icon on the Search page. + * Collapses the panel showing data sources. + * + * @example + * ```js + * disabledActions: [Action.CollapseDataPanel] + * ``` + * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw + */ + CollapseDataSources = "collapseDataSources", + /** + * The **Collapse data panel** icon on the Search page. + * Collapses the data panel view. + * + * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl + * + * @example + * ```js + * disabledActions: [Action.CollapseDataPanel] + * ``` + */ + CollapseDataPanel = "collapseDataPanel", + /** + * The **Choose sources** button on Search page. + * Allows selecting data sources for search queries. + * @example + * ```js + * disabledActions: [Action.ChooseDataSources] + * ``` + */ + ChooseDataSources = "chooseDataSources", + /** + * The **Create formula** action on a Search or Answer page. + * Allows adding formulas to an Answer. + * @example + * ```js + * disabledActions: [Action.AddFormula] + * ``` + */ + AddFormula = "addFormula", + /** + * The **Add parameter** action on a Liveboard or Answer. + * Allows adding Parameters to a Liveboard or Answer. + * @example + * ```js + * disabledActions: [Action.AddParameter] + * ``` + */ + AddParameter = "addParameter", + /** + * The **Add Column Set** action on a Answer. + * Allows adding column sets to a Answer. + * @example + * ```js + * disabledActions: [Action.AddColumnSet] + * ``` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw + */ + AddColumnSet = "addSimpleCohort", + /** + * The **Add Query Set** action on a Answer. + * Allows adding query sets to a Answer. + * @example + * ```js + * disabledActions: [Action.AddQuerySet] + * ``` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw + */ + AddQuerySet = "addAdvancedCohort", + /** + * @hidden + */ + SearchOnTop = "searchOnTop", + /** + * The **SpotIQ analyze** menu action on a visualization or + * Answer page. + * @example + * ```js + * disabledActions: [Action.SpotIQAnalyze] + * ``` + */ + SpotIQAnalyze = "spotIQAnalyze", + /** + * @hidden + */ + ExplainInsight = "explainInsight", + /** + * @hidden + */ + SpotIQFollow = "spotIQFollow", + /** + * The Share action for a Liveboard visualization. + */ + ShareViz = "shareViz", + /** + * @hidden + */ + ReplaySearch = "replaySearch", + /** + * The **Show underlying data** menu action on a + * visualization or Answer page. + * Displays detailed information and raw data + * for a given visualization. + * @example + * ```js + * disabledActions: [Action.ShowUnderlyingData] + * ``` + */ + ShowUnderlyingData = "showUnderlyingData", + /** + * The **Download** menu action on Liveboard + * visualizations and Answers. + * Allows downloading a visualization or Answer. + * @example + * ```js + * disabledActions: [Action.DownloadAsPng] + * ``` + */ + Download = "download", + /** + * 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] + * ``` + */ + DownloadAsPng = "downloadAsPng", + /** + * + *The **Download PDF** action that downloads a Liveboard, + * visualization, or Answer as a PDF file. + * + * **NOTE**: The **Download** > **PDF** option is available for + * tables in visualizations and Answers. + * @example + * ```js + * disabledActions: [Action.DownloadAsPdf] + * ``` + */ + DownloadAsPdf = "downloadAsPdf", + /** + * 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] + * ``` + */ + DownloadAsCsv = "downloadAsCSV", + /** + * 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] + * ``` + */ + DownloadAsXlsx = "downloadAsXLSX", + /** + * @hidden + */ + DownloadTrace = "downloadTrace", + /** + * The **Export TML** menu action on a Liveboard, Answer, and + * the Data Workspace pages for data objects and connections. + * + * Allows exporting an object as a TML file. + * + * @example + * ```js + * disabledActions: [Action.ExportTML] + * ``` + */ + ExportTML = "exportTSL", + /** + * The **Import TML** menu action on the + * *Data Workspace* > *Utilities* page. + * Imports TML representation of ThoughtSpot objects. + * @example + * ```js + * disabledActions: [Action.ImportTML] + * ``` + */ + ImportTML = "importTSL", + /** + * The **Update TML** menu action for Liveboards and Answers. + * Updates TML representation of ThoughtSpot objects. + * @example + * ```js + * disabledActions: [Action.UpdateTML] + * ``` + */ + UpdateTML = "updateTSL", + /** + * The **Edit TML** menu action for Liveboards and Answers. + * Opens the TML editor. + * @example + * ```js + * disabledActions: [Action.EditTML] + * ``` + */ + EditTML = "editTSL", + /** + * The **Present** menu action for Liveboards and Answers. + * Allows presenting a Liveboard or visualization in + * slideshow mode. + * @example + * ```js + * disabledActions: [Action.Present] + * ``` + */ + Present = "present", + /** + * The visualization tile resize option. + * Also available via More `...` options menu on a visualization. + * Allows resizing visualization tiles and switching + * between different preset layout option. + * + * @example + * ```js + * disabledActions: [Action.ToggleSize] + * ``` + */ + ToggleSize = "toggleSize", + /** + * 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] + * ``` + */ + Edit = "edit", + /** + * The text edit option for Liveboard and visualization titles. + * @example + * ```js + * disabledActions: [Action.EditTitle] + * ``` + */ + EditTitle = "editTitle", + /** + * The **Delete** action on a Liveboard, *Liveboards* and + * *Answers* list pages in full application embedding. + * + * @example + * ```js + * disabledActions: [Action.Remove] + * ``` + */ + Remove = "delete", + /** + * @hidden + */ + Ungroup = "ungroup", + /** + * @hidden + */ + Describe = "describe", + /** + * @hidden + */ + Relate = "relate", + /** + * @hidden + */ + CustomizeHeadlines = "customizeHeadlines", + /** + * @hidden + */ + PinboardInfo = "pinboardInfo", + /** + * The **Show Liveboard details** menu action on a Liveboard. + * Displays details such as the name, description, and + * author of the Liveboard, and timestamp of Liveboard creation + * and update. + * @example + * ```js + * disabledActions: [Action.LiveboardInfo] + * ``` + */ + LiveboardInfo = "pinboardInfo", + /** + * @hidden + */ + SendAnswerFeedback = "sendFeedback", + /** + * @hidden + */ + DownloadEmbraceQueries = "downloadEmbraceQueries", + /** + * The **Pin** menu action on an Answer or + * Search results page. + * @example + * ```js + * disabledActions: [Action.Pin] + * ``` + */ + Pin = "pin", + /** + * @hidden + */ + AnalysisInfo = "analysisInfo", + /** + * The **Schedule** menu action on a Liveboard. + * Allows scheduling a Liveboard job. + * @example + * ```js + * disabledActions: [Action.Subscription] + * ``` + */ + Subscription = "subscription", + /** + * The **Explore** action on Liveboard visualizations + * @example + * ```js + * disabledActions: [Action.Explore] + * ``` + */ + Explore = "explore", + /** + * The contextual menu action to include a specific data point + * when drilling down a table or chart on an Answer. + * + * @example + * ```js + * disabledActions: [Action.DrillInclude] + * ``` + */ + DrillInclude = "context-menu-item-include", + /** + * The contextual menu action to exclude a specific data point + * when drilling down a table or chart on an Answer. + * @example + * ```js + * disabledActions: [Action.DrillInclude] + * ``` + */ + DrillExclude = "context-menu-item-exclude", + /** + * The **Copy to clipboard** menu action on tables in an Answer + * or Liveboard. + * Copies the selected data point. + * @example + * ```js + * disabledActions: [Action.CopyToClipboard] + * ``` + */ + CopyToClipboard = "context-menu-item-copy-to-clipboard", + CopyAndEdit = "context-menu-item-copy-and-edit", + /** + * @hidden + */ + DrillEdit = "context-menu-item-edit", + EditMeasure = "context-menu-item-edit-measure", + Separator = "context-menu-item-separator", + /** + * 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] + * ``` + */ + DrillDown = "DRILL", + /** + * The request access action on Liveboards. + * Allows users with view permissions to request edit access to a Liveboard. + * @example + * ```js + * disabledActions: [Action.RequestAccess] + * ``` + */ + RequestAccess = "requestAccess", + /** + * The **Query visualizer** and **Query SQL** buttons in + * Query details panel of the Answer page. + * + * **Query visualizer** - Displays the tables + * and filters used in a search query. + * **Query SQL** - Displays the SQL statements used + * in a search query to fetch data. + * @example + * ```js + * disabledActions: [Action.QueryDetailsButtons] + * ``` + */ + QueryDetailsButtons = "queryDetailsButtons", + /** + * The **Delete** action for Answers in the full application + * embedding mode. + * @example + * ```js + * disabledActions: [Action.AnswerDelete] + * ``` + * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + */ + AnswerDelete = "onDeleteAnswer", + /** + * The chart switcher icon on Answer page and + * visualizations in edit mode. + * Allows switching to the table or chart mode + * when editing a visualization. + * @example + * ```js + * disabledActions: [Action.AnswerChartSwitcher] + * ``` + * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + */ + AnswerChartSwitcher = "answerChartSwitcher", + /** + * The Favorites icon (*) for Answers, + * Liveboard, and data objects like Worksheet, Model, + * Tables and Views. + * Allows adding an object to the user's favorites list. + * @example + * ```js + * disabledActions: [Action.AddToFavorites] + * ``` + * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + */ + AddToFavorites = "addToFavorites", + /** + * The edit icon on Liveboards (Classic experience). + * @example + * ```js + * disabledActions: [Action.EditDetails] + * ``` + * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw + */ + EditDetails = "editDetails", + /** + * The *Create alert* action for KPI charts. + * Allows users to schedule threshold-based alerts + * for KPI charts. + * @example + * ```js + * disabledActions: [Action.CreateMonitor] + * ``` + * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw + */ + CreateMonitor = "createMonitor", + /** + * @deprecated + * Reports errors + * @example + * ```js + * disabledActions: [Action.ReportError] + * ``` + * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw + */ + ReportError = "reportError", + /** + * The **Sync to sheets** action on Answers and Liveboard visualizations. + * Allows sending data to a Google Sheet. + * @example + * ```js + * disabledActions: [Action.SyncToSheets] + * ``` + * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw + */ + SyncToSheets = "sync-to-sheets", + /** + * 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] + * ``` + * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw + */ + SyncToOtherApps = "sync-to-other-apps", + /** + * The **Manage pipelines** action on Answers and Liveboard visualizations. + * Allows users to manage data sync pipelines to third-party apps. + * @example + * ```js + * disabledActions: [Action.ManagePipelines] + * ``` + * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw + */ + ManagePipelines = "manage-pipeline", + /** + * The **Filter** action on Liveboard visualizations. + * Allows users to apply cross-filters on a Liveboard. + * @example + * ```js + * disabledActions: [Action.CrossFilter] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw + */ + CrossFilter = "context-menu-item-cross-filter", + /** + * The **Sync to Slack** action on Liveboard visualizations. + * Allows sending data to third-party apps Slack + * @example + * ```js + * disabledActions: [Action.SyncToSlack] + * ``` + * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl + */ + SyncToSlack = "syncToSlack", + /** + * The **Sync to Teams** action on Liveboard visualizations. + * Allows sending data to third-party apps Team + * @example + * ```js + * disabledActions: [Action.SyncToTeams] + * ``` + * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl + */ + SyncToTeams = "syncToTeams", + /** + * The **Remove** action that appears when cross filters are applied + * on a Liveboard. + * Removes filters applied o a visualization. + * @example + * ```js + * disabledActions: [Action.RemoveCrossFilter] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + RemoveCrossFilter = "context-menu-item-remove-cross-filter", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuAggregate = "axisMenuAggregate", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuTimeBucket = "axisMenuTimeBucket", + /** + * The **Filter** action in the chart axis or table column + * customization menu. + * Allows adding, editing, or removing filters. + * + * @example + * ```js + * disabledActions: [Action.AxisMenuFilter] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuFilter = "axisMenuFilter", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuConditionalFormat = "axisMenuConditionalFormat", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuSort = "axisMenuSort", + /** + * The **Group** option in the chart axis or table column + * customization menu. + * Allows grouping data points if the axes use the same + * unit of measurement and a similar scale. + * @example + * ```js + * disabledActions: [Action.AxisMenuGroup] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuGroup = "axisMenuGroup", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuPosition = "axisMenuPosition", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuRename = "axisMenuRename", + /** + * 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] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuEdit = "axisMenuEdit", + /** + * The **Number format** action to customize the format of + * the data labels on a chart or table. + * @example + * ```js + * disabledActions: [Action.AxisMenuNumberFormat] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuNumberFormat = "axisMenuNumberFormat", + /** + * The **Text wrapping** action on a table. + * Wraps or clips column text on a table. + * @example + * ```js + * disabledActions: [Action.AxisMenuTextWrapping] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuTextWrapping = "axisMenuTextWrapping", + /** + * The **Remove** action in the chart axis or table column + * customization menu. + * Removes the data labels from a chart or the column of a + * table visualization. + * @example + * ```js + * disabledActions: [Action.AxisMenuRemove] + * ``` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw + */ + AxisMenuRemove = "axisMenuRemove", + /** + * @hidden + */ + InsertInToSlide = "insertInToSlide", + /** + * The **Rename** menu action on Liveboards and visualizations. + * Allows renaming a Liveboard or visualization. + * @example + * ```js + * disabledActions: [Action.RenameModalTitleDescription] + * ``` + * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw + */ + RenameModalTitleDescription = "renameModalTitleDescription", + /** + * The *Request verification* action on a Liveboard. + * Initiates a request for Liveboard verification. + * @example + * ```js + * disabledActions: [Action.RequestVerification] + * ``` + * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw + */ + RequestVerification = "requestVerification", + /** + * + * Allows users to mark a Liveboard as verified. + * @example + * ```js + * disabledActions: [Action.MarkAsVerified] + * ``` + * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw + */ + MarkAsVerified = "markAsVerified", + /** + * The **Add Tab** action on a Liveboard. + * Allows adding a new tab to a Liveboard view. + * @example + * ```js + * disabledActions: [Action.AddTab] + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw + */ + AddTab = "addTab", + /** + * + *Initiates contextual change analysis on KPI charts. + * @example + * ```js + * disabledActions: [Action.EnableContextualChangeAnalysis] + * ``` + * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl + */ + EnableContextualChangeAnalysis = "enableContextualChangeAnalysis", + /** + * Action ID to hide or disable Iterative Change Analysis option + * on contextual change analysis Inisght charts context menu + * + * @example + * ```js + * disabledActions: [Action.EnableIterativeChangeAnalysis] + * ``` + * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl + */ + EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis", + /** + * Action ID to hide or disable Natural Language Search query. + * + * @example + * ```js + * disabledActions: [Action.ShowSageQuery] + * ``` + * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl + */ + ShowSageQuery = "showSageQuery", + /** + * + * Action ID to hide or disable the edit option for the + * results generated from the + * Natural Language Search query. + * + * @example + * ```js + * disabledActions: [Action.EditSageAnswer] + * ``` + * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl + */ + EditSageAnswer = "editSageAnswer", + /** + * The feedback widget for AI-generated Answers. + * Allows users to send feedback on the Answers generated + * from a Natural Language Search query. + * + * @example + * ```js + * disabledActions: [Action.SageAnswerFeedback] + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl + */ + SageAnswerFeedback = "sageAnswerFeedback", + /** + * + * @example + * ```js + * disabledActions: [Action.ModifySageAnswer] + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl + */ + ModifySageAnswer = "modifySageAnswer", + /** + * 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] + * ``` + */ + MoveToTab = "onContainerMove", + /** + * The **Manage Alerts** menu action on KPI visualizations. + * Allows creating, viewing, and editing monitor + * alerts for a KPI chart. + * + * @example + * ```js + * disabledActions: [Action.ManageMonitor] + * ``` + */ + ManageMonitor = "manageMonitor", + /** + * The Liveboard Personalised Views dropdown. + * Allows navigating to a personalized Liveboard View. + * @example + * ```js + * disabledActions: [Action.PersonalisedViewsDropdown] + * ``` + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw + */ + PersonalisedViewsDropdown = "personalisedViewsDropdown", + /** + * Action ID for show or hide the user details on a + * Liveboard (Recently visited / social proof) + * @example + * ```js + * disabledActions: [Action.LiveboardUsers] + * ``` + * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw + */ + LiveboardUsers = "liveboardUsers", + /** + * 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 + * visibleActions: [Action.TML, Action.ExportTML, Action.EditTML] + * + * ``` + * @example + * ```js + * 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, 10.1.0.sw + */ + TML = "tml", + /** + * The **Create Liveboard* action on + * the Liveboards page and the Pin modal. + * Allows users to create a Liveboard. + * + * @example + * ```js + * hiddenAction: [Action.CreateLiveboard] + * disabledActions: [Action.CreateLiveboard] + * ``` + * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw + */ + CreateLiveboard = "createLiveboard", + /** + * Action ID for to hide or disable the + * Verified Liveboard banner. + * @example + * ```js + * hiddenAction: [Action.VerifiedLiveboard] + * ``` + * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw + */ + VerifiedLiveboard = "verifiedLiveboard", + /** + * Action ID for the *Ask Sage* In Natural Language Search embed, + * *Spotter* in Liveboard, full app, and Spotter embed. + * + * Allows initiating a conversation with ThoughtSpot AI analyst. + * + * @example + * ```js + * hiddenAction: [Action.AskAi] + * ``` + * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl + */ + AskAi = "AskAi", + /** + * The **Add KPI to Watchlist** action on Home page watchlist. + * Adds a KPI chart to the watchlist on the Home page. + * @example + * ```js + * disabledActions: [Action.AddToWatchlist] + * ``` + * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl + */ + AddToWatchlist = "addToWatchlist", + /** + * The **Remove from watchlist** menu action on KPI watchlist. + * Removes a KPI chart from the watchlist on the Home page. + * @example + * ```js + * disabledActions: [Action.RemoveFromWatchlist] + * ``` + * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl + */ + RemoveFromWatchlist = "removeFromWatchlist", + /** + * The **Organize Favourites** action on Homepage + * *Favorites* module. + * + * @example + * ```js + * disabledActions: [Action.OrganiseFavourites] + * ``` + * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl + */ + OrganiseFavourites = "organiseFavourites", + /** + * The **AI Highlights** action on a Liveboard. + * + * @example + * ```js + * hiddenAction: [Action.AIHighlights] + * ``` + * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl + */ + AIHighlights = "AIHighlights", + /** + * The *Edit* action on the *Liveboard Schedules* page + * (new Homepage experience). + * Allows editing Liveboard schedules. + * + * @example + * ```js + * disabledActions: [Action.EditScheduleHomepage] + * ``` + * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl + */ + EditScheduleHomepage = "editScheduleHomepage", + /** + * The *Pause* action on the *Liveboard Schedules* page + * Pauses a scheduled Liveboard job. + * @example + * ```js + * disabledActions: [Action.PauseScheduleHomepage] + * ``` + * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl + */ + PauseScheduleHomepage = "pauseScheduleHomepage", + /** + * The **View run history** action **Liveboard Schedules** page. + * Allows viewing schedule run history. + * @example + * ```js + * disabledActions: [Action.ViewScheduleRunHomepage] + * ``` + * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl + */ + ViewScheduleRunHomepage = "viewScheduleRunHomepage", + /** + * Action ID to hide or disable the + * unsubscribe option for Liveboard schedules. + * @example + * ```js + * disabledActions: [Action.UnsubscribeScheduleHomepage] + * ``` + * @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 Cloud: 10.3.0.cl + */ + ManageTags = "manageTags", + /** + * The **Delete** action on the **Liveboard Schedules* page. + * Deletes a Liveboard schedule. + * @example + * ```js + * disabledActions: [Action.DeleteScheduleHomepage] + * ``` + * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl + */ + DeleteScheduleHomepage = "deleteScheduleHomepage", + /** + * The **Analyze CTA** action on KPI chart. + * @example + * ```js + * disabledActions: [Action.KPIAnalysisCTA] + * ``` + * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl + */ + KPIAnalysisCTA = "kpiAnalysisCTA", + /** + * Action ID for disabling chip reorder in Answer and Liveboard + * @example + * ```js + * const disabledActions = [Action.DisableChipReorder] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + DisableChipReorder = "disableChipReorder", + /** + * Action ID to show, hide, or disable filters + * in a Liveboard tab. + * + * @example + * ```js + * hiddenAction: [Action.ChangeFilterVisibilityInTab] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab", + /** + * The **Preview data** button on the Spotter interface. + * Allows previewing the data used for Spotter queries. + * + * @example + * ```js + * hiddenAction: [Action.PreviewDataSpotter] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + PreviewDataSpotter = "previewDataSpotter", + /** + * The **Reset** link on the Spotter interface. + * Resets the conversation with Spotter. + * + * @example + * ```js + * hiddenAction: [Action.ResetSpotterChat] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + ResetSpotterChat = "resetSpotterChat", + /** + * Action ID for hide or disable the + * Spotter feedback widget. + * + * @example + * ```js + * hiddenAction: [Action.SpotterFeedback] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + SpotterFeedback = "spotterFeedback", + /** + * Action ID for hide or disable + * the previous prompt edit option in Spotter. + * + * @example + * ```js + * hiddenAction: [Action.EditPreviousPrompt] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + EditPreviousPrompt = "editPreviousPrompt", + /** + * Action ID for hide or disable + * the previous prompt deletion option in Spotter. + * + * @example + * ```js + * hiddenAction: [Action.DeletePreviousPrompt] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + DeletePreviousPrompt = "deletePreviousPrompt", + /** + * Action ID for hide or disable editing tokens generated from + * Spotter results. + * @example + * ```js + * hiddenAction: [Action.EditTokens] + * ``` + * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl + */ + EditTokens = "editTokens", + /** + * Action ID for hiding rename option for Column rename + * @example + * ```js + * hiddenAction: [Action.ColumnRename] + * ``` + * @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl + */ + ColumnRename = "columnRename", + /** + * Action ID for hide checkboxes for include or exclude + * cover and filter pages in the Liveboard PDF + * @example + * ```js + * hiddenAction: [Action.CoverAndFilterOptionInPDF] + * ``` + * @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl + */ + CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF", + /** + * Action ID for hide or disable the + * Spotter in conversation training widget. + * The Add to Coaching feature is currently in beta + * and is disabled by default on embed deployments. + * To enable this feature on your instance, + * contact ThoughtSpot Support. + * @example + * ```js + * hiddenAction: [Action.InConversationTraining] + * disabledActions: [Action.InConversationTraining] + * + * ``` + * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl + */ + InConversationTraining = "InConversationTraining", + /** + * Action ID to hide the warnings banner in + * Spotter results. It's an EA feature and + * handled by LD. + * @example + * ```js + * hiddenAction: [Action.SpotterWarningsBanner] + * ``` + * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl + */ + SpotterWarningsBanner = "SpotterWarningsBanner", + /** + * Action ID to hide the warnings border on the knowledge + * card in Spotter results. It's an EA feature and + * handled by LD. + * @example + * ```js + * hiddenAction: [Action.SpotterWarningsOnTokens] + * ``` + * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl + */ + SpotterWarningsOnTokens = "SpotterWarningsOnTokens", + /** + * Action ID to disable the click event handler on knowledge + * card in Spotter results. It's an EA feature and + * handled by LD. + * @example + * ```js + * hiddenAction: [Action.SpotterTokenQuickEdit] + * ``` + * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl + */ + SpotterTokenQuickEdit = "SpotterTokenQuickEdit", + /** + * The **PNG screenshot in email** option in the schedule email dialog. + * Includes a PNG screenshot in the notification email body. + * @example + * ```js + * disabledActions: [Action.PngScreenshotInEmail] + * ``` + * ``` + * @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl + */ + PngScreenshotInEmail = "pngScreenshotInEmail", + /** + * The **Remove attachment** action in the schedule email dialog. + * Removes an attachment from the email configuration. + * @example + * ```js + * disabledActions: [Action.RemoveAttachment] + * ``` + * ``` + * ``` + * @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl + */ + RemoveAttachment = "removeAttachment" +} +export declare enum PrefetchFeatures { + FullApp = "FullApp", + SearchEmbed = "SearchEmbed", + LiveboardEmbed = "LiveboardEmbed", + VizEmbed = "VizEmbed" +} +/** + * Enum for options to change context trigger. + * The `BOTH_CLICKS` option is available from 10.8.0.cl. + */ +export declare enum ContextMenuTriggerOptions { + LEFT_CLICK = "left-click", + RIGHT_CLICK = "right-click", + BOTH_CLICKS = "both-clicks" +} +export interface ColumnValue { + column: { + id: string; + name: string; + dataType: string; + [key: string]: any; + }; + value: string | number | boolean | { + v: { + s: number; + e: number; + }; + }; +} +export interface VizPoint { + selectedAttributes: ColumnValue[]; + selectedMeasures: ColumnValue[]; +} +/** + * @group Events + */ +export interface CustomActionPayload { + contextMenuPoints?: { + clickedPoint: VizPoint; + selectedPoints: VizPoint[]; + }; + embedAnswerData: { + name: string; + id: string; + sources: { + header: { + guid: string; + }; + }; + columns: any[]; + data: any[]; + [key: string]: any; + }; + session: SessionInterface; + vizId?: string; +} +export interface CustomAction { + name: string; + id: string; + position: CustomActionsPosition; + target: CustomActionTarget; + metadataIds?: { + answerIds?: string[]; + liveboardIds?: string[]; + vizIds?: string[]; + }; + dataModelIds?: { + modelIds?: string[]; + modelColumnNames?: string[]; + }; + orgIds?: string[]; + groupIds?: string[]; +} +/** + * Enum options to show custom actions at different + * positions in the application. + */ +export declare enum CustomActionsPosition { + PRIMARY = "PRIMARY", + MENU = "MENU", + CONTEXTMENU = "CONTEXTMENU" +} +/** + * Enum options to mention the target of the custom action. + */ +export declare enum CustomActionTarget { + LIVEBOARD = "LIVEBOARD", + VIZ = "VIZ", + ANSWER = "ANSWER", + SPOTTER = "SPOTTER" +} +/** + * Enum options to show or suppress Visual Embed SDK and + * ThoughtSpot application logs in the console output. + * This attribute doesn't support suppressing + * browser warnings or errors. + */ +export declare enum LogLevel { + /** + * No application or SDK-related logs will be logged + * in the console output. + * @example + * ```js + * init({ + * ... //other embed view config, + * logLevel: LogLevel.SILENT, + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl + */ + SILENT = "SILENT", + /** + * Log only errors in the console output. + * @example + * ```js + * init({ + * ... //other embed view config, + * logLevel: LogLevel.ERROR, + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl + */ + ERROR = "ERROR", + /** + * Log only warnings and errors in the console output. + * @example + * ```js + * init({ + * ... //other embed view config, + * logLevel: LogLevel.WARN, + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl + */ + WARN = "WARN", + /** + * Log only the information alerts, warnings, and errors + * in the console output. + * @example + * ```js + * init({ + * ... //other embed view config, + * logLevel: LogLevel.INFO, + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl + */ + INFO = "INFO", + /** + * Log debug messages, warnings, information alerts, + * and errors in the console output. + * @example + * ```js + * init({ + * ... //other embed view config, + * logLevel: LogLevel.DEBUG, + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl + */ + DEBUG = "DEBUG", + /** + * All logs will be logged in the browser console. + * @example + * ```js + * init({ + * ... //other embed view config, + * logLevel: LogLevel.TRACE, + * }) + * ``` + * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl + */ + TRACE = "TRACE" +} +export interface DefaultAppInitData { + customisations: CustomisationsInterface; + authToken: string; + runtimeFilterParams: string | null; + runtimeParameterParams: string | null; + hiddenHomepageModules: HomepageModule[]; + reorderedHomepageModules: string[]; + hostConfig: Record; + hiddenHomeLeftNavItems: string[]; + customVariablesForThirdPartyTools: Record; + hiddenListColumns: ListPageColumns[]; + customActions: CustomAction[]; +} +export declare enum UIPassthroughEvent { + PinAnswerToLiveboard = "addVizToPinboard", + SaveAnswer = "saveAnswer", + GetDiscoverabilityStatus = "getDiscoverabilityStatus", + GetAvailableUIPassthroughs = "getAvailableUiPassthroughs", + GetAnswerConfig = "getAnswerPageConfig", + GetLiveboardConfig = "getPinboardPageConfig" +} +export type UIPassthroughContractBase = { + [UIPassthroughEvent.PinAnswerToLiveboard]: { + request: { + vizId?: string; + newVizName: string; + newVizDescription?: string; + liveboardId?: string; + tabId?: string; + newLiveboardName?: string; + newTabName?: string; + }; + response: { + liveboardId: string; + tabId: string; + vizId: string; + }; + }; + [UIPassthroughEvent.SaveAnswer]: { + request: { + name: string; + description: string; + vizId?: string; + isDiscoverable?: boolean; + }; + response: { + answerId: string; + saveResponse?: any; + shareResponse?: any; + }; + }; + [UIPassthroughEvent.GetDiscoverabilityStatus]: { + request: any; + response: { + shouldShowDiscoverability: boolean; + isDiscoverabilityCheckboxUnselectedPerOrg: boolean; + }; + }; + [UIPassthroughEvent.GetAvailableUIPassthroughs]: { + request: any; + response: { + keys: string[]; + }; + }; + [UIPassthroughEvent.GetAnswerConfig]: { + request: { + vizId?: string; + }; + response: any; + }; + [UIPassthroughEvent.GetLiveboardConfig]: { + request: any; + response: any; + }; +}; +export type UIPassthroughRequest = UIPassthroughContractBase[T]["request"]; +export type UIPassthroughResponse = UIPassthroughContractBase[T]["response"]; +export type UIPassthroughArrayResponse = Array<{ + redId?: string; + value?: UIPassthroughResponse; + error?: any; +}>; +export type EmbedApiHostEventMapping = { + [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard; + [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer; +}; +export type HostEventRequest = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest : any; +export type HostEventResponse = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse : any; +export type TriggerPayload = PayloadT | HostEventRequest; +export type TriggerResponse = PayloadT extends HostEventRequest ? HostEventResponse : any; +declare enum ContextType { + Search = "search", + Liveboard = "liveboard", + Answer = "answer", + Spotter = "spotter", + Default = "default" +} +declare class HostEventClient { + iFrame: HTMLIFrameElement; + constructor(iFrame?: HTMLIFrameElement); + /** + * A wrapper over process trigger to + * @param {HostEvent} message Host event to send + * @param {any} data Data to send with the host event + * @returns {Promise} - the response from the process trigger + */ + protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise; + handleHostEventWithParam(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest): Promise>; + hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise; + /** + * Setter for the iframe element used for host events + * @param {HTMLIFrameElement} iFrame - the iframe element to set + */ + setIframeElement(iFrame: HTMLIFrameElement): void; + triggerUIPassthroughApi(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest): Promise>; + protected handlePinEvent(payload: HostEventRequest): Promise>; + protected handleSaveAnswerEvent(payload: HostEventRequest): Promise; + triggerHostEvent(hostEvent: HostEventT, payload?: TriggerPayload, context?: ContextT): Promise>; +} +declare class TsEmbed { + /** + * The DOM node which was inserted by the SDK to either + * render the iframe or display an error message. + * This is useful for removing the DOM node when the + * embed instance is destroyed. + */ + protected insertedDomEl: Node; + /** + * The DOM node where the ThoughtSpot app is to be embedded. + */ + protected el: HTMLElement; + /** + * The key to store the embed instance in the DOM node + */ + protected embedNodeKey: string; + protected isAppInitialized: boolean; + /** + * A reference to the iframe within which the ThoughtSpot app + * will be rendered. + */ + protected iFrame: HTMLIFrameElement; + /** + * Setter for the iframe element + * @param {HTMLIFrameElement} iFrame HTMLIFrameElement + */ + protected setIframeElement(iFrame: HTMLIFrameElement): void; + protected viewConfig: AllEmbedViewConfig & { + visibleTabs?: string[]; + hiddenTabs?: string[]; + showAlerts?: boolean; + }; + protected embedConfig: EmbedConfig; + /** + * The ThoughtSpot hostname or IP address + */ + protected thoughtSpotHost: string; + protected thoughtSpotV2Base: string; + /** + * A map of event handlers for particular message types triggered + * by the embedded app; multiple event handlers can be registered + * against a particular message type. + */ + private eventHandlerMap; + /** + * A flag that is set to true post render. + */ + protected isRendered: boolean; + /** + * A flag to mark if an error has occurred. + */ + private isError; + /** + * A flag that is set to true post preRender. + */ + private isPreRendered; + /** + * Should we encode URL Query Params using base64 encoding which thoughtspot + * will generate for embedding. This provides additional security to + * thoughtspot clusters against Cross site scripting attacks. + * @default false + */ + private shouldEncodeUrlQueryParams; + private defaultHiddenActions; + private resizeObserver; + protected hostEventClient: HostEventClient; + protected isReadyForRenderPromise: Promise; + /** + * Handler for fullscreen change events + */ + private fullscreenChangeHandler; + constructor(domSelector: DOMSelector, viewConfig?: AllEmbedViewConfig); + /** + * Throws error encountered during initialization. + */ + private throwInitError; + /** + * Handles errors within the SDK + * @param error The error message or object + */ + protected handleError(error: string | Record): void; + /** + * Extracts the type field from the event payload + * @param event The window message event + */ + private getEventType; + /** + * Extracts the port field from the event payload + * @param event The window message event + * @returns + */ + private getEventPort; + /** + * Checks if preauth cache is enabled + * from the view config and embed config + * @returns boolean + */ + private isPreAuthCacheEnabled; + /** + * Checks if current embed is FullAppEmbed with visible primary navbar + * @returns boolean + */ + private isFullAppEmbedWithVisiblePrimaryNavbar; + /** + * fix for ts7.sep.cl + * will be removed for ts7.oct.cl + * @param event + * @param eventType + * @hidden + */ + private formatEventData; + private subscribedListeners; + /** + * Subscribe to network events (online/offline) that should + * work regardless of auth status + */ + private subscribeToNetworkEvents; + /** + * Subscribe to message events that depend on successful iframe setup + */ + private subscribeToMessageEvents; + /** + * Adds event listeners for both network and message events. + * This maintains backward compatibility with the existing method. + * Adds a global event listener to window for "message" events. + * ThoughtSpot detects if a particular event is targeted to this + * embed instance through an identifier contained in the payload, + * and executes the registered callbacks accordingly. + */ + private subscribeToEvents; + private unsubscribeToNetworkEvents; + private unsubscribeToMessageEvents; + private unsubscribeToEvents; + protected getAuthTokenForCookielessInit(): Promise; + protected getDefaultAppInitData(): Promise; + protected getAppInitData(): Promise; + /** + * Send Custom style as part of payload of APP_INIT + * @param _ + * @param responder + */ + private appInitCb; + /** + * Sends updated auth token to the iFrame to avoid user logout + * @param _ + * @param responder + */ + private updateAuthToken; + /** + * Auto Login and send updated authToken to the iFrame to avoid user session logout + * @param _ + * @param responder + */ + private idleSessionTimeout; + /** + * Register APP_INIT event and sendback init payload + */ + private registerAppInit; + /** + * Constructs the base URL string to load the ThoughtSpot app. + * @param query + */ + protected getEmbedBasePath(query: string): string; + protected getUpdateEmbedParamsObject(): Record; + /** + * Common query params set for all the embed modes. + * @param queryParams + * @returns queryParams + */ + protected getBaseQueryParams(queryParams?: Record): Record; + /** + * Constructs the base URL string to load v1 of the ThoughtSpot app. + * This is used for embedding Liveboards, visualizations, and full application. + * @param queryString The query string to append to the URL. + * @param isAppEmbed A Boolean parameter to specify if you are embedding + * the full application. + */ + protected getV1EmbedBasePath(queryString: string): string; + protected getEmbedParams(): string; + protected getEmbedParamsObject(): Record; + protected getRootIframeSrc(): string; + protected createIframeEl(frameSrc: string): HTMLIFrameElement; + protected handleInsertionIntoDOM(child: string | Node): void; + /** + * Renders the embedded ThoughtSpot app in an iframe and sets up + * event listeners. + * @param url - The URL of the embedded ThoughtSpot app. + */ + protected renderIFrame(url: string): Promise; + protected createPreRenderWrapper(): HTMLDivElement; + protected preRenderWrapper: HTMLElement; + protected preRenderChild: HTMLElement; + protected connectPreRendered(): boolean; + protected isPreRenderAvailable(): boolean; + protected createPreRenderChild(child: string | Node): HTMLElement; + protected insertIntoDOMForPreRender(child: string | Node): void; + private showPreRenderByDefault; + protected insertIntoDOM(child: string | Node): void; + /** + * Sets the height of the iframe + * @param height The height in pixels + */ + protected setIFrameHeight(height: number | string): void; + /** + * Executes all registered event handlers for a particular event type + * @param eventType The event type + * @param data The payload invoked with the event handler + * @param eventPort The event Port for a specific MessageChannel + */ + protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void; + /** + * Returns the ThoughtSpot hostname or IP address. + */ + protected getThoughtSpotHost(): string; + /** + * Gets the v1 event type (if applicable) for the EmbedEvent type + * @param eventType The v2 event type + * @returns The corresponding v1 event type if one exists + * or else the v2 event type itself + */ + protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent; + /** + * Calculates the iframe center for the current visible viewPort + * of iframe using Scroll position of Host App, offsetTop for iframe + * in Host app. ViewPort height of the tab. + * @returns iframe Center in visible viewport, + * Iframe height, + * View port height. + */ + protected getIframeCenter(): { + iframeCenter: number; + iframeScrolled: number; + iframeHeight: number; + viewPortHeight: number; + iframeVisibleViewPort: number; + }; + /** + * Registers an event listener to trigger an alert when the ThoughtSpot app + * sends an event of a particular message type to the host application. + * @param messageType The message type + * @param callback A callback as a function + * @param options The message options + * @param isSelf + * @param isRegisteredBySDK + * @example + * ```js + * tsEmbed.on(EmbedEvent.Error, (data) => { + * console.error(data); + * }); + * ``` + * @example + * ```js + * tsEmbed.on(EmbedEvent.Save, (data) => { + * console.log("Answer save clicked", data); + * }, { + * start: true // This will trigger the callback on start of save + * }); + * ``` + */ + on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype; + /** + * Removes an event listener for a particular event type. + * @param messageType The message type + * @param callback The callback to remove + * @example + * ```js + * const errorHandler = (data) => { console.error(data); }; + * tsEmbed.on(EmbedEvent.Error, errorHandler); + * tsEmbed.off(EmbedEvent.Error, errorHandler); + * ``` + */ + off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype; + /** + * Triggers an event on specific Port registered against + * for the EmbedEvent + * @param eventType The message type + * @param data The payload to send + * @param eventPort + * @param payload + */ + private triggerEventOnPort; + /** + * @hidden + * Internal state to track if the embed container is loaded. + * This is used to trigger events after the embed container is loaded. + */ + isEmbedContainerLoaded: boolean; + /** + * @hidden + * Internal state to track the callbacks to be executed after the embed container + * is loaded. + * This is used to trigger events after the embed container is loaded. + */ + private embedContainerReadyCallbacks; + protected getPreRenderObj(): T; + private checkEmbedContainerLoaded; + private executeEmbedContainerReadyCallbacks; + /** + * Executes a callback after the embed container is loaded. + * @param callback The callback to execute + */ + protected executeAfterEmbedContainerLoaded(callback: () => void): void; + protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void; + /** + * 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(messageType: HostEventT, data?: TriggerPayload, context?: ContextT): Promise>; + /** + * Triggers an event to the embedded app, skipping the UI flow. + * @param {UIPassthroughEvent} apiName - The name of the API to be triggered. + * @param {UIPassthroughRequest} parameters - The parameters to be passed to the API. + * @returns {Promise} - A promise that resolves with the response + * from the embedded app. + */ + triggerUIPassThrough(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest): Promise>; + /** + * Marks the ThoughtSpot object to have been rendered + * Needs to be overridden by subclasses to do the actual + * rendering of the iframe. + * @param args + */ + render(): Promise; + getIframeSrc(): string; + protected handleRenderForPrerender(): Promise; + getCurrentContext(): Promise; + /** + * Creates the preRender shell + * @param showPreRenderByDefault - Show the preRender after render, hidden by default + */ + preRender(showPreRenderByDefault?: boolean, replaceExistingPreRender?: boolean): Promise; + /** + * Get the Post Url Params for THOUGHTSPOT from the current + * host app URL. + * THOUGHTSPOT URL params starts with a prefix "ts-" + * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw + */ + getThoughtSpotPostUrlParams(additionalParams?: { + [key: string]: string | number; + }): string; + /** + * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. + * @version SDK: 1.19.1 | ThoughtSpot: * + */ + destroy(): void; + getUnderlyingFrameElement(): HTMLIFrameElement; + /** + * 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. + * @version SDK: 1.22.0 + * @returns + */ + prerenderGeneric(): Promise; + protected beforePrerenderVisible(): void; + private validatePreRenderViewConfig; + /** + * 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. + */ + showPreRender(): Promise; + /** + * 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. + * @throws {Error} Throws an error if the embedding element (passed as domSelector) + * is not defined or not found. + */ + syncPreRenderStyle(): void; + /** + * Hides the PreRender component if it is available. + * If the component is not preRendered, it issues a warning. + */ + hidePreRender(): void; + /** + * Retrieves unique HTML element IDs for PreRender-related elements. + * These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'. + * @returns {object} An object containing the IDs for the PreRender elements. + * @property {string} wrapper - The HTML element ID for the PreRender wrapper. + * @property {string} child - The HTML element ID for the PreRender child. + */ + getPreRenderIds(): { + wrapper: string; + child: string; + }; + /** + * Returns the answerService which can be used to make arbitrary graphql calls on top + * session. + * @param vizId [Optional] to get for a specific viz in case of a Liveboard. + * @version SDK: 1.25.0 / ThoughtSpot 9.10.0 + */ + getAnswerService(vizId?: string): Promise; + /** + * Set up fullscreen change detection to automatically trigger ExitPresentMode + * when user exits fullscreen mode + */ + private setupFullscreenChangeHandler; + /** + * Remove fullscreen change handler + */ + private removeFullscreenChangeHandler; +} +declare class V1Embed extends TsEmbed { + protected viewConfig: AllEmbedViewConfig; + constructor(domSelector: DOMSelector, viewConfig: AllEmbedViewConfig); + /** + * Render the app in an iframe and set up event handlers + * @param iframeSrc + */ + protected renderV1Embed(iframeSrc: string): Promise; + protected getRootIframeSrc(): string; + /** + * @inheritdoc + * @example + * ```js + * tsEmbed.on(EmbedEvent.Error, (data) => { + * console.error(data); + * }); + * ``` + * @example + * ```js + * tsEmbed.on(EmbedEvent.Save, (data) => { + * console.log("Answer save clicked", data); + * }, { + * start: true // This will trigger the callback on start of save + * }); + * ``` + */ + 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; +} +/** + * Pages within the ThoughtSpot app that can be embedded. + */ +export declare enum Page { + /** + * Home page + */ + Home = "home", + /** + * Search page + */ + Search = "search", + /** + * Saved answers listing page + */ + Answers = "answers", + /** + * Liveboards listing page + */ + Liveboards = "liveboards", + /** + * @hidden + */ + Pinboards = "pinboards", + /** + * Data management page + */ + Data = "data", + /** + * SpotIQ listing page + */ + SpotIQ = "insights", + /** + * Monitor Alerts Page + */ + Monitor = "monitor" +} +/** + * Define the initial state os column custom group accordions + * in data panel v2. + */ +export declare enum DataPanelCustomColumnGroupsAccordionState { + /** + * Expand all the accordion initially in data panel v2. + */ + EXPAND_ALL = "EXPAND_ALL", + /** + * Collapse all the accordions initially in data panel v2. + */ + COLLAPSE_ALL = "COLLAPSE_ALL", + /** + * Expand the first accordion and collapse the rest. + */ + EXPAND_FIRST = "EXPAND_FIRST" +} +export declare enum HomePageSearchBarMode { + OBJECT_SEARCH = "objectSearch", + AI_ANSWER = "aiAnswer", + NONE = "none" +} +/** + * Define the version of the primary navbar + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ +export declare enum PrimaryNavbarVersion { + /** + * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher, + * along with updates to the top navigation bar. + * It serves as the foundational version of the PrimaryNavBar. + */ + Sliding = "v3" +} +/** + * Define the version of the home page + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ +export declare enum HomePage { + /** + * Modular (v2) introduces the updated Modular Home Experience. + * It serves as the foundational version of the home page. + */ + Modular = "v2", + /** + * ModularWithStylingChanges (v3) introduces Modular Home Experience + * with styling changes. + */ + ModularWithStylingChanges = "v3" +} +/** + * Define the version of the list page + * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl + */ +export declare enum ListPage { + /** + * List (v2) is the traditional List Experience. + * It serves as the foundational version of the list page. + */ + List = "v2", + /** + * ListWithUXChanges (v3) introduces the new updated list page with UX changes. + */ + ListWithUXChanges = "v3" +} +/** + * Define the discovery experience + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + */ +export interface DiscoveryExperience { + /** + * primaryNavbarVersion determines the version of the navigation version. + */ + primaryNavbarVersion?: PrimaryNavbarVersion; + /** + * homePage determines the version of the home page. + */ + homePage?: HomePage; + /** + * listPageVersion determines the version of the list page. + */ + listPageVersion?: ListPage; +} +/** + * The view configuration for full app embedding. + * @group Embed components + */ +export interface AppViewConfig extends AllEmbedViewConfig { + /** + * If true, the top navigation bar within the ThoughtSpot app + * is displayed. By default, the navigation bar is hidden. + * This flag also controls the homepage left navigation bar. + * + * Supported embed types: `AppEmbed` + * @default true + * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * showPrimaryNavbar:true, + * }) + * ``` + */ + showPrimaryNavbar?: boolean; + /** + * Control the visibility of the left navigation bar on the Homepage. + * If showPrimaryNavbar is true, that is, if the Global and Homepage + * nav-bars are visible, this flag will only hide the homepage left nav-bar. + * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav. + * + * **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). + * + * Supported embed types: `AppEmbed` + * @default false + * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideHomepageLeftNav : true, + * }) + * ``` + */ + hideHomepageLeftNav?: boolean; + /** + * Control the visibility of the help (?) and profile buttons on the + * Global nav-bar. By default, these buttons are visible on the nav-bar. + * + * Supported embed types: `AppEmbed` + * @default false + * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * disableProfileAndHelp: true, + * }) + * ``` + */ + disableProfileAndHelp?: boolean; + /** + * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl + * @default true + * Whether the help menu in the top nav bar should be served + * from Pendo or ThoughtSpot's internal help items. + * + * Supported embed types: `AppEmbed` + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * enablePendoHelp: false, + * }); + * ``` + */ + enablePendoHelp?: boolean; + /** + * Control the visibility of the hamburger icon on the top nav bar + * available when new navigation V3 is enabled. + * + * Supported embed types: `AppEmbed` + * @default false + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideHamburger : true, + * }) + * ``` + */ + hideHamburger?: boolean; + /** + * Control the visibility of the Eureka search on the top nav bar + * this will control for both new V2 and new navigation V3. + * + * Supported embed types: `AppEmbed` + * @default true + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideObjectSearch: false, + * }) + * ``` + */ + hideObjectSearch?: boolean; + /** + * Control the visibility of the notification on the top nav bar V3, + * available when new navigation V3 is enabled. + * + * Supported embed types: `AppEmbed` + * @default true + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideNotification: false, + * }) + * ``` + */ + hideNotification?: boolean; + /** + * Control the visibility of the application switcher button on the nav-bar. + * By default, the application switcher is shown. + * + * **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). + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl + * @default false + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideApplicationSwitcher : true, + * }) + * ``` + */ + hideApplicationSwitcher?: boolean; + /** + * Control the visibility of the Org switcher button on the nav-bar. + * By default, the Org switcher button is shown. + * + * **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). + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl + * @default true + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideOrgSwitcher : true, + * }) + * ``` + */ + hideOrgSwitcher?: boolean; + /** + * A URL path to the embedded application page + * If both path and pageId attributes are defined, the path definition + * takes precedence. This is the path post the `#/` in the URL of the standalone + * ThoughtSpot app. Use this to open the embedded view to a specific path. + * + * For eg, if you want the component to open to a specific Liveboard + * you could set the path to `pinboard//tab/`. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * path:"pinboard/1234/tab/7464", + * }) + * ``` + */ + path?: string; + /** + * The application page to set as the start page + * in the embedded view. + * + * Use this to open to particular page in the app. To open to a specific + * path within the app, use the `path` attribute which is more flexible. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * pageId : Page.Answers | Page.Data, + * }) + * ``` + */ + pageId?: Page; + /** + * This puts a filter tag on the application. All metadata lists in the + * application, such as Liveboards and answers, would be filtered by this + * tag. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * tag:'value', + * }) + * ``` + */ + tag?: string; + /** + * Hide tag filter chips that appear when content is filtered by tags. + * When enabled, this automatically: + * - Hides tag filter indicators/chips from the UI + * + * This provides a clean interface without tag-related UI elements. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl + * @example + * ```js + * // Simple usage - automatically hides all tag-related UI + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * tag: 'Some Tag', + * hideTagFilterChips: true, // This is all you need! + * }); + * ``` + */ + hideTagFilterChips?: boolean; + /** + * The array of GUIDs to be hidden + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * hideObjects: [ + * '430496d6-6903-4601-937e-2c691821af3c', + * 'f547ec54-2a37-4516-a222-2b06719af726' + * ] + * }) + * ``` + */ + hideObjects?: string[]; + /** + * Render liveboards using the new v2 rendering mode + * This is a transient flag which is primarily meant for internal use + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw + * @hidden + */ + liveboardV2?: boolean; + /** + * If set to true, the Search Assist feature is enabled. + * + * Supported embed types: `AppEmbed` + * @default true + * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * enableSearchAssist: true, + * }) + * ``` + */ + enableSearchAssist?: boolean; + /** + * If set to true, the Liveboard 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. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * fullHeight: true, + * }) + * ``` + */ + fullHeight?: boolean; + /** + * Flag to control new Modular Home experience. + * + * Supported embed types: `AppEmbed` + * @default false + * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * modularHomeExperience : true, + * }) + * ``` + */ + modularHomeExperience?: boolean; + /** + * To configure the top-left navigation and home page experience + * + * Supported embed types: `AppEmbed` + * @default false + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * discoveryExperience : { + * primaryNavbarVersion: PrimaryNavbarVersion.Sliding, + * homePage: HomePage.Modular, + * }, + * }) + * ``` + */ + discoveryExperience?: DiscoveryExperience; + /** + * To set the initial state of the search bar in case of saved-answers. + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl + * @default false + * @deprecated Use {@link collapseSearchBar} instead + */ + collapseSearchBarInitially?: boolean; + /** + * This controls the initial behaviour of custom column groups accordion. + * It takes DataPanelCustomColumnGroupsAccordionState enum values as input. + * List of different enum values:- + * - EXPAND_ALL: Expand all the accordion initially in data panel v2. + * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2. + * - EXPAND_FIRST: Expand the first accordion and collapse the rest. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl + * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL + * @example + * ```js + * const embed = new AppEmbed('#embed', { + * ... // other app view config + * dataPanelCustomGroupsAccordionInitialState: + * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, + * }); + * ``` + */ + dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState; + /** + * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`. + * @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl + */ + isOnBeforeGetVizDataInterceptEnabled?: boolean; + /** + * Flag to use home page search bar mode + * + * Supported embed types: `AppEmbed` + * @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl + */ + homePageSearchBarMode?: HomePageSearchBarMode; + /** + * This flag is used to enable unified search experience for full app embed. + * + * Supported embed types: `AppEmbed` + * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl + * @default true + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * isUnifiedSearchExperienceEnabled: true, + * }) + * ``` + */ + isUnifiedSearchExperienceEnabled?: boolean; + /** + * This flag is used to enable/disable the styling and grouping in a Liveboard + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @type {boolean} + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * isLiveboardStylingAndGroupingEnabled: true, + * }) + * ``` + */ + isLiveboardStylingAndGroupingEnabled?: boolean; + /** + * This flag is used to enable/disable the png embedding of liveboard in scheduled mails + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @type {boolean} + * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * isPNGInScheduledEmailsEnabled: true, + * }) + * ``` + */ + isPNGInScheduledEmailsEnabled?: boolean; + /** + * This flag is used to enable the full height lazy load data. + * + * @example + * ```js + * const embed = new AppEmbed('#embed-container', { + * // ...other options + * fullHeight: true, + * lazyLoadingForFullHeight: true, + * }) + * ``` + * + * @type {boolean} + * @default false + * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl + */ + lazyLoadingForFullHeight?: boolean; + /** + * The margin to be used for lazy loading. + * + * For example, if the margin is set to '10px', + * the visualization will be loaded 10px before the its top edge is visible in the + * viewport. + * + * The format is similar to CSS margin. + * + * @example + * ```js + * const embed = new AppEmbed('#embed-container', { + * // ...other options + * fullHeight: true, + * lazyLoadingForFullHeight: true, + * // Using 0px, the visualization will be only loaded when its visible in the viewport. + * lazyLoadingMargin: '0px', + * }) + * ``` + * @type {string} + * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl + */ + lazyLoadingMargin?: string; +} +/** + * Embeds full ThoughtSpot experience in a host application. + * @group Embed components + */ +export declare class AppEmbed extends V1Embed { + protected viewConfig: AppViewConfig; + private defaultHeight; + constructor(domSelector: DOMSelector, viewConfig: AppViewConfig); + /** + * Constructs a map of parameters to be passed on to the + * embedded Liveboard or visualization. + */ + protected getEmbedParams(): string; + private sendFullHeightLazyLoadData; + /** + * This is a handler for the RequestVisibleEmbedCoordinates event. + * It is used to send the visible coordinates data to the host application. + * @param data The event payload + * @param responder The responder function + */ + private requestVisibleEmbedCoordinatesHandler; + /** + * Constructs the URL of the ThoughtSpot app page to be rendered. + * @param pageId The ID of the page to be embedded. + */ + getIFrameSrc(): string; + /** + * Set the iframe height as per the computed height received + * from the ThoughtSpot app. + * @param data The event payload + */ + protected updateIFrameHeight: (data: MessagePayload) => void; + private embedIframeCenter; + private setIframeHeightForNonEmbedLiveboard; + /** + * Gets the ThoughtSpot route of the page for a particular page ID. + * @param pageId The identifier for a page in the ThoughtSpot app. + * @param modularHomeExperience + */ + private getPageRoute; + /** + * Formats the path provided by the user. + * @param path The URL path. + * @returns The URL path that the embedded app understands. + */ + private formatPath; + /** + * Navigate to particular page for app embed. eg:answers/pinboards/home + * This is used for embedding answers, pinboards, visualizations and full application + * only. + * @param path string | number The string, set to iframe src and navigate to new page + * eg: appEmbed.navigateToPage('pinboards') + * When used with `noReload` (default: true) this can also be a number + * like 1/-1 to go forward/back. + * @param noReload boolean Trigger the navigation without reloading the page + * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw + */ + navigateToPage(path: string | number, noReload?: boolean): void; + /** + * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + destroy(): void; + private postRender; + private registerLazyLoadEvents; + private unregisterLazyLoadEvents; + /** + * Renders the embedded application pages in the ThoughtSpot app. + * @param renderOptions An object containing the page ID + * to be embedded. + */ + render(): Promise; +} +/** + * Enum for auth failure types. This is the parameter passed to the listner + * of {@link AuthStatus.FAILURE}. + * @group Authentication / Init + */ +export declare enum AuthFailureType { + SDK = "SDK", + NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS", + EXPIRY = "EXPIRY", + OTHER = "OTHER", + IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT", + UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE" +} +/** + * Enum for auth status emitted by the emitter returned from {@link init}. + * @group Authentication / Init + */ +export declare enum AuthStatus { + /** + * Emits when the SDK fails to authenticate + */ + FAILURE = "FAILURE", + /** + * Emits when the SDK authenticates successfully + */ + SDK_SUCCESS = "SDK_SUCCESS", + /** + * @hidden + * Emits when iframe is loaded and session info is available + */ + SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS", + /** + * Emits when the app sends an authentication success message + */ + SUCCESS = "SUCCESS", + /** + * Emits when a user logs out + */ + LOGOUT = "LOGOUT", + /** + * Emitted when inPopup is true in the SAMLRedirect flow and the + * popup is waiting to be triggered either programmatically + * or by the trigger button. + * @version SDK: 1.19.0 + */ + WAITING_FOR_POPUP = "WAITING_FOR_POPUP", + /** + * Emitted when the SAML popup is closed without authentication + */ + SAML_POPUP_CLOSED_NO_AUTH = "SAML_POPUP_CLOSED_NO_AUTH" +} +/** + * Event emitter returned from {@link init}. + * @group Authentication / Init + */ +export interface AuthEventEmitter { + /** + * Register a listener on Auth failure. + * @param event + * @param listener + */ + on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this; + /** + * Register a listener on Auth SDK success. + * @param event + * @param listener + */ + on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this; + on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this; + once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this; + once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this; + once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this; + /** + * Trigger an event on the emitter returned from init. + * @param {@link AuthEvent} + */ + emit(event: AuthEvent, ...args: any[]): boolean; + /** + * Remove listener from the emitter returned from init. + * @param event + * @param listener + * @param context + * @param once + */ + off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this; + /** + * Remove all the event listeners + * @param event + */ + removeAllListeners(event: AuthStatus): this; +} +/** + * Events which can be triggered on the emitter returned from {@link init}. + * @group Authentication / Init + */ +export declare enum AuthEvent { + /** + * Manually trigger the SSO popup. This is useful when + * authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true + */ + TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP" +} +export interface executeTMLInput { + metadata_tmls: string[]; + import_policy?: "PARTIAL" | "ALL_OR_NONE" | "VALIDATE_ONLY"; + create_new?: boolean; +} +export interface exportTMLInput { + metadata: { + identifier: string; + type?: "LIVEBOARD" | "ANSWER" | "LOGICAL_TABLE" | "CONNECTION"; + }[]; + export_associated?: boolean; + export_fqn?: boolean; + edoc_format?: "YAML" | "JSON"; +} +/** + * Prefetches static resources from the specified URL. Web browsers can then cache the + * prefetched resources and serve them from the user's local disk to provide faster access + * to your app. + * @param url The URL provided for prefetch + * @param prefetchFeatures Specify features which needs to be prefetched. + * @param additionalFlags This can be used to add any URL flag. + * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1 + * @group Global methods + */ +export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: { + [key: string]: string | number | boolean; +}) => void; +/** + * Initializes the Visual Embed SDK globally and perform + * authentication if applicable. This function needs to be called before any ThoughtSpot + * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS + * to actually embed. That is handled internally. + * @param embedConfig The configuration object containing ThoughtSpot host, + * authentication mechanism and so on. + * @example + * ```js + * const authStatus = init({ + * thoughtSpotHost: 'https://my.thoughtspot.cloud', + * authType: AuthType.None, + * }); + * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here }); + * ``` + * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success, + * failure and logout. See {@link AuthStatus} + * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1 + * @group Authentication / Init + */ +export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter; +/** + * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to + * prevent the SDK from automatically logging in again. + * + * You can call the `init` method again to re login, if autoLogin is set to + * true in this second call it will be honored. + * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin + * @returns Promise which resolves when logout completes. + * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw + * @group Global methods + */ +export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise; +/** + * Imports TML representation of the metadata objects into ThoughtSpot. + * @param data + * @returns imports TML data into ThoughtSpot + * @example + * ```js + * 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 + */ +export declare const executeTML: (data: executeTMLInput) => Promise; +/** + * 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); + * }); + * ``` + * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl + * @group Global methods + */ +export declare const exportTML: (data: exportTMLInput) => Promise; +declare enum ContextType$1 { + Search = "search", + Liveboard = "liveboard", + Answer = "answer", + Spotter = "spotter", + Default = "default" +} +declare enum PageType { + PAGE = "page", + DIALOG = "dialog" +} +export interface ObjectIds { + answerId?: string; + liveboardId?: string; + vizIds?: string[]; + dataModelIds?: string[]; +} +export type PageContextOptions = { + page: ContextType$1; + pageType: PageType; + objectIds: ObjectIds; +}; +/** + * The configuration for the embedded Liveboard or visualization page view. + * @group Embed components + */ +export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, LiveboardAppEmbedViewConfig { + /** + * 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 + * + * Supported embed types: `LiveboardEmbed` + * @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. + * + * Supported embed types: `LiveboardEmbed` + * @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 embed view config + * 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. + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1 + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * liveboardId:id of liveboard, + * }) + */ + liveboardId?: string; + /** + * To support backward compatibility + * @hidden + */ + pinboardId?: string; + /** + * The visualization within the Liveboard to display. + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * 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) + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * 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. + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * 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. + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * liveboardV2:true, + * }) + * ``` + */ + liveboardV2?: boolean; + /** + * Set a Liveboard tab as an active tab. + * Specify the tab ID. + * + * Supported embed types: `LiveboardEmbed` + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * 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. + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * hideTabPanel:true, + * }) + * ``` + */ + hideTabPanel?: 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. + * + * Supported embed types: `LiveboardEmbed` + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * liveboardId: 'liveboard-id', + * vizId: 'viz-id', + * showPreviewLoader: true, + * }); + * embed.render(); + * ``` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl + */ + showPreviewLoader?: boolean; + /** + * The Liveboard to run on regular intervals to fetch the cdw token. + * + * Supported embed types: `LiveboardEmbed` + * @hidden + * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * oAuthPollingInterval: value in milliseconds, + * }) + */ + oAuthPollingInterval?: number; + /** + * The Liveboard is set to force a token fetch during the initial load. + * + * Supported embed types: `LiveboardEmbed` + * @hidden + * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * isForceRedirect: false, + * }) + */ + isForceRedirect?: boolean; + /** + * The source connection ID for authentication. + * @hidden + * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl + * + * Supported embed types: `LiveboardEmbed` + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... //other embed view config + * dataSourceId: '', + * }) + */ + dataSourceId?: string; + /** + * The list of tab IDs to hide from the embedded. + * This Tabs will be hidden from their respective LBs. + * Use this to hide an tabID. + * + * Supported embed types: `LiveboardEmbed` + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... // other embed view config + * hiddenTabs: [ + * '430496d6-6903-4601-937e-2c691821af3c', + * 'f547ec54-2a37-4516-a222-2b06719af726' + * ] + * }); + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw + */ + hiddenTabs?: string[]; + /** + * The list of tab IDs to show in the embedded Liveboard. + * Only the tabs specified in the array will be shown in the Liveboard. + * + * Use either `visibleTabs` or `hiddenTabs`. + * + * Supported embed types: `LiveboardEmbed` + * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw + * @example + * ```js + * const embed = new LiveboardEmbed('#tsEmbed', { + * ... // other embed view config + * visibleTabs: [ + * '430496d6-6903-4601-937e-2c691821af3c', + * 'f547ec54-2a37-4516-a222-2b06719af726' + * ] + * }) + * ``` + */ + visibleTabs?: string[]; + /** + * This flag is used to enable/disable the styling and grouping in a Liveboard + * + * Supported embed types: `LiveboardEmbed`, `AppEmbed` + * @type {boolean} + * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * isLiveboardStylingAndGroupingEnabled: true, + * }) + * ``` + */ + isLiveboardStylingAndGroupingEnabled?: boolean; + /** + * This flag is used to enable/disable the png embedding of liveboard in scheduled mails + * + * Supported embed types: `AppEmbed`, `LiveboardEmbed` + * @type {boolean} + * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl + * @example + * ```js + * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * isPNGInScheduledEmailsEnabled: true, + * }) + * ``` + */ + isPNGInScheduledEmailsEnabled?: boolean; + /** + * This flag is used to enable the full height lazy load data. + * + * @example + * ```js + * const embed = new LiveboardEmbed('#embed-container', { + * // ...other options + * fullHeight: true, + * lazyLoadingForFullHeight: true, + * }) + * ``` + * + * @type {boolean} + * @default false + * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl + */ + lazyLoadingForFullHeight?: boolean; + /** + * The margin to be used for lazy loading. + * + * For example, if the margin is set to '10px', + * the visualization will be loaded 10px before the its top edge is visible in the + * viewport. + * + * The format is similar to CSS margin. + * + * @example + * ```js + * const embed = new LiveboardEmbed('#embed-container', { + * // ...other options + * fullHeight: true, + * lazyLoadingForFullHeight: true, + * // Using 0px, the visualization will be only loaded when its visible in the viewport. + * lazyLoadingMargin: '0px', + * }) + * ``` + * @type {string} + * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl + */ + lazyLoadingMargin?: string; + /** + * showSpotterLimitations : show limitation text + * of the spotter underneath the chat input. + * default is false. + * + * @example + * ```js + * const embed = new LiveboardEmbed('#embed-container', { + * // ...other options + * showSpotterLimitations: true, + * }) + * ``` + * @type {boolean} + * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl + */ + showSpotterLimitations?: 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: , + * // .. 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; + protected getEmbedParamsObject(): any; + private getIframeSuffixSrc; + private sendFullHeightLazyLoadData; + /** + * This is a handler for the RequestVisibleEmbedCoordinates event. + * It is used to send the visible coordinates data to the host application. + * @param data The event payload + * @param responder The responder function + */ + private requestVisibleEmbedCoordinatesHandler; + /** + * 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; + /** + * @hidden + * Internal state to track the current liveboard id. + * This is used to navigate to the correct liveboard when the prerender is visible. + */ + currentLiveboardState: { + liveboardId: string; + vizId: string; + activeTabId: string; + }; + protected beforePrerenderVisible(): void; + protected handleRenderForPrerender(): Promise; + /** + * 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(messageType: HostEventT, data?: TriggerPayload, context?: ContextT): Promise>; + /** + * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. + * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + */ + destroy(): void; + private postRender; + private registerLazyLoadEvents; + private unregisterLazyLoadEvents; + /** + * Render an embedded ThoughtSpot Liveboard or visualization + * @param renderOptions An object specifying the Liveboard ID, + * visualization ID and the runtime filters. + */ + render(): Promise; + 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; + getCurrentContext(): Promise; +} +/** + * @hidden + */ +export declare class PinboardEmbed extends LiveboardEmbed { +} +/** + * Configuration for search options. + * + */ +export interface SearchOptions { + /** + * Search tokens to pass in the query. + */ + searchTokenString: string; + /** + * Boolean to define if the search should be executed or not. + * If it is executed, the focus is placed on the results. + * If it’s not executed, the focus is placed at the end of + * the token string in the search bar. + */ + executeSearch?: boolean; +} +declare enum DataPanelCustomColumnGroupsAccordionState$1 { + /** + * Expand all the accordion initially in data panel v2. + */ + EXPAND_ALL = "EXPAND_ALL", + /** + * Collapse all the accordions initially in data panel v2. + */ + COLLAPSE_ALL = "COLLAPSE_ALL", + /** + * Expand the first accordion and collapse the rest. + */ + EXPAND_FIRST = "EXPAND_FIRST" +} +/** + * The configuration attributes for the embedded search view. + * @group Embed components + */ +export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit { + /** + * If set to true, the data sources panel is collapsed on load, + * but can be expanded manually. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * collapseDataSources:true, + * }) + * ``` + */ + collapseDataSources?: boolean; + /** + * If set to true, the data panel is collapsed on load, + * but can be expanded manually. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * collapseDataPanel:true, + * }) + * ``` + */ + collapseDataPanel?: boolean; + /** + * Show or hide the data sources panel. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * hideDataSources:true, + * }) + * ``` + */ + hideDataSources?: boolean; + /** + * Show or hide the charts and tables in search answers. + * This attribute can be used to create a custom visualization + * using raw answer data. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * hideResults:true, + * }) + * ``` + */ + hideResults?: boolean; + /** + * If set to true, the Search Assist feature is enabled. + * + * Supported embed types: `SearchEmbed` + * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * enableSearchAssist:true, + * }) + * ``` + */ + enableSearchAssist?: boolean; + /** + * If set to true, the tabular view is set as the default + * format for presenting search data. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * forceTable:true, + * }) + */ + forceTable?: boolean; + /** + * The array of data source GUIDs to set on load. + * Only a single data source is supported currently. + * @deprecated Use `dataSource` instead. + * + * Supported embed types: `SearchEmbed` + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * dataSources:['id-234','id-456'], + * }) + * ``` + */ + dataSources?: string[]; + /** + * The array of data source GUIDs to set on load. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.19.0 + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * dataSource:'id-234', + * }) + * ``` + */ + dataSource?: string; + /** + * The initial search query to load the answer with. + * @deprecated + * + * Use {@link searchOptions} instead. + */ + searchQuery?: string; + /** + * Configuration for search options. + * Includes the following properties: + * + * `searchTokenString`: Search tokens to pass in the query. + * + * `executeSearch`: Boolean to define if the search should be executed or not. + * If it is executed, the focus is placed on the results. + * If it’s not executed, the focus is placed at the end of + * the token string in the search bar. + * + * Supported embed types: `SearchEmbed` + * @example + * ```js + * searchOptions: { + * searchTokenString: '[quantity purchased] [region]', + * executeSearch: true, + * } + * ``` + */ + searchOptions?: SearchOptions; + /** + * Exclude the search token string from the URL. + * If set to true, the search token string is not appended to the URL. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * searchOptions: { + * searchTokenString: '[quantity purchased] [region]', + * executeSearch: true, + * }, + * excludeSearchTokenStringFromURL: true, + * }); + * ``` + */ + excludeSearchTokenStringFromURL?: boolean; + /** + * The GUID of a saved answer to load initially. + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * answerId:'sed-1234', + * }) + * ``` + */ + answerId?: string; + /** + * If set to true, the search page will render without the Search Bar + * The chart/table should still be visible. + * + * Supported embed types: `SearchEmbed` + * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * hideSearchBar:true, + * }) + * ``` + */ + hideSearchBar?: boolean; + /** + * Flag to set if last selected dataSource should be used + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.24.0 + */ + useLastSelectedSources?: boolean; + /** + * To set the initial state of the search bar in case of saved-answers. + * @default false + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl + * @deprecated Use {@link collapseSearchBar} instead + */ + collapseSearchBarInitially?: boolean; + /** + * Flag to enable onBeforeSearchExecute Embed Event + * + * Supported embed types: `SearchEmbed` + * @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl + */ + isOnBeforeGetVizDataInterceptEnabled?: boolean; + /** + * This controls the initial behaviour of custom column groups accordion. + * It takes DataPanelCustomColumnGroupsAccordionState enum values as input. + * List of different enum values:- + * - EXPAND_ALL: Expand all the accordion initially in data panel v2. + * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2. + * - EXPAND_FIRST: Expand the first accordion and collapse the rest. + * + * Supported embed types: `SearchEmbed` + * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl + * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * dataPanelCustomGroupsAccordionInitialState: + * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, + * }); + * ``` + */ + dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState$1; + /** + * Flag to remove focus from search bar initially when user + * lands on search embed page. + * + * Supported embed types: `SearchEmbed` + * @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl + * @default true + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * ... // other embed view config + * focusSearchBarOnRender: false, + * }); + * ``` + */ + focusSearchBarOnRender?: boolean; +} +export interface SearchAppInitData extends DefaultAppInitData { + searchOptions?: SearchOptions; +} +/** + * Embed ThoughtSpot search + * @group Embed components + */ +export declare class SearchEmbed extends TsEmbed { + /** + * The view configuration for the embedded ThoughtSpot search. + */ + protected viewConfig: SearchViewConfig; + constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig); + /** + * Get the state of the data sources panel that the embedded + * ThoughtSpot search will be initialized with. + */ + private getDataSourceMode; + protected getSearchInitData(): { + searchOptions?: { + searchTokenString: string; + }; + }; + protected getAppInitData(): Promise; + protected getEmbedParamsObject(): Record; + protected getEmbedParams(): string; + /** + * Construct the URL of the embedded ThoughtSpot search to be + * loaded in the iframe + * @param answerId The GUID of a saved answer + * @param dataSources A list of data source GUIDs + */ + getIFrameSrc(): string; + /** + * Render the embedded ThoughtSpot search + */ + render(): Promise; + getCurrentContext(): Promise; +} +/** + * @group Embed components + */ +export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig { + /** + * The array of data source GUIDs to set on load. + * Only a single data source is supported currently. + * + * Supported embed types: `SearchBarEmbed` + * @deprecated Use `dataSource` instead + * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw + * @example + * ```js + * const embed = new SearchBarEmbed('#tsEmbed', { + * ... //other embed view config + * dataSources:['id-2345','id-2345'], + * }) + * ``` + */ + dataSources?: string[]; + /** + * Pass the ID of the source to be selected. + * + * Supported embed types: `SearchBarEmbed` + * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw + * @example + * ```js + * const embed = new SearchBarEmbed('#tsEmbed', { + * ... //other embed view config + * dataSource:'id-2345', + * }) + * ``` + */ + dataSource?: string; + /** + * Boolean to define if the last selected data source should be used + * + * Supported embed types: `SearchBarEmbed` + * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw + * @example + * ```js + * const embed = new SearchBarEmbed('#tsEmbed', { + * ... //other embed view config + * useLastSelectedSources:false, + * }) + * ``` + */ + useLastSelectedSources?: boolean; + /** + * Configuration for search options. + * Includes the following properties: + * + * `searchTokenString`: Search tokens to pass in the query. + * + * `executeSearch`: Boolean to define if the search should be executed or not. + * If it is executed, the focus is placed on the results. + * If it’s not executed, the focus is placed at the end of + * the token string in the search bar. + * + * Supported embed types: `SearchBarEmbed` + * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw + * @example + * ```js + * const embed = new SearchBarEmbed('#tsEmbed', { + * ... //other embed view config + * searchOptions: { + * searchTokenString: '[quantity purchased] [region]', + * executeSearch: true, + * } + * }) + * ``` + */ + searchOptions?: SearchOptions; + /** + * Exclude the search token string from the URL. + * If set to true, the search token string is not appended to the URL. + * + * Supported embed types: `SearchBarEmbed` + * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl + * @example + * ```js + * const embed = new SearchEmbed('#tsEmbed', { + * searchOptions: { + * searchTokenString: '[quantity purchased] [region]', + * executeSearch: true, + * }, + * excludeSearchTokenStringFromURL: true, + * }); + * ``` + */ + excludeSearchTokenStringFromURL?: boolean; +} +interface SearchAppInitData$1 extends DefaultAppInitData { + searchOptions: SearchOptions; +} +/** + * Embed ThoughtSpot search bar + * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw + * @group Embed components + */ +export declare class SearchBarEmbed extends TsEmbed { + /** + * The view configuration for the embedded ThoughtSpot search bar. + */ + protected viewConfig: SearchBarViewConfig; + protected embedComponentType: string; + constructor(domSelector: string, viewConfig: SearchBarViewConfig); + protected getEmbedParamsObject(): Record; + /** + * Construct the URL of the embedded ThoughtSpot search to be + * loaded in the iframe + * @param dataSources A list of data source GUIDs + */ + private getIFrameSrc; + /** + * Render the embedded ThoughtSpot search + */ + render(): Promise; + protected getSearchInitData(): { + searchOptions: SearchOptions; + }; + protected getAppInitData(): Promise; + getCurrentContext(): Promise; +} +/** + * Configuration for bodyless conversation options. + * @group Embed components + */ +export interface SpotterAgentEmbedViewConfig extends Omit { + /** + * The ID of the worksheet to use for the conversation. + */ + worksheetId: string; +} +/** + * Configuration for conversation options. + * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + * Use {@link SpotterAgentEmbedViewConfig} instead + * @group Embed components + */ +export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig { +} +export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig { + sessionId: string; + genNo: number; + acSessionId: string; + acGenNo: number; + convId: string; + messageId: string; +} +declare class ConversationMessage extends TsEmbed { + protected viewConfig: SpotterAgentMessageViewConfig; + constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig); + protected getEmbedParamsObject(): Record; + getIframeSrc(): string; + render(): Promise; +} +/** + * Create a conversation embed, which can be integrated inside + * chatbots or other conversational interfaces. + * @example + * ```js + * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk'; + * + * const conversation = new SpotterAgentEmbed({ + * worksheetId: 'worksheetId', + * }); + * + * const { container, error } = await conversation.sendMessage('show me sales by region'); + * + * // append the container to the DOM + * document.body.appendChild(container); // or to any other element + * ``` + * @group Embed components + * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl + */ +export declare class SpotterAgentEmbed { + private viewConfig; + private conversationService; + constructor(viewConfig: SpotterAgentEmbedViewConfig); + sendMessage(userMessage: string): Promise<{ + error: any; + container?: undefined; + viz?: undefined; + } | { + container: HTMLDivElement; + viz: ConversationMessage; + error?: undefined; + }>; + /** + * Send a message to the conversation service and return only the data. + * @param userMessage - The message to send to the conversation service. + * @returns The data from the conversation service. + */ + sendMessageData(userMessage: string): Promise<{ + error: any; + data?: undefined; + } | { + data: { + convId: any; + messageId: any; + sessionId: any; + genNo: any; + acSessionId: any; + acGenNo: any; + }; + error?: undefined; + }>; +} +/** + * Create a conversation embed, which can be integrated inside + * chatbots or other conversational interfaces. + * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + * Use {@link SpotterAgentEmbed} instead + * @example + * ```js + * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk'; + * + * const conversation = new SpotterAgentEmbed({ + * worksheetId: 'worksheetId', + * }); + * + * const { container, error } = await conversation.sendMessage('show me sales by region'); + * + * // append the container to the DOM + * document.body.appendChild(container); // or to any other element + * ``` + * @group Embed components + */ +export declare class BodylessConversation extends SpotterAgentEmbed { + constructor(viewConfig: BodylessConversationViewConfig); +} +interface SearchOptions$1 { + /** + * The query string to pass to start the Conversation. + */ + searchQuery: string; +} +/** + * The configuration for the embedded spotterEmbed options. + * @group Embed components + */ +export interface SpotterEmbedViewConfig extends Omit { + /** + * The ID of the data source object. For example, Model, View, or Table. Spotter uses + * this object to query data and generate Answers. + */ + worksheetId: string; + /** + * Ability to pass a starting search query to the conversation. + */ + searchOptions?: SearchOptions$1; + /** + * disableSourceSelection : Disables data source selection + * but still display the selected data source. + * + * Supported embed types: `SpotterEmbed` + * @example + * ```js + * const embed = new SpotterEmbed('#tsEmbed', { + * ... //other embed view config + * disableSourceSelection : true, + * }) + * ``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl + */ + disableSourceSelection?: boolean; + /** + * hideSourceSelection : Hide data source selection + * + * Supported embed types: `SpotterEmbed` + * @example + * ```js + * const embed = new SpotterEmbed('#tsEmbed', { + * ... //other embed view config + * hideSourceSelection : true, + * }) + * ``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl + */ + hideSourceSelection?: boolean; + /** + * Flag to control Data panel experience + * + * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed` + * @default true + * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl + * @example + * ```js + * // Replace with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed + * const embed = new ('#tsEmbed', { + * ... // other embed view config + * dataPanelV2: true, + * }) + * ``` + */ + dataPanelV2?: boolean; + /** + * showSpotterLimitations : show limitation text + * of the spotter underneath the chat input. + * default is false. + * + * Supported embed types: `SpotterEmbed` + * @example + * ```js + * const embed = new SpotterEmbed('#tsEmbed', { + * ... //other embed view config + * showSpotterLimitations : true, + * }) + * ``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl + */ + showSpotterLimitations?: boolean; + /** + * hideSampleQuestions : Hide sample questions on + * the initial screen of the conversation. + * + * Supported embed types: `SpotterEmbed` + * @example + * ```js + * const embed = new SpotterEmbed('#tsEmbed', { + * ... //other embed view config + * hideSampleQuestions : true, + * }) + * ``` + * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl + */ + hideSampleQuestions?: boolean; + /** + * The list of runtime filters to apply to a search Answer, + * visualization, or Liveboard. + * + * Supported embed types: `SpotterEmbed` + * @example + * ```js + * const embed = new SpotterEmbed('#tsEmbed', { + * // other embed view config + * runtimeFilters: [ + * { + * columnName: 'color', + * operator: RuntimeFilterOp.EQ, + * values: ['red'], + * }, + * ], + * }) + * ``` + * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl + */ + runtimeFilters?: RuntimeFilter[]; + /** + * Flag to control whether runtime filters should be included in the URL. + * If true, filters will be passed via app initialization payload instead. + * If false/undefined, filters will be added to URL (default behavior). + * + * Supported embed types: `SpotterEmbed` + * @default false + * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl + */ + excludeRuntimeFiltersfromURL?: boolean; + /** + * The list of runtime parameters to apply to the conversation. + * + * Supported embed types: `SpotterEmbed` + * @example + * ```js + * const embed = new SpotterEmbed('#tsEmbed', { + * // other embed view config + * runtimeParameters: [ + * { + * name: 'Integer Param', + * value: 10, + * }, + * ], + * }) + * ``` + * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl + */ + runtimeParameters?: RuntimeParameter[]; + /** + * Flag to control whether runtime parameters should be included in the URL. + * If true, parameters will be passed via app initialization payload instead. + * If false/undefined, parameters will be added to URL (default behavior). + * + * Supported embed types: `SpotterEmbed` + * @default false + * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl + */ + excludeRuntimeParametersfromURL?: boolean; +} +/** + * The configuration for the embedded spotterEmbed options. + * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + * Use {@link SpotterEmbedViewConfig} instead + * @group Embed components + */ +export interface ConversationViewConfig extends SpotterEmbedViewConfig { +} +/** + * Embed ThoughtSpot AI Conversation. + * @group Embed components + * @example + * ```js + * const conversation = new SpotterEmbed('#tsEmbed', { + * worksheetId: 'worksheetId', + * searchOptions: { + * searchQuery: 'searchQuery', + * }, + * }); + * conversation.render(); + * ``` + * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl + */ +export declare class SpotterEmbed extends TsEmbed { + protected viewConfig: SpotterEmbedViewConfig; + constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig); + protected getEmbedParamsObject(): Record; + getIframeSrc(): string; + render(): Promise; + getCurrentContext(): Promise; +} +/** + * Embed ThoughtSpot AI Conversation. + * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl + * Use {@link SpotterEmbed} instead + * @group Embed components + * @example + * ```js + * const conversation = new SpotterEmbed('#tsEmbed', { + * worksheetId: 'worksheetId', + * searchOptions: { + * searchQuery: 'searchQuery', + * }, + * }); + * conversation.render(); + * ``` + * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl + */ +export declare class ConversationEmbed extends SpotterEmbed { + protected viewConfig: ConversationViewConfig; + constructor(container: HTMLElement, viewConfig: ConversationViewConfig); +} +export type SessionInfo = { + releaseVersion: string; + userGUID: string; + currentOrgId: number; + privileges: string[]; + mixpanelToken: string; + isPublicUser: boolean; + clusterId: string; + clusterName: string; + [key: string]: any; +}; +/** + * Returns the cached session info object and caches it for future use. + * Once fetched the session info object is cached and returned from the cache on + * subsequent calls. + * This cache is cleared when inti is called OR resetCachedSessionInfo is called. + * @example ```js + * const sessionInfo = await getSessionInfo(); + * console.log(sessionInfo); + * ``` + * @version SDK: 1.28.3 | ThoughtSpot: * + * @returns {Promise} The session info object. + */ +export declare function getSessionInfo(): Promise; +interface SearchOptions$2 { + /** + * The query string to pass for Natural Language Search. + */ + searchQuery: string; + /** + * Boolean to define if the search should be executed or not. + * If it is executed, the focus is placed on the results. + * If it’s not executed, the focus is placed at the end of + * the token string in the search bar. + */ + executeSearch?: boolean; +} +/** + * The configuration attributes for the embedded Natural language search view. Based on + * GPT and LLM. + * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + * + * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl + * @group Embed components + */ +export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit { + /** + * If set to true, a list of Liveboard and Answers related + * to the natural language search will be shown below the + * AI generated answer. + * @deprecated Currently Liveboard and Answers related + * to the natural language search will not be shown for sage + * embed + */ + showObjectResults?: boolean; + /** + * flag used by the TS product tour page to show the blue search bar + * even after the search is completed. This is different from ThoughtSpot Embedded + * Sage Embed experience where it mimics closer to the non-embed case. + * The Sample questions container is collapsed when this value is set after + * does a search. + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl + * @hidden + */ + isProductTour?: boolean; + /** + * Show or hide the search bar title. + * @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + * @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl + */ + hideSearchBarTitle?: boolean; + /** + * Show or hide the Answer header, that is, the `AI Answer` title + * at the top of the Answer page. + * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl + */ + hideSageAnswerHeader?: boolean; + /** + * Disable the worksheet selection option. + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + */ + disableWorksheetChange?: boolean; + /** + * Hide the worksheet selection panel. + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + */ + hideWorksheetSelector?: boolean; + /** + * Show or hide autocomplete suggestions for the search query string. + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + */ + hideAutocompleteSuggestions?: boolean; + /** + * Show or hide autocomplete suggestions for the search query string. + * @deprecated + * Currently, the object suggestions will not be shown for Natural Language Search. + * You can use {@link hideAutocompleteSuggestions} instead. + */ + showObjectSuggestions?: boolean; + /** + * Show or hide sample questions. + * The sample questions are autogenerated based on the worksheet + * selected for the search operation. + * + * Supported embed types: `SageEmbed` + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + * @example + * ```js + * const embed = new SageEmbed('#tsEmbed', { + * ... //other embed view config + * hideSampleQuestions : true, + * }) + * ``` + */ + hideSampleQuestions?: boolean; + /** + * The data source GUID (Worksheet GUID) to set on load. + */ + dataSource?: string; + /** + * Includes the following properties: + * + * `searchQuery`: The search query string to pass in the search bar. + * Supports Natural Language Search queries. + * + * `executeSearch`: Boolean to define if the search should be executed or not. + * If it is executed, the focus is placed on the results. + * If it’s not executed, the focus is placed at the end of + * the token string in the search bar. + * + * Supported embed types: `SageEmbed` + * @example + * ```js + * searchOptions: { + * searchQuery: 'average sales by country and product type', + * executeSearch: true, + * } + * ``` + * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw + */ + searchOptions?: SearchOptions$2; +} +/** + * Embed ThoughtSpot LLM and GPT-based Natural Language Search component. + * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw + * + * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl + * @group Embed components + */ +export declare class SageEmbed extends V1Embed { + /** + * The view configuration for the embedded ThoughtSpot sage. + * + */ + protected viewConfig: SageViewConfig; + constructor(domSelector: DOMSelector, viewConfig: SageViewConfig); + protected getEmbedParamsObject(): Record; + /** + * Constructs a map of parameters to be passed on to the + * embedded Eureka or Sage search page. + * @returns {string} query string + */ + protected getEmbedParams(): string; + /** + * Construct the URL of the embedded ThoughtSpot sage to be + * loaded in the iframe + * @returns {string} iframe url + */ + getIFrameSrc(): string; + /** + * Render the embedded ThoughtSpot Sage + * @returns {SageEmbed} Eureka/Sage embed + */ + render(): Promise; + getCurrentContext(): Promise; +} +/** + * Gets the embed configuration settings that were used to + * initialize the SDK. + * @returns {@link EmbedConfig} + * + * @example + * ```js + * import { getInitConfig } from '@thoughtspot/visual-embed-sdk'; + * // Call the getInitConfig method to retrieve the embed configuration + * const config = getInitConfig(); + * // Log the configuration settings + * console.log(config); + * ``` + * Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig] + * object, which contains the configuration settings used to + * initialize the SDK, including the following: + * + * - `thoughtSpotHost` - ThoughtSpot host URL + * - `authType`: The authentication method used. For example, + * `AuthServerCookieless` for `AuthType.TrustedAuthTokenCookieless` + * - `customizations` - Style, text, and icon customization settings + * that were applied during the SDK initialization. + * + * The following JSON output shows the embed configuration + * settings returned from the code in the previous example: + * + * @example + * ```json + * { + * "thoughtSpotHost": "https://{ThoughtSpot-Host}", + * "authType": "AuthServerCookieless", + * "customizations": { + * "style": { + * "customCSS": { + * "variables": { + * "--ts-var-button--secondary-background": "#7492d5", + * "--ts-var-button--secondary--hovers-background": "#aac2f8", + * "--ts-var-root-background": "#f1f4f8" + * } + * } + * } + * }, + * "loginFailedMessage": "Login failed, please try again", + * "authTriggerText": "Authorize", + * "disableTokenVerification": true, + * "authTriggerContainer": "#your-own-div" + * } + * ``` + * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later + * @group Global methods + */ +declare const getEmbedConfig: () => EmbedConfig; +/** + * Enum of mixpanel events + * @hidden + */ +export declare const MIXPANEL_EVENT: { + VISUAL_SDK_RENDER_START: string; + VISUAL_SDK_CALLED_INIT: string; + VISUAL_SDK_RENDER_COMPLETE: string; + VISUAL_SDK_RENDER_FAILED: string; + VISUAL_SDK_TRIGGER: string; + VISUAL_SDK_ON: string; + VISUAL_SDK_IFRAME_LOAD_PERFORMANCE: string; + VISUAL_SDK_EMBED_CREATE: string; + VERCEL_INTEGRATION_COMPLETED: string; +}; +/** + * Pushes the event with its Property key-value map to mixpanel. + * @param eventId + * @param eventProps + */ +export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): void; +/** + * Fetch wrapper that adds the authentication token to the request. + * Use this to call the ThoughtSpot APIs when using the visual embed sdk. + * The interface for this method is the same as Web `Fetch`. + * @param input + * @param init + * @example + * ```js + * tokenizedFetch("/api/rest/2.0/auth/session/user", { + * // .. fetch options .. + * }); + *``` + * @version SDK: 1.28.0 + * @group Global methods + */ +export declare const tokenizedFetch: typeof fetch; +/** + * Get answer from natural language query + * @param query string + * @param worksheetId string + * @returns AnswerService and the suggestion response. + * @version SDK: 1.33.1 | ThoughtSpot: 10.3.0.cl + * @example + * ```js + * const { answer } = await getAnswerFromQuery('revenue', 'worksheetId'); + * ``` + */ +export declare const getAnswerFromQuery: (query: string, worksheetId: string) => Promise<{ + answer: AnswerService; + suggestion: any; +}>; +/** + * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances. + * + * Each answer will be added as a visualization to the newly created Liveboard. + * + * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances + * representing the answers to be added to the Liveboard. + * @param {string} name - The name of the Liveboard to create. + * @returns result Promise + * @version SDK: 1.33.1 | ThoughtSpot: * + * @example + * ```js + * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk"; + * + * embed.on(EmbedEvent.Data, async () => { + * try { + * const answerService = await embed.getAnswerService(); + * const lb = await createLiveboardWithAnswers( + * [answerService], + * "My Liveboard" + * ); + * console.log("Liveboard created:", lb); + * } catch (err) { + * console.error("Failed to create liveboard:", err); + * } + * }); + * ``` + */ +export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise; +/** + * Resets the auth token and a new token will be fetched on the next request. + * @example + * ```js + * resetCachedAuthToken(); + * ``` + * @version SDK: 1.28.0 | ThoughtSpot: * + * @group Authentication / Init + */ +export declare const resetCachedAuthToken: () => void; + +export { + getEmbedConfig as getInitConfig, +}; + +export {}; From dcc5864069f036d9953bfd9bafcd9424f92ef3f3 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 12 Dec 2025 13:12:56 +0530 Subject: [PATCH 04/23] added context in ui passthrough events --- src/embed/hostEventClient/contracts.ts | 3 +-- src/embed/hostEventClient/host-event-client.ts | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/src/embed/hostEventClient/contracts.ts b/src/embed/hostEventClient/contracts.ts index f6f096a4..5d5b151d 100644 --- a/src/embed/hostEventClient/contracts.ts +++ b/src/embed/hostEventClient/contracts.ts @@ -105,11 +105,10 @@ export type TriggerResponse ? HostEventResponse : any; export enum ContextType { - Search = 'search', + Search = 'search-answer', Liveboard = 'liveboard', Answer = 'answer', Spotter = 'spotter', - Default = 'default', } export enum PageType { diff --git a/src/embed/hostEventClient/host-event-client.ts b/src/embed/hostEventClient/host-event-client.ts index c2478ed5..6aa8301f 100644 --- a/src/embed/hostEventClient/host-event-client.ts +++ b/src/embed/hostEventClient/host-event-client.ts @@ -42,8 +42,9 @@ export class HostEventClient { public async handleHostEventWithParam( apiName: UIPassthroughEventT, parameters: UIPassthroughRequest, + context?: ContextType, ): Promise> { - const response = (await this.triggerUIPassthroughApi(apiName, parameters)) + const response = (await this.triggerUIPassthroughApi(apiName, parameters, context as ContextType)) ?.filter?.((r) => r.error || r.value)[0]; if (!response) { @@ -83,20 +84,22 @@ export class HostEventClient { public async triggerUIPassthroughApi( apiName: UIPassthroughEventT, parameters: UIPassthroughRequest, + context?: ContextType, ): Promise> { const res = await this.processTrigger(HostEvent.UIPassthrough, { type: apiName, parameters, - }); + }, context); return res; } protected async handlePinEvent( payload: HostEventRequest, + context?: ContextType, ): Promise> { if (!payload || !('newVizName' in payload)) { - return this.hostEventFallback(HostEvent.Pin, payload); + return this.hostEventFallback(HostEvent.Pin, payload, context); } const formattedPayload = { @@ -107,6 +110,7 @@ export class HostEventClient { const data = await this.handleHostEventWithParam( UIPassthroughEvent.PinAnswerToLiveboard, formattedPayload, + context as ContextType, ); return { @@ -117,14 +121,16 @@ export class HostEventClient { protected async handleSaveAnswerEvent( payload: HostEventRequest, + context?: ContextType, ): Promise { if (!payload || !('name' in payload) || !('description' in payload)) { // Save is the fallback for SaveAnswer - return this.hostEventFallback(HostEvent.Save, payload); + return this.hostEventFallback(HostEvent.Save, payload, context); } const data = await this.handleHostEventWithParam( UIPassthroughEvent.SaveAnswer, payload, + context as ContextType, ); return { ...data, @@ -143,10 +149,11 @@ export class HostEventClient { ): Promise> { switch (hostEvent) { case HostEvent.Pin: - return this.handlePinEvent(payload as HostEventRequest) as any; + return this.handlePinEvent(payload as HostEventRequest, context as ContextType) as any; case HostEvent.SaveAnswer: return this.handleSaveAnswerEvent( payload as HostEventRequest, + context as ContextType, ) as any; default: return this.hostEventFallback(hostEvent, payload, context); From 97047e3716ae1c99e7a95209d8cf8d7a28b1804c Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 12 Dec 2025 13:32:30 +0530 Subject: [PATCH 05/23] added types --- src/embed/app.ts | 12 + src/embed/conversation.ts | 8 +- src/embed/hostEventClient/contracts.ts | 34 +- src/embed/liveboard.ts | 8 +- src/embed/sage.ts | 2 +- src/embed/search-bar.tsx | 7 +- src/embed/search.ts | 6 + src/embed/ts-embed.ts | 1 - src/types.ts | 10 + visual-embed-sdk.d.ts | 9631 ------------------------ 10 files changed, 71 insertions(+), 9648 deletions(-) delete mode 100644 visual-embed-sdk.d.ts diff --git a/src/embed/app.ts b/src/embed/app.ts index 359d05fc..f2ed2c90 100644 --- a/src/embed/app.ts +++ b/src/embed/app.ts @@ -19,6 +19,7 @@ import { AllEmbedViewConfig, } from '../types'; import { V1Embed } from './ts-embed'; +import { PageContextOptions } from './hostEventClient/contracts'; /** * Pages within the ThoughtSpot app that can be embedded. @@ -1078,4 +1079,15 @@ export class AppEmbed extends V1Embed { this.postRender(); return this; } + + /** + * Get the current context of the embedded application. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + */ + public async getCurrentContext(): Promise { + const context = await super.getCurrentContext(); + return context; + } + } diff --git a/src/embed/conversation.ts b/src/embed/conversation.ts index 9477cb4d..39853e23 100644 --- a/src/embed/conversation.ts +++ b/src/embed/conversation.ts @@ -3,8 +3,7 @@ import { ERROR_MESSAGE } from '../errors'; import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes } from '../types'; import { TsEmbed } from './ts-embed'; import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils'; -import { ContextType } from './hostEventClient/contracts'; -import { PageContextOptions } from 'visual-embed-sdk'; +import { PageContextOptions } from './hostEventClient/contracts'; /** * Configuration for search options @@ -331,6 +330,11 @@ export class SpotterEmbed extends TsEmbed { return this; } + /** + * Get the current context of the embedded conversation. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); return context; diff --git a/src/embed/hostEventClient/contracts.ts b/src/embed/hostEventClient/contracts.ts index afe3c12e..6911452e 100644 --- a/src/embed/hostEventClient/contracts.ts +++ b/src/embed/hostEventClient/contracts.ts @@ -114,14 +114,28 @@ export type TriggerPayload = export type TriggerResponse = PayloadT extends HostEventRequest ? HostEventResponse : any; - export enum ContextType { - Search = 'search-answer', - Liveboard = 'liveboard', - Answer = 'answer', - Spotter = 'spotter', - } +export enum ContextType { + Search = 'search-answer', + Liveboard = 'liveboard', + Answer = 'answer', + Spotter = 'spotter', + Sage = 'sage', +} + +export enum PageType { + PAGE = 'page', + DIALOG = 'dialog', +} - export enum PageType { - PAGE = 'page', - DIALOG = 'dialog', - } \ No newline at end of file +interface ObjectIds { + answerId?: string; + liveboardId?: string; + vizIds?: string[]; + dataModelIds?: string[]; +} + +export interface PageContextOptions { + page: ContextType; + pageType: PageType; + objectIds: ObjectIds; +} diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index b7c19440..0177fe6e 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -27,9 +27,8 @@ import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidC import { getAuthPromise } from './base'; import { TsEmbed, V1Embed } from './ts-embed'; import { addPreviewStylesIfNotPresent } from '../utils/global-styles'; -import { ContextType, TriggerPayload, TriggerResponse } from './hostEventClient/contracts'; +import { ContextType, TriggerPayload, TriggerResponse, PageContextOptions } from './hostEventClient/contracts'; import { logger } from '../utils/logger'; -import { PageContextOptions } from 'visual-embed-sdk'; /** @@ -892,6 +891,11 @@ export class LiveboardEmbed extends V1Embed { return url; } + /** + * Get the current context of the embedded liveboard. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); return context; diff --git a/src/embed/sage.ts b/src/embed/sage.ts index ebf3f5d8..d0b99762 100644 --- a/src/embed/sage.ts +++ b/src/embed/sage.ts @@ -6,7 +6,7 @@ * @author Mourya Balabhadra */ -import { PageContextOptions } from 'visual-embed-sdk'; +import { PageContextOptions } from './hostEventClient/contracts'; import { DOMSelector, Param, BaseViewConfig, SearchLiveboardCommonViewConfig } from '../types'; import { getQueryParamString } from '../utils'; import { V1Embed } from './ts-embed'; diff --git a/src/embed/search-bar.tsx b/src/embed/search-bar.tsx index 7b034523..1a6aa1ed 100644 --- a/src/embed/search-bar.tsx +++ b/src/embed/search-bar.tsx @@ -2,7 +2,7 @@ import { SearchLiveboardCommonViewConfig, BaseViewConfig, DefaultAppInitData, Pa import { getQueryParamString } from '../utils'; import { TsEmbed } from './ts-embed'; import { SearchOptions } from './search'; -import { PageContextOptions } from 'visual-embed-sdk'; +import { PageContextOptions } from './hostEventClient/contracts'; /** * @group Embed components @@ -200,6 +200,11 @@ export class SearchBarEmbed extends TsEmbed { return { ...defaultAppInitData, ...this.getSearchInitData() }; } + /** + * Get the current context of the embedded search bar. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); return context; diff --git a/src/embed/search.ts b/src/embed/search.ts index 78205250..06845714 100644 --- a/src/embed/search.ts +++ b/src/embed/search.ts @@ -27,6 +27,7 @@ import { getAuthPromise } from './base'; import { getReleaseVersion } from '../auth'; import { getEmbedConfig } from './embedConfig'; import { getInterceptInitData } from '../api-intercept'; +import { PageContextOptions } from './hostEventClient/contracts'; /** * Configuration for search options. @@ -524,6 +525,11 @@ export class SearchEmbed extends TsEmbed { return this; } + /** + * Get the current context of the embedded search. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); return context; diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index b2bb0651..1b2f411b 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -16,7 +16,6 @@ import { UIPassthroughArrayResponse, UIPassthroughEvent, UIPassthroughRequest, - PageType, } from './hostEventClient/contracts'; import { logger } from '../utils/logger'; import { getAuthenticationToken } from '../authToken'; diff --git a/src/types.ts b/src/types.ts index fc30c3b4..327aeead 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4488,6 +4488,16 @@ export enum HostEvent { * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl */ StartNewSpotterConversation = 'StartNewSpotterConversation', + + /** + * Get the current context of the embedded page. + * @example + * ```js + * const context = await liveboardEmbed.trigger(HostEvent.GetPageContext); + * ``` + * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + */ + GetPageContext = 'GetPageContext', } /** diff --git a/visual-embed-sdk.d.ts b/visual-embed-sdk.d.ts deleted file mode 100644 index 0b16b91b..00000000 --- a/visual-embed-sdk.d.ts +++ /dev/null @@ -1,9631 +0,0 @@ -// Generated by dts-bundle-generator v9.5.1 - -/** - * The list of customization css variables. These - * are the only allowed variables possible. - */ -export interface CustomCssVariables { - /** - * Background color of the Liveboard, visualization, Search, and Answer pages. - */ - "--ts-var-root-background"?: string; - /** - * Color of the text on application pages. - */ - "--ts-var-root-color"?: string; - /** - * Font type for the text on application pages. - */ - "--ts-var-root-font-family"?: string; - /** - * Text transformation specification for UI elements in the app. - */ - "--ts-var-root-text-transform"?: string; - /** - * 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), title text on the AI-generated charts and tables, and object titles on - * list pages such as *Liveboards* and *Answers*. - * The default color code is #2770EF. - * - */ - "--ts-var-application-color"?: string; - /** - * Background color of the top navigation panel. - */ - "--ts-var-nav-background"?: string; - /** - * Font color of the top navigation panel. - */ - "--ts-var-nav-color"?: string; - /** - * Background color of the *Search data* button. - */ - "--ts-var-search-data-button-background"?: string; - /** - * Color of the text on the *Search data* button. - */ - "--ts-var-search-data-button-font-color"?: string; - /** - * Font of the text on the *Search data* button. - */ - "--ts-var-search-data-button-font-family"?: string; - /** - * Font color of the text in the Search bar. - */ - "--ts-var-search-bar-text-font-color"?: string; - /** - * Font of the text in the Search bar. - */ - "--ts-var-search-bar-text-font-family"?: string; - /** - * Font style of the text in the Search bar. - */ - "--ts-var-search-bar-text-font-style"?: string; - /** - * Background color of the search bar. - */ - "--ts-var-search-bar-background"?: string; - /** - * Background color of the search suggestions panel. - */ - "--ts-var-search-auto-complete-background"?: string; - /** - * Background color of the navigation panel that allows you to undo, redo, and reset - * search operations. - */ - "--ts-var-search-navigation-button-background"?: string; - /** - * Background color of the navigation help text that appears at the bottom of the - * search suggestions panel. - */ - "--ts-var-search-bar-navigation-help-text-background"?: string; - /** - * Background color of the search suggestion block on hover. - */ - "--ts-var-search-bar-auto-complete-hover-background"?: string; - /** - * Font color of the text in the search suggestion panel. - */ - "--ts-var-search-auto-complete-font-color"?: string; - /** - * Font color of the sub-text that appears below the keyword in the search suggestion - * panel. - */ - "--ts-var-search-auto-complete-subtext-font-color"?: string; - /** - * Background color of the input box in the Spotter page. - */ - "--ts-var-spotter-input-background"?: string; - /** - * Background color of the previously asked prompt message in the Spotter page. - */ - "--ts-var-spotter-prompt-background"?: string; - /** - * Background color of the data panel. - */ - "--ts-var-answer-data-panel-background-color"?: string; - /** - * Background color of the vertical panel on the right side of the Answer page, which - * includes the options to edit charts and tables. - */ - "--ts-var-answer-edit-panel-background-color"?: string; - /** - * Background color of the chart switcher on search results and Answer pages. - */ - "--ts-var-answer-view-table-chart-switcher-background"?: string; - /** - * Background color of the currently selected chart type in the chart switcher. - */ - "--ts-var-answer-view-table-chart-switcher-active-background"?: string; - /** - * Border-radius of main buttons. - * For example, the *Search data* button in the top navigation panel. - */ - "--ts-var-button-border-radius"?: string; - /** - * Border-radius of small buttons such as secondary buttons. - * For example, share and favorite buttons. - */ - "--ts-var-button--icon-border-radius"?: string; - /** - * Font color of the text on primary buttons. For example, the primary buttons on - * Liveboard*, Answer, *Data* workspace, *SpotIQ*, or *Home* page. - */ - "--ts-var-button--primary-color"?: string; - /** - * Font family specification for the text on primary buttons. - */ - "--ts-var-button--primary--font-family"?: string; - /** - * Background color of the primary buttons. For example, the primary buttons such as - * Pin* and *Save*. - */ - "--ts-var-button--primary-background"?: string; - /** - * 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. - */ - "--ts-var-button--secondary-color"?: string; - /** - * Font family specification for the text on the secondary buttons. - */ - "--ts-var-button--secondary--font-family"?: string; - /** - * Background color of the secondary buttons. - */ - "--ts-var-button--secondary-background"?: string; - /** - * 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. - */ - "--ts-var-button--tertiary-color"?: string; - /** - * Background color of the tertiary button. - */ - "--ts-var-button--tertiary-background"?: string; - /** - * 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. - */ - "--ts-var-viz-title-color"?: string; - /** - * Font family specification for the title text of a visualization/Answer. - */ - "--ts-var-viz-title-font-family"?: string; - /** - * Text transformation specification for visualization and Answer titles. - */ - "--ts-var-viz-title-text-transform"?: string; - /** - * Font color of the description text and subtitle of a visualization or Answer. - */ - "--ts-var-viz-description-color"?: string; - /** - * Font family specification of description text and subtitle of a visualization or - * Answer. - */ - "--ts-var-viz-description-font-family"?: string; - /** - * Text transformation specification for description text and subtitle of a - * visualization or Answer. - */ - "--ts-var-viz-description-text-transform"?: string; - /** - * Border-radius for the visualization tiles and header panel on a Liveboard. - */ - "--ts-var-viz-border-radius"?: string; - /** - * Box shadow property for the visualization tiles and header panel on a Liveboard. - */ - "--ts-var-viz-box-shadow"?: string; - /** - * Background color of the visualization tiles and header panel on a Liveboard. - */ - "--ts-var-viz-background"?: string; - /** - * Background color of the legend on a visualization or Answer. - */ - "--ts-var-viz-legend-hover-background"?: string; - /** - * Background color of the selected chart type on the chart selection widget. - */ - "--ts-var-answer-chart-select-background"?: string; - /** - * Background color of the chart type element when a user hovers over a chart type on - * the chart selection widget. - */ - "--ts-var-answer-chart-hover-background"?: string; - /** - * Border-radius of filter chips. - */ - "--ts-var-chip-border-radius"?: string; - /** - * Shadow effect for filter chips. - */ - "--ts-var-chip-box-shadow"?: string; - /** - * Background color of filter chips. - */ - "--ts-var-chip-background"?: string; - /** - * Font color of the filter label when a filter chip is selected - */ - "--ts-var-chip--active-color"?: string; - /** - * Background color of the filter chips when selected. - */ - "--ts-var-chip--active-background"?: string; - /** - * Font color of the text on filter chips when hovered over. - */ - "--ts-var-chip--hover-color"?: string; - /** - * Background color of filter chips on hover. - */ - "--ts-var-chip--hover-background"?: string; - /** - * Font color of the text on filter chips. - */ - "--ts-var-chip-color"?: string; - /** - * Font family specification for the text on filter chips. - */ - "--ts-var-chip-title-font-family"?: string; - /** - * Font color of axis title on charts. - */ - "--ts-var-axis-title-color"?: string; - /** - * Font family specification for the X and Y axis title text. - */ - "--ts-var-axis-title-font-family"?: string; - /** - * Font color of the X and Y axis labels. - */ - "--ts-var-axis-data-label-color"?: string; - /** - * Font family specification for X and Y axis labels. - */ - "--ts-var-axis-data-label-font-family"?: string; - /** - * Font color of the menu items. - */ - "--ts-var-menu-color"?: string; - /** - * Background color of menu panels. - */ - "--ts-var-menu-background"?: string; - /** - * Font family specification for the menu items. - */ - "--ts-var-menu-font-family"?: string; - /** - * Text capitalization specification for the menu items. - */ - "--ts-var-menu-text-transform"?: string; - /** - * Background color for menu items on hover. - */ - "--ts-var-menu--hover-background"?: string; - /** - * Text color for selected menu items. - */ - "--ts-var-menu-selected-text-color"?: string; - /** - * Background color of the dialogs. - */ - "--ts-var-dialog-body-background"?: string; - /** - * Font color of the body text displayed on dialogs. - */ - "--ts-var-dialog-body-color"?: string; - /** - * Background color of the header text on dialogs. - */ - "--ts-var-dialog-header-background"?: string; - /** - * Font color of the header text on dialogs. - */ - "--ts-var-dialog-header-color"?: string; - /** - * Background color of the footer area on dialogs. - */ - "--ts-var-dialog-footer-background"?: string; - /** - * Background for selected state in list - */ - "--ts-var-list-selected-background"?: string; - /** - * Background for hover state in list - */ - "--ts-var-list-hover-background"?: string; - /** - * Background for hover state in segment control. - */ - "--ts-var-segment-control-hover-background"?: string; - /** - * Text color for slected item in modular home's watchlist. - */ - "--ts-var-home-watchlist-selected-text-color"?: string; - /** - * Text color for favorite carousel find your favorites card in modular home. - */ - "--ts-var-home-favorite-suggestion-card-text-color"?: string; - /** - * Icon color for favorite carousel find your favorites card in modular home. - */ - "--ts-var-home-favorite-suggestion-card-icon-color"?: string; - /** - * 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; - /** - * Height of the tiles in the Liveboard. - */ - "--ts-var-viz-tile-height"?: string; - /** - * Background color of the layout in the Liveboard. - */ - "--ts-var-liveboard-layout-background"?: string; - /** - * Font color of the title of the layout in the Liveboard. - */ - "--ts-var-liveboard-layout-title-color"?: string; - /** - * Font size of the title of the layout in the Liveboard. - */ - "--ts-var-liveboard-layout-title-fontsize"?: string; - /** - * Background color of the header in the Liveboard. - */ - "--ts-var-liveboard-header-background"?: string; - /** - * Font size of the header in the Liveboard. - */ - "--ts-var-liveboard-header-fontsize"?: string; - /** - * Font color of the header in the Liveboard. - */ - "--ts-var-liveboard-header-font-color"?: string; - /** - * Border color of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-border-color"?: string; - /** - * Background color of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-background"?: string; - /** - * Border radius of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-border-radius"?: string; - /** - * Padding of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-padding"?: string; - /** - * Background color of the table header in the Liveboard. - */ - "--ts-var-liveboard-tile-table-header-background"?: string; - /** - * Padding of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-padding"?: string; - /** - * Padding of the title of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-title-padding"?: string; - /** - * Font size of the title of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-title-font-size"?: string; - /** - * Font weight of the title of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-title-font-weight"?: string; - /** - * Font size of the title of the tiles inside the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-title-font-size"?: string; - /** - * Font weight of the title of the tiles inside the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-title-font-weight"?: string; - /** - * Font size of the description of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-description-font-size"?: string; - /** - * Font weight of the description of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-description-font-weight"?: string; - /** - * Border of the group tiles in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-border"?: string; - /** - * Padding of the group tiles in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-padding"?: string; - /** - * Padding of the answer viz in the Liveboard. - */ - "--ts-var-liveboard-answer-viz-padding"?: string; - /** - * Background color of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-background"?: string; - /** - * Border color of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-border-color"?: string; - /** - * Font color of the heading of the note title in the Liveboard. - */ - "--ts-var-liveboard-notetitle-heading-font-color"?: string; - /** - * Font color of the body of the note title in the Liveboard. - */ - "--ts-var-liveboard-notetitle-body-font-color"?: string; - /** - * Font color of the title of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-title-font-color"?: string; - /** - * Font color of the description of the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-description-font-color"?: string; - /** - * Font color of the title of the tiles inside the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-title-font-color"?: string; - /** - * Font color of the description of the tiles inside the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-description-font-color"?: string; - /** - * Background color of the tiles inside the groups in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-group-tile-background"?: string; - /** - * Background color of the filter chips in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-chip-background"?: string; - /** - * Font color of the filter chips in the Liveboard. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-chip-color"?: string; - /** - * Background color of the filter chips in the Liveboard on hover. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-chip--hover-background"?: string; - /** - * Background color of the filter chips in the Liveboard on active. - * - * Please enable the Liveboard styling and grouping feature in your ThoughtSpot instance and then set the isLiveboardStylingAndGrouping SDK flag to true to start modifying this CSS variable. - */ - "--ts-var-liveboard-chip--active-background"?: string; - /** - * Width of the side panel in the Liveboard. - */ - "--ts-var-side-panel-width"?: string; - /** - * Background color of the edit bar in the Liveboard. - */ - "--ts-var-liveboard-edit-bar-background"?: string; - /** - * Breakpoint for the dual column layout in the Liveboard. - */ - "--ts-var-liveboard-dual-column-breakpoint"?: string; - /** - * Breakpoint for the single column layout in the Liveboard. - */ - "--ts-var-liveboard-single-column-breakpoint"?: string; - /** - * Background color of the cross filter layout in the Liveboard. - */ - "--ts-var-liveboard-cross-filter-layout-background"?: string; - /** - * Border color of the active tab in the Liveboard. - */ - "--ts-var-liveboard-tab-active-border-color"?: string; - /** - * Font color of the hover tab in the Liveboard. - */ - "--ts-var-liveboard-tab-hover-color"?: string; - /** - * Font size of the title of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-title-fontsize"?: string; - /** - * Font weight of the title of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-title-fontweight"?: string; - /** - * Font weight of the description of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-description-font-weight"?: string; - /** - * Opacity of the description of the tiles in the Liveboard. - */ - "--ts-var-liveboard-tile-description-opacity"?: string; - /** - * Background color of the parameter chips in the Liveboard. - */ - "--ts-var-parameter-chip-background"?: string; - /** - * Font color of the parameter chips in the Liveboard. - */ - "--ts-var-parameter-chip-text-color"?: string; - /** - * Background color of the parameter chips in the Liveboard on hover. - */ - "--ts-var-parameter-chip-hover-background"?: string; - /** - * Font color of the parameter chips in the Liveboard on hover. - */ - "--ts-var-parameter-chip-hover-text-color"?: string; - /** - * Background color of the parameter chips in the Liveboard on active. - */ - "--ts-var-parameter-chip-active-background"?: string; - /** - * Font color of the parameter chips in the Liveboard on active. - */ - "--ts-var-parameter-chip-active-text-color"?: string; - /** - * Background color of the action button in the Liveboard header. - */ - "--ts-var-liveboard-header-action-button-background"?: string; - /** - * Font color of the action button in the Liveboard header. - */ - "--ts-var-liveboard-header-action-button-font-color"?: string; - /** - * Font color of the action button in the Liveboard header on hover. - */ - "--ts-var-liveboard-header-action-button-hover-color"?: string; - /** - * Font color of the action button in the Liveboard header on active. - */ - "--ts-var-liveboard-header-action-button-active-color"?: string; - /** - * Background color of the badge in the Liveboard header. - */ - "--ts-var-liveboard-header-badge-background"?: string; - /** - * Font color of the badge in the Liveboard header. - */ - "--ts-var-liveboard-header-badge-font-color"?: string; - /** - * Background color of the modified badge in the Liveboard header. - */ - "--ts-var-liveboard-header-badge-modified-background"?: string; - /** - * Font color of the modified badge in the Liveboard header. - */ - "--ts-var-liveboard-header-badge-modified-font-color"?: string; - /** - * Font color of the badge in the Liveboard header on hover. - */ - "--ts-var-liveboard-header-badge-hover-color"?: string; - /** - * Font color of the badge in the Liveboard header on active. - */ - "--ts-var-liveboard-header-badge-active-color"?: string; - /** - * Font color of the hero text in the KPI widget. - */ - "--ts-var-kpi-hero-color"?: string; - /** - * Font color of the comparison text in the KPI widget. - */ - "--ts-var-kpi-comparison-color"?: string; - /** - * Font color of the analyze text in the KPI widget. - */ - "--ts-var-kpi-analyze-text-color"?: string; - /** - * Font color of the legend title in the heatmap chart. - */ - "--ts-var-chart-heatmap-legend-title-color"?: string; - /** - * Font color of the legend label in the heatmap chart. - */ - "--ts-var-chart-heatmap-legend-label-color"?: string; - /** - * Font color of the legend title in the treemap chart. - */ - "--ts-var-chart-treemap-legend-title-color"?: string; - /** - * Font color of the legend label in the treemap chart. - */ - "--ts-var-chart-treemap-legend-label-color"?: string; - /** - * Color of the positive change in the KPI. - */ - "--ts-var-kpi-positive-change-color"?: string; - /** - * Color of the negative change in the KPI. - */ - "--ts-var-kpi-negative-change-color"?: string; - /** - * Background color of the change analysis insights. - */ - "--ts-var-change-analysis-insights-background"?: string; - /** - * Background color of the forecasting card in the SpotIQ analyze. - */ - "--ts-var-spotiq-analyze-forecasting-card-background"?: string; - /** - * Background color of the outlier card in the SpotIQ analyze. - */ - "--ts-var-spotiq-analyze-outlier-card-background"?: string; - /** - * Background color of the trend card in the SpotIQ analyze. - */ - "--ts-var-spotiq-analyze-trend-card-background"?: string; - /** - * Background color of the crosscorrelation card in the SpotIQ analyze. - */ - "--ts-var-spotiq-analyze-crosscorrelation-card-background"?: string; - /** - * Background color of the summary header in the CCA modal. - */ - "--ts-var-cca-modal-summary-header-background"?: string; -} -export interface SessionInterface { - sessionId: string; - genNo: number; - acSession: { - sessionId: string; - genNo: number; - }; -} -export interface UnderlyingDataPoint { - columnId: string; - dataValue: any; -} -/** - * AnswerService provides a simple way to work with ThoughtSpot Answers. - * - * This service allows you to interact with ThoughtSpot Answers programmatically, - * making it easy to customize visualizations, filter data, and extract insights - * directly from your application. - * - * You can use this service to: - * - * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`) - * - Apply filters to Answers (`addFilter`) - * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`) - * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`) - * - Run custom queries (`executeQuery`) - * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`) - * - * @example - * ```js - * // Get the answer service - * embed.on(EmbedEvent.Data, async (e) => { - * const service = await embed.getAnswerService(); - * - * // Add columns to the answer - * await service.addColumnsByName(["Sales", "Region"]); - * - * // Get the data - * const data = await service.fetchData(); - * console.log(data); - * }); - * ``` - * - * @example - * ```js - * // Get data for a point in a visualization - * embed.on(EmbedEvent.CustomAction, async (e) => { - * const underlying = await e.answerService.getUnderlyingDataForPoint([ - * 'Product Name', - * 'Sales Amount' - * ]); - * - * const data = await underlying.fetchData(0, 100); - * console.log(data); - * }); - * ``` - * - * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl - * @group Events - */ -export declare class AnswerService { - private session; - private thoughtSpotHost; - private selectedPoints?; - private answer; - private tmlOverride; - /** - * Should not need to be called directly. - * @param session - * @param answer - * @param thoughtSpotHost - * @param selectedPoints - */ - constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]); - /** - * Get the details about the source used in the answer. - * This can be used to get the list of all columns in the data source for example. - */ - getSourceDetail(): Promise; - /** - * Remove columnIds and return updated answer session. - * @param columnIds - * @returns - */ - removeColumns(columnIds: string[]): Promise; - /** - * Add columnIds and return updated answer session. - * @param columnIds - * @returns - */ - addColumns(columnIds: string[]): Promise; - /** - * Add columns by names and return updated answer session. - * @param columnNames - * @returns - * @example - * ```js - * embed.on(EmbedEvent.Data, async (e) => { - * const service = await embed.getAnswerService(); - * await service.addColumnsByName([ - * "col name 1", - * "col name 2" - * ]); - * console.log(await service.fetchData()); - * }); - */ - addColumnsByName(columnNames: string[]): Promise; - /** - * Add a filter to the answer. - * @param columnName - * @param operator - * @param values - * @returns - */ - addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter["values"]): Promise; - getSQLQuery(): Promise; - /** - * Fetch data from the answer. - * @param offset - * @param size - * @returns - */ - fetchData(offset?: number, size?: number): Promise<{ - columns: any; - data: any; - }>; - /** - * Fetch the data for the answer as a CSV blob. This might be - * quicker for larger data. - * @param userLocale - * @param includeInfo Include the CSV header in the output - * @returns Response - */ - fetchCSVBlob(userLocale?: string, includeInfo?: boolean): Promise; - /** - * Fetch the data for the answer as a PNG blob. This might be - * quicker for larger data. - * @param userLocale - * @param includeInfo - * @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; - /** - * Just get the internal URL for this answer's data - * as a CSV blob. - * @param userLocale - * @param includeInfo - * @returns - */ - getFetchCSVBlobUrl(userLocale?: string, includeInfo?: boolean): string; - /** - * Just get the internal URL for this answer's data - * as a PNG blob. - * @param userLocale - * @param omitBackground - * @param deviceScaleFactor - */ - 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 - * automatically passed. - * @param outputColumnNames - * @param selectedPoints - * @example - * ```js - * embed.on(EmbedEvent.CustomAction, e => { - * const underlying = await e.answerService.getUnderlyingDataForPoint([ - * 'col name 1' // The column should exist in the data source. - * ]); - * const data = await underlying.fetchData(0, 100); - * }) - * ``` - * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl - */ - getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise; - /** - * Execute a custom graphql query in the context of the answer. - * @param query graphql query - * @param variables graphql variables - * @returns - */ - executeQuery(query: string, variables: any): Promise; - /** - * Get the internal session details for the answer. - * @returns - */ - getSession(): SessionInterface; - getAnswer(): Promise; - getTML(): Promise; - addDisplayedVizToLiveboard(liveboardId: string): Promise; - setTMLOverride(override: any): void; -} -/** - * The authentication mechanism for allowing access to the - * the embedded app - * @group Authentication / Init - */ -export declare enum AuthType { - /** - * No authentication on the SDK. Pass-through to the embedded App. Alias for - * `Passthrough`. - * @example - * ```js - * init({ - * // ... - * authType: AuthType.None, - * }); - * ``` - */ - None = "None", - /** - * Passthrough SSO to the embedded application within the iframe. Requires least - * configuration, but may not be supported by all IDPs. This will behave like `None` - * if SSO is not configured on ThoughtSpot. - * - * 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({ - * // ... - * authType: AuthType.EmbeddedSSO, - * }); - * ``` - * @version: SDK: 1.15.0 | ThoughtSpot: 8.8.0.cl - */ - EmbeddedSSO = "EmbeddedSSO", - /** - * SSO using SAML - * @deprecated Use {@link SAMLRedirect} instead - * @hidden - */ - SSO = "SSO_SAML", - /** - * SSO using SAML - * @deprecated Use {@link SAMLRedirect} instead - * @hidden - */ - SAML = "SSO_SAML", - /** - * SSO using SAML - * Makes the host application redirect to the SAML IdP. Use this - * if your IdP does not allow itself to be embedded. - * - * 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({ - * // ... - * authType: AuthType.SAMLRedirect, - * }); - * ``` - * - * This opens the SAML IdP in a popup window. The popup is triggered - * when the user clicks the trigger button. The popup window will be - * closed automatically after authentication. - * @example - * ```js - * init({ - * // ... - * authType: AuthType.SAMLRedirect, - * authTriggerText: 'Login with SAML', - * authTriggerContainer: '#tsEmbed', - * inPopup: true, - * }); - * ``` - * - * Can also use the event to trigger the popup flow. Works the same - * as the above example. - * @example - * ```js - * const authEE = init({ - * // ... - * authType: AuthType.SAMLRedirect, - * inPopup: true, - * }); - * - * someButtonOnYourPage.addEventListener('click', () => { - * authEE.emit(AuthEvent.TRIGGER_SSO_POPUP); - * }); - * ``` - */ - SAMLRedirect = "SSO_SAML", - /** - * SSO using OIDC - * @hidden - * @deprecated Use {@link OIDCRedirect} instead - */ - OIDC = "SSO_OIDC", - /** - * SSO using OIDC - * Will make the host application redirect to the OIDC IdP. - * See code samples in {@link SAMLRedirect}. - */ - OIDCRedirect = "SSO_OIDC", - /** - * Trusted authentication server - * @hidden - * @deprecated Use {@link TrustedAuth} instead - */ - AuthServer = "AuthServer", - /** - * Trusted authentication server. Use your own authentication server - * which returns a bearer token, generated using the `secret_key` obtained - * from ThoughtSpot. - * @example - * ```js - * init({ - * // ... - * authType: AuthType.TrustedAuthToken, - * getAuthToken: () => { - * return fetch('https://my-backend.app/ts-token') - * .then((response) => response.json()) - * .then((data) => data.token); - * } - * }); - * ``` - */ - TrustedAuthToken = "AuthServer", - /** - * Trusted authentication server Cookieless, Use your own authentication - * server which returns a bearer token, generated using the `secret_key` - * 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({ - * // ... - * authType: AuthType.TrustedAuthTokenCookieless, - * getAuthToken: () => { - * return fetch('https://my-backend.app/ts-token') - * .then((response) => response.json()) - * .then((data) => data.token); - * } - * ``` - * @version SDK: 1.22.0| ThoughtSpot: 9.3.0.cl, 9.5.1.sw - */ - TrustedAuthTokenCookieless = "AuthServerCookieless", - /** - * Use the ThoughtSpot login API to authenticate to the cluster directly. - * - * Warning: This feature is primarily intended for developer testing. It is - * strongly advised not to use this authentication method in production. - */ - Basic = "Basic" -} -/** - * - * This option does not apply to the classic homepage experience. - * To access the updated modular homepage, - * set `modularHomeExperience` to `true` - * (available as Early Access feature in 9.12.5.cl). - * - */ -export declare enum HomeLeftNavItem { - /** - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl - */ - SearchData = "search-data", - /** - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl - */ - Home = "insights-home", - /** - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl - */ - Liveboards = "liveboards", - /** - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl - */ - Answers = "answers", - /** - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl - */ - MonitorSubscription = "monitor-alerts", - /** - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl - */ - SpotIQAnalysis = "spotiq-analysis", - /** - * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl - */ - LiveboardSchedules = "liveboard-schedules", - /** - * Create new options in the insights left navigation, - * available when new navigation V3 is enabled. - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - Create = "create", - /** - * Spotter option in the insights left navigation, - * available when new navigation V3 is enabled. - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - Spotter = "spotter", - /** - * Favorites option in the insights left navigation, - * available when new navigation V3 is enabled. - * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl - */ - Favorites = "favorites" -} -export type DOMSelector = string | HTMLElement; -/** - * inline customCSS within the {@link CustomisationsInterface}. - * Use {@link CustomCssVariables} or css rules. - */ -export interface customCssInterface { - /** - * The custom css variables, which can be set. - * The variables are available in the {@link CustomCssVariables} - * interface. For more information, see - * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference]. - */ - variables?: CustomCssVariables; - /** - * Can be used to define a custom font face - * like: - * @example - * ```js - * rules_UNSTABLE?: { - * "@font-face": { - * "font-family": "custom-font", - * "src": url("/path/") - * }; - * }; - * ``` - * - * Also, custom css rules outside of variables. - * @example - * ```js - * rules_UNSTABLE?: { - * ".thoughtspot_class_name": { - * "border-radius": "10px", - * margin: "20px" - * }; - * }; - * ``` - */ - rules_UNSTABLE?: { - [selector: string]: { - [declaration: string]: string; - }; - }; -} -/** - * Styles within the {@link CustomisationsInterface}. - */ -export interface CustomStyles { - customCSSUrl?: string; - customCSS?: customCssInterface; -} -/** - * Configuration to define the customization on the Embedded - * ThoughtSpot components. - * You can customize styles, text strings, and icons. - * For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework]. - * @example - * ```js - * init({ - * // ... - * customizations: { - * style: { - * customCSS: { - * variables: {}, - * rules_UNSTABLE: {} - * } - * }, - * content: { - * strings: { - * 'LIVEBOARDS': 'Dashboards', - * 'ANSWERS': 'Visualizations', - * 'Edit': 'Modify', - * 'Show underlying data': 'Show source data', - * 'SpotIQ': 'Insights', - * 'Monitor': 'Alerts', - * } - * }, - * iconSpriteUrl: 'https://my-custom-icon-sprite.svg' - * } - * }) - * ``` - */ -export interface CustomisationsInterface { - style?: CustomStyles; - content?: { - /** - * @version SDK: 1.26.0 | 9.7.0.cl - */ - strings?: Record; - stringIDs?: Record; - stringIDsUrl?: string; - [key: string]: any; - }; - iconSpriteUrl?: string; -} -/** - * The configuration object for embedding ThoughtSpot content. - * It includes the ThoughtSpot hostname or IP address, - * the type of authentication, and the authentication endpoint - * if a trusted authentication server is used. - * @group Authentication / Init - */ -export interface EmbedConfig { - /** - * The ThoughtSpot cluster hostname or IP address. - */ - thoughtSpotHost: string; - /** - * The authentication mechanism to use. - */ - authType: AuthType; - /** - * [AuthServer] The trusted authentication endpoint to use to get the - * authentication token. A `GET` request is made to the - * authentication API endpoint, which returns the token - * as a plaintext response. For trusted authentication, - * the `authEndpoint` or `getAuthToken` attribute is required. - */ - authEndpoint?: string; - /** - * [AuthServer] A function that invokes the trusted authentication endpoint - * and returns a Promise that resolves to the `auth token` string. - * For trusted authentication, the `authEndpoint` or `getAuthToken` - * attribute is required. - * - * It is advisable to fetch a new token inside this method and not - * reuse the old issued token. When auth expires this method is - * called again and if it is called with an older token, the authentication - * will not succeed. - */ - getAuthToken?: () => Promise; - /** - * [AuthServer / Basic] The user name of the ThoughtSpot user. This - * attribute is required for trusted authentication. - */ - username?: string; - /** - * [Basic] The ThoughtSpot login password corresponding to the username - * - * Warning: This feature is primarily intended for developer testing. It is - * strongly advised not to use this authentication method in production. - */ - password?: string; - /** - * [SSO] For SSO Authentication, if `noRedirect` is set to true, it will - * open the SAML auth flow in a popup, instead of redirecting the browser in - * place. - * @default false - * @deprecated - */ - noRedirect?: boolean; - /** - * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open - * the SAML auth flow in a popup, instead of redirecting the browser in place. - * - * Need to use this with `authTriggerContainer`. Or manually trigger - * the `AuthEvent.TRIGGER_SSO_POPUP` event on a user interaction. - * @default false - * @version SDK: 1.18.0 - */ - inPopup?: boolean; - /** - * [SSO] For SSO Authentication, one can supply an optional path param; - * This will be the path on the host origin where the SAML flow will be - * terminated. - * - * Eg: "/dashboard", "#/foo" [Do not include the host] - * @version SDK: 1.10.2 | ThoughtSpot 8.2.0.cl, 8.4.1.sw - */ - redirectPath?: string; - /** @internal */ - basepath?: string; - /** - * Boolean to define if the query parameters in the ThoughtSpot URL - * should be encoded in base64. This provides additional security to - * ThoughtSpot clusters against cross-site scripting attacks. - * @default false - */ - shouldEncodeUrlQueryParams?: boolean; - /** - * Suppress cookie access alert when third-party cookies are blocked by the - * user's browser. Third-party cookie blocking is the default behaviour on - * some web browsers like Safari. If you set this attribute to `true`, - * you are encouraged to handle `noCookieAccess` event, to show your own treatment - * in this case. - * @default false - */ - suppressNoCookieAccessAlert?: boolean; - /** - * Ignore the cookie access alert when third-party cookies are blocked by the - * user's browser. If you set this to `true`, the embedded iframe behaviour - * persists even in the case of a non-logged-in user. - * @default false - */ - ignoreNoCookieAccess?: boolean; - /** - * Re-login a user with the previous login options - * when a user session expires. - * @default false - */ - autoLogin?: boolean; - /** - * Disable redirection to the login page when the embedded session expires - * This flag is typically used alongside the combination of authentication modes such - * as {@link AuthType.AuthServer} and auto-login behavior {@link - * EmbedConfig.autoLogin} - * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - * @default false - */ - disableLoginRedirect?: boolean; - /** - * This message is displayed in the embedded view when a user login fails. - * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw - */ - loginFailedMessage?: string; - /** - * Calls the prefetch method internally when set to `true` - * @default false - */ - callPrefetch?: boolean; - /** - * When there are multiple objects embedded, queue the rendering of embedded objects - * to start after the previous embed's render is complete. This helps improve - * performance by decreasing the load on the browser. - * @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1 - * @default false - */ - queueMultiRenders?: boolean; - /** - * [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 - * `NO_COOKIE_ACCESS` event to handle the situation. - * - * This is slightly slower than letting the browser handle the cookie check, as it - * involves an extra network call. - * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw - */ - detectCookieAccessSlow?: boolean; - /** - * Hide the `beta` alert warning message for SearchEmbed. - * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw* - */ - suppressSearchEmbedBetaWarning?: boolean; - /** - * Hide `beta` alert warning message for SageEmbed. - * - */ - suppressSageEmbedBetaWarning?: boolean; - /** - * Custom style params for embed Config. - * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw - */ - customizations?: CustomisationsInterface; - /** - * For `inPopup` SAMLRedirect or OIDCRedirect authentication, we need a - * button that the user can click to trigger the flow. - * This attribute sets a containing element for that button. - * @example - * ```js - * init({ - * authType: AuthType.SAMLRedirect, - * inPopup: true, - * authTriggerContainer: '#auth-trigger-container' - * }) - * ``` - * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw - */ - authTriggerContainer?: string | HTMLElement; - /** - * Specify that we want to use the `AuthEvent.TRIGGER_SSO_POPUP` event to trigger - * SAML popup. This is useful when you want to trigger the popup on a custom user - * action. - * - */ - useEventForSAMLPopup?: boolean; - /** - * Text to show in the button which triggers the popup auth flow. - * Default: `Authorize`. - * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl, 9.0.1.sw - */ - authTriggerText?: string; - /** - * Prevent users from accessing the full application or ThoughtSpot application pages - * access to the embedded application users - * outside of the iframe. - * @default true - * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1.sw - */ - blockNonEmbedFullAppAccess?: boolean; - /** - * Host config in case embedded app is inside TS app itself - * @hidden - */ - hostConfig?: { - hostUserGuid: string; - hostClusterId: string; - hostClusterName: string; - }; - /** - * Pendo API key to enable Pendo tracking to your own subscription, the key - * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document]. - * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl - */ - pendoTrackingKey?: string; - /** - * If passed as true all alerts will be suppressed in the embedded app. - * @version SDK: 1.26.2 | ThoughtSpot: * - */ - suppressErrorAlerts?: boolean; - /** - * Suppress or show specific types of logs in the console output. - * For example, `LogLevel.ERROR` shows only Visual Embed SDK and - * ThoughtSpot application errors and suppresses - * other logs such as warnings, information alerts, - * and debug messages in the console output. - * - * @default LogLevel.ERROR - * @example - * ```js - * init({ - * ...embedConfig, - * logLevel: LogLevel.SILENT - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl - */ - logLevel?: LogLevel; - /** - * Disables the Mixpanel tracking from the SDK. - * @version SDK: 1.27.9 - */ - disableSDKTracking?: boolean; - /** - * Overrides default/user preferred locale for date formatting - * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw - */ - dateFormatLocale?: string; - /** - * Overrides default/user preferred locale for number formatting - * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw - */ - numberFormatLocale?: string; - /** - * Format to be used for currency when currency format is set to infer from browser - * @version SDK: 1.28.4 | ThoughtSpot: 10.0.0.cl, 9.5.0.sw - */ - currencyFormat?: string; - /** - * This flag is used to disable the token verification in the SDK. - * Enabling this flag will also disable the caching of the token. - * @hidden - * @example - * ```js - * init({ - * ...embedConfig, - * disableTokenVerification : true - * }) - * ``` - * @version SDK: 1.28.5 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw - */ - disableTokenVerification?: boolean; - /** - * This flag is used to disable showing the login failure page in the embedded app. - * @version SDK 1.32.3 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw - */ - disableLoginFailurePage?: boolean; - /** - * This is an object (key/val) of override flags which will be applied - * to the internal embedded object. This can be used to add any - * URL flag. - * Warning: This option is for advanced use only and is used internally - * to control embed behavior in non-regular ways. We do not publish the - * list of supported keys and values associated with each. - * @example - * ```js - * const embed = new LiveboardEmbed('#embed', { - * ... // other liveboard view config - * additionalFlags: { - * flag1: 'value1', - * flag2: 'value2' - * } - * }); - * ``` - * @version SDK: 1.33.5 | ThoughtSpot: * - */ - additionalFlags?: { - [key: string]: string | number | boolean; - }; - /** - * This is an object (key/val) for customVariables being - * used by the third party tool's script. - * @example - * ```js - * const embed = new LiveboardEmbed('#embed', { - * ... // other liveboard view config - * customVariablesForThirdPartyTools: { - * key1: 'value1', - * key2: 'value2' - * } - * }); - * ``` - * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl - */ - customVariablesForThirdPartyTools?: Record; - disablePreauthCache?: boolean; - /** - * Disable fullscreen presentation mode functionality. When enabled, prevents entering - * and exiting fullscreen mode for embedded visualizations during presentations. - * @default true (feature is disabled by default) - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * init({ - * ... // other embed config options - * disableFullscreenPresentation: false, // enables the feature - * }) - * ``` - */ - disableFullscreenPresentation?: boolean; - /** - * Custom Actions allows users to define interactive UI actions (like buttons or menu - * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These - * actions enable users to trigger custom workflows — such as navigating to an - * external app, calling an API, or opening a modal — based on the data context of - * what they clicked can be used to trigger custom logic when the action is clicked. - * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl - * @example - * ```js - * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk'; - * init({ - * ... // other embed config options - * customActions: [ - * { - * name: 'customAction', - * id: 'customAction', - * target: CustomActionTarget.VISUALIZATION, - * position: CustomActionPosition.PRIMARY, - * } - * } - * ] - * }) - * ``` - */ - customActions?: CustomAction[]; -} -export interface LayoutConfig { -} -/** - * Embedded iframe configuration - * @group Embed components - */ -export interface FrameParams { - /** - * The width of the iframe (unit is pixels if numeric). - */ - width?: number | string; - /** - * The height of the iframe (unit is pixels if numeric). - */ - height?: number | string; - /** - * Set to 'lazy' to enable lazy loading of the embedded TS frame. - * This will defer loading of the frame until it comes into the - * viewport. This is useful for performance optimization. - */ - loading?: "lazy" | "eager" | "auto"; - /** - * This parameters will be passed on the iframe - * as is. - */ - [key: string]: string | number | boolean | undefined; -} -/** - * The common configuration object for an embedded view. - */ -export interface BaseViewConfig { - /** - * @hidden - */ - layoutConfig?: LayoutConfig; - /** - * The width and height dimensions to render an embedded - * object inside your app. Specify the values in pixels or percentage. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1 - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * frameParams: { - * width: '500px' | '50%', - * height: '400px' | '60%', - * }, - * }) - * ``` - */ - frameParams?: FrameParams; - /** - * @hidden - */ - theme?: string; - /** - * @hidden - */ - styleSheet__unstable?: string; - /** - * The list of actions to disable from the primary menu, more menu - * (...), and the contextual menu. These actions will be disabled - * for the user. - * Use this to disable actions. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * disabledActions: [Action.Download, Action.Save], - * }); - * ``` - */ - disabledActions?: Action[]; - /** - * The tooltip to display for disabled actions. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * disabledActions: [Action.Download, Action.Save], - * disabledActionReason: "Reason for disabling", - * }); - * ``` - */ - disabledActionReason?: string; - /** - * The list of actions to hide from the embedded. - * This actions will be hidden from the user. - * Use this to hide an action. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * hiddenActions: [Action.Download, Action.Export], - * }); - * ``` - * @important - */ - hiddenActions?: Action[]; - /** - * The list of actions to display from the primary menu, more menu - * (...), and the contextual menu. These will be only actions that - * are visible to the user. - * Use this to hide all actions except the ones you want to show. - * - * Use either this or hiddenActions. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw - * @important - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * visibleActions: [Action.Download, Action.Export], - * }); - * ``` - */ - visibleActions?: Action[]; - /** - * The locale settings to apply to the embedded view. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * locale:'en', - * }) - * ``` - */ - locale?: string; - /** - * This is an object (key/val) of override flags which will be applied - * to the internal embedded object. This can be used to add any - * URL flag. - * If the same flags are passed in init, they will be overriden by the values here. - * Warning: This option is for advanced use only and is used internally - * to control embed behavior in non-regular ways. We do not publish the - * list of supported keys and values associated with each. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * additionalFlags: { - * flag1: 'value1', - * flag2: 'value2' - * }, - * }); - * ``` - * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - */ - additionalFlags?: { - [key: string]: string | number | boolean; - }; - /** - * Dynamic CSSUrl and customCSS to be injected in the loaded application. - * You would also need to set `style-src` in the CSP settings. - * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1.sw, 8.4.0.cl - * @default '' - */ - customizations?: CustomisationsInterface; - /** - * Insert as a sibling of the target container, instead of appending to a - * child inside it. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * insertAsSibling:true, - * }) - * ``` - */ - insertAsSibling?: boolean; - /** - * Use a pre-rendered iframe from a pool of pre-rendered iframes - * if available and matches the configuration. - * @version SDK: 1.22.0 - * @hidden - * - * See [docs]() on how to create a prerender pool. - */ - usePrerenderedIfAvailable?: boolean; - /** - * PreRender id to be used for PreRendering the embed. - * Use PreRender to render the embed in the background and then - * show or hide the rendered embed using showPreRender or hidePreRender respectively. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * preRenderId: "preRenderId-123", - * }); - * embed.showPreRender(); - * ``` - * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw - */ - preRenderId?: string; - /** - * Determines if the PreRender component should dynamically track the size - * of its embedding element and adjust its own size accordingly. - * Enabling this option allows the PreRender component to automatically adapt - * its dimensions based on changes to the size of the embedding element. - * @type {boolean} - * @default false - * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw - * @example - * ```js - * // Disable tracking PreRender size in the configuration - * const config = { - * doNotTrackPreRenderSize: true, - * }; - * - * // Instantiate an object with the configuration - * const myComponent = new MyComponent(config); - * ``` - */ - doNotTrackPreRenderSize?: boolean; - /** - * Enable the V2 shell. This can provide performance benefits - * due to a lighterweight shell. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * enableV2Shell_experimental: true, - * }); - * ``` - * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl - */ - enableV2Shell_experimental?: boolean; - /** - * For internal tracking of the embed component type. - * @hidden - */ - embedComponentType?: string; - /** - * This flag can be used to expose translation IDs on the embedded app. - * @default false - * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl - */ - exposeTranslationIDs?: boolean; - /** - * This flag can be used to disable links inside the embedded app, - * and disable redirection of links in a new tab. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * disableRedirectionLinksInNewTab: true, - * }); - * ``` - * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl - */ - disableRedirectionLinksInNewTab?: boolean; - /** - * Overrides an Org context for embedding application users. - * This parameter allows a user authenticated to one Org to view the - * objects from another Org. - * The `overrideOrgId` setting is honoured only if the - * Per Org URL feature is enabled on your ThoughtSpot instance. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * overrideOrgId: 142536, - * }); - * ``` - * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl - */ - overrideOrgId?: number; - /** - * Flag to override the *Open Link in New Tab* context menu option. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * linkOverride:false, - * }) - * ``` - */ - linkOverride?: boolean; - /** - * The primary action to display on top of the viz for Liveboard and App Embed. - * Use this to set the primary action. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * primaryAction: Action.Download - * }); - * ``` - */ - primaryAction?: Action | string; - /** - * flag to enable insert into slides action - * @hidden - * @private - */ - insertInToSlide?: boolean; - /** - * Show alert messages and toast messages in the embed. - * Supported embed in all embed types. - * - * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * showAlerts:true, - * }) - * ``` - */ - showAlerts?: boolean; - /** - * Custom Actions allows users to define interactive UI actions (like buttons or menu - * items) that appear in ThoughtSpot's visualizations, answers, and Liveboards. These - * actions enable users to trigger custom workflows — such as navigating to an - * external app, calling an API, or opening a modal — based on the data context of - * what they clicked can be used to trigger custom logic when the action is clicked. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterEmbed` - * @version SDK: 1.43.0 | ThoughtSpot: 10.14.0.cl - * @example - * ```js - * import { CustomActionPosition, CustomActionTarget } from '@thoughtspot/visual-embed-sdk'; - * // Use supported embed types such as AppEmbed or LiveboardEmbed - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... // other embed config options - * customActions: [ - * { - * name: 'customAction', - * id: 'customAction', - * target: CustomActionTarget.VISUALIZATION, - * position: CustomActionPosition.PRIMARY, - * } - * } - * ] - * }) - * ``` - */ - customActions?: CustomAction[]; -} -/** - * The configuration object for Home page embeds configs. - */ -export interface HomePageConfig { - /** - * Hide list page columns - * For example: hiddenListColumns = [ListPageColumns.Author] - * - * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum. - * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl - * @example - * ```js - * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk'; - * - * const embed = new AppEmbed('#tsEmbed', { - * ... //other embed view config - * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author], - * }) - * ``` - */ - hiddenListColumns?: ListPageColumns[]; - /** - * Hide the home page modules - * For example: hiddenHomepageModules = [HomepageModule.MyLibrary] - * - * **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). - * To use it, you need to import `HomepageModule` enum. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw - * @example - * ```js - * import { HomepageModule } from '@thoughtspot/visual-embed-sdk'; - * - * const embed = new AppEmbed('#tsEmbed', { - * ... //other embed view config - * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning], - * }) - * ``` - */ - hiddenHomepageModules?: HomepageModule[]; - /** - * reordering the home page modules - * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist] - * - * **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). - * To use it, you need to import `HomepageModule` enum. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw - * @example - * ```js - * import { HomepageModule } from '@thoughtspot/visual-embed-sdk'; - * - * const embed = new AppEmbed('#tsEmbed', { - * ... //other embed view config - * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary], - * }) - * ``` - */ - reorderedHomepageModules?: HomepageModule[]; - /** - * homepageLeftNavItems : Show or hide the left navigation bar items. - * There are 8 eight home navigation list items. - * To hide these items, specify the string in the array. - * - * Supported embed types: `AppEmbed` - * @example - * ```js - * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk'; - * - * const embed = new AppEmbed('#tsEmbed', { - * ... //other embed view config - * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers], - * }) - * ``` - * - * **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). - * To use it, you need to import `HomeLeftNavItem` enum. - * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw - */ - hiddenHomeLeftNavItems?: HomeLeftNavItem[]; -} -/** - * The configuration object for common Search and Liveboard embeds configs. - */ -export interface SearchLiveboardCommonViewConfig { - /** - * The list of runtime filters to apply to a search Answer, - * visualization, or Liveboard. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed` - * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * runtimeFilters: [ - * { - * columnName: 'value', - * operator: RuntimeFilterOp.EQ, - * values: ['string' | 123 | true], - * }, - * ], - * }) - * ``` - */ - runtimeFilters?: RuntimeFilter[]; - /** - * The list of parameter override to apply to a search Answer, - * visualization, or Liveboard. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed` - * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * runtimeParameters: [ - * { - * name: 'value', - * value: 'string' | 123 | true, - * }, - * ] - * }) - * ``` - */ - runtimeParameters?: RuntimeParameter[]; - /** - * flag to set ContextMenu Trigger to either left or right click. - * - * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK, - * }) - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl - */ - contextMenuTrigger?: ContextMenuTriggerOptions; - /** - * Boolean to exclude runtimeFilters in the URL - * By default it is true, this flag removes runtime filters from the URL - * when set to false, runtime filters will be included in the URL. - * - * Irrespective of this flag, runtime filters ( if passed ) will be applied to the - * embedded view. - * @default false - * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl - */ - excludeRuntimeFiltersfromURL?: boolean; - /** - * Boolean to exclude runtimeParameters from the URL - * when set to true, this flag removes runtime parameters from the URL. - * - * Irrespective of this flag, runtime filters ( if passed ) will be applied to the - * embedded view. - * @default false - * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl - */ - excludeRuntimeParametersfromURL?: boolean; - /** - * To set the initial state of the search bar in case of saved Answers. - * - * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed` - * @default true - * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl - * @example - * ```js - * // Replace with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * collapseSearchBar: true, - * }); - */ - collapseSearchBar?: boolean; - /** - * Flag to control Data panel experience - * - * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed` - * @default true - * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl - * @example - * ```js - * // Replace with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * dataPanelV2: true, - * }) - * ``` - */ - dataPanelV2?: boolean; - /** - * To enable custom column groups in data panel v2 - * - * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw - * @default false - * @example - * ```js - * // Replace with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * enableCustomColumnGroups: true, - * }); - * ``` - */ - enableCustomColumnGroups?: boolean; -} -/** - * The configuration object for common Liveboard and App embeds configs. - */ -export interface LiveboardAppEmbedViewConfig { - /** - * Show or hide Liveboard header - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl - * @default false - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * hideLiveboardHeader : true, - * }) - * ``` - */ - hideLiveboardHeader?: boolean; - /** - * Show or hide Liveboard title - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl - * @default false - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * showLiveboardTitle:true, - * }) - * ``` - */ - showLiveboardTitle?: boolean; - /** - * Show or hide Liveboard description - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl - * @default false - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * showLiveboardDescription:true, - * }) - * ``` - */ - showLiveboardDescription?: boolean; - /** - * Boolean to control if Liveboard header is sticky or not. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#embed', { - * ... // other app view config - * isLiveboardHeaderSticky: true, - * }); - * ``` - * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl - */ - isLiveboardHeaderSticky?: boolean; - /** - * This attribute can be used to enable the two-column layout on an embedded Liveboard - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @type {boolean} - * @default false - * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * enable2ColumnLayout: true, - * }) - * ``` - */ - enable2ColumnLayout?: boolean; - /** - * This flag can be used to enable the compact header in Liveboard - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @type {boolean} - * @default false - * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * isLiveboardCompactHeaderEnabled: true, - * }) - * ``` - */ - isLiveboardCompactHeaderEnabled?: boolean; - /** - * This flag can be used to show or hide the Liveboard verified icon in the compact - * header. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl - * @default true - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * showLiveboardVerifiedBadge: true, - * }) - * ``` - */ - showLiveboardVerifiedBadge?: boolean; - /** - * This flag is used to enable/disable hide irrelevant filters in Liveboard tab - * - * **Note**: This feature is supported only if compact header is enabled on your Liveboard. To enable compact header, use the `isLiveboardCompactHeaderEnabled` attribute. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl - * @default false - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * hideIrrelevantChipsInLiveboardTabs: true, - * isLiveboardCompactHeaderEnabled: true, - * }) - * ``` - */ - hideIrrelevantChipsInLiveboardTabs?: boolean; - /** - * This flag can be used to show or hide the re-verify banner on the Liveboard - * compact header - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl - * @default true - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * showLiveboardReverifyBanner: true, - * }) - * ``` - */ - showLiveboardReverifyBanner?: boolean; - /** - * enable or disable ask sage - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl - * @default false - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * enableAskSage:true, - * }) - * ``` - */ - enableAskSage?: boolean; - /** - * This flag is used to show or hide checkboxes for including or excluding - * the cover and filters pages in the Liveboard PDF. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * coverAndFilterOptionInPDF: false, - * }) - * ``` - */ - coverAndFilterOptionInPDF?: boolean; - /** - * This flag is used to enable or disable the XLSX/CSV download option for Liveboards. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.41.0 | ThoughtSpot: 10.14.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * liveboardXLSXCSVDownload: true, - * }) - * ``` - */ - liveboardXLSXCSVDownload?: boolean; - /** - * This flag is used to enable or disable the link parameters in liveboard. - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * isLinkParametersEnabled: true, - * }) - * ``` - */ - isLinkParametersEnabled?: boolean; -} -export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig { -} -/** - * MessagePayload: Embed event payload: message type, data and status (start/end) - * @group Events - */ -export type MessagePayload = { - type: string; - data: any; - status?: string; -}; -/** - * MessageOptions: By providing options, getting specific event start / end based on - * option - * @group Events - */ -export type MessageOptions = { - /** - * A boolean value indicating that start status events of this type - * will be dispatched. - */ - start?: boolean; -}; -/** - * MessageCallback: Embed event message callback - * @group Events - */ -export type MessageCallback = (payload: MessagePayload, -/** - * responder: Message callback function triggered when embed event - * initiated - */ -responder?: (data: any) => void) => void; -/** - * A map of the supported runtime filter operations - */ -export declare enum RuntimeFilterOp { - /** - * Equals - */ - EQ = "EQ", - /** - * Does not equal - */ - NE = "NE", - /** - * Less than - */ - LT = "LT", - /** - * Less than or equal to - */ - LE = "LE", - /** - * Greater than - */ - GT = "GT", - /** - * Greater than or equal to - */ - GE = "GE", - /** - * Contains - */ - CONTAINS = "CONTAINS", - /** - * Begins with - */ - BEGINS_WITH = "BEGINS_WITH", - /** - * Ends with - */ - ENDS_WITH = "ENDS_WITH", - /** - * Between, inclusive of higher value - */ - BW_INC_MAX = "BW_INC_MAX", - /** - * Between, inclusive of lower value - */ - BW_INC_MIN = "BW_INC_MIN", - /** - * Between, inclusive of both higher and lower value - */ - BW_INC = "BW_INC", - /** - * Between, non-inclusive - */ - BW = "BW", - /** - * Is included in this list of values - */ - IN = "IN", - /** - * Is not included in this list of values - */ - NOT_IN = "NOT_IN" -} -/** - * 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, 10.1.0.sw - */ -export declare enum HomepageModule { - /** - * Search bar - */ - Search = "SEARCH", - /** - * kPI watchlist module - */ - Watchlist = "WATCHLIST", - /** - * favorite objects - */ - Favorite = "FAVORITE", - /** - * List of answers and Liveboards - */ - MyLibrary = "MY_LIBRARY", - /** - * Trending list - */ - Trending = "TRENDING", - /** - * Learning videos - */ - Learning = "LEARNING" -} -/** - * List page columns that can be hidden. - * **Note**: This option is applicable to full app embedding only. - * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl - */ -export declare enum ListPageColumns { - /** - * Favourite - */ - Favourite = "FAVOURITE", - /** - * Tags - */ - Tags = "TAGS", - /** - * Author - */ - Author = "AUTHOR", - /** - * Last viewed/Last modified - */ - DateSort = "DATE_SORT", - /** - * Share - */ - Share = "SHARE" -} -/** - * A filter that can be applied to ThoughtSpot answers, Liveboards, or - * visualizations at runtime. - */ -export interface RuntimeFilter { - /** - * The name of the column to filter on (case-sensitive) - */ - columnName: string; - /** - * The operator to apply - */ - operator: RuntimeFilterOp; - /** - * The list of operands. Some operators like EQ, LE accept - * a single operand, whereas other operators like BW and IN accept multiple - * operands. - */ - values: (number | boolean | string | bigint)[]; -} -/** - * A filter that can be applied to ThoughtSpot Answers, Liveboards, or - * visualizations at runtime. - */ -export interface RuntimeParameter { - /** - * The name of the runtime parameter to filter on (case-sensitive) - */ - name: string; - /** - * Values - */ - value: number | boolean | string; -} -/** - * Event types emitted by the embedded ThoughtSpot application. - * - * 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'; - * // Or - * // const { EmbedEvent } = window.tsembed; - * - * // create the liveboard embed. - * - * liveboardEmbed.on(EmbedEvent.Drilldown, (drilldown) => { - * 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` convention. - * For example,`onAlert`, `onCopyToClipboard` and so on. - * @example - * ```js - * // ... - * const MyComponent = ({ dataSources }) => { - * const onLoad = () => { - * console.log(EmbedEvent.Load, {}); - * }; - * - * return ( - * - * ); - * }; - * ``` - * @group Events - */ -export declare enum EmbedEvent { - /** - * Rendering has initialized. - * @example - *```js - * liveboardEmbed.on(EmbedEvent.Init, showLoader) - * //show a loader - * function showLoader() { - * document.getElementById("loader"); - * } - *``` - * @returns timestamp - The timestamp when the event was generated. - */ - 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 => { - * console.log('AuthInit', payload); - * }) - *``` - * @returns isLoggedIn - A Boolean specifying whether authentication was successful. - */ - 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 - * liveboardEmbed.on(EmbedEvent.Load, hideLoader) - * //hide loader - * function hideLoader() { - * document.getElementById("loader"); - * } - *``` - */ - Load = "load", - /** - * Data pertaining to an Answer, Liveboard or Spotter visualization is received. - * The event payload includes the raw data of the object. - * @return data - Answer of Liveboard data - * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw - * @example - *```js - * liveboardEmbed.on(EmbedEvent.Data, payload => { - * console.log('data', payload); - * }) - *``` - * @important - */ - Data = "data", - /** - * Search query has been updated by the user. - * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw - * @example - *```js - * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload)) - *``` - */ - 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 - * @example - *```js - * searchEmbed.on(EmbedEvent.DrillDown, { - * points: { - * clickedPoint, - * selectedPoints: selectedPoint - * }, - * autoDrillDown: true, - * }) - *``` - * In this example, `VizPointDoubleClick` event is used for - * triggering the `DrillDown` event when an area or specific - * data point on a table or chart is double-clicked. - * @example - *```js - * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => { - * console.log(payload); - * const clickedPoint = payload.data.clickedPoint; - * const selectedPoint = payload.data.selectedPoints; - * console.log('>>> called', clickedPoint); - * embed.trigger(HostEvent.DrillDown, { - * points: { - * clickedPoint, - * selectedPoints: selectedPoint - * }, - * autoDrillDown: true, - * }) - * }) - *``` - */ - 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 - * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => { - * console.log('DataSourceSelected', payload); - * }) - * ``` - */ - 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 - * ```js - * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => { - * console.log('AddRemoveColumns', payload); - * }) - * ``` - */ - 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 - * appEmbed.on(EmbedEvent.customAction, payload => { - * const data = payload.data; - * if (data.id === 'insert Custom Action ID here') { - * console.log('Custom Action event:', data.embedAnswerData); - * } - * }) - * ``` - */ - 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 - * ```js - * LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => { - * console.log('VizPointDoubleClick', payload); - * }) - * ``` - */ - 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 - * @example - * ```js - * embed.on(EmbedEvent.VizPointClick, ({data}) => { - * console.log( - * data.vizId, // viz id - * data.clickedPoint.selectedAttributes[0].value, - * data.clickedPoint.selectedAttributes[0].column.name, - * data.clickedPoint.selectedMeasures[0].value, - * data.clickedPoint.selectedMeasures[0].column.name, - * ) - * }); - * ``` - */ - VizPointClick = "vizPointClick", - /** - * An error has occurred. This event is fired for the following error types: - * - * `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. - * - * 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 - * // API error - * SearchEmbed.on(EmbedEvent.Error, (error) => { - * console.log(error); - * // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } } - * }); - * ``` - * @example - * ```js - * // Fullscreen error (Errors during presenting of a liveboard) - * LiveboardEmbed.on(EmbedEvent.Error, (error) => { - * console.log(error); - * // { type: "Error", data: { errorType: "FULLSCREEN", error: { - * // message: "Fullscreen API is not enabled", - * // stack: "..." - * // } }} - * }) - * ``` - */ - 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) - * ``` - */ - Alert = "alert", - /** - * The ThoughtSpot authentication session has expired. - * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw - * @example - *```js - * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired) - * //show auth expired banner - * function showAuthExpired() { - * document.getElementById("authExpiredBanner"); - * } - *``` - */ - AuthExpire = "ThoughtspotAuthExpired", - /** - * ThoughtSpot failed to validate the auth session. - * @hidden - */ - AuthFailure = "ThoughtspotAuthFailure", - /** - * ThoughtSpot failed to re validate the auth session. - * @hidden - */ - IdleSessionTimeout = "IdleSessionTimeout", - /** - * ThoughtSpot failed to validate the auth session. - * @hidden - */ - AuthLogout = "ThoughtspotAuthLogout", - /** - * The height of the embedded Liveboard or visualization has been computed. - * @returns data - The height of the embedded Liveboard or visualization - * @hidden - */ - EmbedHeight = "EMBED_HEIGHT", - /** - * The center of visible iframe viewport is calculated. - * @returns data - The center of the visible Iframe viewport. - * @hidden - */ - EmbedIframeCenter = "EmbedIframeCenter", - /** - * 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 - * searchbarEmbed.on(EmbedEvent.GetDataClick) - * .then(data => { - * console.log('Answer Data:', data); - * }) - *``` - */ - GetDataClick = "getDataClick", - /** - * Detects the route change. - * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw - * @example - *```js - * searchEmbed.on(EmbedEvent.RouteChange, payload => - * console.log('data', payload)) - *``` - */ - RouteChange = "ROUTE_CHANGE", - /** - * The v1 event type for Data - * @hidden - */ - 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. `NoCookieAccess` can trigger. - * @example - *```js - * appEmbed.on(EmbedEvent.NoCookieAccess) - *``` - * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1.sw - */ - NoCookieAccess = "noCookieAccess", - /** - * Emitted when SAML is complete - * @private - * @hidden - */ - 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 - * appEmbed.on(EmbedEvent.DialogOpen, payload => { - * console.log('dialog open', payload); - * }) - *``` - */ - 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 - * appEmbed.on(EmbedEvent.DialogClose, payload => { - * console.log('dialog close', payload); - * }) - *``` - */ - DialogClose = "dialog-close", - /** - * Emitted when the Liveboard shell loads. - * You can use this event as a hook to trigger - * other events on the rendered Liveboard. - * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - * @example - *```js - * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => { - console.log('Liveboard is rendered', payload); - }) - *``` - * The following example shows how to trigger - * `SetVisibleVizs` event using LiveboardRendered embed event: - * @example - *```js - * const embedRef = useEmbedRef(); - * const onLiveboardRendered = () => { - * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']); - * }; - *``` - */ - LiveboardRendered = "PinboardRendered", - /** - * Emits all events. - * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw - * @example - *```js - * appEmbed.on(EmbedEvent.ALL, payload => { - * console.log('Embed Events', payload) - * }) - *``` - */ - 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 - * //Emit when action starts - * searchEmbed.on(EmbedEvent.Save, payload => { - * console.log('Save', payload) - * }, { - * start: true - * }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.Save, payload => { - * console.log('Save', payload) - * }) - *``` - */ - Save = "save", - /** - * Emitted when the download action is triggered on an Answer. - * - * **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 - * liveboardEmbed.on(EmbedEvent.Download, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c' - * }) - *``` - */ - 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 - * //emit when action starts - * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => { - * console.log('download PNG', payload)}, {start: true }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => { - * console.log('download PNG', payload)}) - *``` - */ - 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 - * //emit when action starts - * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => { - * console.log('download PDF', payload)}, {start: true }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => { - * console.log('download PDF', payload)}) - *``` - */ - 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 - * //emit when action starts - * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => { - * console.log('download CSV', payload)}, {start: true }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => { - * console.log('download CSV', payload)}) - *``` - */ - 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 - * //emit when action starts - * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => { - * console.log('download Xlsx', payload)}, { start: true }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => { - * console.log('download Xlsx', payload)}) - *``` - */ - 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 }) - * //trigger when action is completed - * appEmbed.on(EmbedEvent.AnswerDelete, payload => { - * console.log('delete answer', payload)}) - *``` - */ - AnswerDelete = "answerDelete", - /** - * Emitted when a user initiates the Pin action to - * add an Answer to a Liveboard. - * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw - * @example - *```js - * //emit when action starts - * searchEmbed.on(EmbedEvent.Pin, payload => { - * console.log('pin', payload) - * }, { - * start: true - * }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.Pin, payload => { - * console.log('pin', payload) - * }) - *``` - */ - Pin = "pin", - /** - * Emitted when SpotIQ analysis is triggered - * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw - * @example - *```js - * //emit when action starts - * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => { - * console.log('SpotIQAnalyze', payload) - * }, { - * start: true - * }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => { - * console.log('SpotIQ analyze', payload) - * }) - *``` - */ - 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 - * //emit when action starts - * searchEmbed.on(EmbedEvent.Share, payload => { - * console.log('Share', payload) - * }, { - * start: true - * }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.Share, payload => { - * console.log('Share', payload) - * }) - *``` - */ - Share = "share", - /** - * 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 - * appEmbed.on(EmbedEvent.DrillInclude, payload => { - * console.log('Drill include', payload); - * }) - *``` - */ - DrillInclude = "context-menu-item-include", - /** - * 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 - * appEmbed.on(EmbedEvent.DrillExclude, payload => { - * console.log('Drill exclude', payload); - * }) - *``` - */ - 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 - * seachEmbed.on(EmbedEvent.CopyToClipboard, payload => { - * console.log('copy to clipboard', payload); - * }) - *``` - */ - CopyToClipboard = "context-menu-item-copy-to-clipboard", - /** - * 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 - * liveboardEmbed.on(EmbedEvent.UpdateTML) - * }) - *``` - */ - 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 - * appEmbed.on(EmbedEvent.EditTML, payload => { - * console.log('Edit TML', payload); - * }) - *``` - */ - EditTML = "editTSL", - /** - * 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 - * //emit when action starts - * searchEmbed.on(EmbedEvent.ExportTML, payload => { - * console.log('Export TML', payload)}, { start: true }) - * //emit when action ends - * searchEmbed.on(EmbedEvent.ExportTML, payload => { - * console.log('Export TML', payload)}) - *``` - */ - 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 - * appEmbed.on(EmbedEvent.SaveAsView, payload => { - * console.log('View', payload); - * }) - *``` - */ - 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 - * //emit when action starts - * appEmbed.on(EmbedEvent.CopyAEdit, payload => { - * console.log('Copy and edit', payload)}, {start: true }) - * //emit when action ends - * appEmbed.on(EmbedEvent.CopyAEdit, payload => { - * console.log('Copy and edit', payload)}) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.ShowUnderlyingData, payload => { - * console.log('show data', payload); - * }) - *``` - */ - 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 - * searchEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => { - * console.log('switch view', payload); - * }) - *``` - */ - AnswerChartSwitcher = "answerChartSwitcher", - /** - * Internal event to communicate the initial settings back to the ThoughtSpot app - * @hidden - */ - APP_INIT = "appInit", - /** - * Internal event to clear the cached info - * @hidden - */ - CLEAR_INFO_CACHE = "clearInfoCache", - /** - * 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 - * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => { - * console.log('Liveboard details', payload); - * }) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.AddToFavorites, payload => { - * console.log('favorites', payload); - * }) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.Schedule, payload => { - * console.log(`Liveboard schedule', payload); - * }) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.Edit, payload => { - * console.log(`Liveboard edit', payload); - * }) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.MakeACopy, payload => { - * console.log(`Copy', payload); - * }) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.Present) - *``` - * @example - *```js - * liveboardEmbed.on(EmbedEvent.Present, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - * }) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.Delete, - * {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.SchedulesList) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.Cancel) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.Explore, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - *``` - */ - 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 - * liveboardEmbed.on(EmbedEvent.CopyLink, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - *``` - */ - 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, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - *``` - */ - 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 - * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => { - * console.log('VizPointClick', payload) - * }) - *``` - */ - VizPointRightClick = "vizPointRightClick", - /** - * Emitted when a user clicks **Insert to slide** on a visualization - * @hidden - */ - InsertIntoSlide = "insertInToSlide", - /** - * 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 - * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => { - * console.log('payload', payload); - * }) - * - * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw - */ - FilterChanged = "filterChanged", - /** - * Emitted when a user clicks the **Go** button to initiate - * a Natural Language Search query - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - SageEmbedQuery = "sageEmbedQuery", - /** - * Emitted when a user selects a data source on the embedded - * Natural Language Search interface. - * - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - 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 - */ - 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 - */ - 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 - * @returns isPublic: boolean - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - UpdatePersonalisedView = "updatePersonalisedView", - /** - * Emitted when a Personalised view is saved. - * @returns viewName: string - * @returns viewId: string - * @returns liveboardId: string - * @returns isPublic: boolean - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - SavePersonalisedView = "savePersonalisedView", - /** - * Emitted when a Liveboard is reset. - * @returns viewName: string - * @returns viewId: string - * @returns liveboardId: string - * @returns isPublic: boolean - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - 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 - */ - DeletePersonalisedView = "deletePersonalisedView", - /** - * Emitted when a user creates a Worksheet. - * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - */ - CreateWorksheet = "createWorksheet", - /** - * Emitted when the *Ask Sage* is initialized. - * @returns viewName: string - * @returns viewId: string - * @returns liveboardId: string - * @returns isPublic: boolean - * @version SDK : 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl - */ - AskSageInit = "AskSageInit", - /** - * Emitted when a Liveboard or visualization is renamed. - * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw - */ - Rename = "rename", - /** - * - * This event can be emitted to intercept search execution initiated by - * the users and implement the logic to allow or restrict search execution. - * You can can also show custom error text if the search query must be - * restricted due to your application or business requirements. - - * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true` - * for this embed event to get emitted. - * @param: payload - * @param: responder - * Contains elements that lets developers define whether ThoughtSpot - * should run the search, and if not, what error message - * should be shown to the user. - * - * 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 error message text when `execute` - * returns `false` using the error parameter in responder. - * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl - * @example - *```js - * .on(EmbedEvent.OnBeforeGetVizDataIntercept, - * (payload, responder) => { - * responder({ - * data: { - * 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." - * } - * }}) - * }) - *``` - */ - OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept", - /** - * Emitted when parameter changes in an Answer - * or Liveboard. - * ```js - * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl - */ - ParameterChanged = "parameterChanged", - /** - * Emits when a table visualization is rendered in - * the ThoughtSpot embedded app. - * - * You can also use this event as a hook to trigger host events - * such as `HostEvent.TransformTableVizData` on the table visualization. - * The event payload contains the data used in the rendered table. - * You can extract the relevant data from the payload - * stored in `payload.data.data.columnDataLite`. - * - * `columnDataLite` is a multidimensional array that contains - * data values for each column, which was used in the query to - * generate the table visualization. To find and modify specific cell data, - * you can either loop through the array or directly access a cell if - * you know its position and data index. - * - * In the following code sample, the first cell in the first column - * (`columnDataLite[0].dataValue[0]`) is set to `new fob`. - * Note that any changes made to the data in the payload will only update the - * visual presentation and do not affect the underlying data. - * To persist data value modifications after a reload or during chart - * interactions such as drill down, ensure that the modified - * payload in the `columnDataLite` is passed on to - * `HostEvent.TransformTableVizData` and trigger an update to - * the table visualization. - * - * If the Row-Level Security (RLS) rules are applied on the - * Worksheet or Model, exercise caution when changing column - * or table cell values to maintain data security. - * - * @example - * ```js - * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => { - * console.log(payload); - * const columnDataLite = payload.data.data.columnDataLite; - * columnDataLite[0].dataValue[0]="new fob"; - * console.log('>>> new Data', columnDataLite); - * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite); - * }) - * ``` - * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl - */ - TableVizRendered = "TableVizRendered", - /** - * Emitted when the liveboard is created from pin modal or Liveboard list page. - * You can use this event as a hook to trigger - * other events on liveboard creation. - * - * ```js - * liveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl - */ - CreateLiveboard = "createLiveboard", - /** - * Emitted when a user creates a Model. - * @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl - */ - CreateModel = "createModel", - /** - * @hidden - * Emitted when a user exits present mode. - * @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - ExitPresentMode = "exitPresentMode", - /** - * Emitted when a user requests the full height lazy load data. - * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl - * @hidden - */ - RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates", - /** - * Emitted when Spotter response is text data - * @example - * ```js - * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - SpotterData = "SpotterData", - /** - * Emitted when user opens up the worksheet preview modal in Spotter embed. - * @example - * ```js - * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - PreviewSpotterData = "PreviewSpotterData", - /** - * Emitted when the Spotter query is triggered in Spotter embed. - * @example - * ```js - * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - SpotterQueryTriggered = "SpotterQueryTriggered", - /** - * Emitted when the last Spotter query is edited in Spotter embed. - * @example - * ```js - * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - LastPromptEdited = "LastPromptEdited", - /** - * Emitted when the last Spotter query is deleted in Spotter embed. - * @example - * ```js - * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - LastPromptDeleted = "LastPromptDeleted", - /** - * Emitted when the coversation is reset in spotter embed. - * @example - * ```js - * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - ResetSpotterConversation = "ResetSpotterConversation", - /** - * Emitted when the *Spotter* is initialized. - * @example - * ```js - * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => { - * console.log('payload', payload); - * }) - *``` - * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl - */ - SpotterInit = "spotterInit", - /** - * @hidden - * Triggers when the embed listener is ready to receive events. - * This is used to trigger events after the embed container is loaded. - * @example - * ```js - * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => { - * console.log('EmbedListenerReady'); - * }) - * ``` - */ - EmbedListenerReady = "EmbedListenerReady", - /** - * Emitted when the organization is switched. - * @example - * ```js - * appEmbed.on(EmbedEvent.OrgSwitched, (payload) => { - * console.log('payload', payload); - * }) - * ``` - * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl - */ - OrgSwitched = "orgSwitched" -} -/** - * Event types that can be triggered by the host application - * to the embedded ThoughtSpot app. - * - * 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'; - * // Or - * // const { HostEvent } = window.tsembed; - * - * // create the liveboard embed. - * - * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [ - * { 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 ( - * - * ); - * } - * ``` - * @group Events - */ -export declare enum HostEvent { - /** - * Triggers a search operation with the search tokens specified in - * 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 - * is supported. - * @param - `execute` - executes search and updates the existing query - * @example - * ```js - * searchembed.trigger(HostEvent.Search, { - searchQuery: "[sales] by [item type]", - dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"], - execute: true - }); - * ``` - */ - Search = "search", - /** - * 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 - * by. If not provided it will auto drill by the configured - * column. - * @param - autoDrillDown - Optional. If true, the drill down will be - * done automatically on the most popular column. - * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill - * in case of a Liveboard. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. - * @example - * ```js - * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => { - * console.log(payload); - * const clickedPoint = payload.data.clickedPoint; - * const selectedPoint = payload.data.selectedPoints; - * console.log('>>> called', clickedPoint); - * searchEmbed.trigger(HostEvent.DrillDown, { - * points: { - * clickedPoint, - * selectedPoints: selectedPoint - * }, - * autoDrillDown: true, - * }); - * }) - * ``` - * @example - * ```js - * // Works with TS 9.8.0 and above - * - * liveboardEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => { - * console.log(payload); - * const clickedPoint = payload.data.clickedPoint; - * const selectedPoint = payload.data.selectedPoints; - * console.log('>>> called', clickedPoint); - * liveboardEmbed.trigger(HostEvent.DrillDown, { - * points: { - * clickedPoint, - * selectedPoints: selectedPoint - * }, - * columnGuid: "", - * vizId: payload.data.vizId - * }); - * }) - * ``` - * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1 - */ - DrillDown = "triggerDrillDown", - /** - * Apply filters - * @hidden - */ - Filter = "filter", - /** - * Reload the Answer or visualization - * @hidden - */ - Reload = "reload", - /** - * Get iframe URL for the current embed view on the playground. - * Developers can use this URL to embed a ThoughtSpot object - * in apps like Salesforce or Sharepoint. - * @example - * ```js - * const url = embed.trigger(HostEvent.GetIframeUrl); - * console.log("iFrameURL",url); - * ``` - * @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 - * in this parameter will be hidden. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [ - * '730496d6-6903-4601-937e-2c691821af3c', - * 'd547ec54-2a37-4516-a222-2b06719af726']) - * ``` - * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw - */ - SetVisibleVizs = "SetPinboardVisibleVizs", - /** - * Set a Liveboard tab as an active tab. - * @param - tabId - string of id of Tab to show - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.SetActiveTab,{ - * tabId:'730496d6-6903-4601-937e-2c691821af3c' - * }) - * ``` - * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw - */ - SetActiveTab = "SetActiveTab", - /** - * Updates the runtime filters applied on a Liveboard. The filter - * attributes passed with this event are appended to the existing runtime - * filters applied on a Liveboard. - * - * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed` - * and `AppEmbed` only. In full application embedding, this event updates - * the runtime filters applied on the Liveboard and saved Answer objects. - * - * @param - Pass an array of {@link RuntimeFilter} with the following attributes: - * `columnName` - _String_. The name of the column to filter on. - * - * `operator` - {@link RuntimeFilterOp} to apply. For more information, - * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation]. - * - * `values` - List of operands. Some operators such as EQ and LE allow a - * single value, whereas BW and IN accept multiple values. - * - * **Note**: Updating runtime filters resets the ThoughtSpot - * object to its original state and applies new filter conditions. - * Any user changes (like drilling into a visualization) - * will be cleared, restoring the original visualization - * with the updated filters. - * - - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [ - * {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]}, - * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]} - * ]) - * ``` - * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - * @important - */ - UpdateRuntimeFilters = "UpdateRuntimeFilters", - /** - * 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 - * ```js - * appEmbed.navigateToPage(-1) - * ``` - * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1.sw - */ - Navigate = "Navigate", - /** - * Open the filter panel for a particular column. - * Works with Search and Liveboard embed. - * @param - { columnId: string, - * name: string, - * type: ATTRIBUTE/MEASURE, - * dataType: INT64/CHAR/DATE } - * @example - * ```js - * searchEmbed.trigger(HostEvent.OpenFilter, - * {column: { columnId: '', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}}) - * ``` - * @example - * ```js - * LiveboardEmbed.trigger(HostEvent.OpenFilter, - * { column: {columnId: ''}}) - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl - */ - OpenFilter = "openFilter", - /** - * Add columns to the current search query. - * @param - { columnIds: string[] } - * @example - * ```js - * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['',''] }) - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl - */ - AddColumns = "addColumns", - /** - * Remove a column from the current search query. - * @param - { columnId: string } - * @example - * ```js - * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '' }) - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl - */ - RemoveColumn = "removeColumn", - /** - * Get the transient state of a Liveboard as encoded content. - * This includes unsaved and ad hoc changes such as - * 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. - * For more information, see - * link:https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#transient-lb-content[Liveboard data with unsaved changes]. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then( - * data=>console.log(data)) - * ``` - * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw - */ - getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard", - /** - * Trigger **Pin** action on an embedded object. - * If no parameters are defined, the pin action is triggered - * for the Answer that the user is currently on - * and a modal opens for Liveboard selection. - * To add an Answer or visualization to a Liveboard programmatically without - * showing requiring additional user input via *Pin to Liveboard* modal, define - * the following parameters: - * - * @param - * `vizId`- GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard. - * Optional when pinning a new chart or table generated from a Search query. - * **Required** in Spotter Embed. - * @param - * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard, - * specify the `newLiveboardName` parameter to create a new Liveboard. - * @param - * `tabId` - GUID of the Liveboard tab. Adds the Answer to the Liveboard tab - * specified in the code. - * @param - * `newVizName` - Name string for the Answer or visualization. If defined, - * this parameter adds a new visualization object or creates a copy of the - * Answer or visualization specified in `vizId`. - * Required attribute. - * @param - * `newLiveboardName` - Name string for the Liveboard. - * Creates a new Liveboard object with the specified name. - * @param - * `newTabName` - Name of the tab. Adds a new tab Liveboard specified - * in the code. - * - * @example - * ```js - * const pinResponse = await appEmbed.trigger(HostEvent.Pin, { - * vizId: "123", - * newVizName: "Sales by region", - * liveboardId: "123", - * tabId: "123" - * }); - * ``` - * @example - * ```js - * const pinResponse = await appEmbed.trigger(HostEvent.Pin, { - * newVizName: "Total sales of Jackets", - * liveboardId: "123" - * }); - * ``` - * - * @example - * ```js - * const pinResponse = await searchEmbed.trigger(HostEvent.Pin, { - * newVizName: "Sales by state", - * newLiveboardName: "Sales", - * newTabName: "Products" - * }); - * ``` - * @example - * ```js - * appEmbed.trigger(HostEvent.Pin) - * ``` - * @example - * ```js - - * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId }); - * ``` - * - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - Pin = "pin", - /** - * Trigger the **Show Liveboard details** action - * on an embedded Liveboard. - * @example - *```js - * liveboardEmbed.trigger(HostEvent.LiveboardInfo) - *``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - LiveboardInfo = "pinboardInfo", - /** - * Trigger the **Schedule** action on an embedded Liveboard. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.Schedule) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - Schedule = "subscription", - /** - * Trigger the **Manage schedule** action on an embedded Liveboard - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.ScheduleList) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - SchedulesList = "schedule-list", - /** - * 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 - */ - ExportTML = "exportTSL", - /** - * Trigger the **Edit TML** action on an embedded Liveboard or - * saved Answers in the full application embedding. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.EditTML) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - EditTML = "editTSL", - /** - * Trigger the **Update TML** action on an embedded Liveboard. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.UpdateTML) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - UpdateTML = "updateTSL", - /** - * Trigger the **Download PDF** action on an embedded Liveboard, - * visualization or Answer. - * - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. - * - * **NOTE**: The **Download** > **PDF** action is available on - * visualizations and Answers if the data is in tabular format. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.DownloadAsPdf) - * ``` - * @example - * ```js - - * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPdf host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId }); - * ``` - * - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - DownloadAsPdf = "downloadAsPdf", - /** - * Trigger the **Make a copy** action on a Liveboard, - * visualization, or Answer page. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.MakeACopy) - * ``` - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.MakeACopy, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * @example - * ```js - * vizEmbed.trigger(HostEvent.MakeACopy) - * ``` - * @example - * ```js - * searchEmbed.trigger(HostEvent.MakeACopy) - * ``` - * @example - * ```js - * // You can use the Data event dispatched on each answer creation to get the vizId and use in MakeACopy host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId }); - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - MakeACopy = "makeACopy", - /** - * Trigger the **Delete** action for a Liveboard. - * @example - * ```js - * appEmbed.trigger(HostEvent.Remove) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - * * @example - * ```js - * liveboardEmbed.trigger(HostEvent.Remove) - * ``` - * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw - */ - Remove = "delete", - /** - * Trigger the **Explore** action on a visualization. - * @param - an object with `vizId` as a key - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - Explore = "explore", - /** - * Trigger the **Create alert** action on a KPI chart - * in a Liveboard or saved Answer. - * @param - an object with `vizId` as a key - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.CreateMonitor, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c' - * }) - * ``` - * @example - * ```js - * searchEmbed.trigger(HostEvent.CreateMonitor) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - CreateMonitor = "createMonitor", - /** - * Trigger the **Manage alerts** action on a KPI chart - * in a visualization or saved Answer. - * @param - an object with `vizId` as a key - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.ManageMonitor, { - * vizId: '730496d6-6903-4601-937e-2c691821af3c' - * }) - * ``` - * @example - * ```js - * searchEmbed.trigger(HostEvent.ManageMonitor) - * ``` - * @example - * ```js - * vizEmbed.trigger(HostEvent.ManageMonitor) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - ManageMonitor = "manageMonitor", - /** - * 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. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. - * - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.Edit) - * ``` - * ```js - * liveboardEmbed.trigger(HostEvent.Edit, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * @example - * ```js - * spotterEmbed.trigger(HostEvent.Edit); - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - 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 - * ```js - * liveboardEmbed.trigger(HostEvent.CopyLink) - * ``` - * ```js - * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger((HostEvent.CopyLink) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - 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 - * ```js - * liveboardEmbed.trigger(HostEvent.Present) - * ``` - * ```js - * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger((HostEvent.Present) - * ``` - * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw - */ - Present = "present", - /** - * Get TML for the current search. - * @example - * ```js - * searchEmbed.trigger(HostEvent.GetTML).then((tml) => { - * console.log( - * tml.answer.search_query // TML representation of the search query - * ); - * }) - * ``` - * * @example - * ```js - - * // You can use the Data event dispatched on each answer creation to get the vizId and use in Pin host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.GetTML, { - * vizId: latestSpotterVizId - * }).then((tml) => { - * console.log( - * tml.answer.search_query // TML representation of the search query - * ); - * }) - * ``` - * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw - * @important - */ - GetTML = "getTML", - /** - * Trigger the **Show underlying data** action on a - * chart or table. - * - * @param - an object with vizId as a key - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.ShowUnderlyingData) - * ``` - * ```js - * searchEmbed.trigger(HostEvent.ShowUnderlyingData) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - ShowUnderlyingData = "showUnderlyingData", - /** - * 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 - * ```js - * liveboardEmbed.trigger(HostEvent.Delete, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * searchEmbed.trigger(HostEvent.Delete) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - Delete = "onDeleteAnswer", - /** - * Trigger the **SpotIQ analyze** action on a - * chart or table. - * @param - Liveboard embed takes `vizId` as a - * key. Can be left undefined when embedding Search or - * visualization. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.SpotIQAnalyze) - * ``` - * ```js - * searchEmbed.trigger(HostEvent.SpotIQAnalyze) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - SpotIQAnalyze = "spotIQAnalyze", - /** - * Trigger the **Download** action on charts in - * the embedded view. - * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.Download, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * embed.trigger(HostEvent.Download) - * ``` - * ```js - * // You can use the Data event dispatched on each answer creation to get the vizId and use in Download host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.Download, { vizId: latestSpotterVizId }); - * ``` - * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw - * Use {@link DownloadAsPng} - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - Download = "downloadAsPng", - /** - * Trigger the **Download** > **PNG** action on - * charts in the embedded view. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.DownloadAsPng, - * {vizId:'730496d6-6903-4601-937e-2c691821af3c'}) - * - * vizEmbed.trigger(HostEvent.DownloadAsPng) - * - * searchEmbed.trigger(HostEvent.DownloadAsPng) - * - * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsPng host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId }); - * ``` - * - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw - */ - DownloadAsPng = "downloadAsPng", - /** - * Trigger the **Download** > **CSV** action on tables in - * the embedded view. - * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.DownloadAsCsv) - * ``` - * ```js - * searchEmbed.trigger(HostEvent.DownloadAsCsv) - * ``` - * ```js - * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsCsv host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId }); - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - DownloadAsCsv = "downloadAsCSV", - /** - * Trigger the **Download** > **XLSX** action on tables - * in the embedded view. - * @param - `vizId` refers to the Visualization ID in Spotter embed and is required in Spotter embed. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.DownloadAsXlsx) - * ``` - * ```js - * searchEmbed.trigger(HostEvent.DownloadAsXlsx) - * ``` - * ```js - * // You can use the Data event dispatched on each answer creation to get the vizId and use in DownloadAsXlsx host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId }); - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - DownloadAsXlsx = "downloadAsXLSX", - /** - * Trigger the **Share** action on an embedded - * Liveboard or Answer. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.Share) - * ``` - * ```js - * searchEmbed.trigger(HostEvent.Share) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - Share = "share", - /** - * Trigger the **Save** action on a Liveboard, Answer, or Spotter. - * Saves the changes. - * - * @param - `vizId` refers to the Spotter Visualization Id used in Spotter embed. - * It is required and can be retrieved from the data embed event. - * - * @example - * ```js - * // Save changes in a Liveboard - * liveboardEmbed.trigger(HostEvent.Save) - * ``` - * - * ```js - * // Save the current Answer in Search embed - * searchEmbed.trigger(HostEvent.Save) - * ``` - * - * ```js - * // Save a Visualization in Spotter (requires vizId) - * spotterEmbed.trigger(HostEvent.Save, { - * vizId: "730496d6-6903-4601-937e-2c691821af3c" - * }) - * ``` - * - * ```js - * // How to get the vizId in Spotter? - * - * // You can use the Data event dispatched on each answer creation to get the vizId. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId }); - * ``` - * - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - Save = "save", - /** - * 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 - * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.SyncToSheets) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - SyncToSheets = "sync-to-sheets", - /** - * 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 - * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.SyncToOtherApps) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - SyncToOtherApps = "sync-to-other-apps", - /** - * 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 - * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: - * '730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * ```js - * vizEmbed.trigger(HostEvent.ManagePipelines) - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw - */ - ManagePipelines = "manage-pipeline", - /** - * Reset search operation on the Search or Answer page. - * @example - * ```js - * searchEmbed.trigger(HostEvent.ResetSearch) - * ``` - * ```js - * appEmbed.trigger(HostEvent.ResetSearch) - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw - */ - ResetSearch = "resetSearch", - /** - * 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 - */ - 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, - * and values for each. - * - * Each filter object must include the following attributes: - * - * `column` - Name of the column to filter on. - * - * `oper` - Filter operator, for example, EQ, IN, CONTAINS. - * For information about the supported filter operators, - * 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 - * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported - * data types]. - * - * `type` - To update filters for date time, specify the date format type. - * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters]. - * @example - * ```js - * - * liveboardEmbed.trigger(HostEvent.UpdateFilters, { - * filter: { - * column: "item type", - * oper: "IN", - * 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, { - * filters: [{ - * column: "Item Type", - * oper: 'IN', - * values: ["bags","shirts"] - * }, - * { - * column: "Region", - * oper: 'IN', - * values: ["West","Midwest"] - * }, - * { - * column: "Date", - * oper: 'EQ', - * values: ["2023-07-31"], - * type: "EXACT_DATE" - * }] - * }); - * ``` - * If there are multiple columns with the same name, consider - * using `WORKSHEET_NAME::COLUMN_NAME` format. - * - * @example - * - * ```js - * liveboardEmbed.trigger(HostEvent.UpdateFilters, { - * filters: [{ - * column: "(Sample) Retail - Apparel::city", - * oper: 'IN', - * values: ["atlanta"] - * }, - * { - * column: "(Sample) Retail - Apparel::Region", - * oper: 'IN', - * values: ["West","Midwest"] - * }] - * }); - * ``` - * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl - */ - UpdateFilters = "updateFilters", - /** - * Get tab details for the current Liveboard. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => { - * console.log( - * tabDetails // TabDetails of current Liveboard - * ); - * }) - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl - */ - 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 - * ```js - * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [ - * '430496d6-6903-4601-937e-2c691821af3c', - * 'f547ec54-2a37-4516-a222-2b06719af726']) - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - 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 - * ```js - * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [ - * '630496d6-6903-4601-937e-2c691821af3c', - * 'i547ec54-2a37-4516-a222-2b06719af726']) - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - 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 - * ```js - * sageEmbed.trigger(HostEvent.UpdateSageQuery, { - * queryString: 'revenue per year', - * executeSearch: true, - * }) - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - */ - UpdateSageQuery = "updateSageQuery", - /** - * Get the Answer session for a Search or - * Liveboard visualization. - * - * Note: This event is not typically used directly. Instead, use the - * `getAnswerService()` method on the embed instance to get an AnswerService - * object that provides a more convenient interface for working with answers. - * - * @example - * ```js - * // Preferred way to get an AnswerService - * const service = await embed.getAnswerService(); - * - * // Alternative direct usage (not recommended) - * const {session} = await embed.trigger( - * HostEvent.GetAnswerSession, { - * vizId: '123', // For Liveboard Visualization. - * }) - * ``` - * @example - * ```js - * // Preferred way to get an AnswerService - * const service = await embed.getAnswerService(); - * - * // Alternative direct usage (not recommended) - * const {session} = await embed.trigger( HostEvent.GetAnswerSession ) - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw - */ - GetAnswerSession = "getAnswerSession", - /** - * Trigger the *Ask Sage* action for visualizations - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.AskSage, - * {vizId:'730496d6-6903-4601-937e-2c691821af3c'}) - * ``` - * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl - */ - AskSage = "AskSage", - /** - * Trigger cross filter update action on a Liveboard. - * - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, { - * vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e', - * conditions: [ - * { columnName: 'Category', values: ['mfgr#12','mfgr#14'] }, - * { columnName: 'color', values: ['mint','hot'] }, - * ], - * }); - * ``` - * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.0.0.cl, 10.1.0.sw - */ - UpdateCrossFilter = "UpdateCrossFilter", - /** - * Trigger reset action for a personalized Liveboard view. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView); - * ``` - * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw - */ - ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView", - /** - * Triggers an action to update Parameter values on embedded - * Answers, Liveboard and Spotter answer in Edit mode. - * - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{ - * name: "Color", - * value: "almond" - * }]) - * - * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw - */ - UpdateParameters = "UpdateParameters", - /** - * Triggers GetParameters to fetch the runtime Parameters. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. - * ```js - * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => { - * console.log('parameters', parameter); - * }); - *``` - *```js - * // You can use the Data event dispatched on each answer creation to get the vizId and use in GetParameters host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId }); - *``` - * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw - */ - GetParameters = "GetParameters", - /** - * Triggers an event to update a personalized view of a Liveboard. - * ```js - * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'}) - * ``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl - */ - UpdatePersonalisedView = "UpdatePersonalisedView", - /** - * @hidden - * Notify when info call is completed successfully - * ```js - * liveboardEmbed.trigger(HostEvent.InfoSuccess, data); - *``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl - */ - InfoSuccess = "InfoSuccess", - /** - * Trigger the save action for an Answer. - * To programmatically save an answer without opening the - * *Describe your Answer* modal, define the `name` and `description` - * properties. - * If no parameters are specified, the save action is - * triggered with a modal to prompt users to - * add a name and description for the Answer. - * @param - optional attributes to set Answer properties. - * `name` - Name string for the Answer. - * `description` - Description text for the Answer. - * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed. - * @example - * ```js - * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, { - * name: "Sales by states", - * description: "Total sales by states in MidWest" - * }); - * ``` - * @example - * ```js - * // You can use the Data event dispatched on each answer creation to get the vizId and use in SaveAnswer host event. - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId }); - * ``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl - */ - SaveAnswer = "saveAnswer", - /** - * EmbedApi - * @hidden - */ - UIPassthrough = "UiPassthrough", - /** - * Triggers the table visualization re-render with the updated data. - * Includes the following properties: - * @param - `columnDataLite` - an array of object containing the - * data value modifications retrieved from the `EmbedEvent.TableVizRendered` - * payload.For example, { columnDataLite: []}`. - * - * @example - * ```js - * searchEmbed.on(EmbedEvent.TableVizRendered, (payload) => { - * console.log(payload); - * const columnDataLite = payload.data.data.columnDataLite; - * columnDataLite[0].dataValue[0]="new fob"; - * console.log('>>> new Data', columnDataLite); - * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite); - * }) - * ``` - * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl - */ - TransformTableVizData = "TransformTableVizData", - /** - * Triggers a search operation with the search tokens specified in - * the search query string in spotter embed. - * @param - `query`: Text string in Natural Language format - * @param - `executeSearch`: Boolean to execute search and update search query - * @example - * ```js - * spotterEmbed.trigger(HostEvent.SpotterSearch, { - * query: 'revenue per year', - * executeSearch: true, - * }) - * ``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - SpotterSearch = "SpotterSearch", - /** - * Edits the last prompt in spotter embed. - * @param - `query`: Text string - * @example - * ```js - * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year"); - * ``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - EditLastPrompt = "EditLastPrompt", - /** - * Opens the Worksheet preview modal in Spotter Embed. - * @example - * ```js - * spotterEmbed.trigger(HostEvent.PreviewSpotterData); - * ``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - PreviewSpotterData = "PreviewSpotterData", - /** - * Resets the Spotter Embed Conversation. - * @example - * ```js - * spotterEmbed.trigger(HostEvent.ResetSpotterConversation); - * ``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - ResetSpotterConversation = "ResetSpotterConversation", - /** - * Deletes the last prompt in spotter embed. - * @example - * ```js - * spotterEmbed.trigger(HostEvent.DeleteLastPrompt); - * ``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - DeleteLastPrompt = "DeleteLastPrompt", - /** - * Toggle the visualization to chart or table view. - * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required. - * @example - * ```js - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, { vizId: latestSpotterVizId }); - *``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - AnswerChartSwitcher = "answerChartSwitcher", - /** - * @hidden - * Trigger exit from presentation mode when user exits fullscreen. - * This is automatically triggered by the SDK when fullscreen mode is exited. - * ```js - * liveboardEmbed.trigger(HostEvent.ExitPresentMode); - *``` - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ - ExitPresentMode = "exitPresentMode", - /** - * Triggers the full height lazy load data. - * @example - * ```js - * liveboardEmbed.on(EmbedEvent.RequestVisibleEmbedCoordinates, (payload) => { - * console.log(payload); - * }); - * ``` - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - * - * @hidden - */ - VisibleEmbedCoordinates = "visibleEmbedCoordinates", - /** - * Trigger the *Spotter* action for visualizations present on the liveboard's vizzes. - * @param - `vizId` refers to the Visualization ID in Spotter embed and is required. - * @example - * ```js - * let latestSpotterVizId = ''; - * spotterEmbed.on(EmbedEvent.Data, (payload) => { - * latestSpotterVizId = payload.data.id; - * }); - * - * spotterEmbed.trigger(HostEvent.AskSpotter, { vizId: latestSpotterVizId }); - * ``` - * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl - */ - AskSpotter = "AskSpotter", - /** - * @hidden - * Triggers the update of the embed params. - * - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig); - * ``` - */ - UpdateEmbedParams = "updateEmbedParams", - /** - * @hidden - * Triggers the get of the page context. - * @example - * ```js - * liveboardEmbed.trigger(HostEvent.GetPageContext); - * ``` - */ - GetPageContext = "GetPageContext" -} -/** - * The different visual modes that the data sources panel within - * search could appear in, such as hidden, collapsed, or expanded. - */ -export declare enum DataSourceVisualMode { - /** - * The data source panel is hidden. - */ - Hidden = "hide", - /** - * The data source panel is collapsed, but the user can manually expand it. - */ - Collapsed = "collapse", - /** - * The data source panel is expanded, but the user can manually collapse it. - */ - Expanded = "expand" -} -/** - * ThoughtSpot application pages include actions and menu commands - * for various user-initiated operations. These actions are represented - * as enumeration members in the SDK. To show, hide, or disable - * specific actions in the embedded view, define the Action - * enumeration members in the `disabledActions`, `visibleActions`, - * or `hiddenActions` array. - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore], - * disabledActions: [Action.Download], - * //hiddenActions: [], // Set either this or visibleActions - * }) - * ``` - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * //visibleActions: [], - * disabledActions: [Action.Download], - * hiddenActions: [Action.Edit, ActionAction.Explore], - * }) - * ``` - * See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK] - */ -export declare enum Action { - /** - * The **Save** action on an Answer or Liveboard. - * Allows users to save the changes. - * @example - * ```js - * disabledActions: [Action.Save] - * ``` - */ - Save = "save", - /** - * @hidden - */ - Update = "update", - /** - * @hidden - */ - SaveUntitled = "saveUntitled", - /** - * The **Save as View** action on the Answer - * page. Saves an Answer as a View object in the full - * application embedding mode. - * @example - * ```js - * disabledActions: [Action.SaveAsView] - * ``` - */ - SaveAsView = "saveAsView", - /** - * The **Make a copy** action on a Liveboard or Answer - * page. Creates a copy of the Liveboard. - * In LiveboardEmbed, the **Make a copy** action is not available for - * 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] - * ``` - */ - MakeACopy = "makeACopy", - /** - * The **Copy and Edit** action on a Liveboard. - * This action is now replaced with `Action.MakeACopy`. - * @example - * ```js - * disabledActions: [Action.EditACopy] - * ``` - */ - EditACopy = "editACopy", - /** - * The **Copy link** menu action on a Liveboard visualization. - * Copies the visualization URL - * @example - * ```js - * disabledActions: [Action.CopyLink] - * ``` - */ - CopyLink = "embedDocument", - /** - * @hidden - */ - ResetLayout = "resetLayout", - /** - * The **Schedule** menu action on a Liveboard. - * Allows scheduling a Liveboard job, for example, - * sending periodic notifications. - * @example - * ```js - * disabledActions: [Action.Schedule] - * ``` - */ - Schedule = "subscription", - /** - * The **Manage schedules** menu action on a Liveboard. - * Allows users to manage scheduled Liveboard jobs. - * @example - * ```js - * disabledActions: [Action.SchedulesList] - * ``` - */ - SchedulesList = "schedule-list", - /** - * 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] - * ``` - */ - Share = "share", - /** - * The **Add filter** action on a Liveboard page. - * Allows adding filters to visualizations on a Liveboard. - * @example - * ```js - * disabledActions: [Action.AddFilter] - * ``` - */ - AddFilter = "addFilter", - /** - * The **Add Data Panel Objects** action on the data panel v2. - * Allows to show action menu to add different objects (such as - * formulas, Parameters) in data panel new experience. - * @example - * ```js - * disabledActions: [Action.AddDataPanelObjects] - * ``` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw - */ - AddDataPanelObjects = "addDataPanelObjects", - /** - * The filter configuration options for a Liveboard. - * The configuration options are available when adding - * filters on a Liveboard. - * - * @example - * ```js - * disabledActions: [Action.ConfigureFilter] - * ``` - */ - ConfigureFilter = "configureFilter", - /** - * The **Collapse data sources** icon on the Search page. - * Collapses the panel showing data sources. - * - * @example - * ```js - * disabledActions: [Action.CollapseDataPanel] - * ``` - * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw - */ - CollapseDataSources = "collapseDataSources", - /** - * The **Collapse data panel** icon on the Search page. - * Collapses the data panel view. - * - * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl - * - * @example - * ```js - * disabledActions: [Action.CollapseDataPanel] - * ``` - */ - CollapseDataPanel = "collapseDataPanel", - /** - * The **Choose sources** button on Search page. - * Allows selecting data sources for search queries. - * @example - * ```js - * disabledActions: [Action.ChooseDataSources] - * ``` - */ - ChooseDataSources = "chooseDataSources", - /** - * The **Create formula** action on a Search or Answer page. - * Allows adding formulas to an Answer. - * @example - * ```js - * disabledActions: [Action.AddFormula] - * ``` - */ - AddFormula = "addFormula", - /** - * The **Add parameter** action on a Liveboard or Answer. - * Allows adding Parameters to a Liveboard or Answer. - * @example - * ```js - * disabledActions: [Action.AddParameter] - * ``` - */ - AddParameter = "addParameter", - /** - * The **Add Column Set** action on a Answer. - * Allows adding column sets to a Answer. - * @example - * ```js - * disabledActions: [Action.AddColumnSet] - * ``` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw - */ - AddColumnSet = "addSimpleCohort", - /** - * The **Add Query Set** action on a Answer. - * Allows adding query sets to a Answer. - * @example - * ```js - * disabledActions: [Action.AddQuerySet] - * ``` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw - */ - AddQuerySet = "addAdvancedCohort", - /** - * @hidden - */ - SearchOnTop = "searchOnTop", - /** - * The **SpotIQ analyze** menu action on a visualization or - * Answer page. - * @example - * ```js - * disabledActions: [Action.SpotIQAnalyze] - * ``` - */ - SpotIQAnalyze = "spotIQAnalyze", - /** - * @hidden - */ - ExplainInsight = "explainInsight", - /** - * @hidden - */ - SpotIQFollow = "spotIQFollow", - /** - * The Share action for a Liveboard visualization. - */ - ShareViz = "shareViz", - /** - * @hidden - */ - ReplaySearch = "replaySearch", - /** - * The **Show underlying data** menu action on a - * visualization or Answer page. - * Displays detailed information and raw data - * for a given visualization. - * @example - * ```js - * disabledActions: [Action.ShowUnderlyingData] - * ``` - */ - ShowUnderlyingData = "showUnderlyingData", - /** - * The **Download** menu action on Liveboard - * visualizations and Answers. - * Allows downloading a visualization or Answer. - * @example - * ```js - * disabledActions: [Action.DownloadAsPng] - * ``` - */ - Download = "download", - /** - * 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] - * ``` - */ - DownloadAsPng = "downloadAsPng", - /** - * - *The **Download PDF** action that downloads a Liveboard, - * visualization, or Answer as a PDF file. - * - * **NOTE**: The **Download** > **PDF** option is available for - * tables in visualizations and Answers. - * @example - * ```js - * disabledActions: [Action.DownloadAsPdf] - * ``` - */ - DownloadAsPdf = "downloadAsPdf", - /** - * 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] - * ``` - */ - DownloadAsCsv = "downloadAsCSV", - /** - * 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] - * ``` - */ - DownloadAsXlsx = "downloadAsXLSX", - /** - * @hidden - */ - DownloadTrace = "downloadTrace", - /** - * The **Export TML** menu action on a Liveboard, Answer, and - * the Data Workspace pages for data objects and connections. - * - * Allows exporting an object as a TML file. - * - * @example - * ```js - * disabledActions: [Action.ExportTML] - * ``` - */ - ExportTML = "exportTSL", - /** - * The **Import TML** menu action on the - * *Data Workspace* > *Utilities* page. - * Imports TML representation of ThoughtSpot objects. - * @example - * ```js - * disabledActions: [Action.ImportTML] - * ``` - */ - ImportTML = "importTSL", - /** - * The **Update TML** menu action for Liveboards and Answers. - * Updates TML representation of ThoughtSpot objects. - * @example - * ```js - * disabledActions: [Action.UpdateTML] - * ``` - */ - UpdateTML = "updateTSL", - /** - * The **Edit TML** menu action for Liveboards and Answers. - * Opens the TML editor. - * @example - * ```js - * disabledActions: [Action.EditTML] - * ``` - */ - EditTML = "editTSL", - /** - * The **Present** menu action for Liveboards and Answers. - * Allows presenting a Liveboard or visualization in - * slideshow mode. - * @example - * ```js - * disabledActions: [Action.Present] - * ``` - */ - Present = "present", - /** - * The visualization tile resize option. - * Also available via More `...` options menu on a visualization. - * Allows resizing visualization tiles and switching - * between different preset layout option. - * - * @example - * ```js - * disabledActions: [Action.ToggleSize] - * ``` - */ - ToggleSize = "toggleSize", - /** - * 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] - * ``` - */ - Edit = "edit", - /** - * The text edit option for Liveboard and visualization titles. - * @example - * ```js - * disabledActions: [Action.EditTitle] - * ``` - */ - EditTitle = "editTitle", - /** - * The **Delete** action on a Liveboard, *Liveboards* and - * *Answers* list pages in full application embedding. - * - * @example - * ```js - * disabledActions: [Action.Remove] - * ``` - */ - Remove = "delete", - /** - * @hidden - */ - Ungroup = "ungroup", - /** - * @hidden - */ - Describe = "describe", - /** - * @hidden - */ - Relate = "relate", - /** - * @hidden - */ - CustomizeHeadlines = "customizeHeadlines", - /** - * @hidden - */ - PinboardInfo = "pinboardInfo", - /** - * The **Show Liveboard details** menu action on a Liveboard. - * Displays details such as the name, description, and - * author of the Liveboard, and timestamp of Liveboard creation - * and update. - * @example - * ```js - * disabledActions: [Action.LiveboardInfo] - * ``` - */ - LiveboardInfo = "pinboardInfo", - /** - * @hidden - */ - SendAnswerFeedback = "sendFeedback", - /** - * @hidden - */ - DownloadEmbraceQueries = "downloadEmbraceQueries", - /** - * The **Pin** menu action on an Answer or - * Search results page. - * @example - * ```js - * disabledActions: [Action.Pin] - * ``` - */ - Pin = "pin", - /** - * @hidden - */ - AnalysisInfo = "analysisInfo", - /** - * The **Schedule** menu action on a Liveboard. - * Allows scheduling a Liveboard job. - * @example - * ```js - * disabledActions: [Action.Subscription] - * ``` - */ - Subscription = "subscription", - /** - * The **Explore** action on Liveboard visualizations - * @example - * ```js - * disabledActions: [Action.Explore] - * ``` - */ - Explore = "explore", - /** - * The contextual menu action to include a specific data point - * when drilling down a table or chart on an Answer. - * - * @example - * ```js - * disabledActions: [Action.DrillInclude] - * ``` - */ - DrillInclude = "context-menu-item-include", - /** - * The contextual menu action to exclude a specific data point - * when drilling down a table or chart on an Answer. - * @example - * ```js - * disabledActions: [Action.DrillInclude] - * ``` - */ - DrillExclude = "context-menu-item-exclude", - /** - * The **Copy to clipboard** menu action on tables in an Answer - * or Liveboard. - * Copies the selected data point. - * @example - * ```js - * disabledActions: [Action.CopyToClipboard] - * ``` - */ - CopyToClipboard = "context-menu-item-copy-to-clipboard", - CopyAndEdit = "context-menu-item-copy-and-edit", - /** - * @hidden - */ - DrillEdit = "context-menu-item-edit", - EditMeasure = "context-menu-item-edit-measure", - Separator = "context-menu-item-separator", - /** - * 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] - * ``` - */ - DrillDown = "DRILL", - /** - * The request access action on Liveboards. - * Allows users with view permissions to request edit access to a Liveboard. - * @example - * ```js - * disabledActions: [Action.RequestAccess] - * ``` - */ - RequestAccess = "requestAccess", - /** - * The **Query visualizer** and **Query SQL** buttons in - * Query details panel of the Answer page. - * - * **Query visualizer** - Displays the tables - * and filters used in a search query. - * **Query SQL** - Displays the SQL statements used - * in a search query to fetch data. - * @example - * ```js - * disabledActions: [Action.QueryDetailsButtons] - * ``` - */ - QueryDetailsButtons = "queryDetailsButtons", - /** - * The **Delete** action for Answers in the full application - * embedding mode. - * @example - * ```js - * disabledActions: [Action.AnswerDelete] - * ``` - * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - */ - AnswerDelete = "onDeleteAnswer", - /** - * The chart switcher icon on Answer page and - * visualizations in edit mode. - * Allows switching to the table or chart mode - * when editing a visualization. - * @example - * ```js - * disabledActions: [Action.AnswerChartSwitcher] - * ``` - * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - */ - AnswerChartSwitcher = "answerChartSwitcher", - /** - * The Favorites icon (*) for Answers, - * Liveboard, and data objects like Worksheet, Model, - * Tables and Views. - * Allows adding an object to the user's favorites list. - * @example - * ```js - * disabledActions: [Action.AddToFavorites] - * ``` - * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - */ - AddToFavorites = "addToFavorites", - /** - * The edit icon on Liveboards (Classic experience). - * @example - * ```js - * disabledActions: [Action.EditDetails] - * ``` - * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw - */ - EditDetails = "editDetails", - /** - * The *Create alert* action for KPI charts. - * Allows users to schedule threshold-based alerts - * for KPI charts. - * @example - * ```js - * disabledActions: [Action.CreateMonitor] - * ``` - * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw - */ - CreateMonitor = "createMonitor", - /** - * @deprecated - * Reports errors - * @example - * ```js - * disabledActions: [Action.ReportError] - * ``` - * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw - */ - ReportError = "reportError", - /** - * The **Sync to sheets** action on Answers and Liveboard visualizations. - * Allows sending data to a Google Sheet. - * @example - * ```js - * disabledActions: [Action.SyncToSheets] - * ``` - * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw - */ - SyncToSheets = "sync-to-sheets", - /** - * 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] - * ``` - * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw - */ - SyncToOtherApps = "sync-to-other-apps", - /** - * The **Manage pipelines** action on Answers and Liveboard visualizations. - * Allows users to manage data sync pipelines to third-party apps. - * @example - * ```js - * disabledActions: [Action.ManagePipelines] - * ``` - * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw - */ - ManagePipelines = "manage-pipeline", - /** - * The **Filter** action on Liveboard visualizations. - * Allows users to apply cross-filters on a Liveboard. - * @example - * ```js - * disabledActions: [Action.CrossFilter] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.8.0.sw - */ - CrossFilter = "context-menu-item-cross-filter", - /** - * The **Sync to Slack** action on Liveboard visualizations. - * Allows sending data to third-party apps Slack - * @example - * ```js - * disabledActions: [Action.SyncToSlack] - * ``` - * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl - */ - SyncToSlack = "syncToSlack", - /** - * The **Sync to Teams** action on Liveboard visualizations. - * Allows sending data to third-party apps Team - * @example - * ```js - * disabledActions: [Action.SyncToTeams] - * ``` - * @version @version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl - */ - SyncToTeams = "syncToTeams", - /** - * The **Remove** action that appears when cross filters are applied - * on a Liveboard. - * Removes filters applied o a visualization. - * @example - * ```js - * disabledActions: [Action.RemoveCrossFilter] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - RemoveCrossFilter = "context-menu-item-remove-cross-filter", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuAggregate = "axisMenuAggregate", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuTimeBucket = "axisMenuTimeBucket", - /** - * The **Filter** action in the chart axis or table column - * customization menu. - * Allows adding, editing, or removing filters. - * - * @example - * ```js - * disabledActions: [Action.AxisMenuFilter] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuFilter = "axisMenuFilter", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuConditionalFormat = "axisMenuConditionalFormat", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuSort = "axisMenuSort", - /** - * The **Group** option in the chart axis or table column - * customization menu. - * Allows grouping data points if the axes use the same - * unit of measurement and a similar scale. - * @example - * ```js - * disabledActions: [Action.AxisMenuGroup] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuGroup = "axisMenuGroup", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuPosition = "axisMenuPosition", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuRename = "axisMenuRename", - /** - * 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] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuEdit = "axisMenuEdit", - /** - * The **Number format** action to customize the format of - * the data labels on a chart or table. - * @example - * ```js - * disabledActions: [Action.AxisMenuNumberFormat] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuNumberFormat = "axisMenuNumberFormat", - /** - * The **Text wrapping** action on a table. - * Wraps or clips column text on a table. - * @example - * ```js - * disabledActions: [Action.AxisMenuTextWrapping] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuTextWrapping = "axisMenuTextWrapping", - /** - * The **Remove** action in the chart axis or table column - * customization menu. - * Removes the data labels from a chart or the column of a - * table visualization. - * @example - * ```js - * disabledActions: [Action.AxisMenuRemove] - * ``` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.1.sw - */ - AxisMenuRemove = "axisMenuRemove", - /** - * @hidden - */ - InsertInToSlide = "insertInToSlide", - /** - * The **Rename** menu action on Liveboards and visualizations. - * Allows renaming a Liveboard or visualization. - * @example - * ```js - * disabledActions: [Action.RenameModalTitleDescription] - * ``` - * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.8.0.sw - */ - RenameModalTitleDescription = "renameModalTitleDescription", - /** - * The *Request verification* action on a Liveboard. - * Initiates a request for Liveboard verification. - * @example - * ```js - * disabledActions: [Action.RequestVerification] - * ``` - * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw - */ - RequestVerification = "requestVerification", - /** - * - * Allows users to mark a Liveboard as verified. - * @example - * ```js - * disabledActions: [Action.MarkAsVerified] - * ``` - * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 10.1.0.sw - */ - MarkAsVerified = "markAsVerified", - /** - * The **Add Tab** action on a Liveboard. - * Allows adding a new tab to a Liveboard view. - * @example - * ```js - * disabledActions: [Action.AddTab] - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw - */ - AddTab = "addTab", - /** - * - *Initiates contextual change analysis on KPI charts. - * @example - * ```js - * disabledActions: [Action.EnableContextualChangeAnalysis] - * ``` - * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl - */ - EnableContextualChangeAnalysis = "enableContextualChangeAnalysis", - /** - * Action ID to hide or disable Iterative Change Analysis option - * on contextual change analysis Inisght charts context menu - * - * @example - * ```js - * disabledActions: [Action.EnableIterativeChangeAnalysis] - * ``` - * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl - */ - EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis", - /** - * Action ID to hide or disable Natural Language Search query. - * - * @example - * ```js - * disabledActions: [Action.ShowSageQuery] - * ``` - * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl - */ - ShowSageQuery = "showSageQuery", - /** - * - * Action ID to hide or disable the edit option for the - * results generated from the - * Natural Language Search query. - * - * @example - * ```js - * disabledActions: [Action.EditSageAnswer] - * ``` - * @version SDK: 1.26.0 | ThoughtSpot Cloud: 9.7.0.cl - */ - EditSageAnswer = "editSageAnswer", - /** - * The feedback widget for AI-generated Answers. - * Allows users to send feedback on the Answers generated - * from a Natural Language Search query. - * - * @example - * ```js - * disabledActions: [Action.SageAnswerFeedback] - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl - */ - SageAnswerFeedback = "sageAnswerFeedback", - /** - * - * @example - * ```js - * disabledActions: [Action.ModifySageAnswer] - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl - */ - ModifySageAnswer = "modifySageAnswer", - /** - * 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] - * ``` - */ - MoveToTab = "onContainerMove", - /** - * The **Manage Alerts** menu action on KPI visualizations. - * Allows creating, viewing, and editing monitor - * alerts for a KPI chart. - * - * @example - * ```js - * disabledActions: [Action.ManageMonitor] - * ``` - */ - ManageMonitor = "manageMonitor", - /** - * The Liveboard Personalised Views dropdown. - * Allows navigating to a personalized Liveboard View. - * @example - * ```js - * disabledActions: [Action.PersonalisedViewsDropdown] - * ``` - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw - */ - PersonalisedViewsDropdown = "personalisedViewsDropdown", - /** - * Action ID for show or hide the user details on a - * Liveboard (Recently visited / social proof) - * @example - * ```js - * disabledActions: [Action.LiveboardUsers] - * ``` - * @version SDK : 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw - */ - LiveboardUsers = "liveboardUsers", - /** - * 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 - * visibleActions: [Action.TML, Action.ExportTML, Action.EditTML] - * - * ``` - * @example - * ```js - * 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, 10.1.0.sw - */ - TML = "tml", - /** - * The **Create Liveboard* action on - * the Liveboards page and the Pin modal. - * Allows users to create a Liveboard. - * - * @example - * ```js - * hiddenAction: [Action.CreateLiveboard] - * disabledActions: [Action.CreateLiveboard] - * ``` - * @version SDK: 1.32.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw - */ - CreateLiveboard = "createLiveboard", - /** - * Action ID for to hide or disable the - * Verified Liveboard banner. - * @example - * ```js - * hiddenAction: [Action.VerifiedLiveboard] - * ``` - * @version SDK: 1.29.0 | ThoughtSpot: 9.10.0.cl, 10.1.0.sw - */ - VerifiedLiveboard = "verifiedLiveboard", - /** - * Action ID for the *Ask Sage* In Natural Language Search embed, - * *Spotter* in Liveboard, full app, and Spotter embed. - * - * Allows initiating a conversation with ThoughtSpot AI analyst. - * - * @example - * ```js - * hiddenAction: [Action.AskAi] - * ``` - * @version SDK: 1.29.0 | ThoughtSpot Cloud: 9.12.0.cl - */ - AskAi = "AskAi", - /** - * The **Add KPI to Watchlist** action on Home page watchlist. - * Adds a KPI chart to the watchlist on the Home page. - * @example - * ```js - * disabledActions: [Action.AddToWatchlist] - * ``` - * @version SDK : 1.27.9 | ThoughtSpot Cloud: 9.12.5.cl - */ - AddToWatchlist = "addToWatchlist", - /** - * The **Remove from watchlist** menu action on KPI watchlist. - * Removes a KPI chart from the watchlist on the Home page. - * @example - * ```js - * disabledActions: [Action.RemoveFromWatchlist] - * ``` - * @version SDK : 1.27.9 | ThoughtSpot: 9.12.5.cl - */ - RemoveFromWatchlist = "removeFromWatchlist", - /** - * The **Organize Favourites** action on Homepage - * *Favorites* module. - * - * @example - * ```js - * disabledActions: [Action.OrganiseFavourites] - * ``` - * @version SDK : 1.32.0 | ThoughtSpot: 10.0.0.cl - */ - OrganiseFavourites = "organiseFavourites", - /** - * The **AI Highlights** action on a Liveboard. - * - * @example - * ```js - * hiddenAction: [Action.AIHighlights] - * ``` - * @version SDK: 1.27.10 | ThoughtSpot Cloud: 9.12.5.cl - */ - AIHighlights = "AIHighlights", - /** - * The *Edit* action on the *Liveboard Schedules* page - * (new Homepage experience). - * Allows editing Liveboard schedules. - * - * @example - * ```js - * disabledActions: [Action.EditScheduleHomepage] - * ``` - * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl - */ - EditScheduleHomepage = "editScheduleHomepage", - /** - * The *Pause* action on the *Liveboard Schedules* page - * Pauses a scheduled Liveboard job. - * @example - * ```js - * disabledActions: [Action.PauseScheduleHomepage] - * ``` - * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl - */ - PauseScheduleHomepage = "pauseScheduleHomepage", - /** - * The **View run history** action **Liveboard Schedules** page. - * Allows viewing schedule run history. - * @example - * ```js - * disabledActions: [Action.ViewScheduleRunHomepage] - * ``` - * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl - */ - ViewScheduleRunHomepage = "viewScheduleRunHomepage", - /** - * Action ID to hide or disable the - * unsubscribe option for Liveboard schedules. - * @example - * ```js - * disabledActions: [Action.UnsubscribeScheduleHomepage] - * ``` - * @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 Cloud: 10.3.0.cl - */ - ManageTags = "manageTags", - /** - * The **Delete** action on the **Liveboard Schedules* page. - * Deletes a Liveboard schedule. - * @example - * ```js - * disabledActions: [Action.DeleteScheduleHomepage] - * ``` - * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl - */ - DeleteScheduleHomepage = "deleteScheduleHomepage", - /** - * The **Analyze CTA** action on KPI chart. - * @example - * ```js - * disabledActions: [Action.KPIAnalysisCTA] - * ``` - * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl - */ - KPIAnalysisCTA = "kpiAnalysisCTA", - /** - * Action ID for disabling chip reorder in Answer and Liveboard - * @example - * ```js - * const disabledActions = [Action.DisableChipReorder] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - DisableChipReorder = "disableChipReorder", - /** - * Action ID to show, hide, or disable filters - * in a Liveboard tab. - * - * @example - * ```js - * hiddenAction: [Action.ChangeFilterVisibilityInTab] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - ChangeFilterVisibilityInTab = "changeFilterVisibilityInTab", - /** - * The **Preview data** button on the Spotter interface. - * Allows previewing the data used for Spotter queries. - * - * @example - * ```js - * hiddenAction: [Action.PreviewDataSpotter] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - PreviewDataSpotter = "previewDataSpotter", - /** - * The **Reset** link on the Spotter interface. - * Resets the conversation with Spotter. - * - * @example - * ```js - * hiddenAction: [Action.ResetSpotterChat] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - ResetSpotterChat = "resetSpotterChat", - /** - * Action ID for hide or disable the - * Spotter feedback widget. - * - * @example - * ```js - * hiddenAction: [Action.SpotterFeedback] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - SpotterFeedback = "spotterFeedback", - /** - * Action ID for hide or disable - * the previous prompt edit option in Spotter. - * - * @example - * ```js - * hiddenAction: [Action.EditPreviousPrompt] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - EditPreviousPrompt = "editPreviousPrompt", - /** - * Action ID for hide or disable - * the previous prompt deletion option in Spotter. - * - * @example - * ```js - * hiddenAction: [Action.DeletePreviousPrompt] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - DeletePreviousPrompt = "deletePreviousPrompt", - /** - * Action ID for hide or disable editing tokens generated from - * Spotter results. - * @example - * ```js - * hiddenAction: [Action.EditTokens] - * ``` - * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.6.0.cl - */ - EditTokens = "editTokens", - /** - * Action ID for hiding rename option for Column rename - * @example - * ```js - * hiddenAction: [Action.ColumnRename] - * ``` - * @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl - */ - ColumnRename = "columnRename", - /** - * Action ID for hide checkboxes for include or exclude - * cover and filter pages in the Liveboard PDF - * @example - * ```js - * hiddenAction: [Action.CoverAndFilterOptionInPDF] - * ``` - * @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl - */ - CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF", - /** - * Action ID for hide or disable the - * Spotter in conversation training widget. - * The Add to Coaching feature is currently in beta - * and is disabled by default on embed deployments. - * To enable this feature on your instance, - * contact ThoughtSpot Support. - * @example - * ```js - * hiddenAction: [Action.InConversationTraining] - * disabledActions: [Action.InConversationTraining] - * - * ``` - * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl - */ - InConversationTraining = "InConversationTraining", - /** - * Action ID to hide the warnings banner in - * Spotter results. It's an EA feature and - * handled by LD. - * @example - * ```js - * hiddenAction: [Action.SpotterWarningsBanner] - * ``` - * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl - */ - SpotterWarningsBanner = "SpotterWarningsBanner", - /** - * Action ID to hide the warnings border on the knowledge - * card in Spotter results. It's an EA feature and - * handled by LD. - * @example - * ```js - * hiddenAction: [Action.SpotterWarningsOnTokens] - * ``` - * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl - */ - SpotterWarningsOnTokens = "SpotterWarningsOnTokens", - /** - * Action ID to disable the click event handler on knowledge - * card in Spotter results. It's an EA feature and - * handled by LD. - * @example - * ```js - * hiddenAction: [Action.SpotterTokenQuickEdit] - * ``` - * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl - */ - SpotterTokenQuickEdit = "SpotterTokenQuickEdit", - /** - * The **PNG screenshot in email** option in the schedule email dialog. - * Includes a PNG screenshot in the notification email body. - * @example - * ```js - * disabledActions: [Action.PngScreenshotInEmail] - * ``` - * ``` - * @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl - */ - PngScreenshotInEmail = "pngScreenshotInEmail", - /** - * The **Remove attachment** action in the schedule email dialog. - * Removes an attachment from the email configuration. - * @example - * ```js - * disabledActions: [Action.RemoveAttachment] - * ``` - * ``` - * ``` - * @version SDK: 1.42.0 | ThoughtSpot Cloud: 10.14.0.cl - */ - RemoveAttachment = "removeAttachment" -} -export declare enum PrefetchFeatures { - FullApp = "FullApp", - SearchEmbed = "SearchEmbed", - LiveboardEmbed = "LiveboardEmbed", - VizEmbed = "VizEmbed" -} -/** - * Enum for options to change context trigger. - * The `BOTH_CLICKS` option is available from 10.8.0.cl. - */ -export declare enum ContextMenuTriggerOptions { - LEFT_CLICK = "left-click", - RIGHT_CLICK = "right-click", - BOTH_CLICKS = "both-clicks" -} -export interface ColumnValue { - column: { - id: string; - name: string; - dataType: string; - [key: string]: any; - }; - value: string | number | boolean | { - v: { - s: number; - e: number; - }; - }; -} -export interface VizPoint { - selectedAttributes: ColumnValue[]; - selectedMeasures: ColumnValue[]; -} -/** - * @group Events - */ -export interface CustomActionPayload { - contextMenuPoints?: { - clickedPoint: VizPoint; - selectedPoints: VizPoint[]; - }; - embedAnswerData: { - name: string; - id: string; - sources: { - header: { - guid: string; - }; - }; - columns: any[]; - data: any[]; - [key: string]: any; - }; - session: SessionInterface; - vizId?: string; -} -export interface CustomAction { - name: string; - id: string; - position: CustomActionsPosition; - target: CustomActionTarget; - metadataIds?: { - answerIds?: string[]; - liveboardIds?: string[]; - vizIds?: string[]; - }; - dataModelIds?: { - modelIds?: string[]; - modelColumnNames?: string[]; - }; - orgIds?: string[]; - groupIds?: string[]; -} -/** - * Enum options to show custom actions at different - * positions in the application. - */ -export declare enum CustomActionsPosition { - PRIMARY = "PRIMARY", - MENU = "MENU", - CONTEXTMENU = "CONTEXTMENU" -} -/** - * Enum options to mention the target of the custom action. - */ -export declare enum CustomActionTarget { - LIVEBOARD = "LIVEBOARD", - VIZ = "VIZ", - ANSWER = "ANSWER", - SPOTTER = "SPOTTER" -} -/** - * Enum options to show or suppress Visual Embed SDK and - * ThoughtSpot application logs in the console output. - * This attribute doesn't support suppressing - * browser warnings or errors. - */ -export declare enum LogLevel { - /** - * No application or SDK-related logs will be logged - * in the console output. - * @example - * ```js - * init({ - * ... //other embed view config, - * logLevel: LogLevel.SILENT, - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl - */ - SILENT = "SILENT", - /** - * Log only errors in the console output. - * @example - * ```js - * init({ - * ... //other embed view config, - * logLevel: LogLevel.ERROR, - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl - */ - ERROR = "ERROR", - /** - * Log only warnings and errors in the console output. - * @example - * ```js - * init({ - * ... //other embed view config, - * logLevel: LogLevel.WARN, - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl - */ - WARN = "WARN", - /** - * Log only the information alerts, warnings, and errors - * in the console output. - * @example - * ```js - * init({ - * ... //other embed view config, - * logLevel: LogLevel.INFO, - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl - */ - INFO = "INFO", - /** - * Log debug messages, warnings, information alerts, - * and errors in the console output. - * @example - * ```js - * init({ - * ... //other embed view config, - * logLevel: LogLevel.DEBUG, - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl - */ - DEBUG = "DEBUG", - /** - * All logs will be logged in the browser console. - * @example - * ```js - * init({ - * ... //other embed view config, - * logLevel: LogLevel.TRACE, - * }) - * ``` - * @version SDK: 1.26.7 | ThoughtSpot Cloud: 9.10.0.cl - */ - TRACE = "TRACE" -} -export interface DefaultAppInitData { - customisations: CustomisationsInterface; - authToken: string; - runtimeFilterParams: string | null; - runtimeParameterParams: string | null; - hiddenHomepageModules: HomepageModule[]; - reorderedHomepageModules: string[]; - hostConfig: Record; - hiddenHomeLeftNavItems: string[]; - customVariablesForThirdPartyTools: Record; - hiddenListColumns: ListPageColumns[]; - customActions: CustomAction[]; -} -export declare enum UIPassthroughEvent { - PinAnswerToLiveboard = "addVizToPinboard", - SaveAnswer = "saveAnswer", - GetDiscoverabilityStatus = "getDiscoverabilityStatus", - GetAvailableUIPassthroughs = "getAvailableUiPassthroughs", - GetAnswerConfig = "getAnswerPageConfig", - GetLiveboardConfig = "getPinboardPageConfig" -} -export type UIPassthroughContractBase = { - [UIPassthroughEvent.PinAnswerToLiveboard]: { - request: { - vizId?: string; - newVizName: string; - newVizDescription?: string; - liveboardId?: string; - tabId?: string; - newLiveboardName?: string; - newTabName?: string; - }; - response: { - liveboardId: string; - tabId: string; - vizId: string; - }; - }; - [UIPassthroughEvent.SaveAnswer]: { - request: { - name: string; - description: string; - vizId?: string; - isDiscoverable?: boolean; - }; - response: { - answerId: string; - saveResponse?: any; - shareResponse?: any; - }; - }; - [UIPassthroughEvent.GetDiscoverabilityStatus]: { - request: any; - response: { - shouldShowDiscoverability: boolean; - isDiscoverabilityCheckboxUnselectedPerOrg: boolean; - }; - }; - [UIPassthroughEvent.GetAvailableUIPassthroughs]: { - request: any; - response: { - keys: string[]; - }; - }; - [UIPassthroughEvent.GetAnswerConfig]: { - request: { - vizId?: string; - }; - response: any; - }; - [UIPassthroughEvent.GetLiveboardConfig]: { - request: any; - response: any; - }; -}; -export type UIPassthroughRequest = UIPassthroughContractBase[T]["request"]; -export type UIPassthroughResponse = UIPassthroughContractBase[T]["response"]; -export type UIPassthroughArrayResponse = Array<{ - redId?: string; - value?: UIPassthroughResponse; - error?: any; -}>; -export type EmbedApiHostEventMapping = { - [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard; - [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer; -}; -export type HostEventRequest = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest : any; -export type HostEventResponse = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse : any; -export type TriggerPayload = PayloadT | HostEventRequest; -export type TriggerResponse = PayloadT extends HostEventRequest ? HostEventResponse : any; -declare enum ContextType { - Search = "search", - Liveboard = "liveboard", - Answer = "answer", - Spotter = "spotter", - Default = "default" -} -declare class HostEventClient { - iFrame: HTMLIFrameElement; - constructor(iFrame?: HTMLIFrameElement); - /** - * A wrapper over process trigger to - * @param {HostEvent} message Host event to send - * @param {any} data Data to send with the host event - * @returns {Promise} - the response from the process trigger - */ - protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise; - handleHostEventWithParam(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest): Promise>; - hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise; - /** - * Setter for the iframe element used for host events - * @param {HTMLIFrameElement} iFrame - the iframe element to set - */ - setIframeElement(iFrame: HTMLIFrameElement): void; - triggerUIPassthroughApi(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest): Promise>; - protected handlePinEvent(payload: HostEventRequest): Promise>; - protected handleSaveAnswerEvent(payload: HostEventRequest): Promise; - triggerHostEvent(hostEvent: HostEventT, payload?: TriggerPayload, context?: ContextT): Promise>; -} -declare class TsEmbed { - /** - * The DOM node which was inserted by the SDK to either - * render the iframe or display an error message. - * This is useful for removing the DOM node when the - * embed instance is destroyed. - */ - protected insertedDomEl: Node; - /** - * The DOM node where the ThoughtSpot app is to be embedded. - */ - protected el: HTMLElement; - /** - * The key to store the embed instance in the DOM node - */ - protected embedNodeKey: string; - protected isAppInitialized: boolean; - /** - * A reference to the iframe within which the ThoughtSpot app - * will be rendered. - */ - protected iFrame: HTMLIFrameElement; - /** - * Setter for the iframe element - * @param {HTMLIFrameElement} iFrame HTMLIFrameElement - */ - protected setIframeElement(iFrame: HTMLIFrameElement): void; - protected viewConfig: AllEmbedViewConfig & { - visibleTabs?: string[]; - hiddenTabs?: string[]; - showAlerts?: boolean; - }; - protected embedConfig: EmbedConfig; - /** - * The ThoughtSpot hostname or IP address - */ - protected thoughtSpotHost: string; - protected thoughtSpotV2Base: string; - /** - * A map of event handlers for particular message types triggered - * by the embedded app; multiple event handlers can be registered - * against a particular message type. - */ - private eventHandlerMap; - /** - * A flag that is set to true post render. - */ - protected isRendered: boolean; - /** - * A flag to mark if an error has occurred. - */ - private isError; - /** - * A flag that is set to true post preRender. - */ - private isPreRendered; - /** - * Should we encode URL Query Params using base64 encoding which thoughtspot - * will generate for embedding. This provides additional security to - * thoughtspot clusters against Cross site scripting attacks. - * @default false - */ - private shouldEncodeUrlQueryParams; - private defaultHiddenActions; - private resizeObserver; - protected hostEventClient: HostEventClient; - protected isReadyForRenderPromise: Promise; - /** - * Handler for fullscreen change events - */ - private fullscreenChangeHandler; - constructor(domSelector: DOMSelector, viewConfig?: AllEmbedViewConfig); - /** - * Throws error encountered during initialization. - */ - private throwInitError; - /** - * Handles errors within the SDK - * @param error The error message or object - */ - protected handleError(error: string | Record): void; - /** - * Extracts the type field from the event payload - * @param event The window message event - */ - private getEventType; - /** - * Extracts the port field from the event payload - * @param event The window message event - * @returns - */ - private getEventPort; - /** - * Checks if preauth cache is enabled - * from the view config and embed config - * @returns boolean - */ - private isPreAuthCacheEnabled; - /** - * Checks if current embed is FullAppEmbed with visible primary navbar - * @returns boolean - */ - private isFullAppEmbedWithVisiblePrimaryNavbar; - /** - * fix for ts7.sep.cl - * will be removed for ts7.oct.cl - * @param event - * @param eventType - * @hidden - */ - private formatEventData; - private subscribedListeners; - /** - * Subscribe to network events (online/offline) that should - * work regardless of auth status - */ - private subscribeToNetworkEvents; - /** - * Subscribe to message events that depend on successful iframe setup - */ - private subscribeToMessageEvents; - /** - * Adds event listeners for both network and message events. - * This maintains backward compatibility with the existing method. - * Adds a global event listener to window for "message" events. - * ThoughtSpot detects if a particular event is targeted to this - * embed instance through an identifier contained in the payload, - * and executes the registered callbacks accordingly. - */ - private subscribeToEvents; - private unsubscribeToNetworkEvents; - private unsubscribeToMessageEvents; - private unsubscribeToEvents; - protected getAuthTokenForCookielessInit(): Promise; - protected getDefaultAppInitData(): Promise; - protected getAppInitData(): Promise; - /** - * Send Custom style as part of payload of APP_INIT - * @param _ - * @param responder - */ - private appInitCb; - /** - * Sends updated auth token to the iFrame to avoid user logout - * @param _ - * @param responder - */ - private updateAuthToken; - /** - * Auto Login and send updated authToken to the iFrame to avoid user session logout - * @param _ - * @param responder - */ - private idleSessionTimeout; - /** - * Register APP_INIT event and sendback init payload - */ - private registerAppInit; - /** - * Constructs the base URL string to load the ThoughtSpot app. - * @param query - */ - protected getEmbedBasePath(query: string): string; - protected getUpdateEmbedParamsObject(): Record; - /** - * Common query params set for all the embed modes. - * @param queryParams - * @returns queryParams - */ - protected getBaseQueryParams(queryParams?: Record): Record; - /** - * Constructs the base URL string to load v1 of the ThoughtSpot app. - * This is used for embedding Liveboards, visualizations, and full application. - * @param queryString The query string to append to the URL. - * @param isAppEmbed A Boolean parameter to specify if you are embedding - * the full application. - */ - protected getV1EmbedBasePath(queryString: string): string; - protected getEmbedParams(): string; - protected getEmbedParamsObject(): Record; - protected getRootIframeSrc(): string; - protected createIframeEl(frameSrc: string): HTMLIFrameElement; - protected handleInsertionIntoDOM(child: string | Node): void; - /** - * Renders the embedded ThoughtSpot app in an iframe and sets up - * event listeners. - * @param url - The URL of the embedded ThoughtSpot app. - */ - protected renderIFrame(url: string): Promise; - protected createPreRenderWrapper(): HTMLDivElement; - protected preRenderWrapper: HTMLElement; - protected preRenderChild: HTMLElement; - protected connectPreRendered(): boolean; - protected isPreRenderAvailable(): boolean; - protected createPreRenderChild(child: string | Node): HTMLElement; - protected insertIntoDOMForPreRender(child: string | Node): void; - private showPreRenderByDefault; - protected insertIntoDOM(child: string | Node): void; - /** - * Sets the height of the iframe - * @param height The height in pixels - */ - protected setIFrameHeight(height: number | string): void; - /** - * Executes all registered event handlers for a particular event type - * @param eventType The event type - * @param data The payload invoked with the event handler - * @param eventPort The event Port for a specific MessageChannel - */ - protected executeCallbacks(eventType: EmbedEvent, data: any, eventPort?: MessagePort | void): void; - /** - * Returns the ThoughtSpot hostname or IP address. - */ - protected getThoughtSpotHost(): string; - /** - * Gets the v1 event type (if applicable) for the EmbedEvent type - * @param eventType The v2 event type - * @returns The corresponding v1 event type if one exists - * or else the v2 event type itself - */ - protected getCompatibleEventType(eventType: EmbedEvent): EmbedEvent; - /** - * Calculates the iframe center for the current visible viewPort - * of iframe using Scroll position of Host App, offsetTop for iframe - * in Host app. ViewPort height of the tab. - * @returns iframe Center in visible viewport, - * Iframe height, - * View port height. - */ - protected getIframeCenter(): { - iframeCenter: number; - iframeScrolled: number; - iframeHeight: number; - viewPortHeight: number; - iframeVisibleViewPort: number; - }; - /** - * Registers an event listener to trigger an alert when the ThoughtSpot app - * sends an event of a particular message type to the host application. - * @param messageType The message type - * @param callback A callback as a function - * @param options The message options - * @param isSelf - * @param isRegisteredBySDK - * @example - * ```js - * tsEmbed.on(EmbedEvent.Error, (data) => { - * console.error(data); - * }); - * ``` - * @example - * ```js - * tsEmbed.on(EmbedEvent.Save, (data) => { - * console.log("Answer save clicked", data); - * }, { - * start: true // This will trigger the callback on start of save - * }); - * ``` - */ - on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype; - /** - * Removes an event listener for a particular event type. - * @param messageType The message type - * @param callback The callback to remove - * @example - * ```js - * const errorHandler = (data) => { console.error(data); }; - * tsEmbed.on(EmbedEvent.Error, errorHandler); - * tsEmbed.off(EmbedEvent.Error, errorHandler); - * ``` - */ - off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype; - /** - * Triggers an event on specific Port registered against - * for the EmbedEvent - * @param eventType The message type - * @param data The payload to send - * @param eventPort - * @param payload - */ - private triggerEventOnPort; - /** - * @hidden - * Internal state to track if the embed container is loaded. - * This is used to trigger events after the embed container is loaded. - */ - isEmbedContainerLoaded: boolean; - /** - * @hidden - * Internal state to track the callbacks to be executed after the embed container - * is loaded. - * This is used to trigger events after the embed container is loaded. - */ - private embedContainerReadyCallbacks; - protected getPreRenderObj(): T; - private checkEmbedContainerLoaded; - private executeEmbedContainerReadyCallbacks; - /** - * Executes a callback after the embed container is loaded. - * @param callback The callback to execute - */ - protected executeAfterEmbedContainerLoaded(callback: () => void): void; - protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void; - /** - * 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(messageType: HostEventT, data?: TriggerPayload, context?: ContextT): Promise>; - /** - * Triggers an event to the embedded app, skipping the UI flow. - * @param {UIPassthroughEvent} apiName - The name of the API to be triggered. - * @param {UIPassthroughRequest} parameters - The parameters to be passed to the API. - * @returns {Promise} - A promise that resolves with the response - * from the embedded app. - */ - triggerUIPassThrough(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest): Promise>; - /** - * Marks the ThoughtSpot object to have been rendered - * Needs to be overridden by subclasses to do the actual - * rendering of the iframe. - * @param args - */ - render(): Promise; - getIframeSrc(): string; - protected handleRenderForPrerender(): Promise; - getCurrentContext(): Promise; - /** - * Creates the preRender shell - * @param showPreRenderByDefault - Show the preRender after render, hidden by default - */ - preRender(showPreRenderByDefault?: boolean, replaceExistingPreRender?: boolean): Promise; - /** - * Get the Post Url Params for THOUGHTSPOT from the current - * host app URL. - * THOUGHTSPOT URL params starts with a prefix "ts-" - * @version SDK: 1.14.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw - */ - getThoughtSpotPostUrlParams(additionalParams?: { - [key: string]: string | number; - }): string; - /** - * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. - * @version SDK: 1.19.1 | ThoughtSpot: * - */ - destroy(): void; - getUnderlyingFrameElement(): HTMLIFrameElement; - /** - * 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. - * @version SDK: 1.22.0 - * @returns - */ - prerenderGeneric(): Promise; - protected beforePrerenderVisible(): void; - private validatePreRenderViewConfig; - /** - * 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. - */ - showPreRender(): Promise; - /** - * 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. - * @throws {Error} Throws an error if the embedding element (passed as domSelector) - * is not defined or not found. - */ - syncPreRenderStyle(): void; - /** - * Hides the PreRender component if it is available. - * If the component is not preRendered, it issues a warning. - */ - hidePreRender(): void; - /** - * Retrieves unique HTML element IDs for PreRender-related elements. - * These IDs are constructed based on the provided 'preRenderId' from 'viewConfig'. - * @returns {object} An object containing the IDs for the PreRender elements. - * @property {string} wrapper - The HTML element ID for the PreRender wrapper. - * @property {string} child - The HTML element ID for the PreRender child. - */ - getPreRenderIds(): { - wrapper: string; - child: string; - }; - /** - * Returns the answerService which can be used to make arbitrary graphql calls on top - * session. - * @param vizId [Optional] to get for a specific viz in case of a Liveboard. - * @version SDK: 1.25.0 / ThoughtSpot 9.10.0 - */ - getAnswerService(vizId?: string): Promise; - /** - * Set up fullscreen change detection to automatically trigger ExitPresentMode - * when user exits fullscreen mode - */ - private setupFullscreenChangeHandler; - /** - * Remove fullscreen change handler - */ - private removeFullscreenChangeHandler; -} -declare class V1Embed extends TsEmbed { - protected viewConfig: AllEmbedViewConfig; - constructor(domSelector: DOMSelector, viewConfig: AllEmbedViewConfig); - /** - * Render the app in an iframe and set up event handlers - * @param iframeSrc - */ - protected renderV1Embed(iframeSrc: string): Promise; - protected getRootIframeSrc(): string; - /** - * @inheritdoc - * @example - * ```js - * tsEmbed.on(EmbedEvent.Error, (data) => { - * console.error(data); - * }); - * ``` - * @example - * ```js - * tsEmbed.on(EmbedEvent.Save, (data) => { - * console.log("Answer save clicked", data); - * }, { - * start: true // This will trigger the callback on start of save - * }); - * ``` - */ - 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; -} -/** - * Pages within the ThoughtSpot app that can be embedded. - */ -export declare enum Page { - /** - * Home page - */ - Home = "home", - /** - * Search page - */ - Search = "search", - /** - * Saved answers listing page - */ - Answers = "answers", - /** - * Liveboards listing page - */ - Liveboards = "liveboards", - /** - * @hidden - */ - Pinboards = "pinboards", - /** - * Data management page - */ - Data = "data", - /** - * SpotIQ listing page - */ - SpotIQ = "insights", - /** - * Monitor Alerts Page - */ - Monitor = "monitor" -} -/** - * Define the initial state os column custom group accordions - * in data panel v2. - */ -export declare enum DataPanelCustomColumnGroupsAccordionState { - /** - * Expand all the accordion initially in data panel v2. - */ - EXPAND_ALL = "EXPAND_ALL", - /** - * Collapse all the accordions initially in data panel v2. - */ - COLLAPSE_ALL = "COLLAPSE_ALL", - /** - * Expand the first accordion and collapse the rest. - */ - EXPAND_FIRST = "EXPAND_FIRST" -} -export declare enum HomePageSearchBarMode { - OBJECT_SEARCH = "objectSearch", - AI_ANSWER = "aiAnswer", - NONE = "none" -} -/** - * Define the version of the primary navbar - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ -export declare enum PrimaryNavbarVersion { - /** - * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher, - * along with updates to the top navigation bar. - * It serves as the foundational version of the PrimaryNavBar. - */ - Sliding = "v3" -} -/** - * Define the version of the home page - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ -export declare enum HomePage { - /** - * Modular (v2) introduces the updated Modular Home Experience. - * It serves as the foundational version of the home page. - */ - Modular = "v2", - /** - * ModularWithStylingChanges (v3) introduces Modular Home Experience - * with styling changes. - */ - ModularWithStylingChanges = "v3" -} -/** - * Define the version of the list page - * @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl - */ -export declare enum ListPage { - /** - * List (v2) is the traditional List Experience. - * It serves as the foundational version of the list page. - */ - List = "v2", - /** - * ListWithUXChanges (v3) introduces the new updated list page with UX changes. - */ - ListWithUXChanges = "v3" -} -/** - * Define the discovery experience - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - */ -export interface DiscoveryExperience { - /** - * primaryNavbarVersion determines the version of the navigation version. - */ - primaryNavbarVersion?: PrimaryNavbarVersion; - /** - * homePage determines the version of the home page. - */ - homePage?: HomePage; - /** - * listPageVersion determines the version of the list page. - */ - listPageVersion?: ListPage; -} -/** - * The view configuration for full app embedding. - * @group Embed components - */ -export interface AppViewConfig extends AllEmbedViewConfig { - /** - * If true, the top navigation bar within the ThoughtSpot app - * is displayed. By default, the navigation bar is hidden. - * This flag also controls the homepage left navigation bar. - * - * Supported embed types: `AppEmbed` - * @default true - * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * showPrimaryNavbar:true, - * }) - * ``` - */ - showPrimaryNavbar?: boolean; - /** - * Control the visibility of the left navigation bar on the Homepage. - * If showPrimaryNavbar is true, that is, if the Global and Homepage - * nav-bars are visible, this flag will only hide the homepage left nav-bar. - * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav. - * - * **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). - * - * Supported embed types: `AppEmbed` - * @default false - * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideHomepageLeftNav : true, - * }) - * ``` - */ - hideHomepageLeftNav?: boolean; - /** - * Control the visibility of the help (?) and profile buttons on the - * Global nav-bar. By default, these buttons are visible on the nav-bar. - * - * Supported embed types: `AppEmbed` - * @default false - * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * disableProfileAndHelp: true, - * }) - * ``` - */ - disableProfileAndHelp?: boolean; - /** - * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl - * @default true - * Whether the help menu in the top nav bar should be served - * from Pendo or ThoughtSpot's internal help items. - * - * Supported embed types: `AppEmbed` - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * enablePendoHelp: false, - * }); - * ``` - */ - enablePendoHelp?: boolean; - /** - * Control the visibility of the hamburger icon on the top nav bar - * available when new navigation V3 is enabled. - * - * Supported embed types: `AppEmbed` - * @default false - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideHamburger : true, - * }) - * ``` - */ - hideHamburger?: boolean; - /** - * Control the visibility of the Eureka search on the top nav bar - * this will control for both new V2 and new navigation V3. - * - * Supported embed types: `AppEmbed` - * @default true - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideObjectSearch: false, - * }) - * ``` - */ - hideObjectSearch?: boolean; - /** - * Control the visibility of the notification on the top nav bar V3, - * available when new navigation V3 is enabled. - * - * Supported embed types: `AppEmbed` - * @default true - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideNotification: false, - * }) - * ``` - */ - hideNotification?: boolean; - /** - * Control the visibility of the application switcher button on the nav-bar. - * By default, the application switcher is shown. - * - * **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). - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl - * @default false - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideApplicationSwitcher : true, - * }) - * ``` - */ - hideApplicationSwitcher?: boolean; - /** - * Control the visibility of the Org switcher button on the nav-bar. - * By default, the Org switcher button is shown. - * - * **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). - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl - * @default true - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideOrgSwitcher : true, - * }) - * ``` - */ - hideOrgSwitcher?: boolean; - /** - * A URL path to the embedded application page - * If both path and pageId attributes are defined, the path definition - * takes precedence. This is the path post the `#/` in the URL of the standalone - * ThoughtSpot app. Use this to open the embedded view to a specific path. - * - * For eg, if you want the component to open to a specific Liveboard - * you could set the path to `pinboard//tab/`. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * path:"pinboard/1234/tab/7464", - * }) - * ``` - */ - path?: string; - /** - * The application page to set as the start page - * in the embedded view. - * - * Use this to open to particular page in the app. To open to a specific - * path within the app, use the `path` attribute which is more flexible. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * pageId : Page.Answers | Page.Data, - * }) - * ``` - */ - pageId?: Page; - /** - * This puts a filter tag on the application. All metadata lists in the - * application, such as Liveboards and answers, would be filtered by this - * tag. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * tag:'value', - * }) - * ``` - */ - tag?: string; - /** - * Hide tag filter chips that appear when content is filtered by tags. - * When enabled, this automatically: - * - Hides tag filter indicators/chips from the UI - * - * This provides a clean interface without tag-related UI elements. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.44.0 | ThoughtSpot: 10.15.0.cl - * @example - * ```js - * // Simple usage - automatically hides all tag-related UI - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * tag: 'Some Tag', - * hideTagFilterChips: true, // This is all you need! - * }); - * ``` - */ - hideTagFilterChips?: boolean; - /** - * The array of GUIDs to be hidden - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * hideObjects: [ - * '430496d6-6903-4601-937e-2c691821af3c', - * 'f547ec54-2a37-4516-a222-2b06719af726' - * ] - * }) - * ``` - */ - hideObjects?: string[]; - /** - * Render liveboards using the new v2 rendering mode - * This is a transient flag which is primarily meant for internal use - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw - * @hidden - */ - liveboardV2?: boolean; - /** - * If set to true, the Search Assist feature is enabled. - * - * Supported embed types: `AppEmbed` - * @default true - * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * enableSearchAssist: true, - * }) - * ``` - */ - enableSearchAssist?: boolean; - /** - * If set to true, the Liveboard 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. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * fullHeight: true, - * }) - * ``` - */ - fullHeight?: boolean; - /** - * Flag to control new Modular Home experience. - * - * Supported embed types: `AppEmbed` - * @default false - * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * modularHomeExperience : true, - * }) - * ``` - */ - modularHomeExperience?: boolean; - /** - * To configure the top-left navigation and home page experience - * - * Supported embed types: `AppEmbed` - * @default false - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * discoveryExperience : { - * primaryNavbarVersion: PrimaryNavbarVersion.Sliding, - * homePage: HomePage.Modular, - * }, - * }) - * ``` - */ - discoveryExperience?: DiscoveryExperience; - /** - * To set the initial state of the search bar in case of saved-answers. - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl - * @default false - * @deprecated Use {@link collapseSearchBar} instead - */ - collapseSearchBarInitially?: boolean; - /** - * This controls the initial behaviour of custom column groups accordion. - * It takes DataPanelCustomColumnGroupsAccordionState enum values as input. - * List of different enum values:- - * - EXPAND_ALL: Expand all the accordion initially in data panel v2. - * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2. - * - EXPAND_FIRST: Expand the first accordion and collapse the rest. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl - * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL - * @example - * ```js - * const embed = new AppEmbed('#embed', { - * ... // other app view config - * dataPanelCustomGroupsAccordionInitialState: - * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, - * }); - * ``` - */ - dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState; - /** - * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`. - * @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl - */ - isOnBeforeGetVizDataInterceptEnabled?: boolean; - /** - * Flag to use home page search bar mode - * - * Supported embed types: `AppEmbed` - * @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl - */ - homePageSearchBarMode?: HomePageSearchBarMode; - /** - * This flag is used to enable unified search experience for full app embed. - * - * Supported embed types: `AppEmbed` - * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl - * @default true - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * isUnifiedSearchExperienceEnabled: true, - * }) - * ``` - */ - isUnifiedSearchExperienceEnabled?: boolean; - /** - * This flag is used to enable/disable the styling and grouping in a Liveboard - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @type {boolean} - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * isLiveboardStylingAndGroupingEnabled: true, - * }) - * ``` - */ - isLiveboardStylingAndGroupingEnabled?: boolean; - /** - * This flag is used to enable/disable the png embedding of liveboard in scheduled mails - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @type {boolean} - * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * isPNGInScheduledEmailsEnabled: true, - * }) - * ``` - */ - isPNGInScheduledEmailsEnabled?: boolean; - /** - * This flag is used to enable the full height lazy load data. - * - * @example - * ```js - * const embed = new AppEmbed('#embed-container', { - * // ...other options - * fullHeight: true, - * lazyLoadingForFullHeight: true, - * }) - * ``` - * - * @type {boolean} - * @default false - * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl - */ - lazyLoadingForFullHeight?: boolean; - /** - * The margin to be used for lazy loading. - * - * For example, if the margin is set to '10px', - * the visualization will be loaded 10px before the its top edge is visible in the - * viewport. - * - * The format is similar to CSS margin. - * - * @example - * ```js - * const embed = new AppEmbed('#embed-container', { - * // ...other options - * fullHeight: true, - * lazyLoadingForFullHeight: true, - * // Using 0px, the visualization will be only loaded when its visible in the viewport. - * lazyLoadingMargin: '0px', - * }) - * ``` - * @type {string} - * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl - */ - lazyLoadingMargin?: string; -} -/** - * Embeds full ThoughtSpot experience in a host application. - * @group Embed components - */ -export declare class AppEmbed extends V1Embed { - protected viewConfig: AppViewConfig; - private defaultHeight; - constructor(domSelector: DOMSelector, viewConfig: AppViewConfig); - /** - * Constructs a map of parameters to be passed on to the - * embedded Liveboard or visualization. - */ - protected getEmbedParams(): string; - private sendFullHeightLazyLoadData; - /** - * This is a handler for the RequestVisibleEmbedCoordinates event. - * It is used to send the visible coordinates data to the host application. - * @param data The event payload - * @param responder The responder function - */ - private requestVisibleEmbedCoordinatesHandler; - /** - * Constructs the URL of the ThoughtSpot app page to be rendered. - * @param pageId The ID of the page to be embedded. - */ - getIFrameSrc(): string; - /** - * Set the iframe height as per the computed height received - * from the ThoughtSpot app. - * @param data The event payload - */ - protected updateIFrameHeight: (data: MessagePayload) => void; - private embedIframeCenter; - private setIframeHeightForNonEmbedLiveboard; - /** - * Gets the ThoughtSpot route of the page for a particular page ID. - * @param pageId The identifier for a page in the ThoughtSpot app. - * @param modularHomeExperience - */ - private getPageRoute; - /** - * Formats the path provided by the user. - * @param path The URL path. - * @returns The URL path that the embedded app understands. - */ - private formatPath; - /** - * Navigate to particular page for app embed. eg:answers/pinboards/home - * This is used for embedding answers, pinboards, visualizations and full application - * only. - * @param path string | number The string, set to iframe src and navigate to new page - * eg: appEmbed.navigateToPage('pinboards') - * When used with `noReload` (default: true) this can also be a number - * like 1/-1 to go forward/back. - * @param noReload boolean Trigger the navigation without reloading the page - * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw - */ - navigateToPage(path: string | number, noReload?: boolean): void; - /** - * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - destroy(): void; - private postRender; - private registerLazyLoadEvents; - private unregisterLazyLoadEvents; - /** - * Renders the embedded application pages in the ThoughtSpot app. - * @param renderOptions An object containing the page ID - * to be embedded. - */ - render(): Promise; -} -/** - * Enum for auth failure types. This is the parameter passed to the listner - * of {@link AuthStatus.FAILURE}. - * @group Authentication / Init - */ -export declare enum AuthFailureType { - SDK = "SDK", - NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS", - EXPIRY = "EXPIRY", - OTHER = "OTHER", - IDLE_SESSION_TIMEOUT = "IDLE_SESSION_TIMEOUT", - UNAUTHENTICATED_FAILURE = "UNAUTHENTICATED_FAILURE" -} -/** - * Enum for auth status emitted by the emitter returned from {@link init}. - * @group Authentication / Init - */ -export declare enum AuthStatus { - /** - * Emits when the SDK fails to authenticate - */ - FAILURE = "FAILURE", - /** - * Emits when the SDK authenticates successfully - */ - SDK_SUCCESS = "SDK_SUCCESS", - /** - * @hidden - * Emits when iframe is loaded and session info is available - */ - SESSION_INFO_SUCCESS = "SESSION_INFO_SUCCESS", - /** - * Emits when the app sends an authentication success message - */ - SUCCESS = "SUCCESS", - /** - * Emits when a user logs out - */ - LOGOUT = "LOGOUT", - /** - * Emitted when inPopup is true in the SAMLRedirect flow and the - * popup is waiting to be triggered either programmatically - * or by the trigger button. - * @version SDK: 1.19.0 - */ - WAITING_FOR_POPUP = "WAITING_FOR_POPUP", - /** - * Emitted when the SAML popup is closed without authentication - */ - SAML_POPUP_CLOSED_NO_AUTH = "SAML_POPUP_CLOSED_NO_AUTH" -} -/** - * Event emitter returned from {@link init}. - * @group Authentication / Init - */ -export interface AuthEventEmitter { - /** - * Register a listener on Auth failure. - * @param event - * @param listener - */ - on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this; - /** - * Register a listener on Auth SDK success. - * @param event - * @param listener - */ - on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this; - on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this; - once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this; - once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP | AuthStatus.SAML_POPUP_CLOSED_NO_AUTH, listener: () => void): this; - once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this; - /** - * Trigger an event on the emitter returned from init. - * @param {@link AuthEvent} - */ - emit(event: AuthEvent, ...args: any[]): boolean; - /** - * Remove listener from the emitter returned from init. - * @param event - * @param listener - * @param context - * @param once - */ - off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this; - /** - * Remove all the event listeners - * @param event - */ - removeAllListeners(event: AuthStatus): this; -} -/** - * Events which can be triggered on the emitter returned from {@link init}. - * @group Authentication / Init - */ -export declare enum AuthEvent { - /** - * Manually trigger the SSO popup. This is useful when - * authStatus is SAMLRedirect/OIDCRedirect and inPopup is set to true - */ - TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP" -} -export interface executeTMLInput { - metadata_tmls: string[]; - import_policy?: "PARTIAL" | "ALL_OR_NONE" | "VALIDATE_ONLY"; - create_new?: boolean; -} -export interface exportTMLInput { - metadata: { - identifier: string; - type?: "LIVEBOARD" | "ANSWER" | "LOGICAL_TABLE" | "CONNECTION"; - }[]; - export_associated?: boolean; - export_fqn?: boolean; - edoc_format?: "YAML" | "JSON"; -} -/** - * Prefetches static resources from the specified URL. Web browsers can then cache the - * prefetched resources and serve them from the user's local disk to provide faster access - * to your app. - * @param url The URL provided for prefetch - * @param prefetchFeatures Specify features which needs to be prefetched. - * @param additionalFlags This can be used to add any URL flag. - * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1 - * @group Global methods - */ -export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: { - [key: string]: string | number | boolean; -}) => void; -/** - * Initializes the Visual Embed SDK globally and perform - * authentication if applicable. This function needs to be called before any ThoughtSpot - * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS - * to actually embed. That is handled internally. - * @param embedConfig The configuration object containing ThoughtSpot host, - * authentication mechanism and so on. - * @example - * ```js - * const authStatus = init({ - * thoughtSpotHost: 'https://my.thoughtspot.cloud', - * authType: AuthType.None, - * }); - * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here }); - * ``` - * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success, - * failure and logout. See {@link AuthStatus} - * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1 - * @group Authentication / Init - */ -export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter; -/** - * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to - * prevent the SDK from automatically logging in again. - * - * You can call the `init` method again to re login, if autoLogin is set to - * true in this second call it will be honored. - * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin - * @returns Promise which resolves when logout completes. - * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw - * @group Global methods - */ -export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise; -/** - * Imports TML representation of the metadata objects into ThoughtSpot. - * @param data - * @returns imports TML data into ThoughtSpot - * @example - * ```js - * 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 - */ -export declare const executeTML: (data: executeTMLInput) => Promise; -/** - * 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); - * }); - * ``` - * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl - * @group Global methods - */ -export declare const exportTML: (data: exportTMLInput) => Promise; -declare enum ContextType$1 { - Search = "search", - Liveboard = "liveboard", - Answer = "answer", - Spotter = "spotter", - Default = "default" -} -declare enum PageType { - PAGE = "page", - DIALOG = "dialog" -} -export interface ObjectIds { - answerId?: string; - liveboardId?: string; - vizIds?: string[]; - dataModelIds?: string[]; -} -export type PageContextOptions = { - page: ContextType$1; - pageType: PageType; - objectIds: ObjectIds; -}; -/** - * The configuration for the embedded Liveboard or visualization page view. - * @group Embed components - */ -export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, LiveboardAppEmbedViewConfig { - /** - * 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 - * - * Supported embed types: `LiveboardEmbed` - * @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. - * - * Supported embed types: `LiveboardEmbed` - * @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 embed view config - * 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. - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1 - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * liveboardId:id of liveboard, - * }) - */ - liveboardId?: string; - /** - * To support backward compatibility - * @hidden - */ - pinboardId?: string; - /** - * The visualization within the Liveboard to display. - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * 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) - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * 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. - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * 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. - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * liveboardV2:true, - * }) - * ``` - */ - liveboardV2?: boolean; - /** - * Set a Liveboard tab as an active tab. - * Specify the tab ID. - * - * Supported embed types: `LiveboardEmbed` - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * 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. - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * hideTabPanel:true, - * }) - * ``` - */ - hideTabPanel?: 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. - * - * Supported embed types: `LiveboardEmbed` - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * liveboardId: 'liveboard-id', - * vizId: 'viz-id', - * showPreviewLoader: true, - * }); - * embed.render(); - * ``` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl - */ - showPreviewLoader?: boolean; - /** - * The Liveboard to run on regular intervals to fetch the cdw token. - * - * Supported embed types: `LiveboardEmbed` - * @hidden - * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * oAuthPollingInterval: value in milliseconds, - * }) - */ - oAuthPollingInterval?: number; - /** - * The Liveboard is set to force a token fetch during the initial load. - * - * Supported embed types: `LiveboardEmbed` - * @hidden - * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * isForceRedirect: false, - * }) - */ - isForceRedirect?: boolean; - /** - * The source connection ID for authentication. - * @hidden - * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl - * - * Supported embed types: `LiveboardEmbed` - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... //other embed view config - * dataSourceId: '', - * }) - */ - dataSourceId?: string; - /** - * The list of tab IDs to hide from the embedded. - * This Tabs will be hidden from their respective LBs. - * Use this to hide an tabID. - * - * Supported embed types: `LiveboardEmbed` - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... // other embed view config - * hiddenTabs: [ - * '430496d6-6903-4601-937e-2c691821af3c', - * 'f547ec54-2a37-4516-a222-2b06719af726' - * ] - * }); - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw - */ - hiddenTabs?: string[]; - /** - * The list of tab IDs to show in the embedded Liveboard. - * Only the tabs specified in the array will be shown in the Liveboard. - * - * Use either `visibleTabs` or `hiddenTabs`. - * - * Supported embed types: `LiveboardEmbed` - * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw - * @example - * ```js - * const embed = new LiveboardEmbed('#tsEmbed', { - * ... // other embed view config - * visibleTabs: [ - * '430496d6-6903-4601-937e-2c691821af3c', - * 'f547ec54-2a37-4516-a222-2b06719af726' - * ] - * }) - * ``` - */ - visibleTabs?: string[]; - /** - * This flag is used to enable/disable the styling and grouping in a Liveboard - * - * Supported embed types: `LiveboardEmbed`, `AppEmbed` - * @type {boolean} - * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * isLiveboardStylingAndGroupingEnabled: true, - * }) - * ``` - */ - isLiveboardStylingAndGroupingEnabled?: boolean; - /** - * This flag is used to enable/disable the png embedding of liveboard in scheduled mails - * - * Supported embed types: `AppEmbed`, `LiveboardEmbed` - * @type {boolean} - * @version SDK: 1.42.0 | ThoughtSpot: 10.14.0.cl - * @example - * ```js - * // Replace with embed component name. For example, AppEmbed or LiveboardEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * isPNGInScheduledEmailsEnabled: true, - * }) - * ``` - */ - isPNGInScheduledEmailsEnabled?: boolean; - /** - * This flag is used to enable the full height lazy load data. - * - * @example - * ```js - * const embed = new LiveboardEmbed('#embed-container', { - * // ...other options - * fullHeight: true, - * lazyLoadingForFullHeight: true, - * }) - * ``` - * - * @type {boolean} - * @default false - * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl - */ - lazyLoadingForFullHeight?: boolean; - /** - * The margin to be used for lazy loading. - * - * For example, if the margin is set to '10px', - * the visualization will be loaded 10px before the its top edge is visible in the - * viewport. - * - * The format is similar to CSS margin. - * - * @example - * ```js - * const embed = new LiveboardEmbed('#embed-container', { - * // ...other options - * fullHeight: true, - * lazyLoadingForFullHeight: true, - * // Using 0px, the visualization will be only loaded when its visible in the viewport. - * lazyLoadingMargin: '0px', - * }) - * ``` - * @type {string} - * @version SDK: 1.40.0 | ThoughtSpot:10.12.0.cl - */ - lazyLoadingMargin?: string; - /** - * showSpotterLimitations : show limitation text - * of the spotter underneath the chat input. - * default is false. - * - * @example - * ```js - * const embed = new LiveboardEmbed('#embed-container', { - * // ...other options - * showSpotterLimitations: true, - * }) - * ``` - * @type {boolean} - * @version SDK: 1.41.1 | ThoughtSpot: 10.5.0.cl - */ - showSpotterLimitations?: 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: , - * // .. 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; - protected getEmbedParamsObject(): any; - private getIframeSuffixSrc; - private sendFullHeightLazyLoadData; - /** - * This is a handler for the RequestVisibleEmbedCoordinates event. - * It is used to send the visible coordinates data to the host application. - * @param data The event payload - * @param responder The responder function - */ - private requestVisibleEmbedCoordinatesHandler; - /** - * 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; - /** - * @hidden - * Internal state to track the current liveboard id. - * This is used to navigate to the correct liveboard when the prerender is visible. - */ - currentLiveboardState: { - liveboardId: string; - vizId: string; - activeTabId: string; - }; - protected beforePrerenderVisible(): void; - protected handleRenderForPrerender(): Promise; - /** - * 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(messageType: HostEventT, data?: TriggerPayload, context?: ContextT): Promise>; - /** - * Destroys the ThoughtSpot embed, and remove any nodes from the DOM. - * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - */ - destroy(): void; - private postRender; - private registerLazyLoadEvents; - private unregisterLazyLoadEvents; - /** - * Render an embedded ThoughtSpot Liveboard or visualization - * @param renderOptions An object specifying the Liveboard ID, - * visualization ID and the runtime filters. - */ - render(): Promise; - 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; - getCurrentContext(): Promise; -} -/** - * @hidden - */ -export declare class PinboardEmbed extends LiveboardEmbed { -} -/** - * Configuration for search options. - * - */ -export interface SearchOptions { - /** - * Search tokens to pass in the query. - */ - searchTokenString: string; - /** - * Boolean to define if the search should be executed or not. - * If it is executed, the focus is placed on the results. - * If it’s not executed, the focus is placed at the end of - * the token string in the search bar. - */ - executeSearch?: boolean; -} -declare enum DataPanelCustomColumnGroupsAccordionState$1 { - /** - * Expand all the accordion initially in data panel v2. - */ - EXPAND_ALL = "EXPAND_ALL", - /** - * Collapse all the accordions initially in data panel v2. - */ - COLLAPSE_ALL = "COLLAPSE_ALL", - /** - * Expand the first accordion and collapse the rest. - */ - EXPAND_FIRST = "EXPAND_FIRST" -} -/** - * The configuration attributes for the embedded search view. - * @group Embed components - */ -export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit { - /** - * If set to true, the data sources panel is collapsed on load, - * but can be expanded manually. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * collapseDataSources:true, - * }) - * ``` - */ - collapseDataSources?: boolean; - /** - * If set to true, the data panel is collapsed on load, - * but can be expanded manually. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * collapseDataPanel:true, - * }) - * ``` - */ - collapseDataPanel?: boolean; - /** - * Show or hide the data sources panel. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * hideDataSources:true, - * }) - * ``` - */ - hideDataSources?: boolean; - /** - * Show or hide the charts and tables in search answers. - * This attribute can be used to create a custom visualization - * using raw answer data. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * hideResults:true, - * }) - * ``` - */ - hideResults?: boolean; - /** - * If set to true, the Search Assist feature is enabled. - * - * Supported embed types: `SearchEmbed` - * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * enableSearchAssist:true, - * }) - * ``` - */ - enableSearchAssist?: boolean; - /** - * If set to true, the tabular view is set as the default - * format for presenting search data. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * forceTable:true, - * }) - */ - forceTable?: boolean; - /** - * The array of data source GUIDs to set on load. - * Only a single data source is supported currently. - * @deprecated Use `dataSource` instead. - * - * Supported embed types: `SearchEmbed` - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * dataSources:['id-234','id-456'], - * }) - * ``` - */ - dataSources?: string[]; - /** - * The array of data source GUIDs to set on load. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.19.0 - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * dataSource:'id-234', - * }) - * ``` - */ - dataSource?: string; - /** - * The initial search query to load the answer with. - * @deprecated - * - * Use {@link searchOptions} instead. - */ - searchQuery?: string; - /** - * Configuration for search options. - * Includes the following properties: - * - * `searchTokenString`: Search tokens to pass in the query. - * - * `executeSearch`: Boolean to define if the search should be executed or not. - * If it is executed, the focus is placed on the results. - * If it’s not executed, the focus is placed at the end of - * the token string in the search bar. - * - * Supported embed types: `SearchEmbed` - * @example - * ```js - * searchOptions: { - * searchTokenString: '[quantity purchased] [region]', - * executeSearch: true, - * } - * ``` - */ - searchOptions?: SearchOptions; - /** - * Exclude the search token string from the URL. - * If set to true, the search token string is not appended to the URL. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * searchOptions: { - * searchTokenString: '[quantity purchased] [region]', - * executeSearch: true, - * }, - * excludeSearchTokenStringFromURL: true, - * }); - * ``` - */ - excludeSearchTokenStringFromURL?: boolean; - /** - * The GUID of a saved answer to load initially. - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * answerId:'sed-1234', - * }) - * ``` - */ - answerId?: string; - /** - * If set to true, the search page will render without the Search Bar - * The chart/table should still be visible. - * - * Supported embed types: `SearchEmbed` - * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * hideSearchBar:true, - * }) - * ``` - */ - hideSearchBar?: boolean; - /** - * Flag to set if last selected dataSource should be used - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.24.0 - */ - useLastSelectedSources?: boolean; - /** - * To set the initial state of the search bar in case of saved-answers. - * @default false - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl - * @deprecated Use {@link collapseSearchBar} instead - */ - collapseSearchBarInitially?: boolean; - /** - * Flag to enable onBeforeSearchExecute Embed Event - * - * Supported embed types: `SearchEmbed` - * @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl - */ - isOnBeforeGetVizDataInterceptEnabled?: boolean; - /** - * This controls the initial behaviour of custom column groups accordion. - * It takes DataPanelCustomColumnGroupsAccordionState enum values as input. - * List of different enum values:- - * - EXPAND_ALL: Expand all the accordion initially in data panel v2. - * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2. - * - EXPAND_FIRST: Expand the first accordion and collapse the rest. - * - * Supported embed types: `SearchEmbed` - * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl - * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * dataPanelCustomGroupsAccordionInitialState: - * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, - * }); - * ``` - */ - dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState$1; - /** - * Flag to remove focus from search bar initially when user - * lands on search embed page. - * - * Supported embed types: `SearchEmbed` - * @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl - * @default true - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * ... // other embed view config - * focusSearchBarOnRender: false, - * }); - * ``` - */ - focusSearchBarOnRender?: boolean; -} -export interface SearchAppInitData extends DefaultAppInitData { - searchOptions?: SearchOptions; -} -/** - * Embed ThoughtSpot search - * @group Embed components - */ -export declare class SearchEmbed extends TsEmbed { - /** - * The view configuration for the embedded ThoughtSpot search. - */ - protected viewConfig: SearchViewConfig; - constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig); - /** - * Get the state of the data sources panel that the embedded - * ThoughtSpot search will be initialized with. - */ - private getDataSourceMode; - protected getSearchInitData(): { - searchOptions?: { - searchTokenString: string; - }; - }; - protected getAppInitData(): Promise; - protected getEmbedParamsObject(): Record; - protected getEmbedParams(): string; - /** - * Construct the URL of the embedded ThoughtSpot search to be - * loaded in the iframe - * @param answerId The GUID of a saved answer - * @param dataSources A list of data source GUIDs - */ - getIFrameSrc(): string; - /** - * Render the embedded ThoughtSpot search - */ - render(): Promise; - getCurrentContext(): Promise; -} -/** - * @group Embed components - */ -export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig { - /** - * The array of data source GUIDs to set on load. - * Only a single data source is supported currently. - * - * Supported embed types: `SearchBarEmbed` - * @deprecated Use `dataSource` instead - * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw - * @example - * ```js - * const embed = new SearchBarEmbed('#tsEmbed', { - * ... //other embed view config - * dataSources:['id-2345','id-2345'], - * }) - * ``` - */ - dataSources?: string[]; - /** - * Pass the ID of the source to be selected. - * - * Supported embed types: `SearchBarEmbed` - * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw - * @example - * ```js - * const embed = new SearchBarEmbed('#tsEmbed', { - * ... //other embed view config - * dataSource:'id-2345', - * }) - * ``` - */ - dataSource?: string; - /** - * Boolean to define if the last selected data source should be used - * - * Supported embed types: `SearchBarEmbed` - * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw - * @example - * ```js - * const embed = new SearchBarEmbed('#tsEmbed', { - * ... //other embed view config - * useLastSelectedSources:false, - * }) - * ``` - */ - useLastSelectedSources?: boolean; - /** - * Configuration for search options. - * Includes the following properties: - * - * `searchTokenString`: Search tokens to pass in the query. - * - * `executeSearch`: Boolean to define if the search should be executed or not. - * If it is executed, the focus is placed on the results. - * If it’s not executed, the focus is placed at the end of - * the token string in the search bar. - * - * Supported embed types: `SearchBarEmbed` - * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw - * @example - * ```js - * const embed = new SearchBarEmbed('#tsEmbed', { - * ... //other embed view config - * searchOptions: { - * searchTokenString: '[quantity purchased] [region]', - * executeSearch: true, - * } - * }) - * ``` - */ - searchOptions?: SearchOptions; - /** - * Exclude the search token string from the URL. - * If set to true, the search token string is not appended to the URL. - * - * Supported embed types: `SearchBarEmbed` - * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl - * @example - * ```js - * const embed = new SearchEmbed('#tsEmbed', { - * searchOptions: { - * searchTokenString: '[quantity purchased] [region]', - * executeSearch: true, - * }, - * excludeSearchTokenStringFromURL: true, - * }); - * ``` - */ - excludeSearchTokenStringFromURL?: boolean; -} -interface SearchAppInitData$1 extends DefaultAppInitData { - searchOptions: SearchOptions; -} -/** - * Embed ThoughtSpot search bar - * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw - * @group Embed components - */ -export declare class SearchBarEmbed extends TsEmbed { - /** - * The view configuration for the embedded ThoughtSpot search bar. - */ - protected viewConfig: SearchBarViewConfig; - protected embedComponentType: string; - constructor(domSelector: string, viewConfig: SearchBarViewConfig); - protected getEmbedParamsObject(): Record; - /** - * Construct the URL of the embedded ThoughtSpot search to be - * loaded in the iframe - * @param dataSources A list of data source GUIDs - */ - private getIFrameSrc; - /** - * Render the embedded ThoughtSpot search - */ - render(): Promise; - protected getSearchInitData(): { - searchOptions: SearchOptions; - }; - protected getAppInitData(): Promise; - getCurrentContext(): Promise; -} -/** - * Configuration for bodyless conversation options. - * @group Embed components - */ -export interface SpotterAgentEmbedViewConfig extends Omit { - /** - * The ID of the worksheet to use for the conversation. - */ - worksheetId: string; -} -/** - * Configuration for conversation options. - * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - * Use {@link SpotterAgentEmbedViewConfig} instead - * @group Embed components - */ -export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig { -} -export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig { - sessionId: string; - genNo: number; - acSessionId: string; - acGenNo: number; - convId: string; - messageId: string; -} -declare class ConversationMessage extends TsEmbed { - protected viewConfig: SpotterAgentMessageViewConfig; - constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig); - protected getEmbedParamsObject(): Record; - getIframeSrc(): string; - render(): Promise; -} -/** - * Create a conversation embed, which can be integrated inside - * chatbots or other conversational interfaces. - * @example - * ```js - * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk'; - * - * const conversation = new SpotterAgentEmbed({ - * worksheetId: 'worksheetId', - * }); - * - * const { container, error } = await conversation.sendMessage('show me sales by region'); - * - * // append the container to the DOM - * document.body.appendChild(container); // or to any other element - * ``` - * @group Embed components - * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl - */ -export declare class SpotterAgentEmbed { - private viewConfig; - private conversationService; - constructor(viewConfig: SpotterAgentEmbedViewConfig); - sendMessage(userMessage: string): Promise<{ - error: any; - container?: undefined; - viz?: undefined; - } | { - container: HTMLDivElement; - viz: ConversationMessage; - error?: undefined; - }>; - /** - * Send a message to the conversation service and return only the data. - * @param userMessage - The message to send to the conversation service. - * @returns The data from the conversation service. - */ - sendMessageData(userMessage: string): Promise<{ - error: any; - data?: undefined; - } | { - data: { - convId: any; - messageId: any; - sessionId: any; - genNo: any; - acSessionId: any; - acGenNo: any; - }; - error?: undefined; - }>; -} -/** - * Create a conversation embed, which can be integrated inside - * chatbots or other conversational interfaces. - * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - * Use {@link SpotterAgentEmbed} instead - * @example - * ```js - * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk'; - * - * const conversation = new SpotterAgentEmbed({ - * worksheetId: 'worksheetId', - * }); - * - * const { container, error } = await conversation.sendMessage('show me sales by region'); - * - * // append the container to the DOM - * document.body.appendChild(container); // or to any other element - * ``` - * @group Embed components - */ -export declare class BodylessConversation extends SpotterAgentEmbed { - constructor(viewConfig: BodylessConversationViewConfig); -} -interface SearchOptions$1 { - /** - * The query string to pass to start the Conversation. - */ - searchQuery: string; -} -/** - * The configuration for the embedded spotterEmbed options. - * @group Embed components - */ -export interface SpotterEmbedViewConfig extends Omit { - /** - * The ID of the data source object. For example, Model, View, or Table. Spotter uses - * this object to query data and generate Answers. - */ - worksheetId: string; - /** - * Ability to pass a starting search query to the conversation. - */ - searchOptions?: SearchOptions$1; - /** - * disableSourceSelection : Disables data source selection - * but still display the selected data source. - * - * Supported embed types: `SpotterEmbed` - * @example - * ```js - * const embed = new SpotterEmbed('#tsEmbed', { - * ... //other embed view config - * disableSourceSelection : true, - * }) - * ``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl - */ - disableSourceSelection?: boolean; - /** - * hideSourceSelection : Hide data source selection - * - * Supported embed types: `SpotterEmbed` - * @example - * ```js - * const embed = new SpotterEmbed('#tsEmbed', { - * ... //other embed view config - * hideSourceSelection : true, - * }) - * ``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl - */ - hideSourceSelection?: boolean; - /** - * Flag to control Data panel experience - * - * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed` - * @default true - * @version SDK: 1.43.0 | ThoughtSpot Cloud: 10.14.0.cl - * @example - * ```js - * // Replace with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed - * const embed = new ('#tsEmbed', { - * ... // other embed view config - * dataPanelV2: true, - * }) - * ``` - */ - dataPanelV2?: boolean; - /** - * showSpotterLimitations : show limitation text - * of the spotter underneath the chat input. - * default is false. - * - * Supported embed types: `SpotterEmbed` - * @example - * ```js - * const embed = new SpotterEmbed('#tsEmbed', { - * ... //other embed view config - * showSpotterLimitations : true, - * }) - * ``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl - */ - showSpotterLimitations?: boolean; - /** - * hideSampleQuestions : Hide sample questions on - * the initial screen of the conversation. - * - * Supported embed types: `SpotterEmbed` - * @example - * ```js - * const embed = new SpotterEmbed('#tsEmbed', { - * ... //other embed view config - * hideSampleQuestions : true, - * }) - * ``` - * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl - */ - hideSampleQuestions?: boolean; - /** - * The list of runtime filters to apply to a search Answer, - * visualization, or Liveboard. - * - * Supported embed types: `SpotterEmbed` - * @example - * ```js - * const embed = new SpotterEmbed('#tsEmbed', { - * // other embed view config - * runtimeFilters: [ - * { - * columnName: 'color', - * operator: RuntimeFilterOp.EQ, - * values: ['red'], - * }, - * ], - * }) - * ``` - * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl - */ - runtimeFilters?: RuntimeFilter[]; - /** - * Flag to control whether runtime filters should be included in the URL. - * If true, filters will be passed via app initialization payload instead. - * If false/undefined, filters will be added to URL (default behavior). - * - * Supported embed types: `SpotterEmbed` - * @default false - * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl - */ - excludeRuntimeFiltersfromURL?: boolean; - /** - * The list of runtime parameters to apply to the conversation. - * - * Supported embed types: `SpotterEmbed` - * @example - * ```js - * const embed = new SpotterEmbed('#tsEmbed', { - * // other embed view config - * runtimeParameters: [ - * { - * name: 'Integer Param', - * value: 10, - * }, - * ], - * }) - * ``` - * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl - */ - runtimeParameters?: RuntimeParameter[]; - /** - * Flag to control whether runtime parameters should be included in the URL. - * If true, parameters will be passed via app initialization payload instead. - * If false/undefined, parameters will be added to URL (default behavior). - * - * Supported embed types: `SpotterEmbed` - * @default false - * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl - */ - excludeRuntimeParametersfromURL?: boolean; -} -/** - * The configuration for the embedded spotterEmbed options. - * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - * Use {@link SpotterEmbedViewConfig} instead - * @group Embed components - */ -export interface ConversationViewConfig extends SpotterEmbedViewConfig { -} -/** - * Embed ThoughtSpot AI Conversation. - * @group Embed components - * @example - * ```js - * const conversation = new SpotterEmbed('#tsEmbed', { - * worksheetId: 'worksheetId', - * searchOptions: { - * searchQuery: 'searchQuery', - * }, - * }); - * conversation.render(); - * ``` - * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl - */ -export declare class SpotterEmbed extends TsEmbed { - protected viewConfig: SpotterEmbedViewConfig; - constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig); - protected getEmbedParamsObject(): Record; - getIframeSrc(): string; - render(): Promise; - getCurrentContext(): Promise; -} -/** - * Embed ThoughtSpot AI Conversation. - * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl - * Use {@link SpotterEmbed} instead - * @group Embed components - * @example - * ```js - * const conversation = new SpotterEmbed('#tsEmbed', { - * worksheetId: 'worksheetId', - * searchOptions: { - * searchQuery: 'searchQuery', - * }, - * }); - * conversation.render(); - * ``` - * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl - */ -export declare class ConversationEmbed extends SpotterEmbed { - protected viewConfig: ConversationViewConfig; - constructor(container: HTMLElement, viewConfig: ConversationViewConfig); -} -export type SessionInfo = { - releaseVersion: string; - userGUID: string; - currentOrgId: number; - privileges: string[]; - mixpanelToken: string; - isPublicUser: boolean; - clusterId: string; - clusterName: string; - [key: string]: any; -}; -/** - * Returns the cached session info object and caches it for future use. - * Once fetched the session info object is cached and returned from the cache on - * subsequent calls. - * This cache is cleared when inti is called OR resetCachedSessionInfo is called. - * @example ```js - * const sessionInfo = await getSessionInfo(); - * console.log(sessionInfo); - * ``` - * @version SDK: 1.28.3 | ThoughtSpot: * - * @returns {Promise} The session info object. - */ -export declare function getSessionInfo(): Promise; -interface SearchOptions$2 { - /** - * The query string to pass for Natural Language Search. - */ - searchQuery: string; - /** - * Boolean to define if the search should be executed or not. - * If it is executed, the focus is placed on the results. - * If it’s not executed, the focus is placed at the end of - * the token string in the search bar. - */ - executeSearch?: boolean; -} -/** - * The configuration attributes for the embedded Natural language search view. Based on - * GPT and LLM. - * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - * - * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl - * @group Embed components - */ -export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit { - /** - * If set to true, a list of Liveboard and Answers related - * to the natural language search will be shown below the - * AI generated answer. - * @deprecated Currently Liveboard and Answers related - * to the natural language search will not be shown for sage - * embed - */ - showObjectResults?: boolean; - /** - * flag used by the TS product tour page to show the blue search bar - * even after the search is completed. This is different from ThoughtSpot Embedded - * Sage Embed experience where it mimics closer to the non-embed case. - * The Sample questions container is collapsed when this value is set after - * does a search. - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl - * @hidden - */ - isProductTour?: boolean; - /** - * Show or hide the search bar title. - * @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - * @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl - */ - hideSearchBarTitle?: boolean; - /** - * Show or hide the Answer header, that is, the `AI Answer` title - * at the top of the Answer page. - * @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl - */ - hideSageAnswerHeader?: boolean; - /** - * Disable the worksheet selection option. - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - */ - disableWorksheetChange?: boolean; - /** - * Hide the worksheet selection panel. - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - */ - hideWorksheetSelector?: boolean; - /** - * Show or hide autocomplete suggestions for the search query string. - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - */ - hideAutocompleteSuggestions?: boolean; - /** - * Show or hide autocomplete suggestions for the search query string. - * @deprecated - * Currently, the object suggestions will not be shown for Natural Language Search. - * You can use {@link hideAutocompleteSuggestions} instead. - */ - showObjectSuggestions?: boolean; - /** - * Show or hide sample questions. - * The sample questions are autogenerated based on the worksheet - * selected for the search operation. - * - * Supported embed types: `SageEmbed` - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - * @example - * ```js - * const embed = new SageEmbed('#tsEmbed', { - * ... //other embed view config - * hideSampleQuestions : true, - * }) - * ``` - */ - hideSampleQuestions?: boolean; - /** - * The data source GUID (Worksheet GUID) to set on load. - */ - dataSource?: string; - /** - * Includes the following properties: - * - * `searchQuery`: The search query string to pass in the search bar. - * Supports Natural Language Search queries. - * - * `executeSearch`: Boolean to define if the search should be executed or not. - * If it is executed, the focus is placed on the results. - * If it’s not executed, the focus is placed at the end of - * the token string in the search bar. - * - * Supported embed types: `SageEmbed` - * @example - * ```js - * searchOptions: { - * searchQuery: 'average sales by country and product type', - * executeSearch: true, - * } - * ``` - * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw - */ - searchOptions?: SearchOptions$2; -} -/** - * Embed ThoughtSpot LLM and GPT-based Natural Language Search component. - * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw - * - * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl - * @group Embed components - */ -export declare class SageEmbed extends V1Embed { - /** - * The view configuration for the embedded ThoughtSpot sage. - * - */ - protected viewConfig: SageViewConfig; - constructor(domSelector: DOMSelector, viewConfig: SageViewConfig); - protected getEmbedParamsObject(): Record; - /** - * Constructs a map of parameters to be passed on to the - * embedded Eureka or Sage search page. - * @returns {string} query string - */ - protected getEmbedParams(): string; - /** - * Construct the URL of the embedded ThoughtSpot sage to be - * loaded in the iframe - * @returns {string} iframe url - */ - getIFrameSrc(): string; - /** - * Render the embedded ThoughtSpot Sage - * @returns {SageEmbed} Eureka/Sage embed - */ - render(): Promise; - getCurrentContext(): Promise; -} -/** - * Gets the embed configuration settings that were used to - * initialize the SDK. - * @returns {@link EmbedConfig} - * - * @example - * ```js - * import { getInitConfig } from '@thoughtspot/visual-embed-sdk'; - * // Call the getInitConfig method to retrieve the embed configuration - * const config = getInitConfig(); - * // Log the configuration settings - * console.log(config); - * ``` - * Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig] - * object, which contains the configuration settings used to - * initialize the SDK, including the following: - * - * - `thoughtSpotHost` - ThoughtSpot host URL - * - `authType`: The authentication method used. For example, - * `AuthServerCookieless` for `AuthType.TrustedAuthTokenCookieless` - * - `customizations` - Style, text, and icon customization settings - * that were applied during the SDK initialization. - * - * The following JSON output shows the embed configuration - * settings returned from the code in the previous example: - * - * @example - * ```json - * { - * "thoughtSpotHost": "https://{ThoughtSpot-Host}", - * "authType": "AuthServerCookieless", - * "customizations": { - * "style": { - * "customCSS": { - * "variables": { - * "--ts-var-button--secondary-background": "#7492d5", - * "--ts-var-button--secondary--hovers-background": "#aac2f8", - * "--ts-var-root-background": "#f1f4f8" - * } - * } - * } - * }, - * "loginFailedMessage": "Login failed, please try again", - * "authTriggerText": "Authorize", - * "disableTokenVerification": true, - * "authTriggerContainer": "#your-own-div" - * } - * ``` - * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later - * @group Global methods - */ -declare const getEmbedConfig: () => EmbedConfig; -/** - * Enum of mixpanel events - * @hidden - */ -export declare const MIXPANEL_EVENT: { - VISUAL_SDK_RENDER_START: string; - VISUAL_SDK_CALLED_INIT: string; - VISUAL_SDK_RENDER_COMPLETE: string; - VISUAL_SDK_RENDER_FAILED: string; - VISUAL_SDK_TRIGGER: string; - VISUAL_SDK_ON: string; - VISUAL_SDK_IFRAME_LOAD_PERFORMANCE: string; - VISUAL_SDK_EMBED_CREATE: string; - VERCEL_INTEGRATION_COMPLETED: string; -}; -/** - * Pushes the event with its Property key-value map to mixpanel. - * @param eventId - * @param eventProps - */ -export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): void; -/** - * Fetch wrapper that adds the authentication token to the request. - * Use this to call the ThoughtSpot APIs when using the visual embed sdk. - * The interface for this method is the same as Web `Fetch`. - * @param input - * @param init - * @example - * ```js - * tokenizedFetch("/api/rest/2.0/auth/session/user", { - * // .. fetch options .. - * }); - *``` - * @version SDK: 1.28.0 - * @group Global methods - */ -export declare const tokenizedFetch: typeof fetch; -/** - * Get answer from natural language query - * @param query string - * @param worksheetId string - * @returns AnswerService and the suggestion response. - * @version SDK: 1.33.1 | ThoughtSpot: 10.3.0.cl - * @example - * ```js - * const { answer } = await getAnswerFromQuery('revenue', 'worksheetId'); - * ``` - */ -export declare const getAnswerFromQuery: (query: string, worksheetId: string) => Promise<{ - answer: AnswerService; - suggestion: any; -}>; -/** - * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances. - * - * Each answer will be added as a visualization to the newly created Liveboard. - * - * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances - * representing the answers to be added to the Liveboard. - * @param {string} name - The name of the Liveboard to create. - * @returns result Promise - * @version SDK: 1.33.1 | ThoughtSpot: * - * @example - * ```js - * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk"; - * - * embed.on(EmbedEvent.Data, async () => { - * try { - * const answerService = await embed.getAnswerService(); - * const lb = await createLiveboardWithAnswers( - * [answerService], - * "My Liveboard" - * ); - * console.log("Liveboard created:", lb); - * } catch (err) { - * console.error("Failed to create liveboard:", err); - * } - * }); - * ``` - */ -export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise; -/** - * Resets the auth token and a new token will be fetched on the next request. - * @example - * ```js - * resetCachedAuthToken(); - * ``` - * @version SDK: 1.28.0 | ThoughtSpot: * - * @group Authentication / Init - */ -export declare const resetCachedAuthToken: () => void; - -export { - getEmbedConfig as getInitConfig, -}; - -export {}; From 688b0d9eefd0d531537d7521d99dc385e663dfb0 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 12 Dec 2025 13:39:23 +0530 Subject: [PATCH 06/23] tests fix --- src/embed/hostEventClient/host-event-client.spec.ts | 8 +++++++- src/embed/liveboard.spec.ts | 2 +- src/embed/ts-embed.spec.ts | 8 ++++++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/src/embed/hostEventClient/host-event-client.spec.ts b/src/embed/hostEventClient/host-event-client.spec.ts index 38a9a0ac..f65aa82c 100644 --- a/src/embed/hostEventClient/host-event-client.spec.ts +++ b/src/embed/hostEventClient/host-event-client.spec.ts @@ -54,6 +54,7 @@ describe('HostEventClient', () => { type: apiName, parameters, }, + undefined, ); expect(result).toEqual(await triggerResponse); }); @@ -148,6 +149,7 @@ describe('HostEventClient', () => { HostEvent.UIPassthrough, 'http://localhost', { parameters: payload, type: UIPassthroughEvent.PinAnswerToLiveboard }, + undefined, ); expect(result).toEqual(mockResponse.value); }); @@ -185,6 +187,7 @@ describe('HostEventClient', () => { parameters: payload, type: 'saveAnswer', }, + undefined, ); expect(result).toEqual({ answerId: 'newAnswer', ...mockResponse[0].value }); }); @@ -198,7 +201,7 @@ describe('HostEventClient', () => { const result = await client.triggerHostEvent(hostEvent, payload); - expect(client.hostEventFallback).toHaveBeenCalledWith(hostEvent, payload); + expect(client.hostEventFallback).toHaveBeenCalledWith(hostEvent, payload, undefined); expect(result).toEqual(mockResponse); }); @@ -223,6 +226,7 @@ describe('HostEventClient', () => { HostEvent.Pin, mockThoughtSpotHost, {}, + undefined, ); expect(result).toEqual([mockResponse]); }); @@ -248,6 +252,7 @@ describe('HostEventClient', () => { HostEvent.Save, mockThoughtSpotHost, {}, + undefined, ); expect(result).toEqual([mockResponse]); }); @@ -303,6 +308,7 @@ describe('HostEventClient', () => { parameters: { ...payload, pinboardId: 'test', newPinboardName: 'testLiveboard' }, type: 'addVizToPinboard', }, + undefined, ); expect(result).toEqual({ pinboardId: 'testLiveboard', diff --git a/src/embed/liveboard.spec.ts b/src/embed/liveboard.spec.ts index e7697dad..6b076e2f 100644 --- a/src/embed/liveboard.spec.ts +++ b/src/embed/liveboard.spec.ts @@ -1502,7 +1502,7 @@ describe('Liveboard/viz embed tests', () => { await liveboardEmbed.trigger(HostEvent.Save); expect(mockProcessTrigger).toHaveBeenCalledWith(HostEvent.Save, { vizId: 'testViz', - }); + }, undefined); }); }); }); diff --git a/src/embed/ts-embed.spec.ts b/src/embed/ts-embed.spec.ts index a2ea29dd..6fe07e2a 100644 --- a/src/embed/ts-embed.spec.ts +++ b/src/embed/ts-embed.spec.ts @@ -204,6 +204,7 @@ describe('Unit test case for ts embed', () => { parameters: payload, type: UIPassthroughEvent.PinAnswerToLiveboard, }, + undefined, ); }); }); @@ -224,6 +225,7 @@ describe('Unit test case for ts embed', () => { HostEvent.Save, 'http://tshost', {}, + undefined, ); }); }); @@ -245,6 +247,7 @@ describe('Unit test case for ts embed', () => { HostEvent.Save, 'http://tshost', false, + undefined, ); }); }); @@ -1341,6 +1344,7 @@ describe('Unit test case for ts embed', () => { HostEvent.InfoSuccess, 'http://tshost', expect.objectContaining({ info: expect.any(Object) }), + undefined, ); }); }); @@ -1477,6 +1481,7 @@ describe('Unit test case for ts embed', () => { HostEvent.InfoSuccess, 'http://tshost', expect.objectContaining({ info: expect.any(Object) }), + undefined, ); }); }); @@ -1491,6 +1496,7 @@ describe('Unit test case for ts embed', () => { HostEvent.InfoSuccess, 'http://tshost', expect.objectContaining({ info: expect.any(Object) }), + undefined, ); }); }); @@ -1505,6 +1511,7 @@ describe('Unit test case for ts embed', () => { HostEvent.InfoSuccess, 'http://tshost', expect.objectContaining({ info: expect.any(Object) }), + undefined, ); }); }); @@ -1519,6 +1526,7 @@ describe('Unit test case for ts embed', () => { HostEvent.InfoSuccess, 'http://tshost', expect.objectContaining({ info: expect.any(Object) }), + undefined, ); }); }); From 5ab34a06b40a65bad91e3d7c4895933fa3acbfc5 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 12 Dec 2025 18:40:17 +0530 Subject: [PATCH 07/23] fix --- src/embed/app.ts | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/src/embed/app.ts b/src/embed/app.ts index f2ed2c90..f7a96a00 100644 --- a/src/embed/app.ts +++ b/src/embed/app.ts @@ -1079,15 +1079,4 @@ export class AppEmbed extends V1Embed { this.postRender(); return this; } - - /** - * Get the current context of the embedded application. - * @returns The current context object containing the page type and object ids. - * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl - */ - public async getCurrentContext(): Promise { - const context = await super.getCurrentContext(); - return context; - } - } From 47c6bbf0fc64e5bd74644e3a7022801ebb58928f Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 12 Dec 2025 19:05:48 +0530 Subject: [PATCH 08/23] fix --- src/embed/ts-embed.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index 1b2f411b..b2793287 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -1424,9 +1424,11 @@ export class TsEmbed { } public async getCurrentContext(): Promise { - this.executeAfterEmbedContainerLoaded(async () => { - const context = await this.trigger(HostEvent.GetPageContext, {}); - return context; + return new Promise((resolve) => { + this.executeAfterEmbedContainerLoaded(async () => { + const context = await this.trigger(HostEvent.GetPageContext, {}); + resolve(context); + }); }); } From 3d271f49992bcbd0c20c31b972e835b171699ebf Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 29 Dec 2025 08:47:32 +0530 Subject: [PATCH 09/23] added flags --- src/embed/ts-embed.ts | 2 ++ src/types.ts | 43 +++++++++++++++++++++++++++++++++++++++++++ src/utils.ts | 12 +++++++++++- 3 files changed, 56 insertions(+), 1 deletion(-) diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index b2793287..65270eac 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -76,6 +76,7 @@ import { ERROR_MESSAGE } from '../errors'; import { getPreauthInfo } from '../utils/sessionInfoService'; import { HostEventClient } from './hostEventClient/host-event-client'; import { getInterceptInitData, handleInterceptEvent, processApiInterceptResponse, processLegacyInterceptResponse } from '../api-intercept'; +import { getHostEventsConfig } from '../utils'; const { version } = pkgInfo; @@ -481,6 +482,7 @@ export class TsEmbed { hiddenListColumns: this.viewConfig.hiddenListColumns || [], customActions: customActionsResult.actions, ...getInterceptInitData(this.viewConfig), + ...getHostEventsConfig(this.viewConfig), }; return baseInitData; diff --git a/src/types.ts b/src/types.ts index 327aeead..d2b2ed25 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1106,6 +1106,49 @@ export interface BaseViewConfig extends ApiInterceptFlags { * ``` */ customActions?: CustomAction[]; + + /** + * Flag to bypass host events payload validation + * @default false + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * shouldBypassPayloadValidation:true, + * }) + * ``` + */ + shouldBypassPayloadValidation?: boolean; + + + /** + * Flag to bypass host events context check + * @default false + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * shouldByPassContextCheck:true, + * }) + * ``` + */ + shouldByPassContextCheck?: boolean; + + /** + * Flag to use host events v2. This is used to enable the new host events v2 API. + * @default false + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @example + * ```js + * const embed = new AppEmbed('#tsEmbed', { + * ... // other embed view config + * useHostEventsV2:true, + * }) + * ``` + */ + useHostEventsV2?: boolean; } /** diff --git a/src/utils.ts b/src/utils.ts index 6c4a95d9..d73fa363 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -15,6 +15,7 @@ import { DOMSelector, RuntimeParameter, AllEmbedViewConfig, + BaseViewConfig, } from './types'; import { logger } from './utils/logger'; @@ -553,4 +554,13 @@ export const formatTemplate = (template: string, values: Record): s return template.replace(/\{(\w+)\}/g, (match, key) => { return values[key] !== undefined ? String(values[key]) : match; }); -}; \ No newline at end of file +}; + + +export const getHostEventsConfig = (viewConfig: BaseViewConfig) => { + return { + shouldBypassPayloadValidation: viewConfig.shouldBypassPayloadValidation, + shouldByPassContextCheck: viewConfig.shouldByPassContextCheck, + useHostEventsV2: viewConfig.useHostEventsV2, + }; +} \ No newline at end of file From 717d5fa63a9d290663413b2760cc91d446929ff5 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 29 Dec 2025 08:55:24 +0530 Subject: [PATCH 10/23] fixed tests --- src/embed/ts-embed.spec.ts | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/embed/ts-embed.spec.ts b/src/embed/ts-embed.spec.ts index 1a32fe81..156a97af 100644 --- a/src/embed/ts-embed.spec.ts +++ b/src/embed/ts-embed.spec.ts @@ -4063,7 +4063,7 @@ describe('Destroy error handling', () => { }).not.toThrow(); expect(logSpy).toHaveBeenCalledWith('Error destroying TS Embed', expect.any(Error)); - logSpy.mockRestore(); + logSpy.mockReset(); }); }); @@ -4106,11 +4106,12 @@ describe('Fullscreen change handler behavior', () => { document.dispatchEvent(event); await executeAfterWait(() => { - expect(mockProcessTrigger).toHaveBeenCalledWith( + expect(mockProcessTrigger).toHaveBeenLastCalledWith( expect.any(Object), HostEvent.ExitPresentMode, expect.any(String), expect.any(Object), + undefined, ); }); }); @@ -4203,13 +4204,14 @@ describe('ShowPreRender with UpdateEmbedParams', () => { embed2.showPreRender(); await executeAfterWait(() => { - expect(mockProcessTrigger).toHaveBeenCalledWith( + expect(mockProcessTrigger).toHaveBeenLastCalledWith( expect.any(Object), HostEvent.UpdateEmbedParams, expect.any(String), expect.objectContaining({ liveboardId: 'updated-lb', }), + undefined, ); }); }); @@ -4238,7 +4240,7 @@ describe('ShowPreRender with UpdateEmbedParams', () => { embed2.showPreRender(); await executeAfterWait(() => { - expect(mockProcessTrigger).toHaveBeenCalledWith( + expect(mockProcessTrigger).toHaveBeenLastCalledWith( expect.any(Object), HostEvent.UpdateEmbedParams, expect.any(String), @@ -4258,6 +4260,7 @@ describe('ShowPreRender with UpdateEmbedParams', () => { }, ], }), + undefined, ); }); }); @@ -4290,7 +4293,7 @@ describe('ShowPreRender with UpdateEmbedParams', () => { embed2.showPreRender(); await executeAfterWait(() => { - expect(mockProcessTrigger).toHaveBeenCalledWith( + expect(mockProcessTrigger).toHaveBeenLastCalledWith( expect.any(Object), HostEvent.UpdateEmbedParams, expect.any(String), @@ -4305,6 +4308,7 @@ describe('ShowPreRender with UpdateEmbedParams', () => { }, ], }), + undefined, ); }); }); From b4b4b043818cb3779098b2429d8d93992b60e3aa Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 29 Dec 2025 09:00:15 +0530 Subject: [PATCH 11/23] resolved version --- src/embed/conversation.ts | 4 ++-- src/embed/liveboard.ts | 2 +- src/embed/sage.ts | 5 +++++ src/embed/search-bar.tsx | 2 +- src/embed/search.ts | 2 +- src/embed/ts-embed.ts | 5 +++++ 6 files changed, 15 insertions(+), 5 deletions(-) diff --git a/src/embed/conversation.ts b/src/embed/conversation.ts index 39853e23..9e5a4676 100644 --- a/src/embed/conversation.ts +++ b/src/embed/conversation.ts @@ -331,9 +331,9 @@ export class SpotterEmbed extends TsEmbed { } /** - * Get the current context of the embedded conversation. + * Get the current context of the embedded SpotterEmbed. * @returns The current context object containing the page type and object ids. - * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index f661afb9..8f1c2ee5 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -894,7 +894,7 @@ export class LiveboardEmbed extends V1Embed { /** * Get the current context of the embedded liveboard. * @returns The current context object containing the page type and object ids. - * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); diff --git a/src/embed/sage.ts b/src/embed/sage.ts index d0b99762..24a4678b 100644 --- a/src/embed/sage.ts +++ b/src/embed/sage.ts @@ -231,6 +231,11 @@ export class SageEmbed extends V1Embed { return this; } + /** + * Get the current context of the embedded SageEmbed. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); return context; diff --git a/src/embed/search-bar.tsx b/src/embed/search-bar.tsx index 1a6aa1ed..e3855164 100644 --- a/src/embed/search-bar.tsx +++ b/src/embed/search-bar.tsx @@ -203,7 +203,7 @@ export class SearchBarEmbed extends TsEmbed { /** * Get the current context of the embedded search bar. * @returns The current context object containing the page type and object ids. - * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); diff --git a/src/embed/search.ts b/src/embed/search.ts index 06845714..6bad26b4 100644 --- a/src/embed/search.ts +++ b/src/embed/search.ts @@ -528,7 +528,7 @@ export class SearchEmbed extends TsEmbed { /** * Get the current context of the embedded search. * @returns The current context object containing the page type and object ids. - * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl */ public async getCurrentContext(): Promise { const context = await super.getCurrentContext(); diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index 8d117cb0..8f4cd918 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -1429,6 +1429,11 @@ export class TsEmbed { return this.render(); } + /** + * Get the current context of the embedded TS component. + * @returns The current context object containing the page type and object ids. + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + */ public async getCurrentContext(): Promise { return new Promise((resolve) => { this.executeAfterEmbedContainerLoaded(async () => { From 0e548229a7c73fbd9659ff644adfe1d4ef7686fc Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 29 Dec 2025 09:01:26 +0530 Subject: [PATCH 12/23] package changes --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index b8ad0f37..59585999 100644 --- a/package.json +++ b/package.json @@ -57,7 +57,7 @@ "test": "npm run test-sdk", "posttest": "cat ./coverage/sdk/lcov.info | npx coveralls-next", "is-publish-allowed": "node scripts/is-publish-allowed.js", - "prepublishOnly": "npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build", + "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build", "check-size": "npm run build && size-limit", "publish-dev": "npm publish --tag dev", "publish-prod": "npm publish --tag latest", From 107a5fa31eade6ba8e78404e092b8d5a86981dbf Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 29 Dec 2025 09:23:23 +0530 Subject: [PATCH 13/23] removed config key --- src/types.ts | 15 --------------- src/utils.ts | 1 - 2 files changed, 16 deletions(-) diff --git a/src/types.ts b/src/types.ts index f7293a36..0a7dddb7 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1135,21 +1135,6 @@ export interface BaseViewConfig extends ApiInterceptFlags { */ shouldBypassPayloadValidation?: boolean; - - /** - * Flag to bypass host events context check - * @default false - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl - * @example - * ```js - * const embed = new AppEmbed('#tsEmbed', { - * ... // other embed view config - * shouldByPassContextCheck:true, - * }) - * ``` - */ - shouldByPassContextCheck?: boolean; - /** * Flag to use host events v2. This is used to enable the new host events v2 API. * @default false diff --git a/src/utils.ts b/src/utils.ts index f740c12e..42035c47 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -564,7 +564,6 @@ export const formatTemplate = (template: string, values: Record): s export const getHostEventsConfig = (viewConfig: BaseViewConfig) => { return { shouldBypassPayloadValidation: viewConfig.shouldBypassPayloadValidation, - shouldByPassContextCheck: viewConfig.shouldByPassContextCheck, useHostEventsV2: viewConfig.useHostEventsV2, }; } From 9da8a4cb14057fa554edd99c092251c1a3f0cf19 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Sat, 10 Jan 2026 11:51:00 +0530 Subject: [PATCH 14/23] export contexttype --- src/embed/hostEventClient/contracts.ts | 15 ++++----------- src/types.ts | 8 ++++++++ 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/src/embed/hostEventClient/contracts.ts b/src/embed/hostEventClient/contracts.ts index 6911452e..8f68b31f 100644 --- a/src/embed/hostEventClient/contracts.ts +++ b/src/embed/hostEventClient/contracts.ts @@ -1,4 +1,4 @@ -import { HostEvent } from '../../types'; +import { ContextType, HostEvent } from '../../types'; export enum UIPassthroughEvent { PinAnswerToLiveboard = 'addVizToPinboard', @@ -114,28 +114,21 @@ export type TriggerPayload = export type TriggerResponse = PayloadT extends HostEventRequest ? HostEventResponse : any; -export enum ContextType { - Search = 'search-answer', - Liveboard = 'liveboard', - Answer = 'answer', - Spotter = 'spotter', - Sage = 'sage', -} - export enum PageType { PAGE = 'page', DIALOG = 'dialog', } -interface ObjectIds { +interface Objects { answerId?: string; liveboardId?: string; vizIds?: string[]; dataModelIds?: string[]; + modalTitle?: string; } export interface PageContextOptions { page: ContextType; pageType: PageType; - objectIds: ObjectIds; + objects: Objects; } diff --git a/src/types.ts b/src/types.ts index 0a7dddb7..f94ca805 100644 --- a/src/types.ts +++ b/src/types.ts @@ -6466,6 +6466,14 @@ export interface EmbedErrorDetailsEvent { /** Additional context-specific for backward compatibility */ [key: string]: any; } + +export enum ContextType { + Search = 'search-answer', + Liveboard = 'liveboard', + Answer = 'answer', + Spotter = 'spotter', +} + export interface DefaultAppInitData { customisations: CustomisationsInterface; authToken: string; From fd0ada2337abc58f714fbbb1c9a7024094a73ce5 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Sat, 10 Jan 2026 11:54:47 +0530 Subject: [PATCH 15/23] fixed tests --- src/embed/hostEventClient/host-event-client.ts | 3 +-- src/embed/liveboard.ts | 4 +++- src/embed/ts-embed.ts | 2 +- src/utils/processTrigger.ts | 3 +-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/embed/hostEventClient/host-event-client.ts b/src/embed/hostEventClient/host-event-client.ts index 6aa8301f..0bf45687 100644 --- a/src/embed/hostEventClient/host-event-client.ts +++ b/src/embed/hostEventClient/host-event-client.ts @@ -1,4 +1,4 @@ -import { HostEvent } from '../../types'; +import { ContextType, HostEvent } from '../../types'; import { processTrigger as processTriggerService } from '../../utils/processTrigger'; import { getEmbedConfig } from '../embedConfig'; import { @@ -8,7 +8,6 @@ import { UIPassthroughResponse, TriggerPayload, TriggerResponse, - ContextType, } from './contracts'; export class HostEventClient { diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index 8f1c2ee5..b4f4fcc5 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -22,12 +22,13 @@ import { LiveboardAppEmbedViewConfig, ErrorDetailsTypes, EmbedErrorCodes, + ContextType, } from '../types'; import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidCssMargin } from '../utils'; import { getAuthPromise } from './base'; import { TsEmbed, V1Embed } from './ts-embed'; import { addPreviewStylesIfNotPresent } from '../utils/global-styles'; -import { ContextType, TriggerPayload, TriggerResponse, PageContextOptions } from './hostEventClient/contracts'; +import { TriggerPayload, TriggerResponse, PageContextOptions } from './hostEventClient/contracts'; import { logger } from '../utils/logger'; @@ -642,6 +643,7 @@ export class LiveboardEmbed extends V1Embed { } private sendFullHeightLazyLoadData = () => { + console.log('sendFullHeightLazyLoadData', this.iFrame); const data = calculateVisibleElementData(this.iFrame); this.trigger(HostEvent.VisibleEmbedCoordinates, data); } diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index 8f4cd918..e3e95fa3 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -10,7 +10,6 @@ import isEqual from 'lodash/isEqual'; import isEmpty from 'lodash/isEmpty'; import isObject from 'lodash/isObject'; import { - ContextType, TriggerPayload, TriggerResponse, UIPassthroughArrayResponse, @@ -61,6 +60,7 @@ import { EmbedErrorDetailsEvent, ErrorDetailsTypes, EmbedErrorCodes, + ContextType, } from '../types'; import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service'; import { processEventData, processAuthFailure } from '../utils/processData'; diff --git a/src/utils/processTrigger.ts b/src/utils/processTrigger.ts index d27b3acf..204e4fbc 100644 --- a/src/utils/processTrigger.ts +++ b/src/utils/processTrigger.ts @@ -1,9 +1,8 @@ import { ERROR_MESSAGE } from '../errors'; -import { HostEvent, MessagePayload } from '../types'; +import { ContextType, HostEvent, MessagePayload } from '../types'; import { logger } from '../utils/logger'; import { handlePresentEvent } from '../utils'; import { getEmbedConfig } from '../embed/embedConfig'; -import { ContextType } from 'src/embed/hostEventClient/contracts'; /** * Reloads the ThoughtSpot iframe. From 397a854bafa9c5b519e2b8393ad75c405b4f9afd Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Sat, 10 Jan 2026 11:58:59 +0530 Subject: [PATCH 16/23] exposed contexttype --- src/index.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/index.ts b/src/index.ts index 17c89638..d9da0fbe 100644 --- a/src/index.ts +++ b/src/index.ts @@ -68,6 +68,7 @@ import { InterceptedApiType, EmbedErrorCodes, ErrorDetailsTypes, + ContextType, } from './types'; import { CustomCssVariables } from './css-variables'; import { SageEmbed, SageViewConfig } from './embed/sage'; @@ -121,6 +122,7 @@ export { RuntimeFilterOp, EmbedEvent, HostEvent, + ContextType, DataSourceVisualMode, Action, ContextMenuTriggerOptions, From d4666ed6d2597f008c0995423be13534f07fa035 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 12 Jan 2026 14:49:14 +0530 Subject: [PATCH 17/23] typedoc --- static/typedoc/typedoc.json | 9770 +++++++++++++++++++++-------------- 1 file changed, 5807 insertions(+), 3963 deletions(-) diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 37621f0d..23e33991 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 2177, + "id": 2223, "name": "Action", "kind": 4, "kindString": "Enumeration", @@ -27,7 +27,7 @@ }, "children": [ { - "id": 2290, + "id": 2336, "name": "AIHighlights", "kind": 16, "kindString": "Enumeration member", @@ -48,14 +48,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5767, + "line": 5805, "character": 4 } ], "defaultValue": "\"AIHighlights\"" }, { - "id": 2197, + "id": 2243, "name": "AddColumnSet", "kind": 16, "kindString": "Enumeration member", @@ -76,14 +76,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4913, + "line": 4951, "character": 4 } ], "defaultValue": "\"addSimpleCohort\"" }, { - "id": 2190, + "id": 2236, "name": "AddDataPanelObjects", "kind": 16, "kindString": "Enumeration member", @@ -104,14 +104,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4842, + "line": 4880, "character": 4 } ], "defaultValue": "\"addDataPanelObjects\"" }, { - "id": 2189, + "id": 2235, "name": "AddFilter", "kind": 16, "kindString": "Enumeration member", @@ -128,14 +128,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4831, + "line": 4869, "character": 4 } ], "defaultValue": "\"addFilter\"" }, { - "id": 2195, + "id": 2241, "name": "AddFormula", "kind": 16, "kindString": "Enumeration member", @@ -152,14 +152,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4894, + "line": 4932, "character": 4 } ], "defaultValue": "\"addFormula\"" }, { - "id": 2196, + "id": 2242, "name": "AddParameter", "kind": 16, "kindString": "Enumeration member", @@ -176,14 +176,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4903, + "line": 4941, "character": 4 } ], "defaultValue": "\"addParameter\"" }, { - "id": 2198, + "id": 2244, "name": "AddQuerySet", "kind": 16, "kindString": "Enumeration member", @@ -204,14 +204,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4923, + "line": 4961, "character": 4 } ], "defaultValue": "\"addAdvancedCohort\"" }, { - "id": 2272, + "id": 2318, "name": "AddTab", "kind": 16, "kindString": "Enumeration member", @@ -232,14 +232,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5561, + "line": 5599, "character": 4 } ], "defaultValue": "\"addTab\"" }, { - "id": 2245, + "id": 2291, "name": "AddToFavorites", "kind": 16, "kindString": "Enumeration member", @@ -260,14 +260,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5283, + "line": 5321, "character": 4 } ], "defaultValue": "\"addToFavorites\"" }, { - "id": 2287, + "id": 2333, "name": "AddToWatchlist", "kind": 16, "kindString": "Enumeration member", @@ -288,14 +288,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5734, + "line": 5772, "character": 4 } ], "defaultValue": "\"addToWatchlist\"" }, { - "id": 2244, + "id": 2290, "name": "AnswerChartSwitcher", "kind": 16, "kindString": "Enumeration member", @@ -316,14 +316,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5271, + "line": 5309, "character": 4 } ], "defaultValue": "\"answerChartSwitcher\"" }, { - "id": 2243, + "id": 2289, "name": "AnswerDelete", "kind": 16, "kindString": "Enumeration member", @@ -344,14 +344,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5259, + "line": 5297, "character": 4 } ], "defaultValue": "\"onDeleteAnswer\"" }, { - "id": 2286, + "id": 2332, "name": "AskAi", "kind": 16, "kindString": "Enumeration member", @@ -373,14 +373,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5723, + "line": 5761, "character": 4 } ], "defaultValue": "\"AskAi\"" }, { - "id": 2256, + "id": 2302, "name": "AxisMenuAggregate", "kind": 16, "kindString": "Enumeration member", @@ -401,14 +401,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5396, + "line": 5434, "character": 4 } ], "defaultValue": "\"axisMenuAggregate\"" }, { - "id": 2259, + "id": 2305, "name": "AxisMenuConditionalFormat", "kind": 16, "kindString": "Enumeration member", @@ -429,14 +429,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5430, + "line": 5468, "character": 4 } ], "defaultValue": "\"axisMenuConditionalFormat\"" }, { - "id": 2264, + "id": 2310, "name": "AxisMenuEdit", "kind": 16, "kindString": "Enumeration member", @@ -457,14 +457,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5485, + "line": 5523, "character": 4 } ], "defaultValue": "\"axisMenuEdit\"" }, { - "id": 2258, + "id": 2304, "name": "AxisMenuFilter", "kind": 16, "kindString": "Enumeration member", @@ -485,14 +485,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5419, + "line": 5457, "character": 4 } ], "defaultValue": "\"axisMenuFilter\"" }, { - "id": 2261, + "id": 2307, "name": "AxisMenuGroup", "kind": 16, "kindString": "Enumeration member", @@ -513,14 +513,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5453, + "line": 5491, "character": 4 } ], "defaultValue": "\"axisMenuGroup\"" }, { - "id": 2265, + "id": 2311, "name": "AxisMenuNumberFormat", "kind": 16, "kindString": "Enumeration member", @@ -541,14 +541,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5495, + "line": 5533, "character": 4 } ], "defaultValue": "\"axisMenuNumberFormat\"" }, { - "id": 2262, + "id": 2308, "name": "AxisMenuPosition", "kind": 16, "kindString": "Enumeration member", @@ -569,14 +569,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5464, + "line": 5502, "character": 4 } ], "defaultValue": "\"axisMenuPosition\"" }, { - "id": 2267, + "id": 2313, "name": "AxisMenuRemove", "kind": 16, "kindString": "Enumeration member", @@ -597,14 +597,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5517, + "line": 5555, "character": 4 } ], "defaultValue": "\"axisMenuRemove\"" }, { - "id": 2263, + "id": 2309, "name": "AxisMenuRename", "kind": 16, "kindString": "Enumeration member", @@ -625,14 +625,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5474, + "line": 5512, "character": 4 } ], "defaultValue": "\"axisMenuRename\"" }, { - "id": 2260, + "id": 2306, "name": "AxisMenuSort", "kind": 16, "kindString": "Enumeration member", @@ -653,14 +653,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5441, + "line": 5479, "character": 4 } ], "defaultValue": "\"axisMenuSort\"" }, { - "id": 2266, + "id": 2312, "name": "AxisMenuTextWrapping", "kind": 16, "kindString": "Enumeration member", @@ -681,14 +681,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5505, + "line": 5543, "character": 4 } ], "defaultValue": "\"axisMenuTextWrapping\"" }, { - "id": 2257, + "id": 2303, "name": "AxisMenuTimeBucket", "kind": 16, "kindString": "Enumeration member", @@ -709,14 +709,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5407, + "line": 5445, "character": 4 } ], "defaultValue": "\"axisMenuTimeBucket\"" }, { - "id": 2299, + "id": 2345, "name": "ChangeFilterVisibilityInTab", "kind": 16, "kindString": "Enumeration member", @@ -737,14 +737,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5865, + "line": 5903, "character": 4 } ], "defaultValue": "\"changeFilterVisibilityInTab\"" }, { - "id": 2194, + "id": 2240, "name": "ChooseDataSources", "kind": 16, "kindString": "Enumeration member", @@ -761,14 +761,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4885, + "line": 4923, "character": 4 } ], "defaultValue": "\"chooseDataSources\"" }, { - "id": 2193, + "id": 2239, "name": "CollapseDataPanel", "kind": 16, "kindString": "Enumeration member", @@ -789,14 +789,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4876, + "line": 4914, "character": 4 } ], "defaultValue": "\"collapseDataPanel\"" }, { - "id": 2192, + "id": 2238, "name": "CollapseDataSources", "kind": 16, "kindString": "Enumeration member", @@ -817,14 +817,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4864, + "line": 4902, "character": 4 } ], "defaultValue": "\"collapseDataSources\"" }, { - "id": 2306, + "id": 2352, "name": "ColumnRename", "kind": 16, "kindString": "Enumeration member", @@ -845,14 +845,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5941, + "line": 5979, "character": 4 } ], "defaultValue": "\"columnRename\"" }, { - "id": 2191, + "id": 2237, "name": "ConfigureFilter", "kind": 16, "kindString": "Enumeration member", @@ -869,14 +869,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4853, + "line": 4891, "character": 4 } ], "defaultValue": "\"configureFilter\"" }, { - "id": 2236, + "id": 2282, "name": "CopyAndEdit", "kind": 16, "kindString": "Enumeration member", @@ -884,14 +884,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5210, + "line": 5248, "character": 4 } ], "defaultValue": "\"context-menu-item-copy-and-edit\"" }, { - "id": 2184, + "id": 2230, "name": "CopyLink", "kind": 16, "kindString": "Enumeration member", @@ -908,14 +908,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4790, + "line": 4828, "character": 4 } ], "defaultValue": "\"embedDocument\"" }, { - "id": 2235, + "id": 2281, "name": "CopyToClipboard", "kind": 16, "kindString": "Enumeration member", @@ -932,14 +932,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5209, + "line": 5247, "character": 4 } ], "defaultValue": "\"context-menu-item-copy-to-clipboard\"" }, { - "id": 2307, + "id": 2353, "name": "CoverAndFilterOptionInPDF", "kind": 16, "kindString": "Enumeration member", @@ -960,14 +960,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5951, + "line": 5989, "character": 4 } ], "defaultValue": "\"coverAndFilterOptionInPDF\"" }, { - "id": 2317, + "id": 2363, "name": "CreateGroup", "kind": 16, "kindString": "Enumeration member", @@ -988,14 +988,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6063, + "line": 6101, "character": 4 } ], "defaultValue": "\"createGroup\"" }, { - "id": 2284, + "id": 2330, "name": "CreateLiveboard", "kind": 16, "kindString": "Enumeration member", @@ -1016,14 +1016,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5698, + "line": 5736, "character": 4 } ], "defaultValue": "\"createLiveboard\"" }, { - "id": 2247, + "id": 2293, "name": "CreateMonitor", "kind": 16, "kindString": "Enumeration member", @@ -1044,14 +1044,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5303, + "line": 5341, "character": 4 } ], "defaultValue": "\"createMonitor\"" }, { - "id": 2252, + "id": 2298, "name": "CrossFilter", "kind": 16, "kindString": "Enumeration member", @@ -1072,14 +1072,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5354, + "line": 5392, "character": 4 } ], "defaultValue": "\"context-menu-item-cross-filter\"" }, { - "id": 2304, + "id": 2350, "name": "DeletePreviousPrompt", "kind": 16, "kindString": "Enumeration member", @@ -1100,14 +1100,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5922, + "line": 5960, "character": 4 } ], "defaultValue": "\"deletePreviousPrompt\"" }, { - "id": 2296, + "id": 2342, "name": "DeleteScheduleHomepage", "kind": 16, "kindString": "Enumeration member", @@ -1128,14 +1128,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5834, + "line": 5872, "character": 4 } ], "defaultValue": "\"deleteScheduleHomepage\"" }, { - "id": 2298, + "id": 2344, "name": "DisableChipReorder", "kind": 16, "kindString": "Enumeration member", @@ -1156,14 +1156,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5853, + "line": 5891, "character": 4 } ], "defaultValue": "\"disableChipReorder\"" }, { - "id": 2206, + "id": 2252, "name": "Download", "kind": 16, "kindString": "Enumeration member", @@ -1180,14 +1180,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4973, + "line": 5011, "character": 4 } ], "defaultValue": "\"download\"" }, { - "id": 2209, + "id": 2255, "name": "DownloadAsCsv", "kind": 16, "kindString": "Enumeration member", @@ -1204,14 +1204,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5006, + "line": 5044, "character": 4 } ], "defaultValue": "\"downloadAsCSV\"" }, { - "id": 2208, + "id": 2254, "name": "DownloadAsPdf", "kind": 16, "kindString": "Enumeration member", @@ -1229,14 +1229,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4996, + "line": 5034, "character": 4 } ], "defaultValue": "\"downloadAsPdf\"" }, { - "id": 2207, + "id": 2253, "name": "DownloadAsPng", "kind": 16, "kindString": "Enumeration member", @@ -1253,14 +1253,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4983, + "line": 5021, "character": 4 } ], "defaultValue": "\"downloadAsPng\"" }, { - "id": 2210, + "id": 2256, "name": "DownloadAsXlsx", "kind": 16, "kindString": "Enumeration member", @@ -1277,14 +1277,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5016, + "line": 5054, "character": 4 } ], "defaultValue": "\"downloadAsXLSX\"" }, { - "id": 2240, + "id": 2286, "name": "DrillDown", "kind": 16, "kindString": "Enumeration member", @@ -1301,14 +1301,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5226, + "line": 5264, "character": 4 } ], "defaultValue": "\"DRILL\"" }, { - "id": 2234, + "id": 2280, "name": "DrillExclude", "kind": 16, "kindString": "Enumeration member", @@ -1325,14 +1325,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5199, + "line": 5237, "character": 4 } ], "defaultValue": "\"context-menu-item-exclude\"" }, { - "id": 2233, + "id": 2279, "name": "DrillInclude", "kind": 16, "kindString": "Enumeration member", @@ -1349,14 +1349,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5190, + "line": 5228, "character": 4 } ], "defaultValue": "\"context-menu-item-include\"" }, { - "id": 2218, + "id": 2264, "name": "Edit", "kind": 16, "kindString": "Enumeration member", @@ -1373,14 +1373,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5092, + "line": 5130, "character": 4 } ], "defaultValue": "\"edit\"" }, { - "id": 2183, + "id": 2229, "name": "EditACopy", "kind": 16, "kindString": "Enumeration member", @@ -1397,14 +1397,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4781, + "line": 4819, "character": 4 } ], "defaultValue": "\"editACopy\"" }, { - "id": 2246, + "id": 2292, "name": "EditDetails", "kind": 16, "kindString": "Enumeration member", @@ -1425,14 +1425,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5292, + "line": 5330, "character": 4 } ], "defaultValue": "\"editDetails\"" }, { - "id": 2238, + "id": 2284, "name": "EditMeasure", "kind": 16, "kindString": "Enumeration member", @@ -1440,14 +1440,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5215, + "line": 5253, "character": 4 } ], "defaultValue": "\"context-menu-item-edit-measure\"" }, { - "id": 2303, + "id": 2349, "name": "EditPreviousPrompt", "kind": 16, "kindString": "Enumeration member", @@ -1468,14 +1468,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5911, + "line": 5949, "character": 4 } ], "defaultValue": "\"editPreviousPrompt\"" }, { - "id": 2276, + "id": 2322, "name": "EditSageAnswer", "kind": 16, "kindString": "Enumeration member", @@ -1496,14 +1496,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5605, + "line": 5643, "character": 4 } ], "defaultValue": "\"editSageAnswer\"" }, { - "id": 2291, + "id": 2337, "name": "EditScheduleHomepage", "kind": 16, "kindString": "Enumeration member", @@ -1524,14 +1524,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5780, + "line": 5818, "character": 4 } ], "defaultValue": "\"editScheduleHomepage\"" }, { - "id": 2215, + "id": 2261, "name": "EditTML", "kind": 16, "kindString": "Enumeration member", @@ -1548,14 +1548,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5060, + "line": 5098, "character": 4 } ], "defaultValue": "\"editTSL\"" }, { - "id": 2219, + "id": 2265, "name": "EditTitle", "kind": 16, "kindString": "Enumeration member", @@ -1572,14 +1572,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5100, + "line": 5138, "character": 4 } ], "defaultValue": "\"editTitle\"" }, { - "id": 2305, + "id": 2351, "name": "EditTokens", "kind": 16, "kindString": "Enumeration member", @@ -1600,14 +1600,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5932, + "line": 5970, "character": 4 } ], "defaultValue": "\"editTokens\"" }, { - "id": 2273, + "id": 2319, "name": "EnableContextualChangeAnalysis", "kind": 16, "kindString": "Enumeration member", @@ -1628,14 +1628,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5571, + "line": 5609, "character": 4 } ], "defaultValue": "\"enableContextualChangeAnalysis\"" }, { - "id": 2274, + "id": 2320, "name": "EnableIterativeChangeAnalysis", "kind": 16, "kindString": "Enumeration member", @@ -1656,14 +1656,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5582, + "line": 5620, "character": 4 } ], "defaultValue": "\"enableIterativeChangeAnalysis\"" }, { - "id": 2232, + "id": 2278, "name": "Explore", "kind": 16, "kindString": "Enumeration member", @@ -1680,14 +1680,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5179, + "line": 5217, "character": 4 } ], "defaultValue": "\"explore\"" }, { - "id": 2212, + "id": 2258, "name": "ExportTML", "kind": 16, "kindString": "Enumeration member", @@ -1705,14 +1705,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5032, + "line": 5070, "character": 4 } ], "defaultValue": "\"exportTSL\"" }, { - "id": 2213, + "id": 2259, "name": "ImportTML", "kind": 16, "kindString": "Enumeration member", @@ -1729,14 +1729,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5042, + "line": 5080, "character": 4 } ], "defaultValue": "\"importTSL\"" }, { - "id": 2308, + "id": 2354, "name": "InConversationTraining", "kind": 16, "kindString": "Enumeration member", @@ -1757,14 +1757,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5967, + "line": 6005, "character": 4 } ], "defaultValue": "\"InConversationTraining\"" }, { - "id": 2297, + "id": 2343, "name": "KPIAnalysisCTA", "kind": 16, "kindString": "Enumeration member", @@ -1785,14 +1785,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5844, + "line": 5882, "character": 4 } ], "defaultValue": "\"kpiAnalysisCTA\"" }, { - "id": 2226, + "id": 2272, "name": "LiveboardInfo", "kind": 16, "kindString": "Enumeration member", @@ -1809,14 +1809,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5141, + "line": 5179, "character": 4 } ], "defaultValue": "\"pinboardInfo\"" }, { - "id": 2314, + "id": 2360, "name": "LiveboardStylePanel", "kind": 16, "kindString": "Enumeration member", @@ -1837,14 +1837,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6033, + "line": 6071, "character": 4 } ], "defaultValue": "\"liveboardStylePanel\"" }, { - "id": 2282, + "id": 2328, "name": "LiveboardUsers", "kind": 16, "kindString": "Enumeration member", @@ -1865,14 +1865,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5666, + "line": 5704, "character": 4 } ], "defaultValue": "\"liveboardUsers\"" }, { - "id": 2182, + "id": 2228, "name": "MakeACopy", "kind": 16, "kindString": "Enumeration member", @@ -1889,14 +1889,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4772, + "line": 4810, "character": 4 } ], "defaultValue": "\"makeACopy\"" }, { - "id": 2280, + "id": 2326, "name": "ManageMonitor", "kind": 16, "kindString": "Enumeration member", @@ -1913,14 +1913,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5646, + "line": 5684, "character": 4 } ], "defaultValue": "\"manageMonitor\"" }, { - "id": 2251, + "id": 2297, "name": "ManagePipelines", "kind": 16, "kindString": "Enumeration member", @@ -1941,14 +1941,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5344, + "line": 5382, "character": 4 } ], "defaultValue": "\"manage-pipeline\"" }, { - "id": 2295, + "id": 2341, "name": "ManageTags", "kind": 16, "kindString": "Enumeration member", @@ -1969,14 +1969,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5823, + "line": 5861, "character": 4 } ], "defaultValue": "\"manageTags\"" }, { - "id": 2271, + "id": 2317, "name": "MarkAsVerified", "kind": 16, "kindString": "Enumeration member", @@ -1997,14 +1997,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5551, + "line": 5589, "character": 4 } ], "defaultValue": "\"markAsVerified\"" }, { - "id": 2278, + "id": 2324, "name": "ModifySageAnswer", "kind": 16, "kindString": "Enumeration member", @@ -2024,14 +2024,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5626, + "line": 5664, "character": 4 } ], "defaultValue": "\"modifySageAnswer\"" }, { - "id": 2316, + "id": 2362, "name": "MoveOutOfGroup", "kind": 16, "kindString": "Enumeration member", @@ -2052,14 +2052,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6053, + "line": 6091, "character": 4 } ], "defaultValue": "\"moveOutOfGroup\"" }, { - "id": 2315, + "id": 2361, "name": "MoveToGroup", "kind": 16, "kindString": "Enumeration member", @@ -2080,14 +2080,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6043, + "line": 6081, "character": 4 } ], "defaultValue": "\"moveToGroup\"" }, { - "id": 2279, + "id": 2325, "name": "MoveToTab", "kind": 16, "kindString": "Enumeration member", @@ -2104,14 +2104,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5635, + "line": 5673, "character": 4 } ], "defaultValue": "\"onContainerMove\"" }, { - "id": 2289, + "id": 2335, "name": "OrganiseFavourites", "kind": 16, "kindString": "Enumeration member", @@ -2132,14 +2132,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5756, + "line": 5794, "character": 4 } ], "defaultValue": "\"organiseFavourites\"" }, { - "id": 2292, + "id": 2338, "name": "PauseScheduleHomepage", "kind": 16, "kindString": "Enumeration member", @@ -2160,14 +2160,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5791, + "line": 5829, "character": 4 } ], "defaultValue": "\"pauseScheduleHomepage\"" }, { - "id": 2281, + "id": 2327, "name": "PersonalisedViewsDropdown", "kind": 16, "kindString": "Enumeration member", @@ -2188,14 +2188,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5656, + "line": 5694, "character": 4 } ], "defaultValue": "\"personalisedViewsDropdown\"" }, { - "id": 2229, + "id": 2275, "name": "Pin", "kind": 16, "kindString": "Enumeration member", @@ -2212,14 +2212,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5158, + "line": 5196, "character": 4 } ], "defaultValue": "\"pin\"" }, { - "id": 2312, + "id": 2358, "name": "PngScreenshotInEmail", "kind": 16, "kindString": "Enumeration member", @@ -2236,14 +2236,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6011, + "line": 6049, "character": 4 } ], "defaultValue": "\"pngScreenshotInEmail\"" }, { - "id": 2216, + "id": 2262, "name": "Present", "kind": 16, "kindString": "Enumeration member", @@ -2260,14 +2260,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5070, + "line": 5108, "character": 4 } ], "defaultValue": "\"present\"" }, { - "id": 2300, + "id": 2346, "name": "PreviewDataSpotter", "kind": 16, "kindString": "Enumeration member", @@ -2288,14 +2288,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5877, + "line": 5915, "character": 4 } ], "defaultValue": "\"previewDataSpotter\"" }, { - "id": 2242, + "id": 2288, "name": "QueryDetailsButtons", "kind": 16, "kindString": "Enumeration member", @@ -2313,14 +2313,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5249, + "line": 5287, "character": 4 } ], "defaultValue": "\"queryDetailsButtons\"" }, { - "id": 2220, + "id": 2266, "name": "Remove", "kind": 16, "kindString": "Enumeration member", @@ -2337,14 +2337,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5110, + "line": 5148, "character": 4 } ], "defaultValue": "\"delete\"" }, { - "id": 2313, + "id": 2359, "name": "RemoveAttachment", "kind": 16, "kindString": "Enumeration member", @@ -2365,14 +2365,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6023, + "line": 6061, "character": 4 } ], "defaultValue": "\"removeAttachment\"" }, { - "id": 2255, + "id": 2301, "name": "RemoveCrossFilter", "kind": 16, "kindString": "Enumeration member", @@ -2393,14 +2393,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5385, + "line": 5423, "character": 4 } ], "defaultValue": "\"context-menu-item-remove-cross-filter\"" }, { - "id": 2288, + "id": 2334, "name": "RemoveFromWatchlist", "kind": 16, "kindString": "Enumeration member", @@ -2421,14 +2421,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5745, + "line": 5783, "character": 4 } ], "defaultValue": "\"removeFromWatchlist\"" }, { - "id": 2269, + "id": 2315, "name": "RenameModalTitleDescription", "kind": 16, "kindString": "Enumeration member", @@ -2449,14 +2449,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5531, + "line": 5569, "character": 4 } ], "defaultValue": "\"renameModalTitleDescription\"" }, { - "id": 2248, + "id": 2294, "name": "ReportError", "kind": 16, "kindString": "Enumeration member", @@ -2480,14 +2480,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5313, + "line": 5351, "character": 4 } ], "defaultValue": "\"reportError\"" }, { - "id": 2241, + "id": 2287, "name": "RequestAccess", "kind": 16, "kindString": "Enumeration member", @@ -2504,14 +2504,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5235, + "line": 5273, "character": 4 } ], "defaultValue": "\"requestAccess\"" }, { - "id": 2270, + "id": 2316, "name": "RequestVerification", "kind": 16, "kindString": "Enumeration member", @@ -2532,14 +2532,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5541, + "line": 5579, "character": 4 } ], "defaultValue": "\"requestVerification\"" }, { - "id": 2301, + "id": 2347, "name": "ResetSpotterChat", "kind": 16, "kindString": "Enumeration member", @@ -2560,14 +2560,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5889, + "line": 5927, "character": 4 } ], "defaultValue": "\"resetSpotterChat\"" }, { - "id": 2277, + "id": 2323, "name": "SageAnswerFeedback", "kind": 16, "kindString": "Enumeration member", @@ -2588,14 +2588,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5617, + "line": 5655, "character": 4 } ], "defaultValue": "\"sageAnswerFeedback\"" }, { - "id": 2178, + "id": 2224, "name": "Save", "kind": 16, "kindString": "Enumeration member", @@ -2612,14 +2612,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4741, + "line": 4779, "character": 4 } ], "defaultValue": "\"save\"" }, { - "id": 2181, + "id": 2227, "name": "SaveAsView", "kind": 16, "kindString": "Enumeration member", @@ -2636,14 +2636,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4759, + "line": 4797, "character": 4 } ], "defaultValue": "\"saveAsView\"" }, { - "id": 2186, + "id": 2232, "name": "Schedule", "kind": 16, "kindString": "Enumeration member", @@ -2660,14 +2660,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4804, + "line": 4842, "character": 4 } ], "defaultValue": "\"subscription\"" }, { - "id": 2187, + "id": 2233, "name": "SchedulesList", "kind": 16, "kindString": "Enumeration member", @@ -2684,14 +2684,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4813, + "line": 4851, "character": 4 } ], "defaultValue": "\"schedule-list\"" }, { - "id": 2239, + "id": 2285, "name": "Separator", "kind": 16, "kindString": "Enumeration member", @@ -2699,14 +2699,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5216, + "line": 5254, "character": 4 } ], "defaultValue": "\"context-menu-item-separator\"" }, { - "id": 2188, + "id": 2234, "name": "Share", "kind": 16, "kindString": "Enumeration member", @@ -2723,14 +2723,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4822, + "line": 4860, "character": 4 } ], "defaultValue": "\"share\"" }, { - "id": 2203, + "id": 2249, "name": "ShareViz", "kind": 16, "kindString": "Enumeration member", @@ -2741,14 +2741,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4948, + "line": 4986, "character": 4 } ], "defaultValue": "\"shareViz\"" }, { - "id": 2275, + "id": 2321, "name": "ShowSageQuery", "kind": 16, "kindString": "Enumeration member", @@ -2769,14 +2769,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5592, + "line": 5630, "character": 4 } ], "defaultValue": "\"showSageQuery\"" }, { - "id": 2205, + "id": 2251, "name": "ShowUnderlyingData", "kind": 16, "kindString": "Enumeration member", @@ -2793,14 +2793,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4963, + "line": 5001, "character": 4 } ], "defaultValue": "\"showUnderlyingData\"" }, { - "id": 2200, + "id": 2246, "name": "SpotIQAnalyze", "kind": 16, "kindString": "Enumeration member", @@ -2817,14 +2817,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4936, + "line": 4974, "character": 4 } ], "defaultValue": "\"spotIQAnalyze\"" }, { - "id": 2302, + "id": 2348, "name": "SpotterFeedback", "kind": 16, "kindString": "Enumeration member", @@ -2845,14 +2845,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5900, + "line": 5938, "character": 4 } ], "defaultValue": "\"spotterFeedback\"" }, { - "id": 2311, + "id": 2357, "name": "SpotterTokenQuickEdit", "kind": 16, "kindString": "Enumeration member", @@ -2873,14 +2873,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6000, + "line": 6038, "character": 4 } ], "defaultValue": "\"SpotterTokenQuickEdit\"" }, { - "id": 2309, + "id": 2355, "name": "SpotterWarningsBanner", "kind": 16, "kindString": "Enumeration member", @@ -2901,14 +2901,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5978, + "line": 6016, "character": 4 } ], "defaultValue": "\"SpotterWarningsBanner\"" }, { - "id": 2310, + "id": 2356, "name": "SpotterWarningsOnTokens", "kind": 16, "kindString": "Enumeration member", @@ -2929,14 +2929,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5989, + "line": 6027, "character": 4 } ], "defaultValue": "\"SpotterWarningsOnTokens\"" }, { - "id": 2231, + "id": 2277, "name": "Subscription", "kind": 16, "kindString": "Enumeration member", @@ -2953,14 +2953,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5171, + "line": 5209, "character": 4 } ], "defaultValue": "\"subscription\"" }, { - "id": 2250, + "id": 2296, "name": "SyncToOtherApps", "kind": 16, "kindString": "Enumeration member", @@ -2981,14 +2981,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5334, + "line": 5372, "character": 4 } ], "defaultValue": "\"sync-to-other-apps\"" }, { - "id": 2249, + "id": 2295, "name": "SyncToSheets", "kind": 16, "kindString": "Enumeration member", @@ -3009,14 +3009,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5323, + "line": 5361, "character": 4 } ], "defaultValue": "\"sync-to-sheets\"" }, { - "id": 2253, + "id": 2299, "name": "SyncToSlack", "kind": 16, "kindString": "Enumeration member", @@ -3037,14 +3037,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5364, + "line": 5402, "character": 4 } ], "defaultValue": "\"syncToSlack\"" }, { - "id": 2254, + "id": 2300, "name": "SyncToTeams", "kind": 16, "kindString": "Enumeration member", @@ -3065,14 +3065,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5374, + "line": 5412, "character": 4 } ], "defaultValue": "\"syncToTeams\"" }, { - "id": 2283, + "id": 2329, "name": "TML", "kind": 16, "kindString": "Enumeration member", @@ -3097,14 +3097,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5685, + "line": 5723, "character": 4 } ], "defaultValue": "\"tml\"" }, { - "id": 2217, + "id": 2263, "name": "ToggleSize", "kind": 16, "kindString": "Enumeration member", @@ -3121,14 +3121,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5082, + "line": 5120, "character": 4 } ], "defaultValue": "\"toggleSize\"" }, { - "id": 2318, + "id": 2364, "name": "UngroupLiveboardGroup", "kind": 16, "kindString": "Enumeration member", @@ -3149,14 +3149,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6073, + "line": 6111, "character": 4 } ], "defaultValue": "\"ungroupLiveboardGroup\"" }, { - "id": 2294, + "id": 2340, "name": "UnsubscribeScheduleHomepage", "kind": 16, "kindString": "Enumeration member", @@ -3177,14 +3177,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5813, + "line": 5851, "character": 4 } ], "defaultValue": "\"unsubscribeScheduleHomepage\"" }, { - "id": 2214, + "id": 2260, "name": "UpdateTML", "kind": 16, "kindString": "Enumeration member", @@ -3201,14 +3201,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5051, + "line": 5089, "character": 4 } ], "defaultValue": "\"updateTSL\"" }, { - "id": 2285, + "id": 2331, "name": "VerifiedLiveboard", "kind": 16, "kindString": "Enumeration member", @@ -3229,14 +3229,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5709, + "line": 5747, "character": 4 } ], "defaultValue": "\"verifiedLiveboard\"" }, { - "id": 2293, + "id": 2339, "name": "ViewScheduleRunHomepage", "kind": 16, "kindString": "Enumeration member", @@ -3257,7 +3257,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5802, + "line": 5840, "character": 4 } ], @@ -3269,142 +3269,142 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2290, - 2197, - 2190, - 2189, - 2195, - 2196, - 2198, - 2272, - 2245, - 2287, - 2244, + 2336, 2243, - 2286, - 2256, - 2259, - 2264, - 2258, - 2261, - 2265, - 2262, - 2267, - 2263, - 2260, - 2266, - 2257, - 2299, - 2194, - 2193, - 2192, - 2306, - 2191, 2236, - 2184, 2235, - 2307, - 2317, - 2284, - 2247, - 2252, - 2304, - 2296, - 2298, - 2206, - 2209, - 2208, - 2207, - 2210, - 2240, - 2234, - 2233, - 2218, - 2183, - 2246, - 2238, - 2303, - 2276, + 2241, + 2242, + 2244, + 2318, 2291, - 2215, - 2219, + 2333, + 2290, + 2289, + 2332, + 2302, 2305, - 2273, - 2274, - 2232, - 2212, - 2213, + 2310, + 2304, + 2307, + 2311, 2308, - 2297, - 2226, - 2314, + 2313, + 2309, + 2306, + 2312, + 2303, + 2345, + 2240, + 2239, + 2238, + 2352, + 2237, 2282, - 2182, + 2230, + 2281, + 2353, + 2363, + 2330, + 2293, + 2298, + 2350, + 2342, + 2344, + 2252, + 2255, + 2254, + 2253, + 2256, + 2286, 2280, - 2251, - 2295, - 2271, - 2278, - 2316, - 2315, 2279, - 2289, - 2292, - 2281, + 2264, 2229, - 2312, - 2216, - 2300, - 2242, - 2220, - 2313, - 2255, + 2292, + 2284, + 2349, + 2322, + 2337, + 2261, + 2265, + 2351, + 2319, + 2320, + 2278, + 2258, + 2259, + 2354, + 2343, + 2272, + 2360, + 2328, + 2228, + 2326, + 2297, + 2341, + 2317, + 2324, + 2362, + 2361, + 2325, + 2335, + 2338, + 2327, + 2275, + 2358, + 2262, + 2346, 2288, - 2269, - 2248, - 2241, - 2270, + 2266, + 2359, 2301, - 2277, - 2178, - 2181, - 2186, - 2187, - 2239, - 2188, - 2203, - 2275, - 2205, - 2200, - 2302, - 2311, - 2309, - 2310, - 2231, - 2250, - 2249, - 2253, - 2254, - 2283, - 2217, - 2318, + 2334, + 2315, 2294, - 2214, + 2287, + 2316, + 2347, + 2323, + 2224, + 2227, + 2232, + 2233, 2285, - 2293 + 2234, + 2249, + 2321, + 2251, + 2246, + 2348, + 2357, + 2355, + 2356, + 2277, + 2296, + 2295, + 2299, + 2300, + 2329, + 2263, + 2364, + 2340, + 2260, + 2331, + 2339 ] } ], "sources": [ { "fileName": "types.ts", - "line": 4732, + "line": 4770, "character": 12 } ] }, { - "id": 1820, + "id": 1860, "name": "AuthEvent", "kind": 4, "kindString": "Enumeration", @@ -3420,7 +3420,7 @@ }, "children": [ { - "id": 1821, + "id": 1861, "name": "TRIGGER_SSO_POPUP", "kind": 16, "kindString": "Enumeration member", @@ -3443,7 +3443,7 @@ "title": "Enumeration members", "kind": 16, "children": [ - 1821 + 1861 ] } ], @@ -3456,7 +3456,7 @@ ] }, { - "id": 1805, + "id": 1845, "name": "AuthFailureType", "kind": 4, "kindString": "Enumeration", @@ -3472,7 +3472,7 @@ }, "children": [ { - "id": 1808, + "id": 1848, "name": "EXPIRY", "kind": 16, "kindString": "Enumeration member", @@ -3487,7 +3487,7 @@ "defaultValue": "\"EXPIRY\"" }, { - "id": 1810, + "id": 1850, "name": "IDLE_SESSION_TIMEOUT", "kind": 16, "kindString": "Enumeration member", @@ -3502,7 +3502,7 @@ "defaultValue": "\"IDLE_SESSION_TIMEOUT\"" }, { - "id": 1807, + "id": 1847, "name": "NO_COOKIE_ACCESS", "kind": 16, "kindString": "Enumeration member", @@ -3517,7 +3517,7 @@ "defaultValue": "\"NO_COOKIE_ACCESS\"" }, { - "id": 1809, + "id": 1849, "name": "OTHER", "kind": 16, "kindString": "Enumeration member", @@ -3532,7 +3532,7 @@ "defaultValue": "\"OTHER\"" }, { - "id": 1806, + "id": 1846, "name": "SDK", "kind": 16, "kindString": "Enumeration member", @@ -3547,7 +3547,7 @@ "defaultValue": "\"SDK\"" }, { - "id": 1811, + "id": 1851, "name": "UNAUTHENTICATED_FAILURE", "kind": 16, "kindString": "Enumeration member", @@ -3567,12 +3567,12 @@ "title": "Enumeration members", "kind": 16, "children": [ - 1808, - 1810, - 1807, - 1809, - 1806, - 1811 + 1848, + 1850, + 1847, + 1849, + 1846, + 1851 ] } ], @@ -3585,7 +3585,7 @@ ] }, { - "id": 1812, + "id": 1852, "name": "AuthStatus", "kind": 4, "kindString": "Enumeration", @@ -3601,7 +3601,7 @@ }, "children": [ { - "id": 1813, + "id": 1853, "name": "FAILURE", "kind": 16, "kindString": "Enumeration member", @@ -3619,7 +3619,7 @@ "defaultValue": "\"FAILURE\"" }, { - "id": 1817, + "id": 1857, "name": "LOGOUT", "kind": 16, "kindString": "Enumeration member", @@ -3637,7 +3637,7 @@ "defaultValue": "\"LOGOUT\"" }, { - "id": 1819, + "id": 1859, "name": "SAML_POPUP_CLOSED_NO_AUTH", "kind": 16, "kindString": "Enumeration member", @@ -3655,7 +3655,7 @@ "defaultValue": "\"SAML_POPUP_CLOSED_NO_AUTH\"" }, { - "id": 1814, + "id": 1854, "name": "SDK_SUCCESS", "kind": 16, "kindString": "Enumeration member", @@ -3673,7 +3673,7 @@ "defaultValue": "\"SDK_SUCCESS\"" }, { - "id": 1816, + "id": 1856, "name": "SUCCESS", "kind": 16, "kindString": "Enumeration member", @@ -3691,7 +3691,7 @@ "defaultValue": "\"SUCCESS\"" }, { - "id": 1818, + "id": 1858, "name": "WAITING_FOR_POPUP", "kind": 16, "kindString": "Enumeration member", @@ -3720,12 +3720,12 @@ "title": "Enumeration members", "kind": 16, "children": [ - 1813, - 1817, - 1819, - 1814, - 1816, - 1818 + 1853, + 1857, + 1859, + 1854, + 1856, + 1858 ] } ], @@ -3738,7 +3738,7 @@ ] }, { - "id": 1967, + "id": 2007, "name": "AuthType", "kind": 4, "kindString": "Enumeration", @@ -3754,7 +3754,7 @@ }, "children": [ { - "id": 1978, + "id": 2018, "name": "Basic", "kind": 16, "kindString": "Enumeration member", @@ -3773,7 +3773,7 @@ "defaultValue": "\"Basic\"" }, { - "id": 1969, + "id": 2009, "name": "EmbeddedSSO", "kind": 16, "kindString": "Enumeration member", @@ -3802,7 +3802,7 @@ "defaultValue": "\"EmbeddedSSO\"" }, { - "id": 1968, + "id": 2008, "name": "None", "kind": 16, "kindString": "Enumeration member", @@ -3826,7 +3826,7 @@ "defaultValue": "\"None\"" }, { - "id": 1974, + "id": 2014, "name": "OIDCRedirect", "kind": 16, "kindString": "Enumeration member", @@ -3844,7 +3844,7 @@ "defaultValue": "\"SSO_OIDC\"" }, { - "id": 1972, + "id": 2012, "name": "SAMLRedirect", "kind": 16, "kindString": "Enumeration member", @@ -3877,7 +3877,7 @@ "defaultValue": "\"SSO_SAML\"" }, { - "id": 1976, + "id": 2016, "name": "TrustedAuthToken", "kind": 16, "kindString": "Enumeration member", @@ -3901,7 +3901,7 @@ "defaultValue": "\"AuthServer\"" }, { - "id": 1977, + "id": 2017, "name": "TrustedAuthTokenCookieless", "kind": 16, "kindString": "Enumeration member", @@ -3934,13 +3934,13 @@ "title": "Enumeration members", "kind": 16, "children": [ - 1978, - 1969, - 1968, - 1974, - 1972, - 1976, - 1977 + 2018, + 2009, + 2008, + 2014, + 2012, + 2016, + 2017 ] } ], @@ -3953,7 +3953,7 @@ ] }, { - "id": 2319, + "id": 2365, "name": "ContextMenuTriggerOptions", "kind": 4, "kindString": "Enumeration", @@ -3963,7 +3963,7 @@ }, "children": [ { - "id": 2322, + "id": 2368, "name": "BOTH_CLICKS", "kind": 16, "kindString": "Enumeration member", @@ -3971,14 +3971,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6093, + "line": 6131, "character": 4 } ], "defaultValue": "\"both-clicks\"" }, { - "id": 2320, + "id": 2366, "name": "LEFT_CLICK", "kind": 16, "kindString": "Enumeration member", @@ -3986,14 +3986,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6091, + "line": 6129, "character": 4 } ], "defaultValue": "\"left-click\"" }, { - "id": 2321, + "id": 2367, "name": "RIGHT_CLICK", "kind": 16, "kindString": "Enumeration member", @@ -4001,7 +4001,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6092, + "line": 6130, "character": 4 } ], @@ -4013,22 +4013,110 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2322, - 2320, - 2321 + 2368, + 2366, + 2367 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6090, + "line": 6128, "character": 12 } ] }, { - "id": 3011, + "id": 2214, + "name": "ContextType", + "kind": 4, + "kindString": "Enumeration", + "flags": {}, + "children": [ + { + "id": 2217, + "name": "Answer", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "types.ts", + "line": 6473, + "character": 4 + } + ], + "defaultValue": "\"answer\"" + }, + { + "id": 2216, + "name": "Liveboard", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "types.ts", + "line": 6472, + "character": 4 + } + ], + "defaultValue": "\"liveboard\"" + }, + { + "id": 2215, + "name": "Search", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "types.ts", + "line": 6471, + "character": 4 + } + ], + "defaultValue": "\"search-answer\"" + }, + { + "id": 2218, + "name": "Spotter", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "sources": [ + { + "fileName": "types.ts", + "line": 6474, + "character": 4 + } + ], + "defaultValue": "\"spotter\"" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 2217, + 2216, + 2215, + 2218 + ] + } + ], + "sources": [ + { + "fileName": "types.ts", + "line": 6470, + "character": 12 + } + ] + }, + { + "id": 3067, "name": "CustomActionTarget", "kind": 4, "kindString": "Enumeration", @@ -4038,7 +4126,7 @@ }, "children": [ { - "id": 3014, + "id": 3070, "name": "ANSWER", "kind": 16, "kindString": "Enumeration member", @@ -4046,14 +4134,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6178, + "line": 6216, "character": 4 } ], "defaultValue": "\"ANSWER\"" }, { - "id": 3012, + "id": 3068, "name": "LIVEBOARD", "kind": 16, "kindString": "Enumeration member", @@ -4061,14 +4149,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6176, + "line": 6214, "character": 4 } ], "defaultValue": "\"LIVEBOARD\"" }, { - "id": 3015, + "id": 3071, "name": "SPOTTER", "kind": 16, "kindString": "Enumeration member", @@ -4076,14 +4164,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6179, + "line": 6217, "character": 4 } ], "defaultValue": "\"SPOTTER\"" }, { - "id": 3013, + "id": 3069, "name": "VIZ", "kind": 16, "kindString": "Enumeration member", @@ -4091,7 +4179,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6177, + "line": 6215, "character": 4 } ], @@ -4103,23 +4191,23 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3014, - 3012, - 3015, - 3013 + 3070, + 3068, + 3071, + 3069 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6175, + "line": 6213, "character": 12 } ] }, { - "id": 3007, + "id": 3063, "name": "CustomActionsPosition", "kind": 4, "kindString": "Enumeration", @@ -4129,7 +4217,7 @@ }, "children": [ { - "id": 3010, + "id": 3066, "name": "CONTEXTMENU", "kind": 16, "kindString": "Enumeration member", @@ -4137,14 +4225,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6169, + "line": 6207, "character": 4 } ], "defaultValue": "\"CONTEXTMENU\"" }, { - "id": 3009, + "id": 3065, "name": "MENU", "kind": 16, "kindString": "Enumeration member", @@ -4152,14 +4240,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6168, + "line": 6206, "character": 4 } ], "defaultValue": "\"MENU\"" }, { - "id": 3008, + "id": 3064, "name": "PRIMARY", "kind": 16, "kindString": "Enumeration member", @@ -4167,7 +4255,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6167, + "line": 6205, "character": 4 } ], @@ -4179,22 +4267,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3010, - 3009, - 3008 + 3066, + 3065, + 3064 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6166, + "line": 6204, "character": 12 } ] }, { - "id": 3003, + "id": 3059, "name": "DataPanelCustomColumnGroupsAccordionState", "kind": 4, "kindString": "Enumeration", @@ -4204,7 +4292,7 @@ }, "children": [ { - "id": 3005, + "id": 3061, "name": "COLLAPSE_ALL", "kind": 16, "kindString": "Enumeration member", @@ -4215,14 +4303,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 74, + "line": 75, "character": 4 } ], "defaultValue": "\"COLLAPSE_ALL\"" }, { - "id": 3004, + "id": 3060, "name": "EXPAND_ALL", "kind": 16, "kindString": "Enumeration member", @@ -4233,14 +4321,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 70, + "line": 71, "character": 4 } ], "defaultValue": "\"EXPAND_ALL\"" }, { - "id": 3006, + "id": 3062, "name": "EXPAND_FIRST", "kind": 16, "kindString": "Enumeration member", @@ -4251,7 +4339,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 78, + "line": 79, "character": 4 } ], @@ -4263,22 +4351,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3005, - 3004, - 3006 + 3061, + 3060, + 3062 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 66, + "line": 67, "character": 12 } ] }, { - "id": 2173, + "id": 2219, "name": "DataSourceVisualMode", "kind": 4, "kindString": "Enumeration", @@ -4288,7 +4376,7 @@ }, "children": [ { - "id": 2175, + "id": 2221, "name": "Collapsed", "kind": 16, "kindString": "Enumeration member", @@ -4299,14 +4387,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4560, + "line": 4598, "character": 4 } ], "defaultValue": "\"collapse\"" }, { - "id": 2176, + "id": 2222, "name": "Expanded", "kind": 16, "kindString": "Enumeration member", @@ -4317,14 +4405,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4564, + "line": 4602, "character": 4 } ], "defaultValue": "\"expand\"" }, { - "id": 2174, + "id": 2220, "name": "Hidden", "kind": 16, "kindString": "Enumeration member", @@ -4335,7 +4423,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4556, + "line": 4594, "character": 4 } ], @@ -4347,22 +4435,300 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2175, - 2176, - 2174 + 2221, + 2222, + 2220 + ] + } + ], + "sources": [ + { + "fileName": "types.ts", + "line": 4590, + "character": 12 + } + ] + }, + { + "id": 3076, + "name": "EmbedErrorCodes", + "kind": 4, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "shortText": "Specific error codes for embedded component errors.", + "text": "These codes provide granular identification of errors that occur in embedded components.\nThey are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for\nprecise error handling and debugging.\n\nThe codes are organized into categories:\n- **Worksheet ID not found or does not exist**: Errors related to applying or updating filters\n- **Liveboard ID missing**: Errors related to missing liveboard ID\n- **Conflicting actions configuration**: Errors related to conflicting actions configuration\n- **Conflicting tabs configuration**: Errors related to conflicting tabs configuration\n- **Initialization error**: Errors related to initialization error\n- **Network error**: Errors related to network error\n- **Custom action validation**: Errors related to custom action validation\n- **Login failed**: Errors related to login failed\n- **Render not called**: Errors related to render not called\n- **Host event type undefined or invalid**: Errors related to host event type undefined or invalid\n", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl" + }, + { + "tag": "group", + "text": "Error Handling" + }, + { + "tag": "see", + "text": "{@link EmbedErrorDetailsEvent} - The error event object that includes these codes" + }, + { + "tag": "see", + "text": "{@link ErrorDetailsTypes} - General error type categories\n" + }, + { + "tag": "example", + "text": "\nHandle specific error codes\n\nembed.on(EmbedEvent.Error, (error) => {\n if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {\n console.error('Worksheet ID not found:', error.message);\n }\n});\n" + } + ] + }, + "children": [ + { + "id": 3079, + "name": "CONFLICTING_ACTIONS_CONFIG", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Conflicting action configuration detected (e.g., both hiddenActions and visibleActions specified)" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6368, + "character": 4 + } + ], + "defaultValue": "\"CONFLICTING_ACTIONS_CONFIG\"" + }, + { + "id": 3080, + "name": "CONFLICTING_TABS_CONFIG", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Conflicting tab configuration detected (e.g., both hiddenTabs and visibleTabs specified)" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6371, + "character": 4 + } + ], + "defaultValue": "\"CONFLICTING_TABS_CONFIG\"" + }, + { + "id": 3083, + "name": "CUSTOM_ACTION_VALIDATION", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Custom action validation failed" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6380, + "character": 4 + } + ], + "defaultValue": "\"CUSTOM_ACTION_VALIDATION\"" + }, + { + "id": 3086, + "name": "HOST_EVENT_TYPE_UNDEFINED", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Host event type is undefined or invalid" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6389, + "character": 4 + } + ], + "defaultValue": "\"HOST_EVENT_TYPE_UNDEFINED\"" + }, + { + "id": 3081, + "name": "INIT_ERROR", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Error during component initialization" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6374, + "character": 4 + } + ], + "defaultValue": "\"INIT_ERROR\"" + }, + { + "id": 3078, + "name": "LIVEBOARD_ID_MISSING", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Required Liveboard ID is missing from configuration" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6365, + "character": 4 + } + ], + "defaultValue": "\"LIVEBOARD_ID_MISSING\"" + }, + { + "id": 3084, + "name": "LOGIN_FAILED", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Authentication/login failed" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6383, + "character": 4 + } + ], + "defaultValue": "\"LOGIN_FAILED\"" + }, + { + "id": 3082, + "name": "NETWORK_ERROR", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Network connectivity or request error" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6377, + "character": 4 + } + ], + "defaultValue": "\"NETWORK_ERROR\"" + }, + { + "id": 3087, + "name": "PARSING_API_INTERCEPT_BODY_ERROR", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Error parsing api intercept body" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6392, + "character": 4 + } + ], + "defaultValue": "\"PARSING_API_INTERCEPT_BODY_ERROR\"" + }, + { + "id": 3085, + "name": "RENDER_NOT_CALLED", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Render method was not called before attempting to use the component" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6386, + "character": 4 + } + ], + "defaultValue": "\"RENDER_NOT_CALLED\"" + }, + { + "id": 3088, + "name": "UPDATE_PARAMS_FAILED", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Failed to update embed parameters during pre-render" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6395, + "character": 4 + } + ], + "defaultValue": "\"UPDATE_PARAMS_FAILED\"" + }, + { + "id": 3077, + "name": "WORKSHEET_ID_NOT_FOUND", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Worksheet ID not found or does not exist" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6362, + "character": 4 + } + ], + "defaultValue": "\"WORKSHEET_ID_NOT_FOUND\"" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 3079, + 3080, + 3083, + 3086, + 3081, + 3078, + 3084, + 3082, + 3087, + 3085, + 3088, + 3077 ] } ], "sources": [ { "fileName": "types.ts", - "line": 4552, + "line": 6360, "character": 12 } ] }, { - "id": 1999, + "id": 2039, "name": "EmbedEvent", "kind": 4, "kindString": "Enumeration", @@ -4387,7 +4753,7 @@ }, "children": [ { - "id": 2035, + "id": 2075, "name": "AIHighlights", "kind": 16, "kindString": "Enumeration member", @@ -4408,14 +4774,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2381, + "line": 2409, "character": 4 } ], "defaultValue": "\"AIHighlights\"" }, { - "id": 2027, + "id": 2067, "name": "ALL", "kind": 16, "kindString": "Enumeration member", @@ -4436,14 +4802,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2260, + "line": 2288, "character": 4 } ], "defaultValue": "\"*\"" }, { - "id": 2007, + "id": 2047, "name": "AddRemoveColumns", "kind": 16, "kindString": "Enumeration member", @@ -4468,14 +4834,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2024, + "line": 2052, "character": 4 } ], "defaultValue": "\"addRemoveColumns\"" }, { - "id": 2086, + "id": 2126, "name": "AddToCoaching", "kind": 16, "kindString": "Enumeration member", @@ -4496,14 +4862,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2985, + "line": 3013, "character": 4 } ], "defaultValue": "\"addToCoaching\"" }, { - "id": 2052, + "id": 2092, "name": "AddToFavorites", "kind": 16, "kindString": "Enumeration member", @@ -4524,14 +4890,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2591, + "line": 2619, "character": 4 } ], "defaultValue": "\"addToFavorites\"" }, { - "id": 2012, + "id": 2052, "name": "Alert", "kind": 16, "kindString": "Enumeration member", @@ -4556,14 +4922,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2118, + "line": 2146, "character": 4 } ], "defaultValue": "\"alert\"" }, { - "id": 2048, + "id": 2088, "name": "AnswerChartSwitcher", "kind": 16, "kindString": "Enumeration member", @@ -4584,14 +4950,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2559, + "line": 2587, "character": 4 } ], "defaultValue": "\"answerChartSwitcher\"" }, { - "id": 2034, + "id": 2074, "name": "AnswerDelete", "kind": 16, "kindString": "Enumeration member", @@ -4612,14 +4978,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2370, + "line": 2398, "character": 4 } ], "defaultValue": "\"answerDelete\"" }, { - "id": 2096, + "id": 2136, "name": "ApiIntercept", "kind": 16, "kindString": "Enumeration member", @@ -4641,14 +5007,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3151, + "line": 3179, "character": 4 } ], "defaultValue": "\"ApiIntercept\"" }, { - "id": 2075, + "id": 2115, "name": "AskSageInit", "kind": 16, "kindString": "Enumeration member", @@ -4681,14 +5047,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2800, + "line": 2828, "character": 4 } ], "defaultValue": "\"AskSageInit\"" }, { - "id": 2013, + "id": 2053, "name": "AuthExpire", "kind": 16, "kindString": "Enumeration member", @@ -4709,14 +5075,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2131, + "line": 2159, "character": 4 } ], "defaultValue": "\"ThoughtspotAuthExpired\"" }, { - "id": 2001, + "id": 2041, "name": "AuthInit", "kind": 16, "kindString": "Enumeration member", @@ -4741,14 +5107,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1926, + "line": 1954, "character": 4 } ], "defaultValue": "\"authInit\"" }, { - "id": 2059, + "id": 2099, "name": "Cancel", "kind": 16, "kindString": "Enumeration member", @@ -4769,14 +5135,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2667, + "line": 2695, "character": 4 } ], "defaultValue": "\"cancel\"" }, { - "id": 2046, + "id": 2086, "name": "CopyAEdit", "kind": 16, "kindString": "Enumeration member", @@ -4797,14 +5163,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2537, + "line": 2565, "character": 4 } ], "defaultValue": "\"copyAEdit\"" }, { - "id": 2061, + "id": 2101, "name": "CopyLink", "kind": 16, "kindString": "Enumeration member", @@ -4825,14 +5191,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2687, + "line": 2715, "character": 4 } ], "defaultValue": "\"embedDocument\"" }, { - "id": 2041, + "id": 2081, "name": "CopyToClipboard", "kind": 16, "kindString": "Enumeration member", @@ -4853,14 +5219,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2472, + "line": 2500, "character": 4 } ], "defaultValue": "\"context-menu-item-copy-to-clipboard\"" }, { - "id": 2069, + "id": 2109, "name": "CreateConnection", "kind": 16, "kindString": "Enumeration member", @@ -4877,14 +5243,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2751, + "line": 2779, "character": 4 } ], "defaultValue": "\"createConnection\"" }, { - "id": 2080, + "id": 2120, "name": "CreateLiveboard", "kind": 16, "kindString": "Enumeration member", @@ -4902,14 +5268,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2935, + "line": 2963, "character": 4 } ], "defaultValue": "\"createLiveboard\"" }, { - "id": 2081, + "id": 2121, "name": "CreateModel", "kind": 16, "kindString": "Enumeration member", @@ -4926,14 +5292,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2940, + "line": 2968, "character": 4 } ], "defaultValue": "\"createModel\"" }, { - "id": 2074, + "id": 2114, "name": "CreateWorksheet", "kind": 16, "kindString": "Enumeration member", @@ -4950,14 +5316,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2791, + "line": 2819, "character": 4 } ], "defaultValue": "\"createWorksheet\"" }, { - "id": 2062, + "id": 2102, "name": "CrossFilterChanged", "kind": 16, "kindString": "Enumeration member", @@ -4978,14 +5344,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2698, + "line": 2726, "character": 4 } ], "defaultValue": "\"cross-filter-changed\"" }, { - "id": 2008, + "id": 2048, "name": "CustomAction", "kind": 16, "kindString": "Enumeration member", @@ -5014,14 +5380,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2041, + "line": 2069, "character": 4 } ], "defaultValue": "\"customAction\"" }, { - "id": 2003, + "id": 2043, "name": "Data", "kind": 16, "kindString": "Enumeration member", @@ -5050,14 +5416,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1954, + "line": 1982, "character": 4 } ], "defaultValue": "\"data\"" }, { - "id": 2087, + "id": 2127, "name": "DataModelInstructions", "kind": 16, "kindString": "Enumeration member", @@ -5078,14 +5444,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2996, + "line": 3024, "character": 4 } ], "defaultValue": "\"DataModelInstructions\"" }, { - "id": 2006, + "id": 2046, "name": "DataSourceSelected", "kind": 16, "kindString": "Enumeration member", @@ -5110,14 +5476,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2012, + "line": 2040, "character": 4 } ], "defaultValue": "\"dataSourceSelected\"" }, { - "id": 2057, + "id": 2097, "name": "Delete", "kind": 16, "kindString": "Enumeration member", @@ -5138,14 +5504,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2649, + "line": 2677, "character": 4 } ], "defaultValue": "\"delete\"" }, { - "id": 2073, + "id": 2113, "name": "DeletePersonalisedView", "kind": 16, "kindString": "Enumeration member", @@ -5170,14 +5536,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2786, + "line": 2814, "character": 4 } ], "defaultValue": "\"deletePersonalisedView\"" }, { - "id": 2025, + "id": 2065, "name": "DialogClose", "kind": 16, "kindString": "Enumeration member", @@ -5198,14 +5564,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2227, + "line": 2255, "character": 4 } ], "defaultValue": "\"dialog-close\"" }, { - "id": 2024, + "id": 2064, "name": "DialogOpen", "kind": 16, "kindString": "Enumeration member", @@ -5226,14 +5592,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2216, + "line": 2244, "character": 4 } ], "defaultValue": "\"dialog-open\"" }, { - "id": 2029, + "id": 2069, "name": "Download", "kind": 16, "kindString": "Enumeration member", @@ -5255,14 +5621,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2295, + "line": 2323, "character": 4 } ], "defaultValue": "\"download\"" }, { - "id": 2032, + "id": 2072, "name": "DownloadAsCsv", "kind": 16, "kindString": "Enumeration member", @@ -5283,14 +5649,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2340, + "line": 2368, "character": 4 } ], "defaultValue": "\"downloadAsCsv\"" }, { - "id": 2031, + "id": 2071, "name": "DownloadAsPdf", "kind": 16, "kindString": "Enumeration member", @@ -5311,14 +5677,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2325, + "line": 2353, "character": 4 } ], "defaultValue": "\"downloadAsPdf\"" }, { - "id": 2030, + "id": 2070, "name": "DownloadAsPng", "kind": 16, "kindString": "Enumeration member", @@ -5339,14 +5705,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2310, + "line": 2338, "character": 4 } ], "defaultValue": "\"downloadAsPng\"" }, { - "id": 2033, + "id": 2073, "name": "DownloadAsXlsx", "kind": 16, "kindString": "Enumeration member", @@ -5367,14 +5733,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2355, + "line": 2383, "character": 4 } ], "defaultValue": "\"downloadAsXlsx\"" }, { - "id": 2040, + "id": 2080, "name": "DrillExclude", "kind": 16, "kindString": "Enumeration member", @@ -5395,14 +5761,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2461, + "line": 2489, "character": 4 } ], "defaultValue": "\"context-menu-item-exclude\"" }, { - "id": 2039, + "id": 2079, "name": "DrillInclude", "kind": 16, "kindString": "Enumeration member", @@ -5423,14 +5789,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2449, + "line": 2477, "character": 4 } ], "defaultValue": "\"context-menu-item-include\"" }, { - "id": 2005, + "id": 2045, "name": "Drilldown", "kind": 16, "kindString": "Enumeration member", @@ -5467,14 +5833,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2000, + "line": 2028, "character": 4 } ], "defaultValue": "\"drillDown\"" }, { - "id": 2054, + "id": 2094, "name": "Edit", "kind": 16, "kindString": "Enumeration member", @@ -5495,14 +5861,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2613, + "line": 2641, "character": 4 } ], "defaultValue": "\"edit\"" }, { - "id": 2043, + "id": 2083, "name": "EditTML", "kind": 16, "kindString": "Enumeration member", @@ -5523,14 +5889,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2495, + "line": 2523, "character": 4 } ], "defaultValue": "\"editTSL\"" }, { - "id": 2011, + "id": 2051, "name": "Error", "kind": 16, "kindString": "Enumeration member", @@ -5560,14 +5926,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2108, + "line": 2136, "character": 4 } ], "defaultValue": "\"Error\"" }, { - "id": 2060, + "id": 2100, "name": "Explore", "kind": 16, "kindString": "Enumeration member", @@ -5588,14 +5954,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2677, + "line": 2705, "character": 4 } ], "defaultValue": "\"explore\"" }, { - "id": 2044, + "id": 2084, "name": "ExportTML", "kind": 16, "kindString": "Enumeration member", @@ -5616,14 +5982,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2511, + "line": 2539, "character": 4 } ], "defaultValue": "\"exportTSL\"" }, { - "id": 2065, + "id": 2105, "name": "FilterChanged", "kind": 16, "kindString": "Enumeration member", @@ -5640,14 +6006,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2728, + "line": 2756, "character": 4 } ], "defaultValue": "\"filterChanged\"" }, { - "id": 2019, + "id": 2059, "name": "GetDataClick", "kind": 16, "kindString": "Enumeration member", @@ -5668,14 +6034,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2173, + "line": 2201, "character": 4 } ], "defaultValue": "\"getDataClick\"" }, { - "id": 2000, + "id": 2040, "name": "Init", "kind": 16, "kindString": "Enumeration member", @@ -5696,14 +6062,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1914, + "line": 1942, "character": 4 } ], "defaultValue": "\"init\"" }, { - "id": 2090, + "id": 2130, "name": "LastPromptDeleted", "kind": 16, "kindString": "Enumeration member", @@ -5724,14 +6090,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3029, + "line": 3057, "character": 4 } ], "defaultValue": "\"LastPromptDeleted\"" }, { - "id": 2089, + "id": 2129, "name": "LastPromptEdited", "kind": 16, "kindString": "Enumeration member", @@ -5752,14 +6118,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3018, + "line": 3046, "character": 4 } ], "defaultValue": "\"LastPromptEdited\"" }, { - "id": 2051, + "id": 2091, "name": "LiveboardInfo", "kind": 16, "kindString": "Enumeration member", @@ -5780,14 +6146,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2580, + "line": 2608, "character": 4 } ], "defaultValue": "\"pinboardInfo\"" }, { - "id": 2026, + "id": 2066, "name": "LiveboardRendered", "kind": 16, "kindString": "Enumeration member", @@ -5812,14 +6178,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2249, + "line": 2277, "character": 4 } ], "defaultValue": "\"PinboardRendered\"" }, { - "id": 2002, + "id": 2042, "name": "Load", "kind": 16, "kindString": "Enumeration member", @@ -5844,14 +6210,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1940, + "line": 1968, "character": 4 } ], "defaultValue": "\"load\"" }, { - "id": 2055, + "id": 2095, "name": "MakeACopy", "kind": 16, "kindString": "Enumeration member", @@ -5872,14 +6238,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2624, + "line": 2652, "character": 4 } ], "defaultValue": "\"makeACopy\"" }, { - "id": 2022, + "id": 2062, "name": "NoCookieAccess", "kind": 16, "kindString": "Enumeration member", @@ -5900,14 +6266,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2199, + "line": 2227, "character": 4 } ], "defaultValue": "\"noCookieAccess\"" }, { - "id": 2077, + "id": 2117, "name": "OnBeforeGetVizDataIntercept", "kind": 16, "kindString": "Enumeration member", @@ -5937,14 +6303,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2868, + "line": 2896, "character": 4 } ], "defaultValue": "\"onBeforeGetVizDataIntercept\"" }, { - "id": 2095, + "id": 2135, "name": "OrgSwitched", "kind": 16, "kindString": "Enumeration member", @@ -5965,14 +6331,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3085, + "line": 3113, "character": 4 } ], "defaultValue": "\"orgSwitched\"" }, { - "id": 2078, + "id": 2118, "name": "ParameterChanged", "kind": 16, "kindString": "Enumeration member", @@ -5989,14 +6355,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2879, + "line": 2907, "character": 4 } ], "defaultValue": "\"parameterChanged\"" }, { - "id": 2036, + "id": 2076, "name": "Pin", "kind": 16, "kindString": "Enumeration member", @@ -6017,14 +6383,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2401, + "line": 2429, "character": 4 } ], "defaultValue": "\"pin\"" }, { - "id": 2056, + "id": 2096, "name": "Present", "kind": 16, "kindString": "Enumeration member", @@ -6049,14 +6415,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2639, + "line": 2667, "character": 4 } ], "defaultValue": "\"present\"" }, { - "id": 2085, + "id": 2125, "name": "PreviewSpotterData", "kind": 16, "kindString": "Enumeration member", @@ -6077,14 +6443,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2974, + "line": 3002, "character": 4 } ], "defaultValue": "\"PreviewSpotterData\"" }, { - "id": 2004, + "id": 2044, "name": "QueryChanged", "kind": 16, "kindString": "Enumeration member", @@ -6105,14 +6471,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1963, + "line": 1991, "character": 4 } ], "defaultValue": "\"queryChanged\"" }, { - "id": 2076, + "id": 2116, "name": "Rename", "kind": 16, "kindString": "Enumeration member", @@ -6129,14 +6495,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2805, + "line": 2833, "character": 4 } ], "defaultValue": "\"rename\"" }, { - "id": 2072, + "id": 2112, "name": "ResetLiveboard", "kind": 16, "kindString": "Enumeration member", @@ -6169,14 +6535,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2779, + "line": 2807, "character": 4 } ], "defaultValue": "\"resetLiveboard\"" }, { - "id": 2091, + "id": 2131, "name": "ResetSpotterConversation", "kind": 16, "kindString": "Enumeration member", @@ -6197,14 +6563,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3040, + "line": 3068, "character": 4 } ], "defaultValue": "\"ResetSpotterConversation\"" }, { - "id": 2020, + "id": 2060, "name": "RouteChange", "kind": 16, "kindString": "Enumeration member", @@ -6225,14 +6591,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2183, + "line": 2211, "character": 4 } ], "defaultValue": "\"ROUTE_CHANGE\"" }, { - "id": 2066, + "id": 2106, "name": "SageEmbedQuery", "kind": 16, "kindString": "Enumeration member", @@ -6249,14 +6615,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2734, + "line": 2762, "character": 4 } ], "defaultValue": "\"sageEmbedQuery\"" }, { - "id": 2067, + "id": 2107, "name": "SageWorksheetUpdated", "kind": 16, "kindString": "Enumeration member", @@ -6273,14 +6639,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2741, + "line": 2769, "character": 4 } ], "defaultValue": "\"sageWorksheetUpdated\"" }, { - "id": 2028, + "id": 2068, "name": "Save", "kind": 16, "kindString": "Enumeration member", @@ -6301,14 +6667,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2279, + "line": 2307, "character": 4 } ], "defaultValue": "\"save\"" }, { - "id": 2045, + "id": 2085, "name": "SaveAsView", "kind": 16, "kindString": "Enumeration member", @@ -6329,14 +6695,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2522, + "line": 2550, "character": 4 } ], "defaultValue": "\"saveAsView\"" }, { - "id": 2071, + "id": 2111, "name": "SavePersonalisedView", "kind": 16, "kindString": "Enumeration member", @@ -6369,14 +6735,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2770, + "line": 2798, "character": 4 } ], "defaultValue": "\"savePersonalisedView\"" }, { - "id": 2053, + "id": 2093, "name": "Schedule", "kind": 16, "kindString": "Enumeration member", @@ -6397,14 +6763,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2602, + "line": 2630, "character": 4 } ], "defaultValue": "\"subscription\"" }, { - "id": 2058, + "id": 2098, "name": "SchedulesList", "kind": 16, "kindString": "Enumeration member", @@ -6425,14 +6791,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2658, + "line": 2686, "character": 4 } ], "defaultValue": "\"schedule-list\"" }, { - "id": 2038, + "id": 2078, "name": "Share", "kind": 16, "kindString": "Enumeration member", @@ -6453,14 +6819,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2437, + "line": 2465, "character": 4 } ], "defaultValue": "\"share\"" }, { - "id": 2047, + "id": 2087, "name": "ShowUnderlyingData", "kind": 16, "kindString": "Enumeration member", @@ -6481,14 +6847,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2548, + "line": 2576, "character": 4 } ], "defaultValue": "\"showUnderlyingData\"" }, { - "id": 2037, + "id": 2077, "name": "SpotIQAnalyze", "kind": 16, "kindString": "Enumeration member", @@ -6509,14 +6875,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2419, + "line": 2447, "character": 4 } ], "defaultValue": "\"spotIQAnalyze\"" }, { - "id": 2084, + "id": 2124, "name": "SpotterData", "kind": 16, "kindString": "Enumeration member", @@ -6537,14 +6903,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2963, + "line": 2991, "character": 4 } ], "defaultValue": "\"SpotterData\"" }, { - "id": 2092, + "id": 2132, "name": "SpotterInit", "kind": 16, "kindString": "Enumeration member", @@ -6565,14 +6931,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3051, + "line": 3079, "character": 4 } ], "defaultValue": "\"spotterInit\"" }, { - "id": 2093, + "id": 2133, "name": "SpotterLoadComplete", "kind": 16, "kindString": "Enumeration member", @@ -6593,14 +6959,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3062, + "line": 3090, "character": 4 } ], "defaultValue": "\"spotterLoadComplete\"" }, { - "id": 2088, + "id": 2128, "name": "SpotterQueryTriggered", "kind": 16, "kindString": "Enumeration member", @@ -6621,14 +6987,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3007, + "line": 3035, "character": 4 } ], "defaultValue": "\"SpotterQueryTriggered\"" }, { - "id": 2079, + "id": 2119, "name": "TableVizRendered", "kind": 16, "kindString": "Enumeration member", @@ -6650,14 +7016,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2922, + "line": 2950, "character": 4 } ], "defaultValue": "\"TableVizRendered\"" }, { - "id": 2068, + "id": 2108, "name": "UpdateConnection", "kind": 16, "kindString": "Enumeration member", @@ -6674,14 +7040,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2746, + "line": 2774, "character": 4 } ], "defaultValue": "\"updateConnection\"" }, { - "id": 2070, + "id": 2110, "name": "UpdatePersonalisedView", "kind": 16, "kindString": "Enumeration member", @@ -6714,14 +7080,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2761, + "line": 2789, "character": 4 } ], "defaultValue": "\"updatePersonalisedView\"" }, { - "id": 2042, + "id": 2082, "name": "UpdateTML", "kind": 16, "kindString": "Enumeration member", @@ -6742,14 +7108,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2483, + "line": 2511, "character": 4 } ], "defaultValue": "\"updateTSL\"" }, { - "id": 2010, + "id": 2050, "name": "VizPointClick", "kind": 16, "kindString": "Enumeration member", @@ -6778,14 +7144,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2072, + "line": 2100, "character": 4 } ], "defaultValue": "\"vizPointClick\"" }, { - "id": 2009, + "id": 2049, "name": "VizPointDoubleClick", "kind": 16, "kindString": "Enumeration member", @@ -6810,14 +7176,14 @@ "sources": [ { "fileName": "types.ts", - "line": 2053, + "line": 2081, "character": 4 } ], "defaultValue": "\"vizPointDoubleClick\"" }, { - "id": 2063, + "id": 2103, "name": "VizPointRightClick", "kind": 16, "kindString": "Enumeration member", @@ -6838,7 +7204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2709, + "line": 2737, "character": 4 } ], @@ -6850,103 +7216,206 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2035, - 2027, - 2007, - 2086, - 2052, - 2012, - 2048, - 2034, - 2096, 2075, - 2013, - 2001, - 2059, - 2046, - 2061, + 2067, + 2047, + 2126, + 2092, + 2052, + 2088, + 2074, + 2136, + 2115, + 2053, 2041, - 2069, - 2080, + 2099, + 2086, + 2101, 2081, - 2074, - 2062, - 2008, - 2003, - 2087, - 2006, - 2057, - 2073, - 2025, - 2024, - 2029, - 2032, - 2031, - 2030, - 2033, - 2040, - 2039, - 2005, - 2054, + 2109, + 2120, + 2121, + 2114, + 2102, + 2048, 2043, - 2011, - 2060, - 2044, + 2127, + 2046, + 2097, + 2113, 2065, - 2019, - 2000, - 2090, - 2089, - 2051, - 2026, - 2002, - 2055, - 2022, - 2077, - 2095, - 2078, - 2036, - 2056, - 2085, - 2004, - 2076, + 2064, + 2069, 2072, - 2091, - 2020, - 2066, - 2067, - 2028, - 2045, 2071, - 2053, - 2058, - 2038, - 2047, - 2037, - 2084, - 2092, - 2093, - 2088, - 2079, - 2068, 2070, + 2073, + 2080, + 2079, + 2045, + 2094, + 2083, + 2051, + 2100, + 2084, + 2105, + 2059, + 2040, + 2130, + 2129, + 2091, + 2066, 2042, - 2010, - 2009, - 2063 + 2095, + 2062, + 2117, + 2135, + 2118, + 2076, + 2096, + 2125, + 2044, + 2116, + 2112, + 2131, + 2060, + 2106, + 2107, + 2068, + 2085, + 2111, + 2093, + 2098, + 2078, + 2087, + 2077, + 2124, + 2132, + 2133, + 2128, + 2119, + 2108, + 2110, + 2082, + 2050, + 2049, + 2103 + ] + } + ], + "sources": [ + { + "fileName": "types.ts", + "line": 1929, + "character": 12 + } + ] + }, + { + "id": 3089, + "name": "ErrorDetailsTypes", + "kind": 4, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "shortText": "Error types emitted by embedded components.", + "text": "These enum values categorize different types of errors that can occur during\nthe lifecycle of an embedded ThoughtSpot component. Use these values to implement\nspecific error handling logic based on the error category.\n", + "tags": [ + { + "tag": "see", + "text": "{@link EmbedErrorDetailsEvent} - The error event object structure" + }, + { + "tag": "see", + "text": "{@link EmbedEvent.Error} - The event that emits these errors" + }, + { + "tag": "version", + "text": "SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl" + }, + { + "tag": "group", + "text": "Error Handling\n" + } + ] + }, + "children": [ + { + "id": 3090, + "name": "API", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "API call failure" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6320, + "character": 4 + } + ], + "defaultValue": "\"API\"" + }, + { + "id": 3092, + "name": "NETWORK", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Network connectivity or request error" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6324, + "character": 4 + } + ], + "defaultValue": "\"NETWORK\"" + }, + { + "id": 3091, + "name": "VALIDATION_ERROR", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "General validation error" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 6322, + "character": 4 + } + ], + "defaultValue": "\"VALIDATION_ERROR\"" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 3090, + 3092, + 3091 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1901, + "line": 6318, "character": 12 } ] }, { - "id": 2709, + "id": 2765, "name": "HomeLeftNavItem", "kind": 4, "kindString": "Enumeration", @@ -6956,7 +7425,7 @@ }, "children": [ { - "id": 2713, + "id": 2769, "name": "Answers", "kind": 16, "kindString": "Enumeration member", @@ -6980,7 +7449,7 @@ "defaultValue": "\"answers\"" }, { - "id": 2717, + "id": 2773, "name": "Create", "kind": 16, "kindString": "Enumeration member", @@ -7004,7 +7473,7 @@ "defaultValue": "\"create\"" }, { - "id": 2719, + "id": 2775, "name": "Favorites", "kind": 16, "kindString": "Enumeration member", @@ -7028,7 +7497,7 @@ "defaultValue": "\"favorites\"" }, { - "id": 2711, + "id": 2767, "name": "Home", "kind": 16, "kindString": "Enumeration member", @@ -7052,7 +7521,7 @@ "defaultValue": "\"insights-home\"" }, { - "id": 2716, + "id": 2772, "name": "LiveboardSchedules", "kind": 16, "kindString": "Enumeration member", @@ -7076,7 +7545,7 @@ "defaultValue": "\"liveboard-schedules\"" }, { - "id": 2712, + "id": 2768, "name": "Liveboards", "kind": 16, "kindString": "Enumeration member", @@ -7100,7 +7569,7 @@ "defaultValue": "\"liveboards\"" }, { - "id": 2714, + "id": 2770, "name": "MonitorSubscription", "kind": 16, "kindString": "Enumeration member", @@ -7124,7 +7593,7 @@ "defaultValue": "\"monitor-alerts\"" }, { - "id": 2710, + "id": 2766, "name": "SearchData", "kind": 16, "kindString": "Enumeration member", @@ -7148,7 +7617,7 @@ "defaultValue": "\"search-data\"" }, { - "id": 2715, + "id": 2771, "name": "SpotIQAnalysis", "kind": 16, "kindString": "Enumeration member", @@ -7172,7 +7641,7 @@ "defaultValue": "\"spotiq-analysis\"" }, { - "id": 2718, + "id": 2774, "name": "Spotter", "kind": 16, "kindString": "Enumeration member", @@ -7201,16 +7670,16 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2713, - 2717, - 2719, - 2711, - 2716, - 2712, - 2714, - 2710, - 2715, - 2718 + 2769, + 2773, + 2775, + 2767, + 2772, + 2768, + 2770, + 2766, + 2771, + 2774 ] } ], @@ -7223,7 +7692,7 @@ ] }, { - "id": 2960, + "id": 3016, "name": "HomePage", "kind": 4, "kindString": "Enumeration", @@ -7239,7 +7708,7 @@ }, "children": [ { - "id": 2961, + "id": 3017, "name": "Modular", "kind": 16, "kindString": "Enumeration member", @@ -7250,14 +7719,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 109, + "line": 110, "character": 4 } ], "defaultValue": "\"v2\"" }, { - "id": 2962, + "id": 3018, "name": "ModularWithStylingChanges", "kind": 16, "kindString": "Enumeration member", @@ -7268,7 +7737,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 114, + "line": 115, "character": 4 } ], @@ -7280,28 +7749,28 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2961, - 2962 + 3017, + 3018 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 104, + "line": 105, "character": 12 } ] }, { - "id": 2954, + "id": 3010, "name": "HomePageSearchBarMode", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 2956, + "id": 3012, "name": "AI_ANSWER", "kind": 16, "kindString": "Enumeration member", @@ -7309,14 +7778,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 83, + "line": 84, "character": 4 } ], "defaultValue": "\"aiAnswer\"" }, { - "id": 2957, + "id": 3013, "name": "NONE", "kind": 16, "kindString": "Enumeration member", @@ -7324,14 +7793,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 84, + "line": 85, "character": 4 } ], "defaultValue": "\"none\"" }, { - "id": 2955, + "id": 3011, "name": "OBJECT_SEARCH", "kind": 16, "kindString": "Enumeration member", @@ -7339,7 +7808,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 82, + "line": 83, "character": 4 } ], @@ -7351,22 +7820,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2956, - 2957, - 2955 + 3012, + 3013, + 3011 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 81, + "line": 82, "character": 12 } ] }, { - "id": 2720, + "id": 2776, "name": "HomepageModule", "kind": 4, "kindString": "Enumeration", @@ -7383,7 +7852,7 @@ }, "children": [ { - "id": 2723, + "id": 2779, "name": "Favorite", "kind": 16, "kindString": "Enumeration member", @@ -7394,14 +7863,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1782, + "line": 1810, "character": 4 } ], "defaultValue": "\"FAVORITE\"" }, { - "id": 2726, + "id": 2782, "name": "Learning", "kind": 16, "kindString": "Enumeration member", @@ -7412,14 +7881,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1794, + "line": 1822, "character": 4 } ], "defaultValue": "\"LEARNING\"" }, { - "id": 2724, + "id": 2780, "name": "MyLibrary", "kind": 16, "kindString": "Enumeration member", @@ -7430,14 +7899,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1786, + "line": 1814, "character": 4 } ], "defaultValue": "\"MY_LIBRARY\"" }, { - "id": 2721, + "id": 2777, "name": "Search", "kind": 16, "kindString": "Enumeration member", @@ -7448,14 +7917,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1774, + "line": 1802, "character": 4 } ], "defaultValue": "\"SEARCH\"" }, { - "id": 2725, + "id": 2781, "name": "Trending", "kind": 16, "kindString": "Enumeration member", @@ -7466,14 +7935,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1790, + "line": 1818, "character": 4 } ], "defaultValue": "\"TRENDING\"" }, { - "id": 2722, + "id": 2778, "name": "Watchlist", "kind": 16, "kindString": "Enumeration member", @@ -7484,7 +7953,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1778, + "line": 1806, "character": 4 } ], @@ -7496,25 +7965,25 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2723, - 2726, - 2724, - 2721, - 2725, - 2722 + 2779, + 2782, + 2780, + 2777, + 2781, + 2778 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1770, + "line": 1798, "character": 12 } ] }, { - "id": 2097, + "id": 2137, "name": "HostEvent", "kind": 4, "kindString": "Enumeration", @@ -7543,7 +8012,7 @@ }, "children": [ { - "id": 2119, + "id": 2159, "name": "AIHighlights", "kind": 16, "kindString": "Enumeration member", @@ -7564,14 +8033,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3597, + "line": 3625, "character": 4 } ], "defaultValue": "\"AIHighlights\"" }, { - "id": 2108, + "id": 2148, "name": "AddColumns", "kind": 16, "kindString": "Enumeration member", @@ -7597,14 +8066,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3402, + "line": 3430, "character": 4 } ], "defaultValue": "\"addColumns\"" }, { - "id": 2162, + "id": 2202, "name": "AddToCoaching", "kind": 16, "kindString": "Enumeration member", @@ -7630,14 +8099,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4432, + "line": 4460, "character": 4 } ], "defaultValue": "\"addToCoaching\"" }, { - "id": 2166, + "id": 2206, "name": "AnswerChartSwitcher", "kind": 16, "kindString": "Enumeration member", @@ -7663,14 +8132,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4474, + "line": 4502, "character": 4 } ], "defaultValue": "\"answerChartSwitcher\"" }, { - "id": 2149, + "id": 2189, "name": "AskSage", "kind": 16, "kindString": "Enumeration member", @@ -7691,14 +8160,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4247, + "line": 4275, "character": 4 } ], "defaultValue": "\"AskSage\"" }, { - "id": 2169, + "id": 2209, "name": "AskSpotter", "kind": 16, "kindString": "Enumeration member", @@ -7724,14 +8193,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4512, + "line": 4540, "character": 4 } ], "defaultValue": "\"AskSpotter\"" }, { - "id": 2126, + "id": 2166, "name": "CopyLink", "kind": 16, "kindString": "Enumeration member", @@ -7757,14 +8226,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3733, + "line": 3761, "character": 4 } ], "defaultValue": "\"embedDocument\"" }, { - "id": 2123, + "id": 2163, "name": "CreateMonitor", "kind": 16, "kindString": "Enumeration member", @@ -7794,14 +8263,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3671, + "line": 3699, "character": 4 } ], "defaultValue": "\"createMonitor\"" }, { - "id": 2163, + "id": 2203, "name": "DataModelInstructions", "kind": 16, "kindString": "Enumeration member", @@ -7822,14 +8291,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4441, + "line": 4469, "character": 4 } ], "defaultValue": "\"DataModelInstructions\"" }, { - "id": 2130, + "id": 2170, "name": "Delete", "kind": 16, "kindString": "Enumeration member", @@ -7855,14 +8324,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3817, + "line": 3845, "character": 4 } ], "defaultValue": "\"onDeleteAnswer\"" }, { - "id": 2165, + "id": 2205, "name": "DeleteLastPrompt", "kind": 16, "kindString": "Enumeration member", @@ -7883,14 +8352,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4459, + "line": 4487, "character": 4 } ], "defaultValue": "\"DeleteLastPrompt\"" }, { - "id": 2171, + "id": 2211, "name": "DestroyEmbed", "kind": 16, "kindString": "Enumeration member", @@ -7911,14 +8380,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4532, + "line": 4560, "character": 4 } ], "defaultValue": "\"EmbedDestroyed\"" }, { - "id": 2132, + "id": 2172, "name": "Download", "kind": 16, "kindString": "Enumeration member", @@ -7948,14 +8417,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3863, + "line": 3891, "character": 4 } ], "defaultValue": "\"downloadAsPng\"" }, { - "id": 2134, + "id": 2174, "name": "DownloadAsCsv", "kind": 16, "kindString": "Enumeration member", @@ -7981,14 +8450,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3914, + "line": 3942, "character": 4 } ], "defaultValue": "\"downloadAsCSV\"" }, { - "id": 2118, + "id": 2158, "name": "DownloadAsPdf", "kind": 16, "kindString": "Enumeration member", @@ -8018,14 +8487,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3587, + "line": 3615, "character": 4 } ], "defaultValue": "\"downloadAsPdf\"" }, { - "id": 2133, + "id": 2173, "name": "DownloadAsPng", "kind": 16, "kindString": "Enumeration member", @@ -8046,14 +8515,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3887, + "line": 3915, "character": 4 } ], "defaultValue": "\"downloadAsPng\"" }, { - "id": 2135, + "id": 2175, "name": "DownloadAsXlsx", "kind": 16, "kindString": "Enumeration member", @@ -8079,14 +8548,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3941, + "line": 3969, "character": 4 } ], "defaultValue": "\"downloadAsXLSX\"" }, { - "id": 2099, + "id": 2139, "name": "DrillDown", "kind": 16, "kindString": "Enumeration member", @@ -8136,14 +8605,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3279, + "line": 3307, "character": 4 } ], "defaultValue": "\"triggerDrillDown\"" }, { - "id": 2125, + "id": 2165, "name": "Edit", "kind": 16, "kindString": "Enumeration member", @@ -8179,14 +8648,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3716, + "line": 3744, "character": 4 } ], "defaultValue": "\"edit\"" }, { - "id": 2160, + "id": 2200, "name": "EditLastPrompt", "kind": 16, "kindString": "Enumeration member", @@ -8212,14 +8681,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4412, + "line": 4440, "character": 4 } ], "defaultValue": "\"EditLastPrompt\"" }, { - "id": 2116, + "id": 2156, "name": "EditTML", "kind": 16, "kindString": "Enumeration member", @@ -8240,14 +8709,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3551, + "line": 3579, "character": 4 } ], "defaultValue": "\"editTSL\"" }, { - "id": 2122, + "id": 2162, "name": "Explore", "kind": 16, "kindString": "Enumeration member", @@ -8273,14 +8742,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3654, + "line": 3682, "character": 4 } ], "defaultValue": "\"explore\"" }, { - "id": 2115, + "id": 2155, "name": "ExportTML", "kind": 16, "kindString": "Enumeration member", @@ -8301,14 +8770,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3541, + "line": 3569, "character": 4 } ], "defaultValue": "\"exportTSL\"" }, { - "id": 2148, + "id": 2188, "name": "GetAnswerSession", "kind": 16, "kindString": "Enumeration member", @@ -8334,14 +8803,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4237, + "line": 4265, "character": 4 } ], "defaultValue": "\"getAnswerSession\"" }, { - "id": 2142, + "id": 2182, "name": "GetFilters", "kind": 16, "kindString": "Enumeration member", @@ -8362,14 +8831,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4064, + "line": 4092, "character": 4 } ], "defaultValue": "\"getFilters\"" }, { - "id": 2102, + "id": 2142, "name": "GetIframeUrl", "kind": 16, "kindString": "Enumeration member", @@ -8390,14 +8859,42 @@ "sources": [ { "fileName": "types.ts", - "line": 3299, + "line": 3327, "character": 4 } ], "defaultValue": "\"GetIframeUrl\"" }, { - "id": 2153, + "id": 2213, + "name": "GetPageContext", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded page.", + "tags": [ + { + "tag": "example", + "text": "\n```js\nconst context = await liveboardEmbed.trigger(HostEvent.GetPageContext);\n```" + }, + { + "tag": "version", + "text": "SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 4582, + "character": 4 + } + ], + "defaultValue": "\"GetPageContext\"" + }, + { + "id": 2193, "name": "GetParameters", "kind": 16, "kindString": "Enumeration member", @@ -8419,14 +8916,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4312, + "line": 4340, "character": 4 } ], "defaultValue": "\"GetParameters\"" }, { - "id": 2128, + "id": 2168, "name": "GetTML", "kind": 16, "kindString": "Enumeration member", @@ -8451,14 +8948,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3781, + "line": 3809, "character": 4 } ], "defaultValue": "\"getTML\"" }, { - "id": 2144, + "id": 2184, "name": "GetTabs", "kind": 16, "kindString": "Enumeration member", @@ -8479,14 +8976,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4167, + "line": 4195, "character": 4 } ], "defaultValue": "\"getTabs\"" }, { - "id": 2112, + "id": 2152, "name": "LiveboardInfo", "kind": 16, "kindString": "Enumeration member", @@ -8507,14 +9004,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3513, + "line": 3541, "character": 4 } ], "defaultValue": "\"pinboardInfo\"" }, { - "id": 2120, + "id": 2160, "name": "MakeACopy", "kind": 16, "kindString": "Enumeration member", @@ -8551,14 +9048,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3630, + "line": 3658, "character": 4 } ], "defaultValue": "\"makeACopy\"" }, { - "id": 2124, + "id": 2164, "name": "ManageMonitor", "kind": 16, "kindString": "Enumeration member", @@ -8592,14 +9089,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3692, + "line": 3720, "character": 4 } ], "defaultValue": "\"manageMonitor\"" }, { - "id": 2140, + "id": 2180, "name": "ManagePipelines", "kind": 16, "kindString": "Enumeration member", @@ -8625,14 +9122,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4041, + "line": 4069, "character": 4 } ], "defaultValue": "\"manage-pipeline\"" }, { - "id": 2106, + "id": 2146, "name": "Navigate", "kind": 16, "kindString": "Enumeration member", @@ -8658,14 +9155,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3372, + "line": 3400, "character": 4 } ], "defaultValue": "\"Navigate\"" }, { - "id": 2107, + "id": 2147, "name": "OpenFilter", "kind": 16, "kindString": "Enumeration member", @@ -8695,14 +9192,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3392, + "line": 3420, "character": 4 } ], "defaultValue": "\"openFilter\"" }, { - "id": 2111, + "id": 2151, "name": "Pin", "kind": 16, "kindString": "Enumeration member", @@ -8763,14 +9260,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3503, + "line": 3531, "character": 4 } ], "defaultValue": "\"pin\"" }, { - "id": 2127, + "id": 2167, "name": "Present", "kind": 16, "kindString": "Enumeration member", @@ -8796,14 +9293,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3750, + "line": 3778, "character": 4 } ], "defaultValue": "\"present\"" }, { - "id": 2161, + "id": 2201, "name": "PreviewSpotterData", "kind": 16, "kindString": "Enumeration member", @@ -8824,14 +9321,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4421, + "line": 4449, "character": 4 } ], "defaultValue": "\"PreviewSpotterData\"" }, { - "id": 2121, + "id": 2161, "name": "Remove", "kind": 16, "kindString": "Enumeration member", @@ -8856,14 +9353,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3644, + "line": 3672, "character": 4 } ], "defaultValue": "\"delete\"" }, { - "id": 2109, + "id": 2149, "name": "RemoveColumn", "kind": 16, "kindString": "Enumeration member", @@ -8889,14 +9386,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3412, + "line": 3440, "character": 4 } ], "defaultValue": "\"removeColumn\"" }, { - "id": 2151, + "id": 2191, "name": "ResetLiveboardPersonalisedView", "kind": 16, "kindString": "Enumeration member", @@ -8917,14 +9414,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4272, + "line": 4300, "character": 4 } ], "defaultValue": "\"ResetLiveboardPersonalisedView\"" }, { - "id": 2141, + "id": 2181, "name": "ResetSearch", "kind": 16, "kindString": "Enumeration member", @@ -8945,14 +9442,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4053, + "line": 4081, "character": 4 } ], "defaultValue": "\"resetSearch\"" }, { - "id": 2164, + "id": 2204, "name": "ResetSpotterConversation", "kind": 16, "kindString": "Enumeration member", @@ -8973,14 +9470,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4450, + "line": 4478, "character": 4 } ], "defaultValue": "\"ResetSpotterConversation\"" }, { - "id": 2137, + "id": 2177, "name": "Save", "kind": 16, "kindString": "Enumeration member", @@ -9006,14 +9503,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3994, + "line": 4022, "character": 4 } ], "defaultValue": "\"save\"" }, { - "id": 2156, + "id": 2196, "name": "SaveAnswer", "kind": 16, "kindString": "Enumeration member", @@ -9053,14 +9550,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4362, + "line": 4390, "character": 4 } ], "defaultValue": "\"saveAnswer\"" }, { - "id": 2113, + "id": 2153, "name": "Schedule", "kind": 16, "kindString": "Enumeration member", @@ -9081,14 +9578,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3522, + "line": 3550, "character": 4 } ], "defaultValue": "\"subscription\"" }, { - "id": 2114, + "id": 2154, "name": "SchedulesList", "kind": 16, "kindString": "Enumeration member", @@ -9109,14 +9606,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3531, + "line": 3559, "character": 4 } ], "defaultValue": "\"schedule-list\"" }, { - "id": 2098, + "id": 2138, "name": "Search", "kind": 16, "kindString": "Enumeration member", @@ -9148,14 +9645,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3228, + "line": 3256, "character": 4 } ], "defaultValue": "\"search\"" }, { - "id": 2104, + "id": 2144, "name": "SetActiveTab", "kind": 16, "kindString": "Enumeration member", @@ -9181,14 +9678,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3324, + "line": 3352, "character": 4 } ], "defaultValue": "\"SetActiveTab\"" }, { - "id": 2146, + "id": 2186, "name": "SetHiddenTabs", "kind": 16, "kindString": "Enumeration member", @@ -9214,14 +9711,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4193, + "line": 4221, "character": 4 } ], "defaultValue": "\"SetPinboardHiddenTabs\"" }, { - "id": 2145, + "id": 2185, "name": "SetVisibleTabs", "kind": 16, "kindString": "Enumeration member", @@ -9247,14 +9744,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4180, + "line": 4208, "character": 4 } ], "defaultValue": "\"SetPinboardVisibleTabs\"" }, { - "id": 2103, + "id": 2143, "name": "SetVisibleVizs", "kind": 16, "kindString": "Enumeration member", @@ -9280,14 +9777,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3312, + "line": 3340, "character": 4 } ], "defaultValue": "\"SetPinboardVisibleVizs\"" }, { - "id": 2136, + "id": 2176, "name": "Share", "kind": 16, "kindString": "Enumeration member", @@ -9308,14 +9805,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3954, + "line": 3982, "character": 4 } ], "defaultValue": "\"share\"" }, { - "id": 2129, + "id": 2169, "name": "ShowUnderlyingData", "kind": 16, "kindString": "Enumeration member", @@ -9341,14 +9838,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3800, + "line": 3828, "character": 4 } ], "defaultValue": "\"showUnderlyingData\"" }, { - "id": 2131, + "id": 2171, "name": "SpotIQAnalyze", "kind": 16, "kindString": "Enumeration member", @@ -9374,14 +9871,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3837, + "line": 3865, "character": 4 } ], "defaultValue": "\"spotIQAnalyze\"" }, { - "id": 2159, + "id": 2199, "name": "SpotterSearch", "kind": 16, "kindString": "Enumeration member", @@ -9412,14 +9909,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4402, + "line": 4430, "character": 4 } ], "defaultValue": "\"SpotterSearch\"" }, { - "id": 2172, + "id": 2212, "name": "StartNewSpotterConversation", "kind": 16, "kindString": "Enumeration member", @@ -9436,14 +9933,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4544, + "line": 4572, "character": 4 } ], "defaultValue": "\"StartNewSpotterConversation\"" }, { - "id": 2139, + "id": 2179, "name": "SyncToOtherApps", "kind": 16, "kindString": "Enumeration member", @@ -9469,14 +9966,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4025, + "line": 4053, "character": 4 } ], "defaultValue": "\"sync-to-other-apps\"" }, { - "id": 2138, + "id": 2178, "name": "SyncToSheets", "kind": 16, "kindString": "Enumeration member", @@ -9502,14 +9999,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4009, + "line": 4037, "character": 4 } ], "defaultValue": "\"sync-to-sheets\"" }, { - "id": 2158, + "id": 2198, "name": "TransformTableVizData", "kind": 16, "kindString": "Enumeration member", @@ -9535,14 +10032,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4387, + "line": 4415, "character": 4 } ], "defaultValue": "\"TransformTableVizData\"" }, { - "id": 2150, + "id": 2190, "name": "UpdateCrossFilter", "kind": 16, "kindString": "Enumeration member", @@ -9563,14 +10060,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4263, + "line": 4291, "character": 4 } ], "defaultValue": "\"UpdateCrossFilter\"" }, { - "id": 2143, + "id": 2183, "name": "UpdateFilters", "kind": 16, "kindString": "Enumeration member", @@ -9613,14 +10110,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4154, + "line": 4182, "character": 4 } ], "defaultValue": "\"updateFilters\"" }, { - "id": 2152, + "id": 2192, "name": "UpdateParameters", "kind": 16, "kindString": "Enumeration member", @@ -9651,14 +10148,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4292, + "line": 4320, "character": 4 } ], "defaultValue": "\"UpdateParameters\"" }, { - "id": 2154, + "id": 2194, "name": "UpdatePersonalisedView", "kind": 16, "kindString": "Enumeration member", @@ -9675,14 +10172,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4320, + "line": 4348, "character": 4 } ], "defaultValue": "\"UpdatePersonalisedView\"" }, { - "id": 2105, + "id": 2145, "name": "UpdateRuntimeFilters", "kind": 16, "kindString": "Enumeration member", @@ -9713,14 +10210,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3360, + "line": 3388, "character": 4 } ], "defaultValue": "\"UpdateRuntimeFilters\"" }, { - "id": 2147, + "id": 2187, "name": "UpdateSageQuery", "kind": 16, "kindString": "Enumeration member", @@ -9751,14 +10248,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4207, + "line": 4235, "character": 4 } ], "defaultValue": "\"updateSageQuery\"" }, { - "id": 2117, + "id": 2157, "name": "UpdateTML", "kind": 16, "kindString": "Enumeration member", @@ -9779,14 +10276,14 @@ "sources": [ { "fileName": "types.ts", - "line": 3560, + "line": 3588, "character": 4 } ], "defaultValue": "\"updateTSL\"" }, { - "id": 2110, + "id": 2150, "name": "getExportRequestForCurrentPinboard", "kind": 16, "kindString": "Enumeration member", @@ -9807,7 +10304,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3428, + "line": 3456, "character": 4 } ], @@ -9819,87 +10316,88 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2119, - 2108, - 2162, + 2159, + 2148, + 2202, + 2206, + 2189, + 2209, 2166, - 2149, - 2169, - 2126, - 2123, 2163, - 2130, + 2203, + 2170, + 2205, + 2211, + 2172, + 2174, + 2158, + 2173, + 2175, + 2139, 2165, - 2171, - 2132, - 2134, - 2118, - 2133, - 2135, - 2099, - 2125, - 2160, - 2116, - 2122, - 2115, - 2148, + 2200, + 2156, + 2162, + 2155, + 2188, + 2182, 2142, - 2102, - 2153, - 2128, - 2144, - 2112, - 2120, - 2124, - 2140, - 2106, - 2107, - 2111, - 2127, - 2161, - 2121, - 2109, - 2151, - 2141, + 2213, + 2193, + 2168, + 2184, + 2152, + 2160, 2164, - 2137, - 2156, - 2113, - 2114, - 2098, - 2104, + 2180, 2146, - 2145, - 2103, - 2136, - 2129, - 2131, - 2159, - 2172, - 2139, + 2147, + 2151, + 2167, + 2201, + 2161, + 2149, + 2191, + 2181, + 2204, + 2177, + 2196, + 2153, + 2154, 2138, - 2158, - 2150, + 2144, + 2186, + 2185, 2143, - 2152, - 2154, - 2105, - 2147, - 2117, - 2110 + 2176, + 2169, + 2171, + 2199, + 2212, + 2179, + 2178, + 2198, + 2190, + 2183, + 2192, + 2194, + 2145, + 2187, + 2157, + 2150 ] } ], "sources": [ { "fileName": "types.ts", - "line": 3208, + "line": 3236, "character": 12 } ] }, { - "id": 3016, + "id": 3072, "name": "InterceptedApiType", "kind": 4, "kindString": "Enumeration", @@ -9909,7 +10407,7 @@ }, "children": [ { - "id": 3018, + "id": 3074, "name": "ALL", "kind": 16, "kindString": "Enumeration member", @@ -9920,14 +10418,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6455, + "line": 6504, "character": 4 } ], "defaultValue": "\"ALL\"" }, { - "id": 3017, + "id": 3073, "name": "AnswerData", "kind": 16, "kindString": "Enumeration member", @@ -9938,14 +10436,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6451, + "line": 6500, "character": 4 } ], "defaultValue": "\"AnswerData\"" }, { - "id": 3019, + "id": 3075, "name": "LiveboardData", "kind": 16, "kindString": "Enumeration member", @@ -9956,7 +10454,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6459, + "line": 6508, "character": 4 } ], @@ -9968,22 +10466,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3018, - 3017, - 3019 + 3074, + 3073, + 3075 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6447, + "line": 6496, "character": 12 } ] }, { - "id": 2963, + "id": 3019, "name": "ListPage", "kind": 4, "kindString": "Enumeration", @@ -9999,7 +10497,7 @@ }, "children": [ { - "id": 2964, + "id": 3020, "name": "List", "kind": 16, "kindString": "Enumeration member", @@ -10010,14 +10508,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 126, + "line": 127, "character": 4 } ], "defaultValue": "\"v2\"" }, { - "id": 2965, + "id": 3021, "name": "ListWithUXChanges", "kind": 16, "kindString": "Enumeration member", @@ -10028,7 +10526,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 130, + "line": 131, "character": 4 } ], @@ -10040,21 +10538,21 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2964, - 2965 + 3020, + 3021 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 121, + "line": 122, "character": 12 } ] }, { - "id": 2997, + "id": 3053, "name": "ListPageColumns", "kind": 4, "kindString": "Enumeration", @@ -10070,7 +10568,7 @@ }, "children": [ { - "id": 3000, + "id": 3056, "name": "Author", "kind": 16, "kindString": "Enumeration member", @@ -10081,14 +10579,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1815, + "line": 1843, "character": 4 } ], "defaultValue": "\"AUTHOR\"" }, { - "id": 3001, + "id": 3057, "name": "DateSort", "kind": 16, "kindString": "Enumeration member", @@ -10099,14 +10597,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1819, + "line": 1847, "character": 4 } ], "defaultValue": "\"DATE_SORT\"" }, { - "id": 2998, + "id": 3054, "name": "Favourite", "kind": 16, "kindString": "Enumeration member", @@ -10117,14 +10615,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1807, + "line": 1835, "character": 4 } ], "defaultValue": "\"FAVOURITE\"" }, { - "id": 3002, + "id": 3058, "name": "Share", "kind": 16, "kindString": "Enumeration member", @@ -10135,14 +10633,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1823, + "line": 1851, "character": 4 } ], "defaultValue": "\"SHARE\"" }, { - "id": 2999, + "id": 3055, "name": "Tags", "kind": 16, "kindString": "Enumeration member", @@ -10153,7 +10651,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1811, + "line": 1839, "character": 4 } ], @@ -10165,24 +10663,24 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3000, - 3001, - 2998, - 3002, - 2999 + 3056, + 3057, + 3054, + 3058, + 3055 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1803, + "line": 1831, "character": 12 } ] }, { - "id": 2931, + "id": 2987, "name": "LogLevel", "kind": 4, "kindString": "Enumeration", @@ -10192,7 +10690,7 @@ }, "children": [ { - "id": 2936, + "id": 2992, "name": "DEBUG", "kind": 16, "kindString": "Enumeration member", @@ -10213,14 +10711,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6253, + "line": 6291, "character": 4 } ], "defaultValue": "\"DEBUG\"" }, { - "id": 2933, + "id": 2989, "name": "ERROR", "kind": 16, "kindString": "Enumeration member", @@ -10241,14 +10739,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6214, + "line": 6252, "character": 4 } ], "defaultValue": "\"ERROR\"" }, { - "id": 2935, + "id": 2991, "name": "INFO", "kind": 16, "kindString": "Enumeration member", @@ -10269,14 +10767,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6239, + "line": 6277, "character": 4 } ], "defaultValue": "\"INFO\"" }, { - "id": 2932, + "id": 2988, "name": "SILENT", "kind": 16, "kindString": "Enumeration member", @@ -10297,14 +10795,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6202, + "line": 6240, "character": 4 } ], "defaultValue": "\"SILENT\"" }, { - "id": 2937, + "id": 2993, "name": "TRACE", "kind": 16, "kindString": "Enumeration member", @@ -10325,14 +10823,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6265, + "line": 6303, "character": 4 } ], "defaultValue": "\"TRACE\"" }, { - "id": 2934, + "id": 2990, "name": "WARN", "kind": 16, "kindString": "Enumeration member", @@ -10353,7 +10851,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6226, + "line": 6264, "character": 4 } ], @@ -10365,25 +10863,25 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2936, - 2933, - 2935, - 2932, - 2937, - 2934 + 2992, + 2989, + 2991, + 2988, + 2993, + 2990 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6189, + "line": 6227, "character": 12 } ] }, { - "id": 1958, + "id": 1998, "name": "Page", "kind": 4, "kindString": "Enumeration", @@ -10393,7 +10891,7 @@ }, "children": [ { - "id": 1961, + "id": 2001, "name": "Answers", "kind": 16, "kindString": "Enumeration member", @@ -10404,14 +10902,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 39, + "line": 40, "character": 4 } ], "defaultValue": "\"answers\"" }, { - "id": 1964, + "id": 2004, "name": "Data", "kind": 16, "kindString": "Enumeration member", @@ -10422,14 +10920,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 51, + "line": 52, "character": 4 } ], "defaultValue": "\"data\"" }, { - "id": 1959, + "id": 1999, "name": "Home", "kind": 16, "kindString": "Enumeration member", @@ -10440,14 +10938,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 31, + "line": 32, "character": 4 } ], "defaultValue": "\"home\"" }, { - "id": 1962, + "id": 2002, "name": "Liveboards", "kind": 16, "kindString": "Enumeration member", @@ -10458,14 +10956,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 43, + "line": 44, "character": 4 } ], "defaultValue": "\"liveboards\"" }, { - "id": 1966, + "id": 2006, "name": "Monitor", "kind": 16, "kindString": "Enumeration member", @@ -10476,14 +10974,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 59, + "line": 60, "character": 4 } ], "defaultValue": "\"monitor\"" }, { - "id": 1960, + "id": 2000, "name": "Search", "kind": 16, "kindString": "Enumeration member", @@ -10494,14 +10992,14 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 35, + "line": 36, "character": 4 } ], "defaultValue": "\"search\"" }, { - "id": 1965, + "id": 2005, "name": "SpotIQ", "kind": 16, "kindString": "Enumeration member", @@ -10512,7 +11010,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 55, + "line": 56, "character": 4 } ], @@ -10524,33 +11022,33 @@ "title": "Enumeration members", "kind": 16, "children": [ - 1961, - 1964, - 1959, - 1962, - 1966, - 1960, - 1965 + 2001, + 2004, + 1999, + 2002, + 2006, + 2000, + 2005 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 27, + "line": 28, "character": 12 } ] }, { - "id": 2698, + "id": 2754, "name": "PrefetchFeatures", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 2699, + "id": 2755, "name": "FullApp", "kind": 16, "kindString": "Enumeration member", @@ -10558,14 +11056,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6080, + "line": 6118, "character": 4 } ], "defaultValue": "\"FullApp\"" }, { - "id": 2701, + "id": 2757, "name": "LiveboardEmbed", "kind": 16, "kindString": "Enumeration member", @@ -10573,14 +11071,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6082, + "line": 6120, "character": 4 } ], "defaultValue": "\"LiveboardEmbed\"" }, { - "id": 2700, + "id": 2756, "name": "SearchEmbed", "kind": 16, "kindString": "Enumeration member", @@ -10588,14 +11086,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6081, + "line": 6119, "character": 4 } ], "defaultValue": "\"SearchEmbed\"" }, { - "id": 2702, + "id": 2758, "name": "VizEmbed", "kind": 16, "kindString": "Enumeration member", @@ -10603,7 +11101,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6083, + "line": 6121, "character": 4 } ], @@ -10615,23 +11113,23 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2699, - 2701, - 2700, - 2702 + 2755, + 2757, + 2756, + 2758 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6079, + "line": 6117, "character": 12 } ] }, { - "id": 2958, + "id": 3014, "name": "PrimaryNavbarVersion", "kind": 4, "kindString": "Enumeration", @@ -10647,7 +11145,7 @@ }, "children": [ { - "id": 2959, + "id": 3015, "name": "Sliding", "kind": 16, "kindString": "Enumeration member", @@ -10658,7 +11156,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 97, + "line": 98, "character": 4 } ], @@ -10670,20 +11168,20 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2959 + 3015 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 91, + "line": 92, "character": 12 } ] }, { - "id": 1983, + "id": 2023, "name": "RuntimeFilterOp", "kind": 4, "kindString": "Enumeration", @@ -10693,7 +11191,7 @@ }, "children": [ { - "id": 1991, + "id": 2031, "name": "BEGINS_WITH", "kind": 16, "kindString": "Enumeration member", @@ -10704,14 +11202,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1730, + "line": 1758, "character": 4 } ], "defaultValue": "\"BEGINS_WITH\"" }, { - "id": 1996, + "id": 2036, "name": "BW", "kind": 16, "kindString": "Enumeration member", @@ -10722,14 +11220,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1750, + "line": 1778, "character": 4 } ], "defaultValue": "\"BW\"" }, { - "id": 1995, + "id": 2035, "name": "BW_INC", "kind": 16, "kindString": "Enumeration member", @@ -10740,14 +11238,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1746, + "line": 1774, "character": 4 } ], "defaultValue": "\"BW_INC\"" }, { - "id": 1993, + "id": 2033, "name": "BW_INC_MAX", "kind": 16, "kindString": "Enumeration member", @@ -10758,14 +11256,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1738, + "line": 1766, "character": 4 } ], "defaultValue": "\"BW_INC_MAX\"" }, { - "id": 1994, + "id": 2034, "name": "BW_INC_MIN", "kind": 16, "kindString": "Enumeration member", @@ -10776,14 +11274,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1742, + "line": 1770, "character": 4 } ], "defaultValue": "\"BW_INC_MIN\"" }, { - "id": 1990, + "id": 2030, "name": "CONTAINS", "kind": 16, "kindString": "Enumeration member", @@ -10794,14 +11292,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1726, + "line": 1754, "character": 4 } ], "defaultValue": "\"CONTAINS\"" }, { - "id": 1992, + "id": 2032, "name": "ENDS_WITH", "kind": 16, "kindString": "Enumeration member", @@ -10812,14 +11310,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1734, + "line": 1762, "character": 4 } ], "defaultValue": "\"ENDS_WITH\"" }, { - "id": 1984, + "id": 2024, "name": "EQ", "kind": 16, "kindString": "Enumeration member", @@ -10830,14 +11328,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1702, + "line": 1730, "character": 4 } ], "defaultValue": "\"EQ\"" }, { - "id": 1989, + "id": 2029, "name": "GE", "kind": 16, "kindString": "Enumeration member", @@ -10848,14 +11346,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1722, + "line": 1750, "character": 4 } ], "defaultValue": "\"GE\"" }, { - "id": 1988, + "id": 2028, "name": "GT", "kind": 16, "kindString": "Enumeration member", @@ -10866,14 +11364,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1718, + "line": 1746, "character": 4 } ], "defaultValue": "\"GT\"" }, { - "id": 1997, + "id": 2037, "name": "IN", "kind": 16, "kindString": "Enumeration member", @@ -10884,14 +11382,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1754, + "line": 1782, "character": 4 } ], "defaultValue": "\"IN\"" }, { - "id": 1987, + "id": 2027, "name": "LE", "kind": 16, "kindString": "Enumeration member", @@ -10902,14 +11400,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1714, + "line": 1742, "character": 4 } ], "defaultValue": "\"LE\"" }, { - "id": 1986, + "id": 2026, "name": "LT", "kind": 16, "kindString": "Enumeration member", @@ -10920,14 +11418,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1710, + "line": 1738, "character": 4 } ], "defaultValue": "\"LT\"" }, { - "id": 1985, + "id": 2025, "name": "NE", "kind": 16, "kindString": "Enumeration member", @@ -10938,14 +11436,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1706, + "line": 1734, "character": 4 } ], "defaultValue": "\"NE\"" }, { - "id": 1998, + "id": 2038, "name": "NOT_IN", "kind": 16, "kindString": "Enumeration member", @@ -10956,7 +11454,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1758, + "line": 1786, "character": 4 } ], @@ -10968,41 +11466,41 @@ "title": "Enumeration members", "kind": 16, "children": [ - 1991, - 1996, - 1995, - 1993, - 1994, - 1990, - 1992, - 1984, - 1989, - 1988, - 1997, - 1987, - 1986, - 1985, - 1998 + 2031, + 2036, + 2035, + 2033, + 2034, + 2030, + 2032, + 2024, + 2029, + 2028, + 2037, + 2027, + 2026, + 2025, + 2038 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1698, + "line": 1726, "character": 12 } ] }, { - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 2994, + "id": 3050, "name": "GetAnswerConfig", "kind": 16, "kindString": "Enumeration member", @@ -11017,7 +11515,7 @@ "defaultValue": "\"getAnswerPageConfig\"" }, { - "id": 2993, + "id": 3049, "name": "GetAvailableUIPassthroughs", "kind": 16, "kindString": "Enumeration member", @@ -11032,7 +11530,7 @@ "defaultValue": "\"getAvailableUiPassthroughs\"" }, { - "id": 2992, + "id": 3048, "name": "GetDiscoverabilityStatus", "kind": 16, "kindString": "Enumeration member", @@ -11047,7 +11545,7 @@ "defaultValue": "\"getDiscoverabilityStatus\"" }, { - "id": 2995, + "id": 3051, "name": "GetLiveboardConfig", "kind": 16, "kindString": "Enumeration member", @@ -11062,7 +11560,7 @@ "defaultValue": "\"getPinboardPageConfig\"" }, { - "id": 2996, + "id": 3052, "name": "GetUnsavedAnswerTML", "kind": 16, "kindString": "Enumeration member", @@ -11077,7 +11575,7 @@ "defaultValue": "\"getUnsavedAnswerTML\"" }, { - "id": 2990, + "id": 3046, "name": "PinAnswerToLiveboard", "kind": 16, "kindString": "Enumeration member", @@ -11092,7 +11590,7 @@ "defaultValue": "\"addVizToPinboard\"" }, { - "id": 2991, + "id": 3047, "name": "SaveAnswer", "kind": 16, "kindString": "Enumeration member", @@ -11112,13 +11610,13 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2994, - 2993, - 2992, - 2995, - 2996, - 2990, - 2991 + 3050, + 3049, + 3048, + 3051, + 3052, + 3046, + 3047 ] } ], @@ -11131,7 +11629,7 @@ ] }, { - "id": 1875, + "id": 1915, "name": "AnswerService", "kind": 128, "kindString": "Class", @@ -11160,7 +11658,7 @@ }, "children": [ { - "id": 1876, + "id": 1916, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -11177,7 +11675,7 @@ ], "signatures": [ { - "id": 1877, + "id": 1917, "name": "new AnswerService", "kind": 16384, "kindString": "Constructor signature", @@ -11187,7 +11685,7 @@ }, "parameters": [ { - "id": 1878, + "id": 1918, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -11195,12 +11693,12 @@ "comment": {}, "type": { "type": "reference", - "id": 1948, + "id": 1988, "name": "SessionInterface" } }, { - "id": 1879, + "id": 1919, "name": "answer", "kind": 32768, "kindString": "Parameter", @@ -11212,7 +11710,7 @@ } }, { - "id": 1880, + "id": 1920, "name": "thoughtSpotHost", "kind": 32768, "kindString": "Parameter", @@ -11224,7 +11722,7 @@ } }, { - "id": 1881, + "id": 1921, "name": "selectedPoints", "kind": 32768, "kindString": "Parameter", @@ -11238,7 +11736,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2966, + "id": 3022, "name": "VizPoint" } } @@ -11246,14 +11744,14 @@ ], "type": { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } } ] }, { - "id": 1890, + "id": 1930, "name": "addColumns", "kind": 2048, "kindString": "Method", @@ -11269,7 +11767,7 @@ ], "signatures": [ { - "id": 1891, + "id": 1931, "name": "addColumns", "kind": 4096, "kindString": "Call signature", @@ -11280,7 +11778,7 @@ }, "parameters": [ { - "id": 1892, + "id": 1932, "name": "columnIds", "kind": 32768, "kindString": "Parameter", @@ -11309,7 +11807,7 @@ ] }, { - "id": 1893, + "id": 1933, "name": "addColumnsByName", "kind": 2048, "kindString": "Method", @@ -11325,7 +11823,7 @@ ], "signatures": [ { - "id": 1894, + "id": 1934, "name": "addColumnsByName", "kind": 4096, "kindString": "Call signature", @@ -11341,7 +11839,7 @@ }, "parameters": [ { - "id": 1895, + "id": 1935, "name": "columnNames", "kind": 32768, "kindString": "Parameter", @@ -11370,7 +11868,7 @@ ] }, { - "id": 1942, + "id": 1982, "name": "addDisplayedVizToLiveboard", "kind": 2048, "kindString": "Method", @@ -11386,14 +11884,14 @@ ], "signatures": [ { - "id": 1943, + "id": 1983, "name": "addDisplayedVizToLiveboard", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1944, + "id": 1984, "name": "liveboardId", "kind": 32768, "kindString": "Parameter", @@ -11418,7 +11916,7 @@ ] }, { - "id": 1896, + "id": 1936, "name": "addFilter", "kind": 2048, "kindString": "Method", @@ -11434,7 +11932,7 @@ ], "signatures": [ { - "id": 1897, + "id": 1937, "name": "addFilter", "kind": 4096, "kindString": "Call signature", @@ -11445,7 +11943,7 @@ }, "parameters": [ { - "id": 1898, + "id": 1938, "name": "columnName", "kind": 32768, "kindString": "Parameter", @@ -11457,7 +11955,7 @@ } }, { - "id": 1899, + "id": 1939, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -11465,12 +11963,12 @@ "comment": {}, "type": { "type": "reference", - "id": 1983, + "id": 2023, "name": "RuntimeFilterOp" } }, { - "id": 1900, + "id": 1940, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -11516,7 +12014,7 @@ ] }, { - "id": 1932, + "id": 1972, "name": "executeQuery", "kind": 2048, "kindString": "Method", @@ -11532,7 +12030,7 @@ ], "signatures": [ { - "id": 1933, + "id": 1973, "name": "executeQuery", "kind": 4096, "kindString": "Call signature", @@ -11543,7 +12041,7 @@ }, "parameters": [ { - "id": 1934, + "id": 1974, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -11557,7 +12055,7 @@ } }, { - "id": 1935, + "id": 1975, "name": "variables", "kind": 32768, "kindString": "Parameter", @@ -11585,7 +12083,7 @@ ] }, { - "id": 1910, + "id": 1950, "name": "fetchCSVBlob", "kind": 2048, "kindString": "Method", @@ -11601,7 +12099,7 @@ ], "signatures": [ { - "id": 1911, + "id": 1951, "name": "fetchCSVBlob", "kind": 4096, "kindString": "Call signature", @@ -11612,7 +12110,7 @@ }, "parameters": [ { - "id": 1912, + "id": 1952, "name": "userLocale", "kind": 32768, "kindString": "Parameter", @@ -11625,7 +12123,7 @@ "defaultValue": "'en-us'" }, { - "id": 1913, + "id": 1953, "name": "includeInfo", "kind": 32768, "kindString": "Parameter", @@ -11654,7 +12152,7 @@ ] }, { - "id": 1903, + "id": 1943, "name": "fetchData", "kind": 2048, "kindString": "Method", @@ -11670,7 +12168,7 @@ ], "signatures": [ { - "id": 1904, + "id": 1944, "name": "fetchData", "kind": 4096, "kindString": "Call signature", @@ -11681,7 +12179,7 @@ }, "parameters": [ { - "id": 1905, + "id": 1945, "name": "offset", "kind": 32768, "kindString": "Parameter", @@ -11694,7 +12192,7 @@ "defaultValue": "0" }, { - "id": 1906, + "id": 1946, "name": "size", "kind": 32768, "kindString": "Parameter", @@ -11713,14 +12211,14 @@ { "type": "reflection", "declaration": { - "id": 1907, + "id": 1947, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1908, + "id": 1948, "name": "columns", "kind": 1024, "kindString": "Property", @@ -11731,7 +12229,7 @@ } }, { - "id": 1909, + "id": 1949, "name": "data", "kind": 1024, "kindString": "Property", @@ -11747,8 +12245,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1908, - 1909 + 1948, + 1949 ] } ] @@ -11761,7 +12259,7 @@ ] }, { - "id": 1914, + "id": 1954, "name": "fetchPNGBlob", "kind": 2048, "kindString": "Method", @@ -11777,7 +12275,7 @@ ], "signatures": [ { - "id": 1915, + "id": 1955, "name": "fetchPNGBlob", "kind": 4096, "kindString": "Call signature", @@ -11788,7 +12286,7 @@ }, "parameters": [ { - "id": 1916, + "id": 1956, "name": "userLocale", "kind": 32768, "kindString": "Parameter", @@ -11801,7 +12299,7 @@ "defaultValue": "'en-us'" }, { - "id": 1917, + "id": 1957, "name": "omitBackground", "kind": 32768, "kindString": "Parameter", @@ -11816,7 +12314,7 @@ "defaultValue": "false" }, { - "id": 1918, + "id": 1958, "name": "deviceScaleFactor", "kind": 32768, "kindString": "Parameter", @@ -11845,7 +12343,7 @@ ] }, { - "id": 1938, + "id": 1978, "name": "getAnswer", "kind": 2048, "kindString": "Method", @@ -11861,7 +12359,7 @@ ], "signatures": [ { - "id": 1939, + "id": 1979, "name": "getAnswer", "kind": 4096, "kindString": "Call signature", @@ -11880,7 +12378,7 @@ ] }, { - "id": 1919, + "id": 1959, "name": "getFetchCSVBlobUrl", "kind": 2048, "kindString": "Method", @@ -11896,7 +12394,7 @@ ], "signatures": [ { - "id": 1920, + "id": 1960, "name": "getFetchCSVBlobUrl", "kind": 4096, "kindString": "Call signature", @@ -11907,7 +12405,7 @@ }, "parameters": [ { - "id": 1921, + "id": 1961, "name": "userLocale", "kind": 32768, "kindString": "Parameter", @@ -11920,7 +12418,7 @@ "defaultValue": "'en-us'" }, { - "id": 1922, + "id": 1962, "name": "includeInfo", "kind": 32768, "kindString": "Parameter", @@ -11941,7 +12439,7 @@ ] }, { - "id": 1923, + "id": 1963, "name": "getFetchPNGBlobUrl", "kind": 2048, "kindString": "Method", @@ -11957,7 +12455,7 @@ ], "signatures": [ { - "id": 1924, + "id": 1964, "name": "getFetchPNGBlobUrl", "kind": 4096, "kindString": "Call signature", @@ -11967,7 +12465,7 @@ }, "parameters": [ { - "id": 1925, + "id": 1965, "name": "userLocale", "kind": 32768, "kindString": "Parameter", @@ -11980,7 +12478,7 @@ "defaultValue": "'en-us'" }, { - "id": 1926, + "id": 1966, "name": "omitBackground", "kind": 32768, "kindString": "Parameter", @@ -11993,7 +12491,7 @@ "defaultValue": "false" }, { - "id": 1927, + "id": 1967, "name": "deviceScaleFactor", "kind": 32768, "kindString": "Parameter", @@ -12016,7 +12514,7 @@ ] }, { - "id": 1901, + "id": 1941, "name": "getSQLQuery", "kind": 2048, "kindString": "Method", @@ -12032,7 +12530,7 @@ ], "signatures": [ { - "id": 1902, + "id": 1942, "name": "getSQLQuery", "kind": 4096, "kindString": "Call signature", @@ -12051,7 +12549,7 @@ ] }, { - "id": 1936, + "id": 1976, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -12067,7 +12565,7 @@ ], "signatures": [ { - "id": 1937, + "id": 1977, "name": "getSession", "kind": 4096, "kindString": "Call signature", @@ -12078,14 +12576,14 @@ }, "type": { "type": "reference", - "id": 1948, + "id": 1988, "name": "SessionInterface" } } ] }, { - "id": 1885, + "id": 1925, "name": "getSourceDetail", "kind": 2048, "kindString": "Method", @@ -12101,7 +12599,7 @@ ], "signatures": [ { - "id": 1886, + "id": 1926, "name": "getSourceDetail", "kind": 4096, "kindString": "Call signature", @@ -12123,7 +12621,7 @@ ] }, { - "id": 1940, + "id": 1980, "name": "getTML", "kind": 2048, "kindString": "Method", @@ -12139,7 +12637,7 @@ ], "signatures": [ { - "id": 1941, + "id": 1981, "name": "getTML", "kind": 4096, "kindString": "Call signature", @@ -12158,7 +12656,7 @@ ] }, { - "id": 1928, + "id": 1968, "name": "getUnderlyingDataForPoint", "kind": 2048, "kindString": "Method", @@ -12174,7 +12672,7 @@ ], "signatures": [ { - "id": 1929, + "id": 1969, "name": "getUnderlyingDataForPoint", "kind": 4096, "kindString": "Call signature", @@ -12194,7 +12692,7 @@ }, "parameters": [ { - "id": 1930, + "id": 1970, "name": "outputColumnNames", "kind": 32768, "kindString": "Parameter", @@ -12209,7 +12707,7 @@ } }, { - "id": 1931, + "id": 1971, "name": "selectedPoints", "kind": 32768, "kindString": "Parameter", @@ -12221,7 +12719,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1955, + "id": 1995, "name": "UnderlyingDataPoint" } } @@ -12232,7 +12730,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -12242,7 +12740,7 @@ ] }, { - "id": 1887, + "id": 1927, "name": "removeColumns", "kind": 2048, "kindString": "Method", @@ -12258,7 +12756,7 @@ ], "signatures": [ { - "id": 1888, + "id": 1928, "name": "removeColumns", "kind": 4096, "kindString": "Call signature", @@ -12269,7 +12767,7 @@ }, "parameters": [ { - "id": 1889, + "id": 1929, "name": "columnIds", "kind": 32768, "kindString": "Parameter", @@ -12298,7 +12796,7 @@ ] }, { - "id": 1945, + "id": 1985, "name": "setTMLOverride", "kind": 2048, "kindString": "Method", @@ -12314,14 +12812,14 @@ ], "signatures": [ { - "id": 1946, + "id": 1986, "name": "setTMLOverride", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1947, + "id": 1987, "name": "override", "kind": 32768, "kindString": "Parameter", @@ -12345,31 +12843,31 @@ "title": "Constructors", "kind": 512, "children": [ - 1876 + 1916 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1890, - 1893, - 1942, - 1896, - 1932, - 1910, - 1903, - 1914, - 1938, - 1919, - 1923, - 1901, + 1930, + 1933, + 1982, 1936, - 1885, - 1940, - 1928, - 1887, - 1945 + 1972, + 1950, + 1943, + 1954, + 1978, + 1959, + 1963, + 1941, + 1976, + 1925, + 1980, + 1968, + 1927, + 1985 ] } ], @@ -12382,7 +12880,7 @@ ] }, { - "id": 1027, + "id": 1047, "name": "AppEmbed", "kind": 128, "kindString": "Class", @@ -12398,7 +12896,7 @@ }, "children": [ { - "id": 1028, + "id": 1048, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -12406,46 +12904,46 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 670, + "line": 671, "character": 4 } ], "signatures": [ { - "id": 1029, + "id": 1049, "name": "new AppEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1030, + "id": 1050, "name": "domSelector", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2727, + "id": 2783, "name": "DOMSelector" } }, { - "id": 1031, + "id": 1051, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2608, + "id": 2662, "name": "AppViewConfig" } } ], "type": { "type": "reference", - "id": 1027, + "id": 1047, "name": "AppEmbed" }, "overwrites": { @@ -12460,7 +12958,7 @@ } }, { - "id": 1065, + "id": 1085, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -12470,13 +12968,13 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 1055, + "line": 1056, "character": 11 } ], "signatures": [ { - "id": 1066, + "id": 1086, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -12506,7 +13004,7 @@ } }, { - "id": 1241, + "id": 1265, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -12516,13 +13014,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 1242, + "id": 1266, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -12538,7 +13036,7 @@ }, "parameters": [ { - "id": 1243, + "id": 1267, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -12559,7 +13057,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -12577,7 +13075,60 @@ } }, { - "id": 1042, + "id": 1236, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/ts-embed.ts", + "line": 1437, + "character": 17 + } + ], + "signatures": [ + { + "id": 1237, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded TS component.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "name": "V1Embed.getCurrentContext" + } + } + ], + "inheritedFrom": { + "type": "reference", + "name": "V1Embed.getCurrentContext" + } + }, + { + "id": 1062, "name": "getIFrameSrc", "kind": 2048, "kindString": "Method", @@ -12587,13 +13138,13 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 924, + "line": 925, "character": 11 } ], "signatures": [ { - "id": 1043, + "id": 1063, "name": "getIFrameSrc", "kind": 4096, "kindString": "Call signature", @@ -12609,7 +13160,7 @@ ] }, { - "id": 1210, + "id": 1232, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -12619,13 +13170,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1416, + "line": 1424, "character": 11 } ], "signatures": [ { - "id": 1211, + "id": 1233, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -12646,7 +13197,7 @@ } }, { - "id": 1236, + "id": 1260, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -12656,13 +13207,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 1237, + "id": 1261, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -12684,14 +13235,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1238, + "id": 1262, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1240, + "id": 1264, "name": "child", "kind": 1024, "kindString": "Property", @@ -12703,7 +13254,7 @@ "defaultValue": "..." }, { - "id": 1239, + "id": 1263, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -12720,8 +13271,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1240, - 1239 + 1264, + 1263 ] } ] @@ -12739,7 +13290,7 @@ } }, { - "id": 1218, + "id": 1242, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -12749,13 +13300,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 1219, + "id": 1243, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -12771,7 +13322,7 @@ }, "parameters": [ { - "id": 1220, + "id": 1244, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -12779,20 +13330,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1221, + "id": 1245, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1222, + "id": 1246, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1223, + "id": 1247, "name": "key", "kind": 32768, "flags": {}, @@ -12837,7 +13388,7 @@ } }, { - "id": 1224, + "id": 1248, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -12847,13 +13398,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 1225, + "id": 1249, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -12874,7 +13425,7 @@ } }, { - "id": 1234, + "id": 1258, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -12884,13 +13435,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 1235, + "id": 1259, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -12914,7 +13465,7 @@ } }, { - "id": 1061, + "id": 1081, "name": "navigateToPage", "kind": 2048, "kindString": "Method", @@ -12924,13 +13475,13 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 1029, + "line": 1030, "character": 11 } ], "signatures": [ { - "id": 1062, + "id": 1082, "name": "navigateToPage", "kind": 4096, "kindString": "Call signature", @@ -12946,7 +13497,7 @@ }, "parameters": [ { - "id": 1063, + "id": 1083, "name": "path", "kind": 32768, "kindString": "Parameter", @@ -12969,7 +13520,7 @@ } }, { - "id": 1064, + "id": 1084, "name": "noReload", "kind": 32768, "kindString": "Parameter", @@ -12992,7 +13543,7 @@ ] }, { - "id": 1181, + "id": 1201, "name": "off", "kind": 2048, "kindString": "Method", @@ -13002,13 +13553,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 1182, + "id": 1202, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -13024,7 +13575,7 @@ }, "parameters": [ { - "id": 1183, + "id": 1203, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -13034,12 +13585,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 1184, + "id": 1204, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -13049,7 +13600,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -13070,7 +13621,7 @@ } }, { - "id": 1080, + "id": 1100, "name": "on", "kind": 2048, "kindString": "Method", @@ -13080,13 +13631,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1790, + "line": 1826, "character": 11 } ], "signatures": [ { - "id": 1081, + "id": 1101, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -13109,38 +13660,38 @@ }, "parameters": [ { - "id": 1082, + "id": 1102, "name": "messageType", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 1083, + "id": 1103, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 1084, + "id": 1104, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." @@ -13162,7 +13713,7 @@ } }, { - "id": 1214, + "id": 1238, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -13172,13 +13723,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 1215, + "id": 1239, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -13188,7 +13739,7 @@ }, "parameters": [ { - "id": 1216, + "id": 1240, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -13203,7 +13754,7 @@ "defaultValue": "false" }, { - "id": 1217, + "id": 1241, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -13237,7 +13788,7 @@ } }, { - "id": 1226, + "id": 1250, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -13247,13 +13798,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 1227, + "id": 1251, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -13290,7 +13841,7 @@ } }, { - "id": 1073, + "id": 1093, "name": "render", "kind": 2048, "kindString": "Method", @@ -13300,13 +13851,13 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 1084, + "line": 1085, "character": 17 } ], "signatures": [ { - "id": 1074, + "id": 1094, "name": "render", "kind": 4096, "kindString": "Call signature", @@ -13319,7 +13870,7 @@ "typeArguments": [ { "type": "reference", - "id": 1027, + "id": 1047, "name": "AppEmbed" } ], @@ -13337,7 +13888,7 @@ } }, { - "id": 1230, + "id": 1254, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -13347,13 +13898,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 1231, + "id": 1255, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -13383,7 +13934,7 @@ } }, { - "id": 1232, + "id": 1256, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -13393,13 +13944,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 1233, + "id": 1257, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -13429,7 +13980,7 @@ } }, { - "id": 1199, + "id": 1219, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -13439,13 +13990,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1346, + "line": 1353, "character": 17 } ], "signatures": [ { - "id": 1200, + "id": 1220, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -13456,28 +14007,40 @@ }, "typeParameter": [ { - "id": 1201, + "id": 1221, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 1202, + "id": 1222, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 1223, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 1203, + "id": 1224, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -13491,7 +14054,7 @@ } }, { - "id": 1204, + "id": 1225, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -13514,6 +14077,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 1226, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -13529,6 +14105,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -13548,7 +14128,7 @@ } }, { - "id": 1205, + "id": 1227, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -13558,13 +14138,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 1206, + "id": 1228, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -13575,21 +14155,21 @@ }, "typeParameter": [ { - "id": 1207, + "id": 1229, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 1208, + "id": 1230, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -13603,7 +14183,7 @@ } }, { - "id": 1209, + "id": 1231, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -13656,38 +14236,39 @@ "title": "Constructors", "kind": 512, "children": [ - 1028 + 1048 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1065, - 1241, - 1042, - 1210, + 1085, + 1265, 1236, - 1218, - 1224, - 1234, - 1061, - 1181, - 1080, - 1214, - 1226, - 1073, - 1230, + 1062, 1232, - 1199, - 1205 + 1260, + 1242, + 1248, + 1258, + 1081, + 1201, + 1100, + 1238, + 1250, + 1093, + 1254, + 1256, + 1219, + 1227 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 664, + "line": 665, "character": 13 } ], @@ -13699,7 +14280,7 @@ ] }, { - "id": 1340, + "id": 1368, "name": "BodylessConversation", "kind": 128, "kindString": "Class", @@ -13723,7 +14304,7 @@ }, "children": [ { - "id": 1341, + "id": 1369, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -13737,45 +14318,45 @@ ], "signatures": [ { - "id": 1342, + "id": 1370, "name": "new BodylessConversation", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1343, + "id": 1371, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1308, + "id": 1334, "name": "BodylessConversationViewConfig" } } ], "type": { "type": "reference", - "id": 1340, + "id": 1368, "name": "BodylessConversation" }, "overwrites": { "type": "reference", - "id": 1246, + "id": 1270, "name": "SpotterAgentEmbed.constructor" } } ], "overwrites": { "type": "reference", - "id": 1245, + "id": 1269, "name": "SpotterAgentEmbed.constructor" } }, { - "id": 1344, + "id": 1372, "name": "sendMessage", "kind": 2048, "kindString": "Method", @@ -13791,14 +14372,14 @@ ], "signatures": [ { - "id": 1345, + "id": 1373, "name": "sendMessage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1346, + "id": 1374, "name": "userMessage", "kind": 32768, "kindString": "Parameter", @@ -13818,14 +14399,14 @@ { "type": "reflection", "declaration": { - "id": 1347, + "id": 1375, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1349, + "id": 1377, "name": "container", "kind": 1024, "kindString": "Property", @@ -13836,7 +14417,7 @@ } }, { - "id": 1348, + "id": 1376, "name": "error", "kind": 1024, "kindString": "Property", @@ -13847,7 +14428,7 @@ } }, { - "id": 1350, + "id": 1378, "name": "viz", "kind": 1024, "kindString": "Property", @@ -13864,9 +14445,9 @@ "title": "Properties", "kind": 1024, "children": [ - 1349, - 1348, - 1350 + 1377, + 1376, + 1378 ] } ] @@ -13875,14 +14456,14 @@ { "type": "reflection", "declaration": { - "id": 1351, + "id": 1379, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1352, + "id": 1380, "name": "container", "kind": 1024, "kindString": "Property", @@ -13893,7 +14474,7 @@ } }, { - "id": 1354, + "id": 1382, "name": "error", "kind": 1024, "kindString": "Property", @@ -13904,7 +14485,7 @@ } }, { - "id": 1353, + "id": 1381, "name": "viz", "kind": 1024, "kindString": "Property", @@ -13921,9 +14502,9 @@ "title": "Properties", "kind": 1024, "children": [ - 1352, - 1354, - 1353 + 1380, + 1382, + 1381 ] } ] @@ -13936,19 +14517,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1250, + "id": 1274, "name": "SpotterAgentEmbed.sendMessage" } } ], "inheritedFrom": { "type": "reference", - "id": 1249, + "id": 1273, "name": "SpotterAgentEmbed.sendMessage" } }, { - "id": 1355, + "id": 1383, "name": "sendMessageData", "kind": 2048, "kindString": "Method", @@ -13964,7 +14545,7 @@ ], "signatures": [ { - "id": 1356, + "id": 1384, "name": "sendMessageData", "kind": 4096, "kindString": "Call signature", @@ -13975,7 +14556,7 @@ }, "parameters": [ { - "id": 1357, + "id": 1385, "name": "userMessage", "kind": 32768, "kindString": "Parameter", @@ -13998,14 +14579,14 @@ { "type": "reflection", "declaration": { - "id": 1358, + "id": 1386, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1360, + "id": 1388, "name": "data", "kind": 1024, "kindString": "Property", @@ -14017,7 +14598,7 @@ "defaultValue": "..." }, { - "id": 1359, + "id": 1387, "name": "error", "kind": 1024, "kindString": "Property", @@ -14033,8 +14614,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1360, - 1359 + 1388, + 1387 ] } ] @@ -14043,14 +14624,14 @@ { "type": "reflection", "declaration": { - "id": 1361, + "id": 1389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1362, + "id": 1390, "name": "data", "kind": 1024, "kindString": "Property", @@ -14058,14 +14639,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1363, + "id": 1391, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1369, + "id": 1397, "name": "acGenNo", "kind": 1024, "kindString": "Property", @@ -14077,7 +14658,7 @@ "defaultValue": "..." }, { - "id": 1368, + "id": 1396, "name": "acSessionId", "kind": 1024, "kindString": "Property", @@ -14089,7 +14670,7 @@ "defaultValue": "..." }, { - "id": 1364, + "id": 1392, "name": "convId", "kind": 1024, "kindString": "Property", @@ -14101,7 +14682,7 @@ "defaultValue": "..." }, { - "id": 1367, + "id": 1395, "name": "genNo", "kind": 1024, "kindString": "Property", @@ -14113,7 +14694,7 @@ "defaultValue": "..." }, { - "id": 1365, + "id": 1393, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -14125,7 +14706,7 @@ "defaultValue": "..." }, { - "id": 1366, + "id": 1394, "name": "sessionId", "kind": 1024, "kindString": "Property", @@ -14142,12 +14723,12 @@ "title": "Properties", "kind": 1024, "children": [ - 1369, - 1368, - 1364, - 1367, - 1365, - 1366 + 1397, + 1396, + 1392, + 1395, + 1393, + 1394 ] } ] @@ -14156,7 +14737,7 @@ "defaultValue": "..." }, { - "id": 1370, + "id": 1398, "name": "error", "kind": 1024, "kindString": "Property", @@ -14172,8 +14753,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1362, - 1370 + 1390, + 1398 ] } ] @@ -14186,14 +14767,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 1261, + "id": 1285, "name": "SpotterAgentEmbed.sendMessageData" } } ], "inheritedFrom": { "type": "reference", - "id": 1260, + "id": 1284, "name": "SpotterAgentEmbed.sendMessageData" } } @@ -14203,15 +14784,15 @@ "title": "Constructors", "kind": 512, "children": [ - 1341 + 1369 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1344, - 1355 + 1372, + 1383 ] } ], @@ -14225,13 +14806,13 @@ "extendedTypes": [ { "type": "reference", - "id": 1244, + "id": 1268, "name": "SpotterAgentEmbed" } ] }, { - "id": 1632, + "id": 1668, "name": "ConversationEmbed", "kind": 128, "kindString": "Class", @@ -14259,7 +14840,7 @@ }, "children": [ { - "id": 1633, + "id": 1669, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -14267,20 +14848,20 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 351, + "line": 362, "character": 4 } ], "signatures": [ { - "id": 1634, + "id": 1670, "name": "new ConversationEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1635, + "id": 1671, "name": "container", "kind": 32768, "kindString": "Parameter", @@ -14291,38 +14872,38 @@ } }, { - "id": 1636, + "id": 1672, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1588, + "id": 1622, "name": "ConversationViewConfig" } } ], "type": { "type": "reference", - "id": 1632, + "id": 1668, "name": "ConversationEmbed" }, "overwrites": { "type": "reference", - "id": 1373, + "id": 1401, "name": "SpotterEmbed.constructor" } } ], "overwrites": { "type": "reference", - "id": 1372, + "id": 1400, "name": "SpotterEmbed.constructor" } }, { - "id": 1783, + "id": 1823, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -14332,13 +14913,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1481, + "line": 1503, "character": 11 } ], "signatures": [ { - "id": 1784, + "id": 1824, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -14358,19 +14939,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1523, + "id": 1555, "name": "SpotterEmbed.destroy" } } ], "inheritedFrom": { "type": "reference", - "id": 1522, + "id": 1554, "name": "SpotterEmbed.destroy" } }, { - "id": 1802, + "id": 1842, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -14380,13 +14961,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 1803, + "id": 1843, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -14402,7 +14983,7 @@ }, "parameters": [ { - "id": 1804, + "id": 1844, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -14423,7 +15004,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -14431,19 +15012,74 @@ }, "inheritedFrom": { "type": "reference", - "id": 1542, + "id": 1574, "name": "SpotterEmbed.getAnswerService" } } ], "inheritedFrom": { "type": "reference", - "id": 1541, + "id": 1573, "name": "SpotterEmbed.getAnswerService" } }, { - "id": 1640, + "id": 1680, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/conversation.ts", + "line": 338, + "character": 17 + } + ], + "signatures": [ + { + "id": 1681, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded SpotterEmbed.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "PageContextOptions" + } + ], + "name": "Promise" + }, + "inheritedFrom": { + "type": "reference", + "id": 1412, + "name": "SpotterEmbed.getCurrentContext" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 1411, + "name": "SpotterEmbed.getCurrentContext" + } + }, + { + "id": 1676, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -14453,13 +15089,13 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 284, + "line": 285, "character": 11 } ], "signatures": [ { - "id": 1641, + "id": 1677, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -14470,19 +15106,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1380, + "id": 1408, "name": "SpotterEmbed.getIframeSrc" } } ], "inheritedFrom": { "type": "reference", - "id": 1379, + "id": 1407, "name": "SpotterEmbed.getIframeSrc" } }, { - "id": 1797, + "id": 1837, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -14492,13 +15128,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 1798, + "id": 1838, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -14520,14 +15156,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1799, + "id": 1839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1801, + "id": 1841, "name": "child", "kind": 1024, "kindString": "Property", @@ -14539,7 +15175,7 @@ "defaultValue": "..." }, { - "id": 1800, + "id": 1840, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -14556,8 +15192,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1801, - 1800 + 1841, + 1840 ] } ] @@ -14565,19 +15201,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1537, + "id": 1569, "name": "SpotterEmbed.getPreRenderIds" } } ], "inheritedFrom": { "type": "reference", - "id": 1536, + "id": 1568, "name": "SpotterEmbed.getPreRenderIds" } }, { - "id": 1777, + "id": 1817, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -14587,13 +15223,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 1778, + "id": 1818, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -14609,7 +15245,7 @@ }, "parameters": [ { - "id": 1779, + "id": 1819, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -14617,20 +15253,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1780, + "id": 1820, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1781, + "id": 1821, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1782, + "id": 1822, "name": "key", "kind": 32768, "flags": {}, @@ -14665,19 +15301,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1517, + "id": 1549, "name": "SpotterEmbed.getThoughtSpotPostUrlParams" } } ], "inheritedFrom": { "type": "reference", - "id": 1516, + "id": 1548, "name": "SpotterEmbed.getThoughtSpotPostUrlParams" } }, { - "id": 1785, + "id": 1825, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -14687,13 +15323,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 1786, + "id": 1826, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -14704,19 +15340,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1525, + "id": 1557, "name": "SpotterEmbed.getUnderlyingFrameElement" } } ], "inheritedFrom": { "type": "reference", - "id": 1524, + "id": 1556, "name": "SpotterEmbed.getUnderlyingFrameElement" } }, { - "id": 1795, + "id": 1835, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -14726,13 +15362,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 1796, + "id": 1836, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -14746,19 +15382,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1535, + "id": 1567, "name": "SpotterEmbed.hidePreRender" } } ], "inheritedFrom": { "type": "reference", - "id": 1534, + "id": 1566, "name": "SpotterEmbed.hidePreRender" } }, { - "id": 1742, + "id": 1780, "name": "off", "kind": 2048, "kindString": "Method", @@ -14768,13 +15404,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 1743, + "id": 1781, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -14790,7 +15426,7 @@ }, "parameters": [ { - "id": 1744, + "id": 1782, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -14800,12 +15436,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 1745, + "id": 1783, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -14815,7 +15451,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -14826,19 +15462,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1482, + "id": 1512, "name": "SpotterEmbed.off" } } ], "inheritedFrom": { "type": "reference", - "id": 1481, + "id": 1511, "name": "SpotterEmbed.off" } }, { - "id": 1736, + "id": 1774, "name": "on", "kind": 2048, "kindString": "Method", @@ -14848,13 +15484,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1207, + "line": 1214, "character": 11 } ], "signatures": [ { - "id": 1737, + "id": 1775, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -14874,7 +15510,7 @@ }, "parameters": [ { - "id": 1738, + "id": 1776, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -14884,12 +15520,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 1739, + "id": 1777, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -14899,12 +15535,12 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 1740, + "id": 1778, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -14914,13 +15550,13 @@ }, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." }, { - "id": 1741, + "id": 1779, "name": "isRegisteredBySDK", "kind": 32768, "kindString": "Parameter", @@ -14939,19 +15575,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1476, + "id": 1506, "name": "SpotterEmbed.on" } } ], "inheritedFrom": { "type": "reference", - "id": 1475, + "id": 1505, "name": "SpotterEmbed.on" } }, { - "id": 1773, + "id": 1813, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -14961,13 +15597,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 1774, + "id": 1814, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -14977,7 +15613,7 @@ }, "parameters": [ { - "id": 1775, + "id": 1815, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -14992,7 +15628,7 @@ "defaultValue": "false" }, { - "id": 1776, + "id": 1816, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -15016,19 +15652,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1513, + "id": 1545, "name": "SpotterEmbed.preRender" } } ], "inheritedFrom": { "type": "reference", - "id": 1512, + "id": 1544, "name": "SpotterEmbed.preRender" } }, { - "id": 1787, + "id": 1827, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -15038,13 +15674,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 1788, + "id": 1828, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -15071,19 +15707,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1527, + "id": 1559, "name": "SpotterEmbed.prerenderGeneric" } } ], "inheritedFrom": { "type": "reference", - "id": 1526, + "id": 1558, "name": "SpotterEmbed.prerenderGeneric" } }, { - "id": 1642, + "id": 1678, "name": "render", "kind": 2048, "kindString": "Method", @@ -15093,13 +15729,13 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 324, + "line": 325, "character": 17 } ], "signatures": [ { - "id": 1643, + "id": 1679, "name": "render", "kind": 4096, "kindString": "Call signature", @@ -15109,7 +15745,7 @@ "typeArguments": [ { "type": "reference", - "id": 1371, + "id": 1399, "name": "SpotterEmbed" } ], @@ -15117,19 +15753,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1382, + "id": 1410, "name": "SpotterEmbed.render" } } ], "inheritedFrom": { "type": "reference", - "id": 1381, + "id": 1409, "name": "SpotterEmbed.render" } }, { - "id": 1791, + "id": 1831, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -15139,13 +15775,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 1792, + "id": 1832, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -15165,19 +15801,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1531, + "id": 1563, "name": "SpotterEmbed.showPreRender" } } ], "inheritedFrom": { "type": "reference", - "id": 1530, + "id": 1562, "name": "SpotterEmbed.showPreRender" } }, { - "id": 1793, + "id": 1833, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -15187,13 +15823,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 1794, + "id": 1834, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -15213,19 +15849,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1533, + "id": 1565, "name": "SpotterEmbed.syncPreRenderStyle" } } ], "inheritedFrom": { "type": "reference", - "id": 1532, + "id": 1564, "name": "SpotterEmbed.syncPreRenderStyle" } }, { - "id": 1760, + "id": 1798, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -15235,13 +15871,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1346, + "line": 1353, "character": 17 } ], "signatures": [ { - "id": 1761, + "id": 1799, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -15252,28 +15888,40 @@ }, "typeParameter": [ { - "id": 1762, + "id": 1800, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 1763, + "id": 1801, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 1802, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 1764, + "id": 1803, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -15287,7 +15935,7 @@ } }, { - "id": 1765, + "id": 1804, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -15310,6 +15958,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 1805, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -15325,6 +15986,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -15334,19 +15999,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 1500, + "id": 1530, "name": "SpotterEmbed.trigger" } } ], "inheritedFrom": { "type": "reference", - "id": 1499, + "id": 1529, "name": "SpotterEmbed.trigger" } }, { - "id": 1766, + "id": 1806, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -15356,13 +16021,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 1767, + "id": 1807, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -15373,21 +16038,21 @@ }, "typeParameter": [ { - "id": 1768, + "id": 1808, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 1769, + "id": 1809, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -15401,7 +16066,7 @@ } }, { - "id": 1770, + "id": 1810, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -15439,14 +16104,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 1506, + "id": 1538, "name": "SpotterEmbed.triggerUIPassThrough" } } ], "inheritedFrom": { "type": "reference", - "id": 1505, + "id": 1537, "name": "SpotterEmbed.triggerUIPassThrough" } } @@ -15456,49 +16121,50 @@ "title": "Constructors", "kind": 512, "children": [ - 1633 + 1669 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1783, - 1802, - 1640, - 1797, - 1777, - 1785, - 1795, - 1742, - 1736, - 1773, - 1787, - 1642, - 1791, - 1793, - 1760, - 1766 + 1823, + 1842, + 1680, + 1676, + 1837, + 1817, + 1825, + 1835, + 1780, + 1774, + 1813, + 1827, + 1678, + 1831, + 1833, + 1798, + 1806 ] } ], "sources": [ { "fileName": "embed/conversation.ts", - "line": 350, + "line": 361, "character": 13 } ], "extendedTypes": [ { "type": "reference", - "id": 1371, + "id": 1399, "name": "SpotterEmbed" } ] }, { - "id": 614, + "id": 626, "name": "LiveboardEmbed", "kind": 128, "kindString": "Class", @@ -15518,7 +16184,7 @@ }, "children": [ { - "id": 615, + "id": 627, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -15526,46 +16192,46 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 457, + "line": 458, "character": 4 } ], "signatures": [ { - "id": 616, + "id": 628, "name": "new LiveboardEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 617, + "id": 629, "name": "domSelector", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2727, + "id": 2783, "name": "DOMSelector" } }, { - "id": 618, + "id": 630, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2476, + "id": 2526, "name": "LiveboardViewConfig" } } ], "type": { "type": "reference", - "id": 614, + "id": 626, "name": "LiveboardEmbed" }, "overwrites": { @@ -15580,7 +16246,7 @@ } }, { - "id": 670, + "id": 684, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -15590,13 +16256,13 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 821, + "line": 824, "character": 11 } ], "signatures": [ { - "id": 671, + "id": 685, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -15626,7 +16292,7 @@ } }, { - "id": 841, + "id": 857, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -15636,13 +16302,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 842, + "id": 858, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -15658,7 +16324,7 @@ }, "parameters": [ { - "id": 843, + "id": 859, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -15679,7 +16345,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -15697,7 +16363,60 @@ } }, { - "id": 814, + "id": 701, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/liveboard.ts", + "line": 901, + "character": 17 + } + ], + "signatures": [ + { + "id": 702, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded liveboard.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "PageContextOptions" + } + ], + "name": "Promise" + }, + "overwrites": { + "type": "reference", + "name": "V1Embed.getCurrentContext" + } + } + ], + "overwrites": { + "type": "reference", + "name": "V1Embed.getCurrentContext" + } + }, + { + "id": 830, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -15707,13 +16426,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1416, + "line": 1424, "character": 11 } ], "signatures": [ { - "id": 815, + "id": 831, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -15734,7 +16453,7 @@ } }, { - "id": 685, + "id": 699, "name": "getLiveboardUrl", "kind": 2048, "kindString": "Method", @@ -15744,13 +16463,13 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 880, + "line": 883, "character": 11 } ], "signatures": [ { - "id": 686, + "id": 700, "name": "getLiveboardUrl", "kind": 4096, "kindString": "Call signature", @@ -15767,7 +16486,7 @@ ] }, { - "id": 836, + "id": 852, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -15777,13 +16496,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 837, + "id": 853, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -15805,14 +16524,14 @@ "type": { "type": "reflection", "declaration": { - "id": 838, + "id": 854, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 840, + "id": 856, "name": "child", "kind": 1024, "kindString": "Property", @@ -15824,7 +16543,7 @@ "defaultValue": "..." }, { - "id": 839, + "id": 855, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -15841,8 +16560,8 @@ "title": "Properties", "kind": 1024, "children": [ - 840, - 839 + 856, + 855 ] } ] @@ -15860,7 +16579,7 @@ } }, { - "id": 820, + "id": 836, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -15870,13 +16589,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 821, + "id": 837, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -15892,7 +16611,7 @@ }, "parameters": [ { - "id": 822, + "id": 838, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -15900,20 +16619,20 @@ "type": { "type": "reflection", "declaration": { - "id": 823, + "id": 839, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 824, + "id": 840, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 825, + "id": 841, "name": "key", "kind": 32768, "flags": {}, @@ -15958,7 +16677,7 @@ } }, { - "id": 826, + "id": 842, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -15968,13 +16687,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 827, + "id": 843, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -15995,7 +16714,7 @@ } }, { - "id": 834, + "id": 850, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -16005,13 +16724,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 835, + "id": 851, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -16035,7 +16754,7 @@ } }, { - "id": 680, + "id": 694, "name": "navigateToLiveboard", "kind": 2048, "kindString": "Method", @@ -16045,20 +16764,20 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 861, + "line": 864, "character": 11 } ], "signatures": [ { - "id": 681, + "id": 695, "name": "navigateToLiveboard", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 682, + "id": 696, "name": "liveboardId", "kind": 32768, "kindString": "Parameter", @@ -16069,7 +16788,7 @@ } }, { - "id": 683, + "id": 697, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -16082,7 +16801,7 @@ } }, { - "id": 684, + "id": 698, "name": "activeTabId", "kind": 32768, "kindString": "Parameter", @@ -16103,7 +16822,7 @@ ] }, { - "id": 791, + "id": 807, "name": "off", "kind": 2048, "kindString": "Method", @@ -16113,13 +16832,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 792, + "id": 808, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -16135,7 +16854,7 @@ }, "parameters": [ { - "id": 793, + "id": 809, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -16145,12 +16864,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 794, + "id": 810, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -16160,7 +16879,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -16181,7 +16900,7 @@ } }, { - "id": 692, + "id": 708, "name": "on", "kind": 2048, "kindString": "Method", @@ -16191,13 +16910,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1790, + "line": 1826, "character": 11 } ], "signatures": [ { - "id": 693, + "id": 709, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -16220,38 +16939,38 @@ }, "parameters": [ { - "id": 694, + "id": 710, "name": "messageType", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 695, + "id": 711, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 696, + "id": 712, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." @@ -16273,7 +16992,7 @@ } }, { - "id": 816, + "id": 832, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -16283,13 +17002,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 817, + "id": 833, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -16299,7 +17018,7 @@ }, "parameters": [ { - "id": 818, + "id": 834, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -16314,7 +17033,7 @@ "defaultValue": "false" }, { - "id": 819, + "id": 835, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -16348,7 +17067,7 @@ } }, { - "id": 828, + "id": 844, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -16358,13 +17077,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 829, + "id": 845, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -16401,7 +17120,7 @@ } }, { - "id": 678, + "id": 692, "name": "render", "kind": 2048, "kindString": "Method", @@ -16411,13 +17130,13 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 850, + "line": 853, "character": 17 } ], "signatures": [ { - "id": 679, + "id": 693, "name": "render", "kind": 4096, "kindString": "Call signature", @@ -16430,7 +17149,7 @@ "typeArguments": [ { "type": "reference", - "id": 614, + "id": 626, "name": "LiveboardEmbed" } ], @@ -16448,7 +17167,7 @@ } }, { - "id": 830, + "id": 846, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -16458,13 +17177,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 831, + "id": 847, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -16494,7 +17213,7 @@ } }, { - "id": 832, + "id": 848, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -16504,13 +17223,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 833, + "id": 849, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -16540,7 +17259,7 @@ } }, { - "id": 664, + "id": 676, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -16550,13 +17269,13 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 803, + "line": 805, "character": 11 } ], "signatures": [ { - "id": 665, + "id": 677, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -16567,28 +17286,40 @@ }, "typeParameter": [ { - "id": 666, + "id": 678, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 667, + "id": 679, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 680, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 668, + "id": 681, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -16602,7 +17333,7 @@ } }, { - "id": 669, + "id": 682, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -16625,6 +17356,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 683, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -16640,6 +17384,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -16659,7 +17407,7 @@ } }, { - "id": 809, + "id": 825, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -16669,13 +17417,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 810, + "id": 826, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -16686,21 +17434,21 @@ }, "typeParameter": [ { - "id": 811, + "id": 827, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 812, + "id": 828, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -16714,7 +17462,7 @@ } }, { - "id": 813, + "id": 829, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -16767,38 +17515,39 @@ "title": "Constructors", "kind": 512, "children": [ - 615 + 627 ] }, { "title": "Methods", "kind": 2048, "children": [ - 670, - 841, - 814, - 685, - 836, - 820, - 826, - 834, - 680, - 791, - 692, - 816, - 828, - 678, + 684, + 857, + 701, 830, + 699, + 852, + 836, + 842, + 850, + 694, + 807, + 708, 832, - 664, - 809 + 844, + 692, + 846, + 848, + 676, + 825 ] } ], "sources": [ { "fileName": "embed/liveboard.ts", - "line": 451, + "line": 452, "character": 13 } ], @@ -16810,7 +17559,7 @@ ] }, { - "id": 844, + "id": 860, "name": "SageEmbed", "kind": 128, "kindString": "Class", @@ -16830,7 +17579,7 @@ }, "children": [ { - "id": 845, + "id": 861, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -16838,46 +17587,46 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 151, + "line": 152, "character": 4 } ], "signatures": [ { - "id": 846, + "id": 862, "name": "new SageEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 847, + "id": 863, "name": "domSelector", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2727, + "id": 2783, "name": "DOMSelector" } }, { - "id": 848, + "id": 864, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2558, + "id": 2610, "name": "SageViewConfig" } } ], "type": { "type": "reference", - "id": 844, + "id": 860, "name": "SageEmbed" }, "overwrites": { @@ -16892,7 +17641,7 @@ } }, { - "id": 1005, + "id": 1025, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -16902,13 +17651,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1481, + "line": 1503, "character": 11 } ], "signatures": [ { - "id": 1006, + "id": 1026, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -16938,7 +17687,7 @@ } }, { - "id": 1024, + "id": 1044, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -16948,13 +17697,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 1025, + "id": 1045, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -16970,7 +17719,7 @@ }, "parameters": [ { - "id": 1026, + "id": 1046, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -16991,7 +17740,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -17009,7 +17758,60 @@ } }, { - "id": 854, + "id": 874, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/sage.ts", + "line": 239, + "character": 17 + } + ], + "signatures": [ + { + "id": 875, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded SageEmbed.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "PageContextOptions" + } + ], + "name": "Promise" + }, + "overwrites": { + "type": "reference", + "name": "V1Embed.getCurrentContext" + } + } + ], + "overwrites": { + "type": "reference", + "name": "V1Embed.getCurrentContext" + } + }, + { + "id": 870, "name": "getIFrameSrc", "kind": 2048, "kindString": "Method", @@ -17019,13 +17821,13 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 200, + "line": 201, "character": 11 } ], "signatures": [ { - "id": 855, + "id": 871, "name": "getIFrameSrc", "kind": 4096, "kindString": "Call signature", @@ -17042,7 +17844,7 @@ ] }, { - "id": 991, + "id": 1011, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -17052,13 +17854,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1416, + "line": 1424, "character": 11 } ], "signatures": [ { - "id": 992, + "id": 1012, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -17079,7 +17881,7 @@ } }, { - "id": 1019, + "id": 1039, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -17089,13 +17891,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 1020, + "id": 1040, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -17117,14 +17919,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1021, + "id": 1041, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1023, + "id": 1043, "name": "child", "kind": 1024, "kindString": "Property", @@ -17136,7 +17938,7 @@ "defaultValue": "..." }, { - "id": 1022, + "id": 1042, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -17153,8 +17955,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1023, - 1022 + 1043, + 1042 ] } ] @@ -17172,7 +17974,7 @@ } }, { - "id": 999, + "id": 1019, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -17182,13 +17984,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 1000, + "id": 1020, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -17204,7 +18006,7 @@ }, "parameters": [ { - "id": 1001, + "id": 1021, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -17212,20 +18014,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1002, + "id": 1022, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1003, + "id": 1023, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1004, + "id": 1024, "name": "key", "kind": 32768, "flags": {}, @@ -17270,7 +18072,7 @@ } }, { - "id": 1007, + "id": 1027, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -17280,13 +18082,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 1008, + "id": 1028, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -17307,7 +18109,7 @@ } }, { - "id": 1017, + "id": 1037, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -17317,13 +18119,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 1018, + "id": 1038, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -17347,7 +18149,7 @@ } }, { - "id": 962, + "id": 980, "name": "off", "kind": 2048, "kindString": "Method", @@ -17357,13 +18159,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 963, + "id": 981, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -17379,7 +18181,7 @@ }, "parameters": [ { - "id": 964, + "id": 982, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -17389,12 +18191,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 965, + "id": 983, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -17404,7 +18206,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -17425,7 +18227,7 @@ } }, { - "id": 863, + "id": 881, "name": "on", "kind": 2048, "kindString": "Method", @@ -17435,13 +18237,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1790, + "line": 1826, "character": 11 } ], "signatures": [ { - "id": 864, + "id": 882, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -17464,38 +18266,38 @@ }, "parameters": [ { - "id": 865, + "id": 883, "name": "messageType", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 866, + "id": 884, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 867, + "id": 885, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." @@ -17517,7 +18319,7 @@ } }, { - "id": 995, + "id": 1015, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -17527,13 +18329,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 996, + "id": 1016, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -17543,7 +18345,7 @@ }, "parameters": [ { - "id": 997, + "id": 1017, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -17558,7 +18360,7 @@ "defaultValue": "false" }, { - "id": 998, + "id": 1018, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -17592,7 +18394,7 @@ } }, { - "id": 1009, + "id": 1029, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -17602,13 +18404,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 1010, + "id": 1030, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -17645,7 +18447,7 @@ } }, { - "id": 856, + "id": 872, "name": "render", "kind": 2048, "kindString": "Method", @@ -17655,13 +18457,13 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 225, + "line": 226, "character": 17 } ], "signatures": [ { - "id": 857, + "id": 873, "name": "render", "kind": 4096, "kindString": "Call signature", @@ -17675,7 +18477,7 @@ "typeArguments": [ { "type": "reference", - "id": 844, + "id": 860, "name": "SageEmbed" } ], @@ -17693,7 +18495,7 @@ } }, { - "id": 1013, + "id": 1033, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -17703,13 +18505,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 1014, + "id": 1034, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -17739,7 +18541,7 @@ } }, { - "id": 1015, + "id": 1035, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -17749,13 +18551,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 1016, + "id": 1036, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -17785,7 +18587,7 @@ } }, { - "id": 980, + "id": 998, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -17795,13 +18597,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1346, + "line": 1353, "character": 17 } ], "signatures": [ { - "id": 981, + "id": 999, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -17812,28 +18614,40 @@ }, "typeParameter": [ { - "id": 982, + "id": 1000, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 983, + "id": 1001, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 1002, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 984, + "id": 1003, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -17847,7 +18661,7 @@ } }, { - "id": 985, + "id": 1004, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -17870,6 +18684,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 1005, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -17885,6 +18712,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -17904,7 +18735,7 @@ } }, { - "id": 986, + "id": 1006, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -17914,13 +18745,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 987, + "id": 1007, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -17931,21 +18762,21 @@ }, "typeParameter": [ { - "id": 988, + "id": 1008, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 989, + "id": 1009, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -17959,7 +18790,7 @@ } }, { - "id": 990, + "id": 1010, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -18012,37 +18843,38 @@ "title": "Constructors", "kind": 512, "children": [ - 845 + 861 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1005, - 1024, - 854, - 991, + 1025, + 1044, + 874, + 870, + 1011, + 1039, 1019, - 999, - 1007, - 1017, - 962, - 863, - 995, - 1009, - 856, - 1013, - 1015, + 1027, + 1037, 980, - 986 + 881, + 1015, + 1029, + 872, + 1033, + 1035, + 998, + 1006 ] } ], "sources": [ { "fileName": "embed/sage.ts", - "line": 143, + "line": 144, "character": 13 } ], @@ -18054,7 +18886,7 @@ ] }, { - "id": 241, + "id": 245, "name": "SearchBarEmbed", "kind": 128, "kindString": "Class", @@ -18074,7 +18906,7 @@ }, "children": [ { - "id": 242, + "id": 246, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -18082,20 +18914,20 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 116, + "line": 117, "character": 4 } ], "signatures": [ { - "id": 243, + "id": 247, "name": "new SearchBarEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 244, + "id": 248, "name": "domSelector", "kind": 32768, "kindString": "Parameter", @@ -18106,21 +18938,21 @@ } }, { - "id": 245, + "id": 249, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2431, + "id": 2479, "name": "SearchBarViewConfig" } } ], "type": { "type": "reference", - "id": 241, + "id": 245, "name": "SearchBarEmbed" }, "overwrites": { @@ -18135,7 +18967,7 @@ } }, { - "id": 399, + "id": 407, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -18145,13 +18977,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1481, + "line": 1503, "character": 11 } ], "signatures": [ { - "id": 400, + "id": 408, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -18181,7 +19013,7 @@ } }, { - "id": 418, + "id": 426, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -18191,13 +19023,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 419, + "id": 427, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -18213,7 +19045,7 @@ }, "parameters": [ { - "id": 420, + "id": 428, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -18234,7 +19066,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -18252,7 +19084,60 @@ } }, { - "id": 385, + "id": 264, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/search-bar.tsx", + "line": 208, + "character": 17 + } + ], + "signatures": [ + { + "id": 265, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded search bar.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "PageContextOptions" + } + ], + "name": "Promise" + }, + "overwrites": { + "type": "reference", + "name": "TsEmbed.getCurrentContext" + } + } + ], + "overwrites": { + "type": "reference", + "name": "TsEmbed.getCurrentContext" + } + }, + { + "id": 393, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -18262,13 +19147,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1416, + "line": 1424, "character": 11 } ], "signatures": [ { - "id": 386, + "id": 394, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -18289,7 +19174,7 @@ } }, { - "id": 413, + "id": 421, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -18299,13 +19184,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 414, + "id": 422, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -18327,14 +19212,14 @@ "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 423, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 425, "name": "child", "kind": 1024, "kindString": "Property", @@ -18346,7 +19231,7 @@ "defaultValue": "..." }, { - "id": 416, + "id": 424, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -18363,8 +19248,8 @@ "title": "Properties", "kind": 1024, "children": [ - 417, - 416 + 425, + 424 ] } ] @@ -18382,7 +19267,7 @@ } }, { - "id": 393, + "id": 401, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -18392,13 +19277,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 394, + "id": 402, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -18414,7 +19299,7 @@ }, "parameters": [ { - "id": 395, + "id": 403, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -18422,20 +19307,20 @@ "type": { "type": "reflection", "declaration": { - "id": 396, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 397, + "id": 405, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 398, + "id": 406, "name": "key", "kind": 32768, "flags": {}, @@ -18480,7 +19365,7 @@ } }, { - "id": 401, + "id": 409, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -18490,13 +19375,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 402, + "id": 410, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -18517,7 +19402,7 @@ } }, { - "id": 411, + "id": 419, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -18527,13 +19412,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 412, + "id": 420, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -18557,7 +19442,7 @@ } }, { - "id": 356, + "id": 362, "name": "off", "kind": 2048, "kindString": "Method", @@ -18567,13 +19452,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 357, + "id": 363, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -18589,7 +19474,7 @@ }, "parameters": [ { - "id": 358, + "id": 364, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -18599,12 +19484,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 359, + "id": 365, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -18614,7 +19499,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -18635,7 +19520,7 @@ } }, { - "id": 350, + "id": 356, "name": "on", "kind": 2048, "kindString": "Method", @@ -18645,13 +19530,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1207, + "line": 1214, "character": 11 } ], "signatures": [ { - "id": 351, + "id": 357, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -18671,7 +19556,7 @@ }, "parameters": [ { - "id": 352, + "id": 358, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -18681,12 +19566,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 353, + "id": 359, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -18696,12 +19581,12 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 354, + "id": 360, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -18711,13 +19596,13 @@ }, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." }, { - "id": 355, + "id": 361, "name": "isRegisteredBySDK", "kind": 32768, "kindString": "Parameter", @@ -18746,7 +19631,7 @@ } }, { - "id": 389, + "id": 397, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -18756,13 +19641,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 390, + "id": 398, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -18772,7 +19657,7 @@ }, "parameters": [ { - "id": 391, + "id": 399, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -18787,7 +19672,7 @@ "defaultValue": "false" }, { - "id": 392, + "id": 400, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -18821,7 +19706,7 @@ } }, { - "id": 403, + "id": 411, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -18831,13 +19716,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 404, + "id": 412, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -18874,7 +19759,7 @@ } }, { - "id": 252, + "id": 256, "name": "render", "kind": 2048, "kindString": "Method", @@ -18884,13 +19769,13 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 182, + "line": 183, "character": 17 } ], "signatures": [ { - "id": 253, + "id": 257, "name": "render", "kind": 4096, "kindString": "Call signature", @@ -18903,7 +19788,7 @@ "typeArguments": [ { "type": "reference", - "id": 241, + "id": 245, "name": "SearchBarEmbed" } ], @@ -18921,7 +19806,7 @@ } }, { - "id": 407, + "id": 415, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -18931,13 +19816,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 408, + "id": 416, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -18967,7 +19852,7 @@ } }, { - "id": 409, + "id": 417, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -18977,13 +19862,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 410, + "id": 418, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -19013,7 +19898,7 @@ } }, { - "id": 374, + "id": 380, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -19023,13 +19908,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1346, + "line": 1353, "character": 17 } ], "signatures": [ { - "id": 375, + "id": 381, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -19040,28 +19925,40 @@ }, "typeParameter": [ { - "id": 376, + "id": 382, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 377, + "id": 383, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 384, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 378, + "id": 385, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -19075,7 +19972,7 @@ } }, { - "id": 379, + "id": 386, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -19098,6 +19995,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 387, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -19113,6 +20023,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -19132,7 +20046,7 @@ } }, { - "id": 380, + "id": 388, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -19142,13 +20056,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 381, + "id": 389, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -19159,21 +20073,21 @@ }, "typeParameter": [ { - "id": 382, + "id": 390, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 383, + "id": 391, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -19187,7 +20101,7 @@ } }, { - "id": 384, + "id": 392, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -19240,36 +20154,37 @@ "title": "Constructors", "kind": 512, "children": [ - 242 + 246 ] }, { "title": "Methods", "kind": 2048, "children": [ - 399, - 418, - 385, - 413, + 407, + 426, + 264, 393, + 421, 401, - 411, - 356, - 350, - 389, - 403, - 252, - 407, 409, - 374, - 380 + 419, + 362, + 356, + 397, + 411, + 256, + 415, + 417, + 380, + 388 ] } ], "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 108, + "line": 109, "character": 13 } ], @@ -19305,7 +20220,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 341, + "line": 342, "character": 4 } ], @@ -19325,7 +20240,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2727, + "id": 2783, "name": "DOMSelector" } }, @@ -19337,7 +20252,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2375, + "id": 2421, "name": "SearchViewConfig" } } @@ -19359,7 +20274,7 @@ } }, { - "id": 219, + "id": 223, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -19369,13 +20284,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1481, + "line": 1503, "character": 11 } ], "signatures": [ { - "id": 220, + "id": 224, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -19405,7 +20320,7 @@ } }, { - "id": 238, + "id": 242, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -19415,13 +20330,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 239, + "id": 243, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -19437,7 +20352,7 @@ }, "parameters": [ { - "id": 240, + "id": 244, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -19458,7 +20373,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -19475,6 +20390,59 @@ "name": "TsEmbed.getAnswerService" } }, + { + "id": 82, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/search.ts", + "line": 533, + "character": 17 + } + ], + "signatures": [ + { + "id": 83, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded search.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "PageContextOptions" + } + ], + "name": "Promise" + }, + "overwrites": { + "type": "reference", + "name": "TsEmbed.getCurrentContext" + } + } + ], + "overwrites": { + "type": "reference", + "name": "TsEmbed.getCurrentContext" + } + }, { "id": 78, "name": "getIFrameSrc", @@ -19486,7 +20454,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 497, + "line": 498, "character": 11 } ], @@ -19508,7 +20476,7 @@ ] }, { - "id": 205, + "id": 209, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -19518,13 +20486,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1416, + "line": 1424, "character": 11 } ], "signatures": [ { - "id": 206, + "id": 210, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -19545,7 +20513,7 @@ } }, { - "id": 233, + "id": 237, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -19555,13 +20523,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 234, + "id": 238, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -19583,14 +20551,14 @@ "type": { "type": "reflection", "declaration": { - "id": 235, + "id": 239, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 237, + "id": 241, "name": "child", "kind": 1024, "kindString": "Property", @@ -19602,7 +20570,7 @@ "defaultValue": "..." }, { - "id": 236, + "id": 240, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -19619,8 +20587,8 @@ "title": "Properties", "kind": 1024, "children": [ - 237, - 236 + 241, + 240 ] } ] @@ -19638,7 +20606,7 @@ } }, { - "id": 213, + "id": 217, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -19648,13 +20616,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 214, + "id": 218, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -19670,7 +20638,7 @@ }, "parameters": [ { - "id": 215, + "id": 219, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -19678,20 +20646,20 @@ "type": { "type": "reflection", "declaration": { - "id": 216, + "id": 220, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 217, + "id": 221, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 218, + "id": 222, "name": "key", "kind": 32768, "flags": {}, @@ -19736,7 +20704,7 @@ } }, { - "id": 221, + "id": 225, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -19746,13 +20714,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 222, + "id": 226, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -19773,7 +20741,7 @@ } }, { - "id": 231, + "id": 235, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -19783,13 +20751,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 232, + "id": 236, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -19813,7 +20781,7 @@ } }, { - "id": 176, + "id": 178, "name": "off", "kind": 2048, "kindString": "Method", @@ -19823,13 +20791,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 177, + "id": 179, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -19845,7 +20813,7 @@ }, "parameters": [ { - "id": 178, + "id": 180, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -19855,12 +20823,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 179, + "id": 181, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -19870,7 +20838,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -19891,7 +20859,7 @@ } }, { - "id": 170, + "id": 172, "name": "on", "kind": 2048, "kindString": "Method", @@ -19901,13 +20869,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1207, + "line": 1214, "character": 11 } ], "signatures": [ { - "id": 171, + "id": 173, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -19927,7 +20895,7 @@ }, "parameters": [ { - "id": 172, + "id": 174, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -19937,12 +20905,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 173, + "id": 175, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -19952,12 +20920,12 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 174, + "id": 176, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -19967,13 +20935,13 @@ }, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." }, { - "id": 175, + "id": 177, "name": "isRegisteredBySDK", "kind": 32768, "kindString": "Parameter", @@ -20002,7 +20970,7 @@ } }, { - "id": 209, + "id": 213, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -20012,13 +20980,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 210, + "id": 214, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -20028,7 +20996,7 @@ }, "parameters": [ { - "id": 211, + "id": 215, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -20043,7 +21011,7 @@ "defaultValue": "false" }, { - "id": 212, + "id": 216, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -20077,7 +21045,7 @@ } }, { - "id": 223, + "id": 227, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -20087,13 +21055,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 224, + "id": 228, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -20140,7 +21108,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 508, + "line": 509, "character": 17 } ], @@ -20177,7 +21145,7 @@ } }, { - "id": 227, + "id": 231, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -20187,13 +21155,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 228, + "id": 232, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -20223,7 +21191,7 @@ } }, { - "id": 229, + "id": 233, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -20233,13 +21201,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 230, + "id": 234, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -20269,7 +21237,7 @@ } }, { - "id": 194, + "id": 196, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -20279,13 +21247,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1346, + "line": 1353, "character": 17 } ], "signatures": [ { - "id": 195, + "id": 197, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -20296,28 +21264,40 @@ }, "typeParameter": [ { - "id": 196, + "id": 198, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 197, + "id": 199, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 200, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 198, + "id": 201, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -20331,7 +21311,7 @@ } }, { - "id": 199, + "id": 202, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -20354,6 +21334,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 203, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -20369,6 +21362,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -20388,7 +21385,7 @@ } }, { - "id": 200, + "id": 204, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -20398,13 +21395,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 201, + "id": 205, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -20415,21 +21412,21 @@ }, "typeParameter": [ { - "id": 202, + "id": 206, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 203, + "id": 207, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -20443,7 +21440,7 @@ } }, { - "id": 204, + "id": 208, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -20503,30 +21500,31 @@ "title": "Methods", "kind": 2048, "children": [ - 219, - 238, + 223, + 242, + 82, 78, - 205, - 233, - 213, - 221, - 231, - 176, - 170, 209, - 223, - 80, + 237, + 217, + 225, + 235, + 178, + 172, + 213, 227, - 229, - 194, - 200 + 80, + 231, + 233, + 196, + 204 ] } ], "sources": [ { "fileName": "embed/search.ts", - "line": 335, + "line": 336, "character": 13 } ], @@ -20538,7 +21536,7 @@ ] }, { - "id": 1244, + "id": 1268, "name": "SpotterAgentEmbed", "kind": 128, "kindString": "Class", @@ -20562,7 +21560,7 @@ }, "children": [ { - "id": 1245, + "id": 1269, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -20576,35 +21574,35 @@ ], "signatures": [ { - "id": 1246, + "id": 1270, "name": "new SpotterAgentEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1247, + "id": 1271, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1276, + "id": 1300, "name": "SpotterAgentEmbedViewConfig" } } ], "type": { "type": "reference", - "id": 1244, + "id": 1268, "name": "SpotterAgentEmbed" } } ] }, { - "id": 1249, + "id": 1273, "name": "sendMessage", "kind": 2048, "kindString": "Method", @@ -20620,14 +21618,14 @@ ], "signatures": [ { - "id": 1250, + "id": 1274, "name": "sendMessage", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1251, + "id": 1275, "name": "userMessage", "kind": 32768, "kindString": "Parameter", @@ -20647,14 +21645,14 @@ { "type": "reflection", "declaration": { - "id": 1252, + "id": 1276, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1254, + "id": 1278, "name": "container", "kind": 1024, "kindString": "Property", @@ -20665,7 +21663,7 @@ } }, { - "id": 1253, + "id": 1277, "name": "error", "kind": 1024, "kindString": "Property", @@ -20676,7 +21674,7 @@ } }, { - "id": 1255, + "id": 1279, "name": "viz", "kind": 1024, "kindString": "Property", @@ -20693,9 +21691,9 @@ "title": "Properties", "kind": 1024, "children": [ - 1254, - 1253, - 1255 + 1278, + 1277, + 1279 ] } ] @@ -20704,14 +21702,14 @@ { "type": "reflection", "declaration": { - "id": 1256, + "id": 1280, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1257, + "id": 1281, "name": "container", "kind": 1024, "kindString": "Property", @@ -20722,7 +21720,7 @@ } }, { - "id": 1259, + "id": 1283, "name": "error", "kind": 1024, "kindString": "Property", @@ -20733,7 +21731,7 @@ } }, { - "id": 1258, + "id": 1282, "name": "viz", "kind": 1024, "kindString": "Property", @@ -20750,9 +21748,9 @@ "title": "Properties", "kind": 1024, "children": [ - 1257, - 1259, - 1258 + 1281, + 1283, + 1282 ] } ] @@ -20767,7 +21765,7 @@ ] }, { - "id": 1260, + "id": 1284, "name": "sendMessageData", "kind": 2048, "kindString": "Method", @@ -20783,7 +21781,7 @@ ], "signatures": [ { - "id": 1261, + "id": 1285, "name": "sendMessageData", "kind": 4096, "kindString": "Call signature", @@ -20794,7 +21792,7 @@ }, "parameters": [ { - "id": 1262, + "id": 1286, "name": "userMessage", "kind": 32768, "kindString": "Parameter", @@ -20817,14 +21815,14 @@ { "type": "reflection", "declaration": { - "id": 1263, + "id": 1287, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1265, + "id": 1289, "name": "data", "kind": 1024, "kindString": "Property", @@ -20836,7 +21834,7 @@ "defaultValue": "..." }, { - "id": 1264, + "id": 1288, "name": "error", "kind": 1024, "kindString": "Property", @@ -20852,8 +21850,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1265, - 1264 + 1289, + 1288 ] } ] @@ -20862,14 +21860,14 @@ { "type": "reflection", "declaration": { - "id": 1266, + "id": 1290, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1267, + "id": 1291, "name": "data", "kind": 1024, "kindString": "Property", @@ -20877,14 +21875,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1268, + "id": 1292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1274, + "id": 1298, "name": "acGenNo", "kind": 1024, "kindString": "Property", @@ -20896,7 +21894,7 @@ "defaultValue": "..." }, { - "id": 1273, + "id": 1297, "name": "acSessionId", "kind": 1024, "kindString": "Property", @@ -20908,7 +21906,7 @@ "defaultValue": "..." }, { - "id": 1269, + "id": 1293, "name": "convId", "kind": 1024, "kindString": "Property", @@ -20920,7 +21918,7 @@ "defaultValue": "..." }, { - "id": 1272, + "id": 1296, "name": "genNo", "kind": 1024, "kindString": "Property", @@ -20932,7 +21930,7 @@ "defaultValue": "..." }, { - "id": 1270, + "id": 1294, "name": "messageId", "kind": 1024, "kindString": "Property", @@ -20944,7 +21942,7 @@ "defaultValue": "..." }, { - "id": 1271, + "id": 1295, "name": "sessionId", "kind": 1024, "kindString": "Property", @@ -20961,12 +21959,12 @@ "title": "Properties", "kind": 1024, "children": [ - 1274, - 1273, - 1269, - 1272, - 1270, - 1271 + 1298, + 1297, + 1293, + 1296, + 1294, + 1295 ] } ] @@ -20975,7 +21973,7 @@ "defaultValue": "..." }, { - "id": 1275, + "id": 1299, "name": "error", "kind": 1024, "kindString": "Property", @@ -20991,8 +21989,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1267, - 1275 + 1291, + 1299 ] } ] @@ -21012,15 +22010,15 @@ "title": "Constructors", "kind": 512, "children": [ - 1245 + 1269 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1249, - 1260 + 1273, + 1284 ] } ], @@ -21034,13 +22032,13 @@ "extendedBy": [ { "type": "reference", - "id": 1340, + "id": 1368, "name": "BodylessConversation" } ] }, { - "id": 1371, + "id": 1399, "name": "SpotterEmbed", "kind": 128, "kindString": "Class", @@ -21064,7 +22062,7 @@ }, "children": [ { - "id": 1372, + "id": 1400, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -21072,20 +22070,20 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 226, + "line": 227, "character": 4 } ], "signatures": [ { - "id": 1373, + "id": 1401, "name": "new SpotterEmbed", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 1374, + "id": 1402, "name": "container", "kind": 32768, "kindString": "Parameter", @@ -21096,21 +22094,21 @@ } }, { - "id": 1375, + "id": 1403, "name": "viewConfig", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1544, + "id": 1576, "name": "SpotterEmbedViewConfig" } } ], "type": { "type": "reference", - "id": 1371, + "id": 1399, "name": "SpotterEmbed" }, "overwrites": { @@ -21125,7 +22123,7 @@ } }, { - "id": 1522, + "id": 1554, "name": "destroy", "kind": 2048, "kindString": "Method", @@ -21135,13 +22133,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1481, + "line": 1503, "character": 11 } ], "signatures": [ { - "id": 1523, + "id": 1555, "name": "destroy", "kind": 4096, "kindString": "Call signature", @@ -21171,7 +22169,7 @@ } }, { - "id": 1541, + "id": 1573, "name": "getAnswerService", "kind": 2048, "kindString": "Method", @@ -21181,13 +22179,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1681, + "line": 1717, "character": 17 } ], "signatures": [ { - "id": 1542, + "id": 1574, "name": "getAnswerService", "kind": 4096, "kindString": "Call signature", @@ -21203,7 +22201,7 @@ }, "parameters": [ { - "id": 1543, + "id": 1575, "name": "vizId", "kind": 32768, "kindString": "Parameter", @@ -21224,7 +22222,7 @@ "typeArguments": [ { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } ], @@ -21242,7 +22240,60 @@ } }, { - "id": 1379, + "id": 1411, + "name": "getCurrentContext", + "kind": 2048, + "kindString": "Method", + "flags": { + "isPublic": true + }, + "sources": [ + { + "fileName": "embed/conversation.ts", + "line": 338, + "character": 17 + } + ], + "signatures": [ + { + "id": 1412, + "name": "getCurrentContext", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Get the current context of the embedded SpotterEmbed.", + "returns": "The current context object containing the page type and object ids.", + "tags": [ + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl\n" + } + ] + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "PageContextOptions" + } + ], + "name": "Promise" + }, + "overwrites": { + "type": "reference", + "name": "TsEmbed.getCurrentContext" + } + } + ], + "overwrites": { + "type": "reference", + "name": "TsEmbed.getCurrentContext" + } + }, + { + "id": 1407, "name": "getIframeSrc", "kind": 2048, "kindString": "Method", @@ -21252,13 +22303,13 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 284, + "line": 285, "character": 11 } ], "signatures": [ { - "id": 1380, + "id": 1408, "name": "getIframeSrc", "kind": 4096, "kindString": "Call signature", @@ -21279,7 +22330,7 @@ } }, { - "id": 1536, + "id": 1568, "name": "getPreRenderIds", "kind": 2048, "kindString": "Method", @@ -21289,13 +22340,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1668, + "line": 1704, "character": 11 } ], "signatures": [ { - "id": 1537, + "id": 1569, "name": "getPreRenderIds", "kind": 4096, "kindString": "Call signature", @@ -21317,14 +22368,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1538, + "id": 1570, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1540, + "id": 1572, "name": "child", "kind": 1024, "kindString": "Property", @@ -21336,7 +22387,7 @@ "defaultValue": "..." }, { - "id": 1539, + "id": 1571, "name": "wrapper", "kind": 1024, "kindString": "Property", @@ -21353,8 +22404,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1540, - 1539 + 1572, + 1571 ] } ] @@ -21372,7 +22423,7 @@ } }, { - "id": 1516, + "id": 1548, "name": "getThoughtSpotPostUrlParams", "kind": 2048, "kindString": "Method", @@ -21382,13 +22433,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1451, + "line": 1473, "character": 11 } ], "signatures": [ { - "id": 1517, + "id": 1549, "name": "getThoughtSpotPostUrlParams", "kind": 4096, "kindString": "Call signature", @@ -21404,7 +22455,7 @@ }, "parameters": [ { - "id": 1518, + "id": 1550, "name": "additionalParams", "kind": 32768, "kindString": "Parameter", @@ -21412,20 +22463,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1519, + "id": 1551, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1520, + "id": 1552, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1521, + "id": 1553, "name": "key", "kind": 32768, "flags": {}, @@ -21470,7 +22521,7 @@ } }, { - "id": 1524, + "id": 1556, "name": "getUnderlyingFrameElement", "kind": 2048, "kindString": "Method", @@ -21480,13 +22531,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1504, + "line": 1526, "character": 11 } ], "signatures": [ { - "id": 1525, + "id": 1557, "name": "getUnderlyingFrameElement", "kind": 4096, "kindString": "Call signature", @@ -21507,7 +22558,7 @@ } }, { - "id": 1534, + "id": 1566, "name": "hidePreRender", "kind": 2048, "kindString": "Method", @@ -21517,13 +22568,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1640, + "line": 1673, "character": 11 } ], "signatures": [ { - "id": 1535, + "id": 1567, "name": "hidePreRender", "kind": 4096, "kindString": "Call signature", @@ -21547,7 +22598,7 @@ } }, { - "id": 1481, + "id": 1511, "name": "off", "kind": 2048, "kindString": "Method", @@ -21557,13 +22608,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1236, + "line": 1243, "character": 11 } ], "signatures": [ { - "id": 1482, + "id": 1512, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -21579,7 +22630,7 @@ }, "parameters": [ { - "id": 1483, + "id": 1513, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -21589,12 +22640,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 1484, + "id": 1514, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -21604,7 +22655,7 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } } @@ -21625,7 +22676,7 @@ } }, { - "id": 1475, + "id": 1505, "name": "on", "kind": 2048, "kindString": "Method", @@ -21635,13 +22686,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1207, + "line": 1214, "character": 11 } ], "signatures": [ { - "id": 1476, + "id": 1506, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -21661,7 +22712,7 @@ }, "parameters": [ { - "id": 1477, + "id": 1507, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -21671,12 +22722,12 @@ }, "type": { "type": "reference", - "id": 1999, + "id": 2039, "name": "EmbedEvent" } }, { - "id": 1478, + "id": 1508, "name": "callback", "kind": 32768, "kindString": "Parameter", @@ -21686,12 +22737,12 @@ }, "type": { "type": "reference", - "id": 2731, + "id": 2787, "name": "MessageCallback" } }, { - "id": 1479, + "id": 1509, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -21701,13 +22752,13 @@ }, "type": { "type": "reference", - "id": 2728, + "id": 2784, "name": "MessageOptions" }, "defaultValue": "..." }, { - "id": 1480, + "id": 1510, "name": "isRegisteredBySDK", "kind": 32768, "kindString": "Parameter", @@ -21736,7 +22787,7 @@ } }, { - "id": 1512, + "id": 1544, "name": "preRender", "kind": 2048, "kindString": "Method", @@ -21746,13 +22797,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1429, + "line": 1451, "character": 17 } ], "signatures": [ { - "id": 1513, + "id": 1545, "name": "preRender", "kind": 4096, "kindString": "Call signature", @@ -21762,7 +22813,7 @@ }, "parameters": [ { - "id": 1514, + "id": 1546, "name": "showPreRenderByDefault", "kind": 32768, "kindString": "Parameter", @@ -21777,7 +22828,7 @@ "defaultValue": "false" }, { - "id": 1515, + "id": 1547, "name": "replaceExistingPreRender", "kind": 32768, "kindString": "Parameter", @@ -21811,7 +22862,7 @@ } }, { - "id": 1526, + "id": 1558, "name": "prerenderGeneric", "kind": 2048, "kindString": "Method", @@ -21821,13 +22872,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1515, + "line": 1537, "character": 17 } ], "signatures": [ { - "id": 1527, + "id": 1559, "name": "prerenderGeneric", "kind": 4096, "kindString": "Call signature", @@ -21864,7 +22915,7 @@ } }, { - "id": 1381, + "id": 1409, "name": "render", "kind": 2048, "kindString": "Method", @@ -21874,13 +22925,13 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 324, + "line": 325, "character": 17 } ], "signatures": [ { - "id": 1382, + "id": 1410, "name": "render", "kind": 4096, "kindString": "Call signature", @@ -21890,7 +22941,7 @@ "typeArguments": [ { "type": "reference", - "id": 1371, + "id": 1399, "name": "SpotterEmbed" } ], @@ -21908,7 +22959,7 @@ } }, { - "id": 1530, + "id": 1562, "name": "showPreRender", "kind": 2048, "kindString": "Method", @@ -21918,13 +22969,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1563, + "line": 1585, "character": 17 } ], "signatures": [ { - "id": 1531, + "id": 1563, "name": "showPreRender", "kind": 4096, "kindString": "Call signature", @@ -21954,7 +23005,7 @@ } }, { - "id": 1532, + "id": 1564, "name": "syncPreRenderStyle", "kind": 2048, "kindString": "Method", @@ -21964,13 +23015,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1621, + "line": 1654, "character": 11 } ], "signatures": [ { - "id": 1533, + "id": 1565, "name": "syncPreRenderStyle", "kind": 4096, "kindString": "Call signature", @@ -22000,7 +23051,7 @@ } }, { - "id": 1499, + "id": 1529, "name": "trigger", "kind": 2048, "kindString": "Method", @@ -22010,13 +23061,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1346, + "line": 1353, "character": 17 } ], "signatures": [ { - "id": 1500, + "id": 1530, "name": "trigger", "kind": 4096, "kindString": "Call signature", @@ -22027,28 +23078,40 @@ }, "typeParameter": [ { - "id": 1501, + "id": 1531, "name": "HostEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2097, + "id": 2137, "name": "HostEvent" } }, { - "id": 1502, + "id": 1532, "name": "PayloadT", "kind": 131072, "kindString": "Type parameter", "flags": {} + }, + { + "id": 1533, + "name": "ContextT", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 2214, + "name": "ContextType" + } } ], "parameters": [ { - "id": 1503, + "id": 1534, "name": "messageType", "kind": 32768, "kindString": "Parameter", @@ -22062,7 +23125,7 @@ } }, { - "id": 1504, + "id": 1535, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -22085,6 +23148,19 @@ "name": "TriggerPayload" }, "defaultValue": "..." + }, + { + "id": 1536, + "name": "context", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "name": "ContextT" + } } ], "type": { @@ -22100,6 +23176,10 @@ { "type": "reference", "name": "HostEventT" + }, + { + "type": "reference", + "name": "ContextT" } ], "name": "TriggerResponse" @@ -22119,7 +23199,7 @@ } }, { - "id": 1505, + "id": 1537, "name": "triggerUIPassThrough", "kind": 2048, "kindString": "Method", @@ -22129,13 +23209,13 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1392, + "line": 1400, "character": 17 } ], "signatures": [ { - "id": 1506, + "id": 1538, "name": "triggerUIPassThrough", "kind": 4096, "kindString": "Call signature", @@ -22146,21 +23226,21 @@ }, "typeParameter": [ { - "id": 1507, + "id": 1539, "name": "UIPassthroughEventT", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { "type": "reference", - "id": 2989, + "id": 3045, "name": "UIPassthroughEvent" } } ], "parameters": [ { - "id": 1508, + "id": 1540, "name": "apiName", "kind": 32768, "kindString": "Parameter", @@ -22174,7 +23254,7 @@ } }, { - "id": 1509, + "id": 1541, "name": "parameters", "kind": 32768, "kindString": "Parameter", @@ -22227,36 +23307,37 @@ "title": "Constructors", "kind": 512, "children": [ - 1372 + 1400 ] }, { "title": "Methods", "kind": 2048, "children": [ - 1522, - 1541, - 1379, - 1536, - 1516, - 1524, - 1534, - 1481, - 1475, - 1512, - 1526, - 1381, - 1530, - 1532, - 1499, - 1505 + 1554, + 1573, + 1411, + 1407, + 1568, + 1548, + 1556, + 1566, + 1511, + 1505, + 1544, + 1558, + 1409, + 1562, + 1564, + 1529, + 1537 ] } ], "sources": [ { "fileName": "embed/conversation.ts", - "line": 225, + "line": 226, "character": 13 } ], @@ -22269,13 +23350,13 @@ "extendedBy": [ { "type": "reference", - "id": 1632, + "id": 1668, "name": "ConversationEmbed" } ] }, { - "id": 2608, + "id": 2662, "name": "AppViewConfig", "kind": 256, "kindString": "Interface", @@ -22291,7 +23372,7 @@ }, "children": [ { - "id": 2647, + "id": 2701, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -22322,20 +23403,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2648, + "id": 2702, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2649, + "id": 2703, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2650, + "id": 2704, "name": "key", "kind": 32768, "flags": {}, @@ -22371,7 +23452,7 @@ } }, { - "id": 2674, + "id": 2730, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -22399,7 +23480,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1312, + "line": 1340, "character": 4 } ], @@ -22413,7 +23494,7 @@ } }, { - "id": 2628, + "id": 2682, "name": "collapseSearchBarInitially", "kind": 1024, "kindString": "Property", @@ -22440,7 +23521,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 505, + "line": 506, "character": 4 } ], @@ -22450,7 +23531,7 @@ } }, { - "id": 2671, + "id": 2727, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -22474,13 +23555,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1276, + "line": 1304, "character": 4 } ], "type": { "type": "reference", - "id": 2319, + "id": 2365, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -22489,7 +23570,7 @@ } }, { - "id": 2691, + "id": 2747, "name": "coverAndFilterOptionInPDF", "kind": 1024, "kindString": "Property", @@ -22513,7 +23594,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1532, + "line": 1560, "character": 4 } ], @@ -22527,7 +23608,7 @@ } }, { - "id": 2665, + "id": 2719, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -22568,7 +23649,7 @@ } }, { - "id": 2651, + "id": 2705, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -22597,7 +23678,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -22606,7 +23687,7 @@ } }, { - "id": 2629, + "id": 2683, "name": "dataPanelCustomGroupsAccordionInitialState", "kind": 1024, "kindString": "Property", @@ -22634,18 +23715,18 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 526, + "line": 527, "character": 4 } ], "type": { "type": "reference", - "id": 3003, + "id": 3059, "name": "DataPanelCustomColumnGroupsAccordionState" } }, { - "id": 2675, + "id": 2731, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -22673,7 +23754,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1328, + "line": 1356, "character": 4 } ], @@ -22687,7 +23768,7 @@ } }, { - "id": 2611, + "id": 2665, "name": "disableProfileAndHelp", "kind": 1024, "kindString": "Property", @@ -22715,7 +23796,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 213, + "line": 214, "character": 4 } ], @@ -22725,7 +23806,7 @@ } }, { - "id": 2659, + "id": 2713, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -22763,7 +23844,7 @@ } }, { - "id": 2643, + "id": 2697, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -22801,7 +23882,7 @@ } }, { - "id": 2642, + "id": 2696, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -22833,7 +23914,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -22843,7 +23924,7 @@ } }, { - "id": 2627, + "id": 2681, "name": "discoveryExperience", "kind": 1024, "kindString": "Property", @@ -22870,7 +23951,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 498, + "line": 499, "character": 4 } ], @@ -22880,7 +23961,7 @@ } }, { - "id": 2655, + "id": 2709, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -22921,7 +24002,7 @@ } }, { - "id": 2685, + "id": 2741, "name": "enable2ColumnLayout", "kind": 1024, "kindString": "Property", @@ -22949,7 +24030,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1430, + "line": 1458, "character": 4 } ], @@ -22963,7 +24044,7 @@ } }, { - "id": 2690, + "id": 2746, "name": "enableAskSage", "kind": 1024, "kindString": "Property", @@ -22991,7 +24072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1516, + "line": 1544, "character": 4 } ], @@ -23005,7 +24086,7 @@ } }, { - "id": 2676, + "id": 2732, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -23033,7 +24114,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1344, + "line": 1372, "character": 4 } ], @@ -23047,7 +24128,7 @@ } }, { - "id": 2612, + "id": 2666, "name": "enablePendoHelp", "kind": 1024, "kindString": "Property", @@ -23073,7 +24154,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 229, + "line": 230, "character": 4 } ], @@ -23083,7 +24164,7 @@ } }, { - "id": 2624, + "id": 2678, "name": "enableSearchAssist", "kind": 1024, "kindString": "Property", @@ -23111,7 +24192,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 439, + "line": 440, "character": 4 } ], @@ -23121,7 +24202,7 @@ } }, { - "id": 2656, + "id": 2710, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -23159,7 +24240,7 @@ } }, { - "id": 2672, + "id": 2728, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -23183,7 +24264,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1287, + "line": 1315, "character": 4 } ], @@ -23197,7 +24278,7 @@ } }, { - "id": 2673, + "id": 2729, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -23221,7 +24302,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1297, + "line": 1325, "character": 4 } ], @@ -23235,7 +24316,7 @@ } }, { - "id": 2658, + "id": 2712, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -23272,7 +24353,7 @@ } }, { - "id": 2639, + "id": 2693, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -23302,7 +24383,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -23311,7 +24392,7 @@ } }, { - "id": 2625, + "id": 2679, "name": "fullHeight", "kind": 1024, "kindString": "Property", @@ -23335,7 +24416,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 462, + "line": 463, "character": 4 } ], @@ -23345,7 +24426,7 @@ } }, { - "id": 2644, + "id": 2698, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -23381,7 +24462,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -23391,7 +24472,7 @@ } }, { - "id": 2680, + "id": 2736, "name": "hiddenHomeLeftNavItems", "kind": 1024, "kindString": "Property", @@ -23415,7 +24496,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1212, + "line": 1240, "character": 4 } ], @@ -23423,7 +24504,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2709, + "id": 2765, "name": "HomeLeftNavItem" } }, @@ -23433,7 +24514,7 @@ } }, { - "id": 2678, + "id": 2734, "name": "hiddenHomepageModules", "kind": 1024, "kindString": "Property", @@ -23457,7 +24538,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1171, + "line": 1199, "character": 4 } ], @@ -23465,7 +24546,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2720, + "id": 2776, "name": "HomepageModule" } }, @@ -23475,7 +24556,7 @@ } }, { - "id": 2677, + "id": 2733, "name": "hiddenListColumns", "kind": 1024, "kindString": "Property", @@ -23499,7 +24580,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1150, + "line": 1178, "character": 4 } ], @@ -23507,7 +24588,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2997, + "id": 3053, "name": "ListPageColumns" } }, @@ -23517,7 +24598,7 @@ } }, { - "id": 2616, + "id": 2670, "name": "hideApplicationSwitcher", "kind": 1024, "kindString": "Property", @@ -23545,7 +24626,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 306, + "line": 307, "character": 4 } ], @@ -23555,7 +24636,7 @@ } }, { - "id": 2613, + "id": 2667, "name": "hideHamburger", "kind": 1024, "kindString": "Property", @@ -23583,7 +24664,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 245, + "line": 246, "character": 4 } ], @@ -23593,7 +24674,7 @@ } }, { - "id": 2610, + "id": 2664, "name": "hideHomepageLeftNav", "kind": 1024, "kindString": "Property", @@ -23621,7 +24702,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 195, + "line": 196, "character": 4 } ], @@ -23631,7 +24712,7 @@ } }, { - "id": 2688, + "id": 2744, "name": "hideIrrelevantChipsInLiveboardTabs", "kind": 1024, "kindString": "Property", @@ -23659,7 +24740,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1483, + "line": 1511, "character": 4 } ], @@ -23673,7 +24754,7 @@ } }, { - "id": 2681, + "id": 2737, "name": "hideLiveboardHeader", "kind": 1024, "kindString": "Property", @@ -23701,7 +24782,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1366, + "line": 1394, "character": 4 } ], @@ -23715,7 +24796,7 @@ } }, { - "id": 2615, + "id": 2669, "name": "hideNotification", "kind": 1024, "kindString": "Property", @@ -23743,7 +24824,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 284, + "line": 285, "character": 4 } ], @@ -23753,7 +24834,7 @@ } }, { - "id": 2614, + "id": 2668, "name": "hideObjectSearch", "kind": 1024, "kindString": "Property", @@ -23781,7 +24862,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 265, + "line": 266, "character": 4 } ], @@ -23791,7 +24872,7 @@ } }, { - "id": 2622, + "id": 2676, "name": "hideObjects", "kind": 1024, "kindString": "Property", @@ -23815,7 +24896,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 415, + "line": 416, "character": 4 } ], @@ -23828,7 +24909,7 @@ } }, { - "id": 2617, + "id": 2671, "name": "hideOrgSwitcher", "kind": 1024, "kindString": "Property", @@ -23856,7 +24937,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 324, + "line": 325, "character": 4 } ], @@ -23866,7 +24947,7 @@ } }, { - "id": 2621, + "id": 2675, "name": "hideTagFilterChips", "kind": 1024, "kindString": "Property", @@ -23890,7 +24971,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 398, + "line": 399, "character": 4 } ], @@ -23900,7 +24981,7 @@ } }, { - "id": 2630, + "id": 2684, "name": "homePageSearchBarMode", "kind": 1024, "kindString": "Property", @@ -23920,18 +25001,18 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 533, + "line": 534, "character": 4 } ], "type": { "type": "reference", - "id": 2954, + "id": 3010, "name": "HomePageSearchBarMode" } }, { - "id": 2652, + "id": 2706, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -23969,7 +25050,7 @@ } }, { - "id": 2668, + "id": 2724, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -23992,7 +25073,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -24006,7 +25087,7 @@ } }, { - "id": 2667, + "id": 2723, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -24029,7 +25110,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -24046,7 +25127,7 @@ } }, { - "id": 2693, + "id": 2749, "name": "isCentralizedLiveboardFilterUXEnabled", "kind": 1024, "kindString": "Property", @@ -24070,7 +25151,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1566, + "line": 1594, "character": 4 } ], @@ -24084,7 +25165,7 @@ } }, { - "id": 2695, + "id": 2751, "name": "isEnhancedFilterInteractivityEnabled", "kind": 1024, "kindString": "Property", @@ -24108,7 +25189,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1597, + "line": 1625, "character": 4 } ], @@ -24122,7 +25203,7 @@ } }, { - "id": 2694, + "id": 2750, "name": "isLinkParametersEnabled", "kind": 1024, "kindString": "Property", @@ -24146,7 +25227,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1581, + "line": 1609, "character": 4 } ], @@ -24160,7 +25241,7 @@ } }, { - "id": 2686, + "id": 2742, "name": "isLiveboardCompactHeaderEnabled", "kind": 1024, "kindString": "Property", @@ -24188,7 +25269,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1447, + "line": 1475, "character": 4 } ], @@ -24202,7 +25283,7 @@ } }, { - "id": 2684, + "id": 2740, "name": "isLiveboardHeaderSticky", "kind": 1024, "kindString": "Property", @@ -24226,7 +25307,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1413, + "line": 1441, "character": 4 } ], @@ -24240,7 +25321,7 @@ } }, { - "id": 2697, + "id": 2753, "name": "isLiveboardMasterpiecesEnabled", "kind": 1024, "kindString": "Property", @@ -24268,7 +25349,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1629, + "line": 1657, "character": 4 } ], @@ -24282,7 +25363,7 @@ } }, { - "id": 2632, + "id": 2686, "name": "isLiveboardStylingAndGroupingEnabled", "kind": 1024, "kindString": "Property", @@ -24306,7 +25387,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 565, + "line": 566, "character": 4 } ], @@ -24316,7 +25397,7 @@ } }, { - "id": 2666, + "id": 2722, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -24336,7 +25417,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -24350,7 +25431,7 @@ } }, { - "id": 2633, + "id": 2687, "name": "isPNGInScheduledEmailsEnabled", "kind": 1024, "kindString": "Property", @@ -24374,7 +25455,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 582, + "line": 583, "character": 4 } ], @@ -24384,7 +25465,7 @@ } }, { - "id": 2631, + "id": 2685, "name": "isUnifiedSearchExperienceEnabled", "kind": 1024, "kindString": "Property", @@ -24412,7 +25493,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 548, + "line": 549, "character": 4 } ], @@ -24422,7 +25503,7 @@ } }, { - "id": 2634, + "id": 2688, "name": "lazyLoadingForFullHeight", "kind": 1024, "kindString": "Property", @@ -24449,7 +25530,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 600, + "line": 601, "character": 4 } ], @@ -24459,7 +25540,7 @@ } }, { - "id": 2635, + "id": 2689, "name": "lazyLoadingMargin", "kind": 1024, "kindString": "Property", @@ -24483,7 +25564,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 624, + "line": 625, "character": 4 } ], @@ -24493,7 +25574,7 @@ } }, { - "id": 2661, + "id": 2715, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -24531,7 +25612,7 @@ } }, { - "id": 2692, + "id": 2748, "name": "liveboardXLSXCSVDownload", "kind": 1024, "kindString": "Property", @@ -24555,7 +25636,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1548, + "line": 1576, "character": 4 } ], @@ -24569,7 +25650,7 @@ } }, { - "id": 2646, + "id": 2700, "name": "locale", "kind": 1024, "kindString": "Property", @@ -24607,7 +25688,7 @@ } }, { - "id": 2637, + "id": 2691, "name": "minimumHeight", "kind": 1024, "kindString": "Property", @@ -24634,7 +25715,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 657, + "line": 658, "character": 4 } ], @@ -24644,7 +25725,7 @@ } }, { - "id": 2626, + "id": 2680, "name": "modularHomeExperience", "kind": 1024, "kindString": "Property", @@ -24671,7 +25752,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 478, + "line": 479, "character": 4 } ], @@ -24681,7 +25762,7 @@ } }, { - "id": 2660, + "id": 2714, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -24719,7 +25800,7 @@ } }, { - "id": 2619, + "id": 2673, "name": "pageId", "kind": 1024, "kindString": "Property", @@ -24743,18 +25824,18 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 362, + "line": 363, "character": 4 } ], "type": { "type": "reference", - "id": 1958, + "id": 1998, "name": "Page" } }, { - "id": 2618, + "id": 2672, "name": "path", "kind": 1024, "kindString": "Property", @@ -24778,7 +25859,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 344, + "line": 345, "character": 4 } ], @@ -24788,7 +25869,7 @@ } }, { - "id": 2654, + "id": 2708, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -24826,7 +25907,7 @@ } }, { - "id": 2662, + "id": 2716, "name": "primaryAction", "kind": 1024, "kindString": "Property", @@ -24864,7 +25945,7 @@ } }, { - "id": 2679, + "id": 2735, "name": "reorderedHomepageModules", "kind": 1024, "kindString": "Property", @@ -24888,7 +25969,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1191, + "line": 1219, "character": 4 } ], @@ -24896,7 +25977,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2720, + "id": 2776, "name": "HomepageModule" } }, @@ -24906,7 +25987,7 @@ } }, { - "id": 2669, + "id": 2725, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -24930,7 +26011,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1240, + "line": 1268, "character": 4 } ], @@ -24938,7 +26019,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } }, @@ -24948,7 +26029,7 @@ } }, { - "id": 2670, + "id": 2726, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -24972,7 +26053,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1261, + "line": 1289, "character": 4 } ], @@ -24980,7 +26061,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } }, @@ -24990,7 +26071,48 @@ } }, { - "id": 2664, + "id": 2720, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "AllEmbedViewConfig.shouldBypassPayloadValidation" + } + }, + { + "id": 2718, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -25027,7 +26149,7 @@ } }, { - "id": 2683, + "id": 2739, "name": "showLiveboardDescription", "kind": 1024, "kindString": "Property", @@ -25055,7 +26177,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1398, + "line": 1426, "character": 4 } ], @@ -25069,7 +26191,7 @@ } }, { - "id": 2689, + "id": 2745, "name": "showLiveboardReverifyBanner", "kind": 1024, "kindString": "Property", @@ -25097,7 +26219,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1500, + "line": 1528, "character": 4 } ], @@ -25111,7 +26233,7 @@ } }, { - "id": 2682, + "id": 2738, "name": "showLiveboardTitle", "kind": 1024, "kindString": "Property", @@ -25139,7 +26261,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1382, + "line": 1410, "character": 4 } ], @@ -25153,7 +26275,7 @@ } }, { - "id": 2687, + "id": 2743, "name": "showLiveboardVerifiedBadge", "kind": 1024, "kindString": "Property", @@ -25181,7 +26303,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1464, + "line": 1492, "character": 4 } ], @@ -25195,7 +26317,7 @@ } }, { - "id": 2696, + "id": 2752, "name": "showMaskedFilterChip", "kind": 1024, "kindString": "Property", @@ -25223,7 +26345,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1613, + "line": 1641, "character": 4 } ], @@ -25237,7 +26359,7 @@ } }, { - "id": 2609, + "id": 2663, "name": "showPrimaryNavbar", "kind": 1024, "kindString": "Property", @@ -25265,7 +26387,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 173, + "line": 174, "character": 4 } ], @@ -25275,7 +26397,7 @@ } }, { - "id": 2620, + "id": 2674, "name": "tag", "kind": 1024, "kindString": "Property", @@ -25299,7 +26421,7 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 378, + "line": 379, "character": 4 } ], @@ -25309,7 +26431,7 @@ } }, { - "id": 2636, + "id": 2690, "name": "updatedSpotterChatPrompt", "kind": 1024, "kindString": "Property", @@ -25337,17 +26459,58 @@ "sources": [ { "fileName": "embed/app.ts", - "line": 640, + "line": 641, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2721, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "AllEmbedViewConfig.useHostEventsV2" } }, { - "id": 2645, + "id": 2699, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -25383,7 +26546,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -25398,92 +26561,94 @@ "title": "Properties", "kind": 1024, "children": [ - 2647, - 2674, - 2628, - 2671, - 2691, + 2701, + 2730, + 2682, + 2727, + 2747, + 2719, + 2705, + 2683, + 2731, 2665, - 2651, - 2629, - 2675, - 2611, - 2659, - 2643, - 2642, - 2627, - 2655, - 2685, - 2690, - 2676, - 2612, - 2624, - 2656, - 2672, - 2673, - 2658, - 2639, - 2625, - 2644, - 2680, - 2678, - 2677, - 2616, - 2613, - 2610, - 2688, - 2681, - 2615, - 2614, - 2622, - 2617, - 2621, - 2630, - 2652, - 2668, - 2667, - 2693, - 2695, - 2694, - 2686, - 2684, + 2713, 2697, - 2632, + 2696, + 2681, + 2709, + 2741, + 2746, + 2732, 2666, - 2633, - 2631, - 2634, - 2635, - 2661, - 2692, - 2646, - 2637, - 2626, - 2660, - 2619, - 2618, - 2654, - 2662, + 2678, + 2710, + 2728, + 2729, + 2712, + 2693, 2679, - 2669, + 2698, + 2736, + 2734, + 2733, 2670, + 2667, 2664, - 2683, - 2689, - 2682, + 2744, + 2737, + 2669, + 2668, + 2676, + 2671, + 2675, + 2684, + 2706, + 2724, + 2723, + 2749, + 2751, + 2750, + 2742, + 2740, + 2753, + 2686, + 2722, 2687, - 2696, - 2609, - 2620, - 2636, - 2645 + 2685, + 2688, + 2689, + 2715, + 2748, + 2700, + 2691, + 2680, + 2714, + 2673, + 2672, + 2708, + 2716, + 2735, + 2725, + 2726, + 2720, + 2718, + 2739, + 2745, + 2738, + 2743, + 2752, + 2663, + 2674, + 2690, + 2721, + 2699 ] } ], "sources": [ { "fileName": "embed/app.ts", - "line": 156, + "line": 157, "character": 17 } ], @@ -25495,7 +26660,7 @@ ] }, { - "id": 1822, + "id": 1862, "name": "AuthEventEmitter", "kind": 256, "kindString": "Interface", @@ -25511,14 +26676,14 @@ }, "children": [ { - "id": 1859, + "id": 1899, "name": "emit", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1860, + "id": 1900, "name": "emit", "kind": 4096, "kindString": "Call signature", @@ -25528,19 +26693,19 @@ }, "parameters": [ { - "id": 1861, + "id": 1901, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1821, + "id": 1861, "name": "TRIGGER_SSO_POPUP" } }, { - "id": 1862, + "id": 1902, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -25564,14 +26729,14 @@ ] }, { - "id": 1863, + "id": 1903, "name": "off", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1864, + "id": 1904, "name": "off", "kind": 4096, "kindString": "Call signature", @@ -25581,7 +26746,7 @@ }, "parameters": [ { - "id": 1865, + "id": 1905, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -25589,12 +26754,12 @@ "comment": {}, "type": { "type": "reference", - "id": 1812, + "id": 1852, "name": "AuthStatus" } }, { - "id": 1866, + "id": 1906, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -25603,21 +26768,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1867, + "id": 1907, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1868, + "id": 1908, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1869, + "id": 1909, "name": "args", "kind": 32768, "kindString": "Parameter", @@ -25643,7 +26808,7 @@ } }, { - "id": 1870, + "id": 1910, "name": "context", "kind": 32768, "kindString": "Parameter", @@ -25655,7 +26820,7 @@ } }, { - "id": 1871, + "id": 1911, "name": "once", "kind": 32768, "kindString": "Parameter", @@ -25671,21 +26836,21 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } } ] }, { - "id": 1823, + "id": 1863, "name": "on", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1824, + "id": 1864, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -25695,7 +26860,7 @@ }, "parameters": [ { - "id": 1825, + "id": 1865, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -25703,12 +26868,12 @@ "comment": {}, "type": { "type": "reference", - "id": 1813, + "id": 1853, "name": "FAILURE" } }, { - "id": 1826, + "id": 1866, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -25719,28 +26884,28 @@ "type": { "type": "reflection", "declaration": { - "id": 1827, + "id": 1867, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1828, + "id": 1868, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1829, + "id": 1869, "name": "failureType", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1805, + "id": 1845, "name": "AuthFailureType" } } @@ -25757,12 +26922,12 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } }, { - "id": 1830, + "id": 1870, "name": "on", "kind": 4096, "kindString": "Call signature", @@ -25772,7 +26937,7 @@ }, "parameters": [ { - "id": 1831, + "id": 1871, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -25783,29 +26948,29 @@ "types": [ { "type": "reference", - "id": 1814, + "id": 1854, "name": "SDK_SUCCESS" }, { "type": "reference", - "id": 1817, + "id": 1857, "name": "LOGOUT" }, { "type": "reference", - "id": 1818, + "id": 1858, "name": "WAITING_FOR_POPUP" }, { "type": "reference", - "id": 1819, + "id": 1859, "name": "SAML_POPUP_CLOSED_NO_AUTH" } ] } }, { - "id": 1832, + "id": 1872, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -25816,14 +26981,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1833, + "id": 1873, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1834, + "id": 1874, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -25840,31 +27005,31 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } }, { - "id": 1835, + "id": 1875, "name": "on", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1836, + "id": 1876, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1816, + "id": 1856, "name": "SUCCESS" } }, { - "id": 1837, + "id": 1877, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -25872,21 +27037,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1838, + "id": 1878, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1839, + "id": 1879, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1840, + "id": 1880, "name": "sessionInfo", "kind": 32768, "kindString": "Parameter", @@ -25909,40 +27074,40 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } } ] }, { - "id": 1841, + "id": 1881, "name": "once", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1842, + "id": 1882, "name": "once", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1843, + "id": 1883, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1813, + "id": 1853, "name": "FAILURE" } }, { - "id": 1844, + "id": 1884, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -25950,28 +27115,28 @@ "type": { "type": "reflection", "declaration": { - "id": 1845, + "id": 1885, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1846, + "id": 1886, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1847, + "id": 1887, "name": "failureType", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1805, + "id": 1845, "name": "AuthFailureType" } } @@ -25988,19 +27153,19 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } }, { - "id": 1848, + "id": 1888, "name": "once", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1849, + "id": 1889, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -26010,29 +27175,29 @@ "types": [ { "type": "reference", - "id": 1814, + "id": 1854, "name": "SDK_SUCCESS" }, { "type": "reference", - "id": 1817, + "id": 1857, "name": "LOGOUT" }, { "type": "reference", - "id": 1818, + "id": 1858, "name": "WAITING_FOR_POPUP" }, { "type": "reference", - "id": 1819, + "id": 1859, "name": "SAML_POPUP_CLOSED_NO_AUTH" } ] } }, { - "id": 1850, + "id": 1890, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -26040,14 +27205,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1851, + "id": 1891, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1852, + "id": 1892, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -26064,31 +27229,31 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } }, { - "id": 1853, + "id": 1893, "name": "once", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1854, + "id": 1894, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 1816, + "id": 1856, "name": "SUCCESS" } }, { - "id": 1855, + "id": 1895, "name": "listener", "kind": 32768, "kindString": "Parameter", @@ -26096,21 +27261,21 @@ "type": { "type": "reflection", "declaration": { - "id": 1856, + "id": 1896, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 1857, + "id": 1897, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 1858, + "id": 1898, "name": "sessionInfo", "kind": 32768, "kindString": "Parameter", @@ -26133,21 +27298,21 @@ ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } } ] }, { - "id": 1872, + "id": 1912, "name": "removeAllListeners", "kind": 2048, "kindString": "Method", "flags": {}, "signatures": [ { - "id": 1873, + "id": 1913, "name": "removeAllListeners", "kind": 4096, "kindString": "Call signature", @@ -26157,7 +27322,7 @@ }, "parameters": [ { - "id": 1874, + "id": 1914, "name": "event", "kind": 32768, "kindString": "Parameter", @@ -26167,14 +27332,14 @@ }, "type": { "type": "reference", - "id": 1812, + "id": 1852, "name": "AuthStatus" } } ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } } @@ -26186,11 +27351,11 @@ "title": "Methods", "kind": 2048, "children": [ - 1859, + 1899, + 1903, 1863, - 1823, - 1841, - 1872 + 1881, + 1912 ] } ], @@ -26203,7 +27368,7 @@ ] }, { - "id": 1308, + "id": 1334, "name": "BodylessConversationViewConfig", "kind": 256, "kindString": "Interface", @@ -26223,7 +27388,7 @@ }, "children": [ { - "id": 1319, + "id": 1345, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -26254,20 +27419,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1320, + "id": 1346, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1321, + "id": 1347, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1322, + "id": 1348, "name": "key", "kind": 32768, "flags": {}, @@ -26299,12 +27464,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1287, + "id": 1311, "name": "SpotterAgentEmbedViewConfig.additionalFlags" } }, { - "id": 1336, + "id": 1362, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -26341,12 +27506,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1304, + "id": 1328, "name": "SpotterAgentEmbedViewConfig.customActions" } }, { - "id": 1323, + "id": 1349, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -26375,17 +27540,17 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { "type": "reference", - "id": 1291, + "id": 1315, "name": "SpotterAgentEmbedViewConfig.customizations" } }, { - "id": 1331, + "id": 1357, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -26419,12 +27584,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1299, + "id": 1323, "name": "SpotterAgentEmbedViewConfig.disableRedirectionLinksInNewTab" } }, { - "id": 1315, + "id": 1341, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -26458,12 +27623,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1283, + "id": 1307, "name": "SpotterAgentEmbedViewConfig.disabledActionReason" } }, { - "id": 1314, + "id": 1340, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -26495,18 +27660,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, "inheritedFrom": { "type": "reference", - "id": 1282, + "id": 1306, "name": "SpotterAgentEmbedViewConfig.disabledActions" } }, { - "id": 1327, + "id": 1353, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -26543,12 +27708,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1295, + "id": 1319, "name": "SpotterAgentEmbedViewConfig.doNotTrackPreRenderSize" } }, { - "id": 1328, + "id": 1354, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -26582,12 +27747,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1296, + "id": 1320, "name": "SpotterAgentEmbedViewConfig.enableV2Shell_experimental" } }, { - "id": 1330, + "id": 1356, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -26620,12 +27785,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1298, + "id": 1322, "name": "SpotterAgentEmbedViewConfig.exposeTranslationIDs" } }, { - "id": 1311, + "id": 1337, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -26655,17 +27820,17 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { "type": "reference", - "id": 1279, + "id": 1303, "name": "SpotterAgentEmbedViewConfig.frameParams" } }, { - "id": 1316, + "id": 1342, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -26701,18 +27866,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, "inheritedFrom": { "type": "reference", - "id": 1284, + "id": 1308, "name": "SpotterAgentEmbedViewConfig.hiddenActions" } }, { - "id": 1324, + "id": 1350, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -26746,12 +27911,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1292, + "id": 1316, "name": "SpotterAgentEmbedViewConfig.insertAsSibling" } }, { - "id": 1339, + "id": 1367, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -26774,7 +27939,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -26784,12 +27949,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1307, + "id": 1333, "name": "SpotterAgentEmbedViewConfig.interceptTimeout" } }, { - "id": 1338, + "id": 1366, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -26812,7 +27977,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -26825,12 +27990,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1306, + "id": 1332, "name": "SpotterAgentEmbedViewConfig.interceptUrls" } }, { - "id": 1337, + "id": 1365, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -26850,7 +28015,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -26860,12 +28025,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1305, + "id": 1331, "name": "SpotterAgentEmbedViewConfig.isOnBeforeGetVizDataInterceptEnabled" } }, { - "id": 1333, + "id": 1359, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -26899,12 +28064,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1301, + "id": 1325, "name": "SpotterAgentEmbedViewConfig.linkOverride" } }, { - "id": 1318, + "id": 1344, "name": "locale", "kind": 1024, "kindString": "Property", @@ -26938,12 +28103,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1286, + "id": 1310, "name": "SpotterAgentEmbedViewConfig.locale" } }, { - "id": 1332, + "id": 1358, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -26977,12 +28142,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1300, + "id": 1324, "name": "SpotterAgentEmbedViewConfig.overrideOrgId" } }, { - "id": 1326, + "id": 1352, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -27016,12 +28181,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 1294, + "id": 1318, "name": "SpotterAgentEmbedViewConfig.preRenderId" } }, { - "id": 1335, + "id": 1363, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 1329, + "name": "SpotterAgentEmbedViewConfig.shouldBypassPayloadValidation" + } + }, + { + "id": 1361, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -27054,12 +28261,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 1303, + "id": 1327, "name": "SpotterAgentEmbedViewConfig.showAlerts" } }, { - "id": 1317, + "id": 1364, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 1330, + "name": "SpotterAgentEmbedViewConfig.useHostEventsV2" + } + }, + { + "id": 1343, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -27095,18 +28344,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, "inheritedFrom": { "type": "reference", - "id": 1285, + "id": 1309, "name": "SpotterAgentEmbedViewConfig.visibleActions" } }, { - "id": 1309, + "id": 1335, "name": "worksheetId", "kind": 1024, "kindString": "Property", @@ -27127,7 +28376,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1277, + "id": 1301, "name": "SpotterAgentEmbedViewConfig.worksheetId" } } @@ -27137,28 +28386,30 @@ "title": "Properties", "kind": 1024, "children": [ - 1319, - 1336, - 1323, - 1331, - 1315, - 1314, - 1327, - 1328, - 1330, - 1311, - 1316, - 1324, - 1339, - 1338, + 1345, + 1362, + 1349, + 1357, + 1341, + 1340, + 1353, + 1354, + 1356, 1337, - 1333, - 1318, - 1332, - 1326, - 1335, - 1317, - 1309 + 1342, + 1350, + 1367, + 1366, + 1365, + 1359, + 1344, + 1358, + 1352, + 1363, + 1361, + 1364, + 1343, + 1335 ] } ], @@ -27172,13 +28423,13 @@ "extendedTypes": [ { "type": "reference", - "id": 1276, + "id": 1300, "name": "SpotterAgentEmbedViewConfig" } ] }, { - "id": 1588, + "id": 1622, "name": "ConversationViewConfig", "kind": 256, "kindString": "Interface", @@ -27198,7 +28449,7 @@ }, "children": [ { - "id": 1611, + "id": 1645, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -27229,20 +28480,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1612, + "id": 1646, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1613, + "id": 1647, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1614, + "id": 1648, "name": "key", "kind": 32768, "flags": {}, @@ -27274,12 +28525,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1567, + "id": 1599, "name": "SpotterEmbedViewConfig.additionalFlags" } }, { - "id": 1628, + "id": 1662, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -27316,12 +28567,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1584, + "id": 1616, "name": "SpotterEmbedViewConfig.customActions" } }, { - "id": 1615, + "id": 1649, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -27350,17 +28601,17 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { "type": "reference", - "id": 1571, + "id": 1603, "name": "SpotterEmbedViewConfig.customizations" } }, { - "id": 1593, + "id": 1627, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -27388,7 +28639,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 75, + "line": 76, "character": 4 } ], @@ -27398,12 +28649,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1549, + "id": 1581, "name": "SpotterEmbedViewConfig.dataPanelV2" } }, { - "id": 1623, + "id": 1657, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -27437,12 +28688,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1579, + "id": 1611, "name": "SpotterEmbedViewConfig.disableRedirectionLinksInNewTab" } }, { - "id": 1591, + "id": 1625, "name": "disableSourceSelection", "kind": 1024, "kindString": "Property", @@ -27466,7 +28717,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 45, + "line": 46, "character": 4 } ], @@ -27476,12 +28727,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1547, + "id": 1579, "name": "SpotterEmbedViewConfig.disableSourceSelection" } }, { - "id": 1607, + "id": 1641, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -27515,12 +28766,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1563, + "id": 1595, "name": "SpotterEmbedViewConfig.disabledActionReason" } }, { - "id": 1606, + "id": 1640, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -27552,18 +28803,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, "inheritedFrom": { "type": "reference", - "id": 1562, + "id": 1594, "name": "SpotterEmbedViewConfig.disabledActions" } }, { - "id": 1619, + "id": 1653, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -27600,12 +28851,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1575, + "id": 1607, "name": "SpotterEmbedViewConfig.doNotTrackPreRenderSize" } }, { - "id": 1600, + "id": 1634, "name": "enablePastConversationsSidebar", "kind": 1024, "kindString": "Property", @@ -27633,7 +28884,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 182, + "line": 183, "character": 4 } ], @@ -27643,12 +28894,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1556, + "id": 1588, "name": "SpotterEmbedViewConfig.enablePastConversationsSidebar" } }, { - "id": 1620, + "id": 1654, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -27682,12 +28933,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1576, + "id": 1608, "name": "SpotterEmbedViewConfig.enableV2Shell_experimental" } }, { - "id": 1597, + "id": 1631, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -27711,7 +28962,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 137, + "line": 138, "character": 4 } ], @@ -27721,12 +28972,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1553, + "id": 1585, "name": "SpotterEmbedViewConfig.excludeRuntimeFiltersfromURL" } }, { - "id": 1599, + "id": 1633, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -27750,7 +29001,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 166, + "line": 167, "character": 4 } ], @@ -27760,12 +29011,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1555, + "id": 1587, "name": "SpotterEmbedViewConfig.excludeRuntimeParametersfromURL" } }, { - "id": 1622, + "id": 1656, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -27798,12 +29049,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1578, + "id": 1610, "name": "SpotterEmbedViewConfig.exposeTranslationIDs" } }, { - "id": 1603, + "id": 1637, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -27833,17 +29084,17 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { "type": "reference", - "id": 1559, + "id": 1591, "name": "SpotterEmbedViewConfig.frameParams" } }, { - "id": 1608, + "id": 1642, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -27879,18 +29130,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, "inheritedFrom": { "type": "reference", - "id": 1564, + "id": 1596, "name": "SpotterEmbedViewConfig.hiddenActions" } }, { - "id": 1595, + "id": 1629, "name": "hideSampleQuestions", "kind": 1024, "kindString": "Property", @@ -27914,7 +29165,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 106, + "line": 107, "character": 4 } ], @@ -27924,12 +29175,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1551, + "id": 1583, "name": "SpotterEmbedViewConfig.hideSampleQuestions" } }, { - "id": 1592, + "id": 1626, "name": "hideSourceSelection", "kind": 1024, "kindString": "Property", @@ -27953,7 +29204,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 59, + "line": 60, "character": 4 } ], @@ -27963,12 +29214,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1548, + "id": 1580, "name": "SpotterEmbedViewConfig.hideSourceSelection" } }, { - "id": 1616, + "id": 1650, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -28002,12 +29253,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1572, + "id": 1604, "name": "SpotterEmbedViewConfig.insertAsSibling" } }, { - "id": 1631, + "id": 1667, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -28030,7 +29281,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -28040,12 +29291,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1587, + "id": 1621, "name": "SpotterEmbedViewConfig.interceptTimeout" } }, { - "id": 1630, + "id": 1666, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -28068,7 +29319,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -28081,12 +29332,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1586, + "id": 1620, "name": "SpotterEmbedViewConfig.interceptUrls" } }, { - "id": 1629, + "id": 1665, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -28106,7 +29357,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -28116,12 +29367,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1585, + "id": 1619, "name": "SpotterEmbedViewConfig.isOnBeforeGetVizDataInterceptEnabled" } }, { - "id": 1625, + "id": 1659, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -28155,12 +29406,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1581, + "id": 1613, "name": "SpotterEmbedViewConfig.linkOverride" } }, { - "id": 1610, + "id": 1644, "name": "locale", "kind": 1024, "kindString": "Property", @@ -28194,12 +29445,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1566, + "id": 1598, "name": "SpotterEmbedViewConfig.locale" } }, { - "id": 1624, + "id": 1658, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -28233,12 +29484,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1580, + "id": 1612, "name": "SpotterEmbedViewConfig.overrideOrgId" } }, { - "id": 1618, + "id": 1652, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -28272,12 +29523,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1574, + "id": 1606, "name": "SpotterEmbedViewConfig.preRenderId" } }, { - "id": 1596, + "id": 1630, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -28301,7 +29552,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 127, + "line": 128, "character": 4 } ], @@ -28309,18 +29560,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } }, "inheritedFrom": { "type": "reference", - "id": 1552, + "id": 1584, "name": "SpotterEmbedViewConfig.runtimeFilters" } }, { - "id": 1598, + "id": 1632, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -28344,7 +29595,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 156, + "line": 157, "character": 4 } ], @@ -28352,18 +29603,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } }, "inheritedFrom": { "type": "reference", - "id": 1554, + "id": 1586, "name": "SpotterEmbedViewConfig.runtimeParameters" } }, { - "id": 1590, + "id": 1624, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -28376,7 +29627,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 30, + "line": 31, "character": 4 } ], @@ -28386,12 +29637,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 1546, + "id": 1578, "name": "SpotterEmbedViewConfig.searchOptions" } }, { - "id": 1627, + "id": 1663, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 1617, + "name": "SpotterEmbedViewConfig.shouldBypassPayloadValidation" + } + }, + { + "id": 1661, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -28424,12 +29717,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1583, + "id": 1615, "name": "SpotterEmbedViewConfig.showAlerts" } }, { - "id": 1594, + "id": 1628, "name": "showSpotterLimitations", "kind": 1024, "kindString": "Property", @@ -28453,7 +29746,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 91, + "line": 92, "character": 4 } ], @@ -28463,12 +29756,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 1550, + "id": 1582, "name": "SpotterEmbedViewConfig.showSpotterLimitations" } }, { - "id": 1601, + "id": 1635, "name": "updatedSpotterChatPrompt", "kind": 1024, "kindString": "Property", @@ -28496,7 +29789,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 198, + "line": 199, "character": 4 } ], @@ -28506,12 +29799,54 @@ }, "inheritedFrom": { "type": "reference", - "id": 1557, + "id": 1589, "name": "SpotterEmbedViewConfig.updatedSpotterChatPrompt" } }, { - "id": 1609, + "id": 1664, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "id": 1618, + "name": "SpotterEmbedViewConfig.useHostEventsV2" + } + }, + { + "id": 1643, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -28547,18 +29882,18 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, "inheritedFrom": { "type": "reference", - "id": 1565, + "id": 1597, "name": "SpotterEmbedViewConfig.visibleActions" } }, { - "id": 1589, + "id": 1623, "name": "worksheetId", "kind": 1024, "kindString": "Property", @@ -28569,7 +29904,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 26, + "line": 27, "character": 4 } ], @@ -28579,7 +29914,7 @@ }, "inheritedFrom": { "type": "reference", - "id": 1545, + "id": 1577, "name": "SpotterEmbedViewConfig.worksheetId" } } @@ -28589,60 +29924,62 @@ "title": "Properties", "kind": 1024, "children": [ - 1611, - 1628, - 1615, - 1593, - 1623, - 1591, - 1607, - 1606, - 1619, - 1600, - 1620, - 1597, - 1599, - 1622, - 1603, - 1608, - 1595, - 1592, - 1616, + 1645, + 1662, + 1649, + 1627, + 1657, + 1625, + 1641, + 1640, + 1653, + 1634, + 1654, 1631, - 1630, + 1633, + 1656, + 1637, + 1642, 1629, - 1625, - 1610, + 1626, + 1650, + 1667, + 1666, + 1665, + 1659, + 1644, + 1658, + 1652, + 1630, + 1632, 1624, - 1618, - 1596, - 1598, - 1590, - 1627, - 1594, - 1601, - 1609, - 1589 + 1663, + 1661, + 1628, + 1635, + 1664, + 1643, + 1623 ] } ], "sources": [ { "fileName": "embed/conversation.ts", - "line": 208, + "line": 209, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 1544, + "id": 1576, "name": "SpotterEmbedViewConfig" } ] }, { - "id": 2969, + "id": 3025, "name": "CustomActionPayload", "kind": 256, "kindString": "Interface", @@ -28657,7 +29994,7 @@ }, "children": [ { - "id": 2970, + "id": 3026, "name": "contextMenuPoints", "kind": 1024, "kindString": "Property", @@ -28667,21 +30004,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6124, + "line": 6162, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 2971, + "id": 3027, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2972, + "id": 3028, "name": "clickedPoint", "kind": 1024, "kindString": "Property", @@ -28689,18 +30026,18 @@ "sources": [ { "fileName": "types.ts", - "line": 6125, + "line": 6163, "character": 8 } ], "type": { "type": "reference", - "id": 2966, + "id": 3022, "name": "VizPoint" } }, { - "id": 2973, + "id": 3029, "name": "selectedPoints", "kind": 1024, "kindString": "Property", @@ -28708,7 +30045,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6126, + "line": 6164, "character": 8 } ], @@ -28716,7 +30053,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2966, + "id": 3022, "name": "VizPoint" } } @@ -28727,8 +30064,8 @@ "title": "Properties", "kind": 1024, "children": [ - 2972, - 2973 + 3028, + 3029 ] } ] @@ -28736,7 +30073,7 @@ } }, { - "id": 2974, + "id": 3030, "name": "embedAnswerData", "kind": 1024, "kindString": "Property", @@ -28744,21 +30081,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6128, + "line": 6166, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 2975, + "id": 3031, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2983, + "id": 3039, "name": "columns", "kind": 1024, "kindString": "Property", @@ -28766,7 +30103,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6136, + "line": 6174, "character": 8 } ], @@ -28779,7 +30116,7 @@ } }, { - "id": 2984, + "id": 3040, "name": "data", "kind": 1024, "kindString": "Property", @@ -28787,7 +30124,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6137, + "line": 6175, "character": 8 } ], @@ -28800,7 +30137,7 @@ } }, { - "id": 2977, + "id": 3033, "name": "id", "kind": 1024, "kindString": "Property", @@ -28808,7 +30145,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6130, + "line": 6168, "character": 8 } ], @@ -28818,7 +30155,7 @@ } }, { - "id": 2976, + "id": 3032, "name": "name", "kind": 1024, "kindString": "Property", @@ -28826,7 +30163,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6129, + "line": 6167, "character": 8 } ], @@ -28836,7 +30173,7 @@ } }, { - "id": 2978, + "id": 3034, "name": "sources", "kind": 1024, "kindString": "Property", @@ -28844,21 +30181,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6131, + "line": 6169, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 2979, + "id": 3035, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2980, + "id": 3036, "name": "header", "kind": 1024, "kindString": "Property", @@ -28866,21 +30203,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6132, + "line": 6170, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2981, + "id": 3037, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2982, + "id": 3038, "name": "guid", "kind": 1024, "kindString": "Property", @@ -28888,7 +30225,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6133, + "line": 6171, "character": 16 } ], @@ -28903,7 +30240,7 @@ "title": "Properties", "kind": 1024, "children": [ - 2982 + 3038 ] } ] @@ -28916,7 +30253,7 @@ "title": "Properties", "kind": 1024, "children": [ - 2980 + 3036 ] } ] @@ -28929,23 +30266,23 @@ "title": "Properties", "kind": 1024, "children": [ - 2983, - 2984, - 2977, - 2976, - 2978 + 3039, + 3040, + 3033, + 3032, + 3034 ] } ], "indexSignature": { - "id": 2985, + "id": 3041, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2986, + "id": 3042, "name": "key", "kind": 32768, "flags": {}, @@ -28964,7 +30301,7 @@ } }, { - "id": 2987, + "id": 3043, "name": "session", "kind": 1024, "kindString": "Property", @@ -28972,18 +30309,18 @@ "sources": [ { "fileName": "types.ts", - "line": 6140, + "line": 6178, "character": 4 } ], "type": { "type": "reference", - "id": 1948, + "id": 1988, "name": "SessionInterface" } }, { - "id": 2988, + "id": 3044, "name": "vizId", "kind": 1024, "kindString": "Property", @@ -28993,7 +30330,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6141, + "line": 6179, "character": 4 } ], @@ -29008,23 +30345,23 @@ "title": "Properties", "kind": 1024, "children": [ - 2970, - 2974, - 2987, - 2988 + 3026, + 3030, + 3043, + 3044 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6123, + "line": 6161, "character": 17 } ] }, { - "id": 2766, + "id": 2822, "name": "CustomCssVariables", "kind": 256, "kindString": "Interface", @@ -29034,7 +30371,7 @@ }, "children": [ { - "id": 2820, + "id": 2876, "name": "--ts-var-answer-chart-hover-background", "kind": 1024, "kindString": "Property", @@ -29057,7 +30394,7 @@ } }, { - "id": 2819, + "id": 2875, "name": "--ts-var-answer-chart-select-background", "kind": 1024, "kindString": "Property", @@ -29080,7 +30417,7 @@ } }, { - "id": 2789, + "id": 2845, "name": "--ts-var-answer-data-panel-background-color", "kind": 1024, "kindString": "Property", @@ -29103,7 +30440,7 @@ } }, { - "id": 2790, + "id": 2846, "name": "--ts-var-answer-edit-panel-background-color", "kind": 1024, "kindString": "Property", @@ -29126,7 +30463,7 @@ } }, { - "id": 2792, + "id": 2848, "name": "--ts-var-answer-view-table-chart-switcher-active-background", "kind": 1024, "kindString": "Property", @@ -29149,7 +30486,7 @@ } }, { - "id": 2791, + "id": 2847, "name": "--ts-var-answer-view-table-chart-switcher-background", "kind": 1024, "kindString": "Property", @@ -29172,7 +30509,7 @@ } }, { - "id": 2771, + "id": 2827, "name": "--ts-var-application-color", "kind": 1024, "kindString": "Property", @@ -29195,7 +30532,7 @@ } }, { - "id": 2832, + "id": 2888, "name": "--ts-var-axis-data-label-color", "kind": 1024, "kindString": "Property", @@ -29218,7 +30555,7 @@ } }, { - "id": 2833, + "id": 2889, "name": "--ts-var-axis-data-label-font-family", "kind": 1024, "kindString": "Property", @@ -29241,7 +30578,7 @@ } }, { - "id": 2830, + "id": 2886, "name": "--ts-var-axis-title-color", "kind": 1024, "kindString": "Property", @@ -29264,7 +30601,7 @@ } }, { - "id": 2831, + "id": 2887, "name": "--ts-var-axis-title-font-family", "kind": 1024, "kindString": "Property", @@ -29287,7 +30624,7 @@ } }, { - "id": 2794, + "id": 2850, "name": "--ts-var-button--icon-border-radius", "kind": 1024, "kindString": "Property", @@ -29310,7 +30647,7 @@ } }, { - "id": 2799, + "id": 2855, "name": "--ts-var-button--primary--active-background", "kind": 1024, "kindString": "Property", @@ -29333,7 +30670,7 @@ } }, { - "id": 2796, + "id": 2852, "name": "--ts-var-button--primary--font-family", "kind": 1024, "kindString": "Property", @@ -29356,7 +30693,7 @@ } }, { - "id": 2798, + "id": 2854, "name": "--ts-var-button--primary--hover-background", "kind": 1024, "kindString": "Property", @@ -29379,7 +30716,7 @@ } }, { - "id": 2797, + "id": 2853, "name": "--ts-var-button--primary-background", "kind": 1024, "kindString": "Property", @@ -29402,7 +30739,7 @@ } }, { - "id": 2795, + "id": 2851, "name": "--ts-var-button--primary-color", "kind": 1024, "kindString": "Property", @@ -29425,7 +30762,7 @@ } }, { - "id": 2804, + "id": 2860, "name": "--ts-var-button--secondary--active-background", "kind": 1024, "kindString": "Property", @@ -29448,7 +30785,7 @@ } }, { - "id": 2801, + "id": 2857, "name": "--ts-var-button--secondary--font-family", "kind": 1024, "kindString": "Property", @@ -29471,7 +30808,7 @@ } }, { - "id": 2803, + "id": 2859, "name": "--ts-var-button--secondary--hover-background", "kind": 1024, "kindString": "Property", @@ -29494,7 +30831,7 @@ } }, { - "id": 2802, + "id": 2858, "name": "--ts-var-button--secondary-background", "kind": 1024, "kindString": "Property", @@ -29517,7 +30854,7 @@ } }, { - "id": 2800, + "id": 2856, "name": "--ts-var-button--secondary-color", "kind": 1024, "kindString": "Property", @@ -29540,7 +30877,7 @@ } }, { - "id": 2808, + "id": 2864, "name": "--ts-var-button--tertiary--active-background", "kind": 1024, "kindString": "Property", @@ -29563,7 +30900,7 @@ } }, { - "id": 2807, + "id": 2863, "name": "--ts-var-button--tertiary--hover-background", "kind": 1024, "kindString": "Property", @@ -29586,7 +30923,7 @@ } }, { - "id": 2806, + "id": 2862, "name": "--ts-var-button--tertiary-background", "kind": 1024, "kindString": "Property", @@ -29609,7 +30946,7 @@ } }, { - "id": 2805, + "id": 2861, "name": "--ts-var-button--tertiary-color", "kind": 1024, "kindString": "Property", @@ -29632,7 +30969,7 @@ } }, { - "id": 2793, + "id": 2849, "name": "--ts-var-button-border-radius", "kind": 1024, "kindString": "Property", @@ -29655,7 +30992,7 @@ } }, { - "id": 2926, + "id": 2982, "name": "--ts-var-cca-modal-summary-header-background", "kind": 1024, "kindString": "Property", @@ -29678,7 +31015,7 @@ } }, { - "id": 2921, + "id": 2977, "name": "--ts-var-change-analysis-insights-background", "kind": 1024, "kindString": "Property", @@ -29701,7 +31038,7 @@ } }, { - "id": 2916, + "id": 2972, "name": "--ts-var-chart-heatmap-legend-label-color", "kind": 1024, "kindString": "Property", @@ -29724,7 +31061,7 @@ } }, { - "id": 2915, + "id": 2971, "name": "--ts-var-chart-heatmap-legend-title-color", "kind": 1024, "kindString": "Property", @@ -29747,7 +31084,7 @@ } }, { - "id": 2918, + "id": 2974, "name": "--ts-var-chart-treemap-legend-label-color", "kind": 1024, "kindString": "Property", @@ -29770,7 +31107,7 @@ } }, { - "id": 2917, + "id": 2973, "name": "--ts-var-chart-treemap-legend-title-color", "kind": 1024, "kindString": "Property", @@ -29793,7 +31130,7 @@ } }, { - "id": 2855, + "id": 2911, "name": "--ts-var-checkbox-active-color", "kind": 1024, "kindString": "Property", @@ -29816,7 +31153,7 @@ } }, { - "id": 2858, + "id": 2914, "name": "--ts-var-checkbox-background-color", "kind": 1024, "kindString": "Property", @@ -29839,7 +31176,7 @@ } }, { - "id": 2853, + "id": 2909, "name": "--ts-var-checkbox-border-color", "kind": 1024, "kindString": "Property", @@ -29862,7 +31199,7 @@ } }, { - "id": 2856, + "id": 2912, "name": "--ts-var-checkbox-checked-color", "kind": 1024, "kindString": "Property", @@ -29885,7 +31222,7 @@ } }, { - "id": 2857, + "id": 2913, "name": "--ts-var-checkbox-checked-disabled", "kind": 1024, "kindString": "Property", @@ -29908,7 +31245,7 @@ } }, { - "id": 2852, + "id": 2908, "name": "--ts-var-checkbox-error-border", "kind": 1024, "kindString": "Property", @@ -29931,7 +31268,7 @@ } }, { - "id": 2854, + "id": 2910, "name": "--ts-var-checkbox-hover-border", "kind": 1024, "kindString": "Property", @@ -29954,7 +31291,7 @@ } }, { - "id": 2825, + "id": 2881, "name": "--ts-var-chip--active-background", "kind": 1024, "kindString": "Property", @@ -29977,7 +31314,7 @@ } }, { - "id": 2824, + "id": 2880, "name": "--ts-var-chip--active-color", "kind": 1024, "kindString": "Property", @@ -30000,7 +31337,7 @@ } }, { - "id": 2827, + "id": 2883, "name": "--ts-var-chip--hover-background", "kind": 1024, "kindString": "Property", @@ -30023,7 +31360,7 @@ } }, { - "id": 2826, + "id": 2882, "name": "--ts-var-chip--hover-color", "kind": 1024, "kindString": "Property", @@ -30046,7 +31383,7 @@ } }, { - "id": 2823, + "id": 2879, "name": "--ts-var-chip-background", "kind": 1024, "kindString": "Property", @@ -30069,7 +31406,7 @@ } }, { - "id": 2821, + "id": 2877, "name": "--ts-var-chip-border-radius", "kind": 1024, "kindString": "Property", @@ -30092,7 +31429,7 @@ } }, { - "id": 2822, + "id": 2878, "name": "--ts-var-chip-box-shadow", "kind": 1024, "kindString": "Property", @@ -30115,7 +31452,7 @@ } }, { - "id": 2828, + "id": 2884, "name": "--ts-var-chip-color", "kind": 1024, "kindString": "Property", @@ -30138,7 +31475,7 @@ } }, { - "id": 2829, + "id": 2885, "name": "--ts-var-chip-title-font-family", "kind": 1024, "kindString": "Property", @@ -30161,7 +31498,7 @@ } }, { - "id": 2840, + "id": 2896, "name": "--ts-var-dialog-body-background", "kind": 1024, "kindString": "Property", @@ -30184,7 +31521,7 @@ } }, { - "id": 2841, + "id": 2897, "name": "--ts-var-dialog-body-color", "kind": 1024, "kindString": "Property", @@ -30207,7 +31544,7 @@ } }, { - "id": 2844, + "id": 2900, "name": "--ts-var-dialog-footer-background", "kind": 1024, "kindString": "Property", @@ -30230,7 +31567,7 @@ } }, { - "id": 2842, + "id": 2898, "name": "--ts-var-dialog-header-background", "kind": 1024, "kindString": "Property", @@ -30253,7 +31590,7 @@ } }, { - "id": 2843, + "id": 2899, "name": "--ts-var-dialog-header-color", "kind": 1024, "kindString": "Property", @@ -30276,7 +31613,7 @@ } }, { - "id": 2851, + "id": 2907, "name": "--ts-var-home-favorite-suggestion-card-background", "kind": 1024, "kindString": "Property", @@ -30299,7 +31636,7 @@ } }, { - "id": 2850, + "id": 2906, "name": "--ts-var-home-favorite-suggestion-card-icon-color", "kind": 1024, "kindString": "Property", @@ -30322,7 +31659,7 @@ } }, { - "id": 2849, + "id": 2905, "name": "--ts-var-home-favorite-suggestion-card-text-color", "kind": 1024, "kindString": "Property", @@ -30345,7 +31682,7 @@ } }, { - "id": 2848, + "id": 2904, "name": "--ts-var-home-watchlist-selected-text-color", "kind": 1024, "kindString": "Property", @@ -30368,7 +31705,7 @@ } }, { - "id": 2914, + "id": 2970, "name": "--ts-var-kpi-analyze-text-color", "kind": 1024, "kindString": "Property", @@ -30391,7 +31728,7 @@ } }, { - "id": 2913, + "id": 2969, "name": "--ts-var-kpi-comparison-color", "kind": 1024, "kindString": "Property", @@ -30414,7 +31751,7 @@ } }, { - "id": 2912, + "id": 2968, "name": "--ts-var-kpi-hero-color", "kind": 1024, "kindString": "Property", @@ -30437,7 +31774,7 @@ } }, { - "id": 2920, + "id": 2976, "name": "--ts-var-kpi-negative-change-color", "kind": 1024, "kindString": "Property", @@ -30460,7 +31797,7 @@ } }, { - "id": 2919, + "id": 2975, "name": "--ts-var-kpi-positive-change-color", "kind": 1024, "kindString": "Property", @@ -30483,7 +31820,7 @@ } }, { - "id": 2846, + "id": 2902, "name": "--ts-var-list-hover-background", "kind": 1024, "kindString": "Property", @@ -30506,7 +31843,7 @@ } }, { - "id": 2845, + "id": 2901, "name": "--ts-var-list-selected-background", "kind": 1024, "kindString": "Property", @@ -30529,7 +31866,7 @@ } }, { - "id": 2873, + "id": 2929, "name": "--ts-var-liveboard-answer-viz-padding", "kind": 1024, "kindString": "Property", @@ -30552,7 +31889,7 @@ } }, { - "id": 2886, + "id": 2942, "name": "--ts-var-liveboard-chip--active-background", "kind": 1024, "kindString": "Property", @@ -30576,7 +31913,7 @@ } }, { - "id": 2885, + "id": 2941, "name": "--ts-var-liveboard-chip--hover-background", "kind": 1024, "kindString": "Property", @@ -30600,7 +31937,7 @@ } }, { - "id": 2883, + "id": 2939, "name": "--ts-var-liveboard-chip-background", "kind": 1024, "kindString": "Property", @@ -30624,7 +31961,7 @@ } }, { - "id": 2884, + "id": 2940, "name": "--ts-var-liveboard-chip-color", "kind": 1024, "kindString": "Property", @@ -30648,7 +31985,7 @@ } }, { - "id": 2891, + "id": 2947, "name": "--ts-var-liveboard-cross-filter-layout-background", "kind": 1024, "kindString": "Property", @@ -30671,7 +32008,7 @@ } }, { - "id": 2889, + "id": 2945, "name": "--ts-var-liveboard-dual-column-breakpoint", "kind": 1024, "kindString": "Property", @@ -30694,7 +32031,7 @@ } }, { - "id": 2888, + "id": 2944, "name": "--ts-var-liveboard-edit-bar-background", "kind": 1024, "kindString": "Property", @@ -30717,7 +32054,7 @@ } }, { - "id": 2874, + "id": 2930, "name": "--ts-var-liveboard-group-background", "kind": 1024, "kindString": "Property", @@ -30741,7 +32078,7 @@ } }, { - "id": 2875, + "id": 2931, "name": "--ts-var-liveboard-group-border-color", "kind": 1024, "kindString": "Property", @@ -30765,7 +32102,7 @@ } }, { - "id": 2879, + "id": 2935, "name": "--ts-var-liveboard-group-description-font-color", "kind": 1024, "kindString": "Property", @@ -30789,7 +32126,7 @@ } }, { - "id": 2867, + "id": 2923, "name": "--ts-var-liveboard-group-padding", "kind": 1024, "kindString": "Property", @@ -30813,7 +32150,7 @@ } }, { - "id": 2882, + "id": 2938, "name": "--ts-var-liveboard-group-tile-background", "kind": 1024, "kindString": "Property", @@ -30837,7 +32174,7 @@ } }, { - "id": 2881, + "id": 2937, "name": "--ts-var-liveboard-group-tile-description-font-color", "kind": 1024, "kindString": "Property", @@ -30861,7 +32198,7 @@ } }, { - "id": 2872, + "id": 2928, "name": "--ts-var-liveboard-group-tile-padding", "kind": 1024, "kindString": "Property", @@ -30885,7 +32222,7 @@ } }, { - "id": 2880, + "id": 2936, "name": "--ts-var-liveboard-group-tile-title-font-color", "kind": 1024, "kindString": "Property", @@ -30909,7 +32246,7 @@ } }, { - "id": 2870, + "id": 2926, "name": "--ts-var-liveboard-group-tile-title-font-size", "kind": 1024, "kindString": "Property", @@ -30933,7 +32270,7 @@ } }, { - "id": 2871, + "id": 2927, "name": "--ts-var-liveboard-group-tile-title-font-weight", "kind": 1024, "kindString": "Property", @@ -30957,7 +32294,7 @@ } }, { - "id": 2878, + "id": 2934, "name": "--ts-var-liveboard-group-title-font-color", "kind": 1024, "kindString": "Property", @@ -30981,7 +32318,7 @@ } }, { - "id": 2868, + "id": 2924, "name": "--ts-var-liveboard-group-title-font-size", "kind": 1024, "kindString": "Property", @@ -31005,7 +32342,7 @@ } }, { - "id": 2869, + "id": 2925, "name": "--ts-var-liveboard-group-title-font-weight", "kind": 1024, "kindString": "Property", @@ -31029,7 +32366,7 @@ } }, { - "id": 2905, + "id": 2961, "name": "--ts-var-liveboard-header-action-button-active-color", "kind": 1024, "kindString": "Property", @@ -31052,7 +32389,7 @@ } }, { - "id": 2902, + "id": 2958, "name": "--ts-var-liveboard-header-action-button-background", "kind": 1024, "kindString": "Property", @@ -31075,7 +32412,7 @@ } }, { - "id": 2903, + "id": 2959, "name": "--ts-var-liveboard-header-action-button-font-color", "kind": 1024, "kindString": "Property", @@ -31098,7 +32435,7 @@ } }, { - "id": 2904, + "id": 2960, "name": "--ts-var-liveboard-header-action-button-hover-color", "kind": 1024, "kindString": "Property", @@ -31121,7 +32458,7 @@ } }, { - "id": 2860, + "id": 2916, "name": "--ts-var-liveboard-header-background", "kind": 1024, "kindString": "Property", @@ -31144,7 +32481,7 @@ } }, { - "id": 2911, + "id": 2967, "name": "--ts-var-liveboard-header-badge-active-color", "kind": 1024, "kindString": "Property", @@ -31167,7 +32504,7 @@ } }, { - "id": 2906, + "id": 2962, "name": "--ts-var-liveboard-header-badge-background", "kind": 1024, "kindString": "Property", @@ -31190,7 +32527,7 @@ } }, { - "id": 2907, + "id": 2963, "name": "--ts-var-liveboard-header-badge-font-color", "kind": 1024, "kindString": "Property", @@ -31213,7 +32550,7 @@ } }, { - "id": 2910, + "id": 2966, "name": "--ts-var-liveboard-header-badge-hover-color", "kind": 1024, "kindString": "Property", @@ -31236,7 +32573,7 @@ } }, { - "id": 2908, + "id": 2964, "name": "--ts-var-liveboard-header-badge-modified-background", "kind": 1024, "kindString": "Property", @@ -31259,7 +32596,7 @@ } }, { - "id": 2909, + "id": 2965, "name": "--ts-var-liveboard-header-badge-modified-font-color", "kind": 1024, "kindString": "Property", @@ -31282,7 +32619,7 @@ } }, { - "id": 2861, + "id": 2917, "name": "--ts-var-liveboard-header-font-color", "kind": 1024, "kindString": "Property", @@ -31305,7 +32642,7 @@ } }, { - "id": 2859, + "id": 2915, "name": "--ts-var-liveboard-layout-background", "kind": 1024, "kindString": "Property", @@ -31328,7 +32665,7 @@ } }, { - "id": 2877, + "id": 2933, "name": "--ts-var-liveboard-notetitle-body-font-color", "kind": 1024, "kindString": "Property", @@ -31351,7 +32688,7 @@ } }, { - "id": 2876, + "id": 2932, "name": "--ts-var-liveboard-notetitle-heading-font-color", "kind": 1024, "kindString": "Property", @@ -31374,7 +32711,7 @@ } }, { - "id": 2890, + "id": 2946, "name": "--ts-var-liveboard-single-column-breakpoint", "kind": 1024, "kindString": "Property", @@ -31397,7 +32734,7 @@ } }, { - "id": 2892, + "id": 2948, "name": "--ts-var-liveboard-tab-active-border-color", "kind": 1024, "kindString": "Property", @@ -31420,7 +32757,7 @@ } }, { - "id": 2893, + "id": 2949, "name": "--ts-var-liveboard-tab-hover-color", "kind": 1024, "kindString": "Property", @@ -31443,7 +32780,7 @@ } }, { - "id": 2863, + "id": 2919, "name": "--ts-var-liveboard-tile-background", "kind": 1024, "kindString": "Property", @@ -31466,7 +32803,7 @@ } }, { - "id": 2862, + "id": 2918, "name": "--ts-var-liveboard-tile-border-color", "kind": 1024, "kindString": "Property", @@ -31489,7 +32826,7 @@ } }, { - "id": 2864, + "id": 2920, "name": "--ts-var-liveboard-tile-border-radius", "kind": 1024, "kindString": "Property", @@ -31512,7 +32849,7 @@ } }, { - "id": 2865, + "id": 2921, "name": "--ts-var-liveboard-tile-padding", "kind": 1024, "kindString": "Property", @@ -31535,7 +32872,7 @@ } }, { - "id": 2866, + "id": 2922, "name": "--ts-var-liveboard-tile-table-header-background", "kind": 1024, "kindString": "Property", @@ -31558,7 +32895,7 @@ } }, { - "id": 2894, + "id": 2950, "name": "--ts-var-liveboard-tile-title-fontsize", "kind": 1024, "kindString": "Property", @@ -31581,7 +32918,7 @@ } }, { - "id": 2895, + "id": 2951, "name": "--ts-var-liveboard-tile-title-fontweight", "kind": 1024, "kindString": "Property", @@ -31604,7 +32941,7 @@ } }, { - "id": 2838, + "id": 2894, "name": "--ts-var-menu--hover-background", "kind": 1024, "kindString": "Property", @@ -31627,7 +32964,7 @@ } }, { - "id": 2835, + "id": 2891, "name": "--ts-var-menu-background", "kind": 1024, "kindString": "Property", @@ -31650,7 +32987,7 @@ } }, { - "id": 2834, + "id": 2890, "name": "--ts-var-menu-color", "kind": 1024, "kindString": "Property", @@ -31673,7 +33010,7 @@ } }, { - "id": 2836, + "id": 2892, "name": "--ts-var-menu-font-family", "kind": 1024, "kindString": "Property", @@ -31696,7 +33033,7 @@ } }, { - "id": 2839, + "id": 2895, "name": "--ts-var-menu-selected-text-color", "kind": 1024, "kindString": "Property", @@ -31719,7 +33056,7 @@ } }, { - "id": 2837, + "id": 2893, "name": "--ts-var-menu-text-transform", "kind": 1024, "kindString": "Property", @@ -31742,7 +33079,7 @@ } }, { - "id": 2772, + "id": 2828, "name": "--ts-var-nav-background", "kind": 1024, "kindString": "Property", @@ -31765,7 +33102,7 @@ } }, { - "id": 2773, + "id": 2829, "name": "--ts-var-nav-color", "kind": 1024, "kindString": "Property", @@ -31788,7 +33125,7 @@ } }, { - "id": 2900, + "id": 2956, "name": "--ts-var-parameter-chip-active-background", "kind": 1024, "kindString": "Property", @@ -31811,7 +33148,7 @@ } }, { - "id": 2901, + "id": 2957, "name": "--ts-var-parameter-chip-active-text-color", "kind": 1024, "kindString": "Property", @@ -31834,7 +33171,7 @@ } }, { - "id": 2896, + "id": 2952, "name": "--ts-var-parameter-chip-background", "kind": 1024, "kindString": "Property", @@ -31857,7 +33194,7 @@ } }, { - "id": 2898, + "id": 2954, "name": "--ts-var-parameter-chip-hover-background", "kind": 1024, "kindString": "Property", @@ -31880,7 +33217,7 @@ } }, { - "id": 2899, + "id": 2955, "name": "--ts-var-parameter-chip-hover-text-color", "kind": 1024, "kindString": "Property", @@ -31903,7 +33240,7 @@ } }, { - "id": 2897, + "id": 2953, "name": "--ts-var-parameter-chip-text-color", "kind": 1024, "kindString": "Property", @@ -31926,7 +33263,7 @@ } }, { - "id": 2767, + "id": 2823, "name": "--ts-var-root-background", "kind": 1024, "kindString": "Property", @@ -31949,7 +33286,7 @@ } }, { - "id": 2768, + "id": 2824, "name": "--ts-var-root-color", "kind": 1024, "kindString": "Property", @@ -31972,7 +33309,7 @@ } }, { - "id": 2769, + "id": 2825, "name": "--ts-var-root-font-family", "kind": 1024, "kindString": "Property", @@ -31995,7 +33332,7 @@ } }, { - "id": 2770, + "id": 2826, "name": "--ts-var-root-text-transform", "kind": 1024, "kindString": "Property", @@ -32018,7 +33355,7 @@ } }, { - "id": 2781, + "id": 2837, "name": "--ts-var-search-auto-complete-background", "kind": 1024, "kindString": "Property", @@ -32041,7 +33378,7 @@ } }, { - "id": 2785, + "id": 2841, "name": "--ts-var-search-auto-complete-font-color", "kind": 1024, "kindString": "Property", @@ -32064,7 +33401,7 @@ } }, { - "id": 2786, + "id": 2842, "name": "--ts-var-search-auto-complete-subtext-font-color", "kind": 1024, "kindString": "Property", @@ -32087,7 +33424,7 @@ } }, { - "id": 2784, + "id": 2840, "name": "--ts-var-search-bar-auto-complete-hover-background", "kind": 1024, "kindString": "Property", @@ -32110,7 +33447,7 @@ } }, { - "id": 2780, + "id": 2836, "name": "--ts-var-search-bar-background", "kind": 1024, "kindString": "Property", @@ -32133,7 +33470,7 @@ } }, { - "id": 2783, + "id": 2839, "name": "--ts-var-search-bar-navigation-help-text-background", "kind": 1024, "kindString": "Property", @@ -32156,7 +33493,7 @@ } }, { - "id": 2777, + "id": 2833, "name": "--ts-var-search-bar-text-font-color", "kind": 1024, "kindString": "Property", @@ -32179,7 +33516,7 @@ } }, { - "id": 2778, + "id": 2834, "name": "--ts-var-search-bar-text-font-family", "kind": 1024, "kindString": "Property", @@ -32202,7 +33539,7 @@ } }, { - "id": 2779, + "id": 2835, "name": "--ts-var-search-bar-text-font-style", "kind": 1024, "kindString": "Property", @@ -32225,7 +33562,7 @@ } }, { - "id": 2774, + "id": 2830, "name": "--ts-var-search-data-button-background", "kind": 1024, "kindString": "Property", @@ -32248,7 +33585,7 @@ } }, { - "id": 2775, + "id": 2831, "name": "--ts-var-search-data-button-font-color", "kind": 1024, "kindString": "Property", @@ -32271,7 +33608,7 @@ } }, { - "id": 2776, + "id": 2832, "name": "--ts-var-search-data-button-font-family", "kind": 1024, "kindString": "Property", @@ -32294,7 +33631,7 @@ } }, { - "id": 2782, + "id": 2838, "name": "--ts-var-search-navigation-button-background", "kind": 1024, "kindString": "Property", @@ -32317,7 +33654,7 @@ } }, { - "id": 2847, + "id": 2903, "name": "--ts-var-segment-control-hover-background", "kind": 1024, "kindString": "Property", @@ -32340,7 +33677,7 @@ } }, { - "id": 2887, + "id": 2943, "name": "--ts-var-side-panel-width", "kind": 1024, "kindString": "Property", @@ -32363,7 +33700,7 @@ } }, { - "id": 2925, + "id": 2981, "name": "--ts-var-spotiq-analyze-crosscorrelation-card-background", "kind": 1024, "kindString": "Property", @@ -32386,7 +33723,7 @@ } }, { - "id": 2922, + "id": 2978, "name": "--ts-var-spotiq-analyze-forecasting-card-background", "kind": 1024, "kindString": "Property", @@ -32409,7 +33746,7 @@ } }, { - "id": 2923, + "id": 2979, "name": "--ts-var-spotiq-analyze-outlier-card-background", "kind": 1024, "kindString": "Property", @@ -32432,7 +33769,7 @@ } }, { - "id": 2924, + "id": 2980, "name": "--ts-var-spotiq-analyze-trend-card-background", "kind": 1024, "kindString": "Property", @@ -32455,7 +33792,7 @@ } }, { - "id": 2927, + "id": 2983, "name": "--ts-var-spotter-chat-width", "kind": 1024, "kindString": "Property", @@ -32478,7 +33815,7 @@ } }, { - "id": 2787, + "id": 2843, "name": "--ts-var-spotter-input-background", "kind": 1024, "kindString": "Property", @@ -32501,7 +33838,7 @@ } }, { - "id": 2788, + "id": 2844, "name": "--ts-var-spotter-prompt-background", "kind": 1024, "kindString": "Property", @@ -32524,7 +33861,7 @@ } }, { - "id": 2817, + "id": 2873, "name": "--ts-var-viz-background", "kind": 1024, "kindString": "Property", @@ -32547,7 +33884,7 @@ } }, { - "id": 2815, + "id": 2871, "name": "--ts-var-viz-border-radius", "kind": 1024, "kindString": "Property", @@ -32570,7 +33907,7 @@ } }, { - "id": 2816, + "id": 2872, "name": "--ts-var-viz-box-shadow", "kind": 1024, "kindString": "Property", @@ -32593,7 +33930,7 @@ } }, { - "id": 2812, + "id": 2868, "name": "--ts-var-viz-description-color", "kind": 1024, "kindString": "Property", @@ -32616,7 +33953,7 @@ } }, { - "id": 2813, + "id": 2869, "name": "--ts-var-viz-description-font-family", "kind": 1024, "kindString": "Property", @@ -32639,7 +33976,7 @@ } }, { - "id": 2814, + "id": 2870, "name": "--ts-var-viz-description-text-transform", "kind": 1024, "kindString": "Property", @@ -32662,7 +33999,7 @@ } }, { - "id": 2818, + "id": 2874, "name": "--ts-var-viz-legend-hover-background", "kind": 1024, "kindString": "Property", @@ -32685,7 +34022,7 @@ } }, { - "id": 2809, + "id": 2865, "name": "--ts-var-viz-title-color", "kind": 1024, "kindString": "Property", @@ -32708,7 +34045,7 @@ } }, { - "id": 2810, + "id": 2866, "name": "--ts-var-viz-title-font-family", "kind": 1024, "kindString": "Property", @@ -32731,7 +34068,7 @@ } }, { - "id": 2811, + "id": 2867, "name": "--ts-var-viz-title-text-transform", "kind": 1024, "kindString": "Property", @@ -32759,167 +34096,167 @@ "title": "Properties", "kind": 1024, "children": [ - 2820, - 2819, - 2789, - 2790, - 2792, - 2791, - 2771, - 2832, - 2833, - 2830, - 2831, - 2794, - 2799, - 2796, - 2798, - 2797, - 2795, - 2804, - 2801, - 2803, - 2802, - 2800, - 2808, - 2807, - 2806, - 2805, - 2793, - 2926, - 2921, - 2916, - 2915, - 2918, - 2917, + 2876, + 2875, + 2845, + 2846, + 2848, + 2847, + 2827, + 2888, + 2889, + 2886, + 2887, + 2850, 2855, - 2858, - 2853, - 2856, - 2857, 2852, 2854, - 2825, - 2824, - 2827, - 2826, - 2823, - 2821, - 2822, - 2828, - 2829, - 2840, - 2841, - 2844, - 2842, - 2843, + 2853, 2851, - 2850, + 2860, + 2857, + 2859, + 2858, + 2856, + 2864, + 2863, + 2862, + 2861, 2849, - 2848, + 2982, + 2977, + 2972, + 2971, + 2974, + 2973, + 2911, 2914, - 2913, + 2909, 2912, - 2920, - 2919, - 2846, - 2845, - 2873, - 2886, - 2885, - 2883, - 2884, - 2891, - 2889, - 2888, - 2874, - 2875, - 2879, - 2867, - 2882, + 2913, + 2908, + 2910, 2881, - 2872, 2880, - 2870, - 2871, + 2883, + 2882, + 2879, + 2877, 2878, - 2868, - 2869, + 2884, + 2885, + 2896, + 2897, + 2900, + 2898, + 2899, + 2907, + 2906, 2905, - 2902, - 2903, 2904, - 2860, - 2911, - 2906, - 2907, - 2910, - 2908, - 2909, - 2861, - 2859, - 2877, - 2876, + 2970, + 2969, + 2968, + 2976, + 2975, + 2902, + 2901, + 2929, + 2942, + 2941, + 2939, + 2940, + 2947, + 2945, + 2944, + 2930, + 2931, + 2935, + 2923, + 2938, + 2937, + 2928, + 2936, + 2926, + 2927, + 2934, + 2924, + 2925, + 2961, + 2958, + 2959, + 2960, + 2916, + 2967, + 2962, + 2963, + 2966, + 2964, + 2965, + 2917, + 2915, + 2933, + 2932, + 2946, + 2948, + 2949, + 2919, + 2918, + 2920, + 2921, + 2922, + 2950, + 2951, + 2894, + 2891, 2890, 2892, - 2893, - 2863, - 2862, - 2864, - 2865, - 2866, - 2894, 2895, - 2838, - 2835, - 2834, + 2893, + 2828, + 2829, + 2956, + 2957, + 2952, + 2954, + 2955, + 2953, + 2823, + 2824, + 2825, + 2826, + 2837, + 2841, + 2842, + 2840, 2836, 2839, - 2837, - 2772, - 2773, - 2900, - 2901, - 2896, - 2898, - 2899, - 2897, - 2767, - 2768, - 2769, - 2770, - 2781, - 2785, - 2786, - 2784, - 2780, - 2783, - 2777, - 2778, - 2779, - 2774, - 2775, - 2776, - 2782, - 2847, - 2887, - 2925, - 2922, - 2923, - 2924, - 2927, - 2787, - 2788, - 2817, - 2815, - 2816, - 2812, - 2813, - 2814, - 2818, - 2809, - 2810, - 2811 + 2833, + 2834, + 2835, + 2830, + 2831, + 2832, + 2838, + 2903, + 2943, + 2981, + 2978, + 2979, + 2980, + 2983, + 2843, + 2844, + 2873, + 2871, + 2872, + 2868, + 2869, + 2870, + 2874, + 2865, + 2866, + 2867 ] } ], @@ -32932,7 +34269,7 @@ ] }, { - "id": 2754, + "id": 2810, "name": "CustomStyles", "kind": 256, "kindString": "Interface", @@ -32942,7 +34279,7 @@ }, "children": [ { - "id": 2756, + "id": 2812, "name": "customCSS", "kind": 1024, "kindString": "Property", @@ -32958,12 +34295,12 @@ ], "type": { "type": "reference", - "id": 2757, + "id": 2813, "name": "customCssInterface" } }, { - "id": 2755, + "id": 2811, "name": "customCSSUrl", "kind": 1024, "kindString": "Property", @@ -32988,8 +34325,8 @@ "title": "Properties", "kind": 1024, "children": [ - 2756, - 2755 + 2812, + 2811 ] } ], @@ -33002,7 +34339,7 @@ ] }, { - "id": 2744, + "id": 2800, "name": "CustomisationsInterface", "kind": 256, "kindString": "Interface", @@ -33018,7 +34355,7 @@ }, "children": [ { - "id": 2746, + "id": 2802, "name": "content", "kind": 1024, "kindString": "Property", @@ -33035,14 +34372,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2747, + "id": 2803, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2749, + "id": 2805, "name": "stringIDs", "kind": 1024, "kindString": "Property", @@ -33072,7 +34409,7 @@ } }, { - "id": 2750, + "id": 2806, "name": "stringIDsUrl", "kind": 1024, "kindString": "Property", @@ -33092,7 +34429,7 @@ } }, { - "id": 2748, + "id": 2804, "name": "strings", "kind": 1024, "kindString": "Property", @@ -33135,21 +34472,21 @@ "title": "Properties", "kind": 1024, "children": [ - 2749, - 2750, - 2748 + 2805, + 2806, + 2804 ] } ], "indexSignature": { - "id": 2751, + "id": 2807, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2752, + "id": 2808, "name": "key", "kind": 32768, "flags": {}, @@ -33168,7 +34505,7 @@ } }, { - "id": 2753, + "id": 2809, "name": "iconSpriteUrl", "kind": 1024, "kindString": "Property", @@ -33188,7 +34525,7 @@ } }, { - "id": 2745, + "id": 2801, "name": "style", "kind": 1024, "kindString": "Property", @@ -33204,7 +34541,7 @@ ], "type": { "type": "reference", - "id": 2754, + "id": 2810, "name": "CustomStyles" } } @@ -33214,9 +34551,9 @@ "title": "Properties", "kind": 1024, "children": [ - 2746, - 2753, - 2745 + 2802, + 2809, + 2801 ] } ], @@ -33229,7 +34566,7 @@ ] }, { - "id": 2323, + "id": 2369, "name": "EmbedConfig", "kind": 256, "kindString": "Interface", @@ -33245,7 +34582,7 @@ }, "children": [ { - "id": 2365, + "id": 2411, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -33275,20 +34612,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2366, + "id": 2412, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2367, + "id": 2413, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2368, + "id": 2414, "name": "key", "kind": 32768, "flags": {}, @@ -33320,7 +34657,7 @@ } }, { - "id": 2326, + "id": 2372, "name": "authEndpoint", "kind": 1024, "kindString": "Property", @@ -33343,7 +34680,7 @@ } }, { - "id": 2347, + "id": 2393, "name": "authTriggerContainer", "kind": 1024, "kindString": "Property", @@ -33385,7 +34722,7 @@ } }, { - "id": 2349, + "id": 2395, "name": "authTriggerText", "kind": 1024, "kindString": "Property", @@ -33414,7 +34751,7 @@ } }, { - "id": 2325, + "id": 2371, "name": "authType", "kind": 1024, "kindString": "Property", @@ -33431,12 +34768,12 @@ ], "type": { "type": "reference", - "id": 1967, + "id": 2007, "name": "AuthType" } }, { - "id": 2338, + "id": 2384, "name": "autoLogin", "kind": 1024, "kindString": "Property", @@ -33465,7 +34802,7 @@ } }, { - "id": 2350, + "id": 2396, "name": "blockNonEmbedFullAppAccess", "kind": 1024, "kindString": "Property", @@ -33498,7 +34835,7 @@ } }, { - "id": 2341, + "id": 2387, "name": "callPrefetch", "kind": 1024, "kindString": "Property", @@ -33527,7 +34864,7 @@ } }, { - "id": 2374, + "id": 2420, "name": "cleanupTimeout", "kind": 1024, "kindString": "Property", @@ -33560,7 +34897,7 @@ } }, { - "id": 2362, + "id": 2408, "name": "currencyFormat", "kind": 1024, "kindString": "Property", @@ -33589,7 +34926,7 @@ } }, { - "id": 2372, + "id": 2418, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -33625,7 +34962,7 @@ } }, { - "id": 2369, + "id": 2415, "name": "customVariablesForThirdPartyTools", "kind": 1024, "kindString": "Property", @@ -33668,7 +35005,7 @@ } }, { - "id": 2346, + "id": 2392, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -33693,12 +35030,12 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" } }, { - "id": 2360, + "id": 2406, "name": "dateFormatLocale", "kind": 1024, "kindString": "Property", @@ -33727,7 +35064,7 @@ } }, { - "id": 2343, + "id": 2389, "name": "detectCookieAccessSlow", "kind": 1024, "kindString": "Property", @@ -33757,7 +35094,7 @@ } }, { - "id": 2371, + "id": 2417, "name": "disableFullscreenPresentation", "kind": 1024, "kindString": "Property", @@ -33794,7 +35131,7 @@ } }, { - "id": 2364, + "id": 2410, "name": "disableLoginFailurePage", "kind": 1024, "kindString": "Property", @@ -33823,7 +35160,7 @@ } }, { - "id": 2339, + "id": 2385, "name": "disableLoginRedirect", "kind": 1024, "kindString": "Property", @@ -33856,7 +35193,7 @@ } }, { - "id": 2370, + "id": 2416, "name": "disablePreauthCache", "kind": 1024, "kindString": "Property", @@ -33876,7 +35213,7 @@ } }, { - "id": 2359, + "id": 2405, "name": "disableSDKTracking", "kind": 1024, "kindString": "Property", @@ -33905,7 +35242,7 @@ } }, { - "id": 2337, + "id": 2383, "name": "ignoreNoCookieAccess", "kind": 1024, "kindString": "Property", @@ -33934,7 +35271,7 @@ } }, { - "id": 2332, + "id": 2378, "name": "inPopup", "kind": 1024, "kindString": "Property", @@ -33968,7 +35305,7 @@ } }, { - "id": 2358, + "id": 2404, "name": "logLevel", "kind": 1024, "kindString": "Property", @@ -34001,12 +35338,12 @@ ], "type": { "type": "reference", - "id": 2931, + "id": 2987, "name": "LogLevel" } }, { - "id": 2340, + "id": 2386, "name": "loginFailedMessage", "kind": 1024, "kindString": "Property", @@ -34035,7 +35372,7 @@ } }, { - "id": 2331, + "id": 2377, "name": "noRedirect", "kind": 1024, "kindString": "Property", @@ -34068,7 +35405,7 @@ } }, { - "id": 2361, + "id": 2407, "name": "numberFormatLocale", "kind": 1024, "kindString": "Property", @@ -34097,7 +35434,7 @@ } }, { - "id": 2330, + "id": 2376, "name": "password", "kind": 1024, "kindString": "Property", @@ -34121,7 +35458,7 @@ } }, { - "id": 2356, + "id": 2402, "name": "pendoTrackingKey", "kind": 1024, "kindString": "Property", @@ -34150,7 +35487,7 @@ } }, { - "id": 2342, + "id": 2388, "name": "queueMultiRenders", "kind": 1024, "kindString": "Property", @@ -34183,7 +35520,7 @@ } }, { - "id": 2333, + "id": 2379, "name": "redirectPath", "kind": 1024, "kindString": "Property", @@ -34213,7 +35550,7 @@ } }, { - "id": 2335, + "id": 2381, "name": "shouldEncodeUrlQueryParams", "kind": 1024, "kindString": "Property", @@ -34242,7 +35579,7 @@ } }, { - "id": 2357, + "id": 2403, "name": "suppressErrorAlerts", "kind": 1024, "kindString": "Property", @@ -34271,7 +35608,7 @@ } }, { - "id": 2336, + "id": 2382, "name": "suppressNoCookieAccessAlert", "kind": 1024, "kindString": "Property", @@ -34300,7 +35637,7 @@ } }, { - "id": 2345, + "id": 2391, "name": "suppressSageEmbedBetaWarning", "kind": 1024, "kindString": "Property", @@ -34323,7 +35660,7 @@ } }, { - "id": 2344, + "id": 2390, "name": "suppressSearchEmbedBetaWarning", "kind": 1024, "kindString": "Property", @@ -34352,7 +35689,7 @@ } }, { - "id": 2324, + "id": 2370, "name": "thoughtSpotHost", "kind": 1024, "kindString": "Property", @@ -34373,7 +35710,7 @@ } }, { - "id": 2348, + "id": 2394, "name": "useEventForSAMLPopup", "kind": 1024, "kindString": "Property", @@ -34396,7 +35733,7 @@ } }, { - "id": 2329, + "id": 2375, "name": "username", "kind": 1024, "kindString": "Property", @@ -34419,7 +35756,7 @@ } }, { - "id": 2373, + "id": 2419, "name": "waitForCleanupOnDestroy", "kind": 1024, "kindString": "Property", @@ -34452,7 +35789,7 @@ } }, { - "id": 2327, + "id": 2373, "name": "getAuthToken", "kind": 2048, "kindString": "Method", @@ -34468,7 +35805,7 @@ ], "signatures": [ { - "id": 2328, + "id": 2374, "name": "getAuthToken", "kind": 4096, "kindString": "Call signature", @@ -34496,52 +35833,52 @@ "title": "Properties", "kind": 1024, "children": [ - 2365, - 2326, - 2347, - 2349, - 2325, - 2338, - 2350, - 2341, - 2374, - 2362, + 2411, 2372, - 2369, - 2346, - 2360, - 2343, + 2393, + 2395, 2371, - 2364, - 2339, + 2384, + 2396, + 2387, + 2420, + 2408, + 2418, + 2415, + 2392, + 2406, + 2389, + 2417, + 2410, + 2385, + 2416, + 2405, + 2383, + 2378, + 2404, + 2386, + 2377, + 2407, + 2376, + 2402, + 2388, + 2379, + 2381, + 2403, + 2382, + 2391, + 2390, 2370, - 2359, - 2337, - 2332, - 2358, - 2340, - 2331, - 2361, - 2330, - 2356, - 2342, - 2333, - 2335, - 2357, - 2336, - 2345, - 2344, - 2324, - 2348, - 2329, - 2373 + 2394, + 2375, + 2419 ] }, { "title": "Methods", "kind": 2048, "children": [ - 2327 + 2373 ] } ], @@ -34554,7 +35891,7 @@ ] }, { - "id": 2703, + "id": 2759, "name": "FrameParams", "kind": 256, "kindString": "Interface", @@ -34570,7 +35907,7 @@ }, "children": [ { - "id": 2705, + "id": 2761, "name": "height", "kind": 1024, "kindString": "Property", @@ -34602,7 +35939,7 @@ } }, { - "id": 2706, + "id": 2762, "name": "loading", "kind": 1024, "kindString": "Property", @@ -34638,7 +35975,7 @@ } }, { - "id": 2704, + "id": 2760, "name": "width", "kind": 1024, "kindString": "Property", @@ -34675,9 +36012,9 @@ "title": "Properties", "kind": 1024, "children": [ - 2705, - 2706, - 2704 + 2761, + 2762, + 2760 ] } ], @@ -34689,7 +36026,7 @@ } ], "indexSignature": { - "id": 2707, + "id": 2763, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -34699,7 +36036,7 @@ }, "parameters": [ { - "id": 2708, + "id": 2764, "name": "key", "kind": 32768, "flags": {}, @@ -34733,7 +36070,7 @@ } }, { - "id": 2476, + "id": 2526, "name": "LiveboardViewConfig", "kind": 256, "kindString": "Interface", @@ -34749,7 +36086,7 @@ }, "children": [ { - "id": 2488, + "id": 2538, "name": "activeTabId", "kind": 1024, "kindString": "Property", @@ -34773,7 +36110,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 210, + "line": 211, "character": 4 } ], @@ -34783,7 +36120,7 @@ } }, { - "id": 2511, + "id": 2561, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -34814,20 +36151,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2512, + "id": 2562, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2513, + "id": 2563, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2514, + "id": 2564, "name": "key", "kind": 32768, "flags": {}, @@ -34863,7 +36200,7 @@ } }, { - "id": 2538, + "id": 2590, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -34891,7 +36228,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1312, + "line": 1340, "character": 4 } ], @@ -34905,7 +36242,7 @@ } }, { - "id": 2535, + "id": 2587, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -34929,13 +36266,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1276, + "line": 1304, "character": 4 } ], "type": { "type": "reference", - "id": 2319, + "id": 2365, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -34944,7 +36281,7 @@ } }, { - "id": 2551, + "id": 2603, "name": "coverAndFilterOptionInPDF", "kind": 1024, "kindString": "Property", @@ -34968,7 +36305,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1532, + "line": 1560, "character": 4 } ], @@ -34982,7 +36319,7 @@ } }, { - "id": 2529, + "id": 2579, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -35023,7 +36360,7 @@ } }, { - "id": 2515, + "id": 2565, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -35052,7 +36389,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -35061,7 +36398,7 @@ } }, { - "id": 2539, + "id": 2591, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -35089,7 +36426,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1328, + "line": 1356, "character": 4 } ], @@ -35103,7 +36440,7 @@ } }, { - "id": 2478, + "id": 2528, "name": "defaultHeight", "kind": 1024, "kindString": "Property", @@ -35135,7 +36472,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 80, + "line": 81, "character": 4 } ], @@ -35145,7 +36482,7 @@ } }, { - "id": 2523, + "id": 2573, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -35183,7 +36520,7 @@ } }, { - "id": 2507, + "id": 2557, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -35221,7 +36558,7 @@ } }, { - "id": 2506, + "id": 2556, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -35253,7 +36590,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -35263,7 +36600,7 @@ } }, { - "id": 2519, + "id": 2569, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -35304,7 +36641,7 @@ } }, { - "id": 2545, + "id": 2597, "name": "enable2ColumnLayout", "kind": 1024, "kindString": "Property", @@ -35332,7 +36669,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1430, + "line": 1458, "character": 4 } ], @@ -35346,7 +36683,7 @@ } }, { - "id": 2550, + "id": 2602, "name": "enableAskSage", "kind": 1024, "kindString": "Property", @@ -35374,7 +36711,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1516, + "line": 1544, "character": 4 } ], @@ -35388,7 +36725,7 @@ } }, { - "id": 2540, + "id": 2592, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -35416,7 +36753,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1344, + "line": 1372, "character": 4 } ], @@ -35430,7 +36767,7 @@ } }, { - "id": 2520, + "id": 2570, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -35468,7 +36805,7 @@ } }, { - "id": 2480, + "id": 2530, "name": "enableVizTransformations", "kind": 1024, "kindString": "Property", @@ -35494,7 +36831,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 109, + "line": 110, "character": 4 } ], @@ -35504,7 +36841,7 @@ } }, { - "id": 2536, + "id": 2588, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -35528,7 +36865,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1287, + "line": 1315, "character": 4 } ], @@ -35542,7 +36879,7 @@ } }, { - "id": 2537, + "id": 2589, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -35566,7 +36903,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1297, + "line": 1325, "character": 4 } ], @@ -35580,7 +36917,7 @@ } }, { - "id": 2522, + "id": 2572, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -35617,7 +36954,7 @@ } }, { - "id": 2503, + "id": 2553, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -35647,7 +36984,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -35656,7 +36993,7 @@ } }, { - "id": 2477, + "id": 2527, "name": "fullHeight", "kind": 1024, "kindString": "Property", @@ -35680,7 +37017,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 61, + "line": 62, "character": 4 } ], @@ -35690,7 +37027,7 @@ } }, { - "id": 2508, + "id": 2558, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -35726,7 +37063,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -35736,7 +37073,7 @@ } }, { - "id": 2494, + "id": 2544, "name": "hiddenTabs", "kind": 1024, "kindString": "Property", @@ -35760,7 +37097,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 310, + "line": 311, "character": 4 } ], @@ -35773,7 +37110,7 @@ } }, { - "id": 2548, + "id": 2600, "name": "hideIrrelevantChipsInLiveboardTabs", "kind": 1024, "kindString": "Property", @@ -35801,7 +37138,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1483, + "line": 1511, "character": 4 } ], @@ -35815,7 +37152,7 @@ } }, { - "id": 2541, + "id": 2593, "name": "hideLiveboardHeader", "kind": 1024, "kindString": "Property", @@ -35843,7 +37180,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1366, + "line": 1394, "character": 4 } ], @@ -35857,7 +37194,7 @@ } }, { - "id": 2489, + "id": 2539, "name": "hideTabPanel", "kind": 1024, "kindString": "Property", @@ -35881,7 +37218,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 224, + "line": 225, "character": 4 } ], @@ -35891,7 +37228,7 @@ } }, { - "id": 2516, + "id": 2566, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -35929,7 +37266,7 @@ } }, { - "id": 2532, + "id": 2584, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -35952,7 +37289,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -35966,7 +37303,7 @@ } }, { - "id": 2531, + "id": 2583, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -35989,7 +37326,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -36006,7 +37343,7 @@ } }, { - "id": 2553, + "id": 2605, "name": "isCentralizedLiveboardFilterUXEnabled", "kind": 1024, "kindString": "Property", @@ -36030,7 +37367,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1566, + "line": 1594, "character": 4 } ], @@ -36044,7 +37381,7 @@ } }, { - "id": 2555, + "id": 2607, "name": "isEnhancedFilterInteractivityEnabled", "kind": 1024, "kindString": "Property", @@ -36068,7 +37405,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1597, + "line": 1625, "character": 4 } ], @@ -36082,7 +37419,7 @@ } }, { - "id": 2554, + "id": 2606, "name": "isLinkParametersEnabled", "kind": 1024, "kindString": "Property", @@ -36106,7 +37443,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1581, + "line": 1609, "character": 4 } ], @@ -36120,7 +37457,7 @@ } }, { - "id": 2546, + "id": 2598, "name": "isLiveboardCompactHeaderEnabled", "kind": 1024, "kindString": "Property", @@ -36148,7 +37485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1447, + "line": 1475, "character": 4 } ], @@ -36162,7 +37499,7 @@ } }, { - "id": 2544, + "id": 2596, "name": "isLiveboardHeaderSticky", "kind": 1024, "kindString": "Property", @@ -36186,7 +37523,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1413, + "line": 1441, "character": 4 } ], @@ -36200,7 +37537,7 @@ } }, { - "id": 2557, + "id": 2609, "name": "isLiveboardMasterpiecesEnabled", "kind": 1024, "kindString": "Property", @@ -36228,7 +37565,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1629, + "line": 1657, "character": 4 } ], @@ -36242,7 +37579,7 @@ } }, { - "id": 2496, + "id": 2546, "name": "isLiveboardStylingAndGroupingEnabled", "kind": 1024, "kindString": "Property", @@ -36266,7 +37603,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 346, + "line": 347, "character": 4 } ], @@ -36276,7 +37613,7 @@ } }, { - "id": 2530, + "id": 2582, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -36296,7 +37633,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -36310,7 +37647,7 @@ } }, { - "id": 2497, + "id": 2547, "name": "isPNGInScheduledEmailsEnabled", "kind": 1024, "kindString": "Property", @@ -36334,7 +37671,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 362, + "line": 363, "character": 4 } ], @@ -36344,7 +37681,7 @@ } }, { - "id": 2498, + "id": 2548, "name": "lazyLoadingForFullHeight", "kind": 1024, "kindString": "Property", @@ -36371,7 +37708,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 379, + "line": 380, "character": 4 } ], @@ -36381,7 +37718,7 @@ } }, { - "id": 2499, + "id": 2549, "name": "lazyLoadingMargin", "kind": 1024, "kindString": "Property", @@ -36405,7 +37742,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 402, + "line": 403, "character": 4 } ], @@ -36415,7 +37752,7 @@ } }, { - "id": 2525, + "id": 2575, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -36453,7 +37790,7 @@ } }, { - "id": 2481, + "id": 2531, "name": "liveboardId", "kind": 1024, "kindString": "Property", @@ -36477,7 +37814,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 123, + "line": 124, "character": 4 } ], @@ -36487,7 +37824,7 @@ } }, { - "id": 2487, + "id": 2537, "name": "liveboardV2", "kind": 1024, "kindString": "Property", @@ -36511,7 +37848,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 195, + "line": 196, "character": 4 } ], @@ -36521,7 +37858,7 @@ } }, { - "id": 2552, + "id": 2604, "name": "liveboardXLSXCSVDownload", "kind": 1024, "kindString": "Property", @@ -36545,7 +37882,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1548, + "line": 1576, "character": 4 } ], @@ -36559,7 +37896,7 @@ } }, { - "id": 2510, + "id": 2560, "name": "locale", "kind": 1024, "kindString": "Property", @@ -36597,7 +37934,7 @@ } }, { - "id": 2479, + "id": 2529, "name": "minimumHeight", "kind": 1024, "kindString": "Property", @@ -36624,7 +37961,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 97, + "line": 98, "character": 4 } ], @@ -36634,7 +37971,7 @@ } }, { - "id": 2524, + "id": 2574, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -36672,7 +38009,7 @@ } }, { - "id": 2518, + "id": 2568, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -36710,7 +38047,7 @@ } }, { - "id": 2484, + "id": 2534, "name": "preventLiveboardFilterRemoval", "kind": 1024, "kindString": "Property", @@ -36734,7 +38071,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 157, + "line": 158, "character": 4 } ], @@ -36744,7 +38081,7 @@ } }, { - "id": 2526, + "id": 2576, "name": "primaryAction", "kind": 1024, "kindString": "Property", @@ -36782,7 +38119,7 @@ } }, { - "id": 2533, + "id": 2585, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -36806,7 +38143,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1240, + "line": 1268, "character": 4 } ], @@ -36814,7 +38151,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } }, @@ -36824,7 +38161,7 @@ } }, { - "id": 2534, + "id": 2586, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -36848,7 +38185,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1261, + "line": 1289, "character": 4 } ], @@ -36856,7 +38193,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } }, @@ -36866,7 +38203,48 @@ } }, { - "id": 2528, + "id": 2580, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "BaseViewConfig.shouldBypassPayloadValidation" + } + }, + { + "id": 2578, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -36903,7 +38281,7 @@ } }, { - "id": 2543, + "id": 2595, "name": "showLiveboardDescription", "kind": 1024, "kindString": "Property", @@ -36931,7 +38309,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1398, + "line": 1426, "character": 4 } ], @@ -36945,7 +38323,7 @@ } }, { - "id": 2549, + "id": 2601, "name": "showLiveboardReverifyBanner", "kind": 1024, "kindString": "Property", @@ -36973,7 +38351,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1500, + "line": 1528, "character": 4 } ], @@ -36987,7 +38365,7 @@ } }, { - "id": 2542, + "id": 2594, "name": "showLiveboardTitle", "kind": 1024, "kindString": "Property", @@ -37015,7 +38393,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1382, + "line": 1410, "character": 4 } ], @@ -37029,7 +38407,7 @@ } }, { - "id": 2547, + "id": 2599, "name": "showLiveboardVerifiedBadge", "kind": 1024, "kindString": "Property", @@ -37057,7 +38435,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1464, + "line": 1492, "character": 4 } ], @@ -37071,7 +38449,7 @@ } }, { - "id": 2556, + "id": 2608, "name": "showMaskedFilterChip", "kind": 1024, "kindString": "Property", @@ -37099,7 +38477,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1613, + "line": 1641, "character": 4 } ], @@ -37113,7 +38491,7 @@ } }, { - "id": 2490, + "id": 2540, "name": "showPreviewLoader", "kind": 1024, "kindString": "Property", @@ -37137,7 +38515,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 247, + "line": 248, "character": 4 } ], @@ -37147,7 +38525,7 @@ } }, { - "id": 2500, + "id": 2550, "name": "showSpotterLimitations", "kind": 1024, "kindString": "Property", @@ -37170,7 +38548,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 418, + "line": 419, "character": 4 } ], @@ -37180,7 +38558,7 @@ } }, { - "id": 2501, + "id": 2551, "name": "updatedSpotterChatPrompt", "kind": 1024, "kindString": "Property", @@ -37208,7 +38586,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 433, + "line": 434, "character": 4 } ], @@ -37218,7 +38596,48 @@ } }, { - "id": 2509, + "id": 2581, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "BaseViewConfig.useHostEventsV2" + } + }, + { + "id": 2559, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -37254,7 +38673,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -37264,7 +38683,7 @@ } }, { - "id": 2495, + "id": 2545, "name": "visibleTabs", "kind": 1024, "kindString": "Property", @@ -37288,7 +38707,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 330, + "line": 331, "character": 4 } ], @@ -37301,7 +38720,7 @@ } }, { - "id": 2485, + "id": 2535, "name": "visibleVizs", "kind": 1024, "kindString": "Property", @@ -37325,7 +38744,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 175, + "line": 176, "character": 4 } ], @@ -37338,7 +38757,7 @@ } }, { - "id": 2483, + "id": 2533, "name": "vizId", "kind": 1024, "kindString": "Property", @@ -37362,7 +38781,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 142, + "line": 143, "character": 4 } ], @@ -37377,80 +38796,82 @@ "title": "Properties", "kind": 1024, "children": [ - 2488, - 2511, 2538, - 2535, - 2551, - 2529, - 2515, + 2561, + 2590, + 2587, + 2603, + 2579, + 2565, + 2591, + 2528, + 2573, + 2557, + 2556, + 2569, + 2597, + 2602, + 2592, + 2570, + 2530, + 2588, + 2589, + 2572, + 2553, + 2527, + 2558, + 2544, + 2600, + 2593, 2539, - 2478, - 2523, - 2507, - 2506, - 2519, - 2545, - 2550, - 2540, - 2520, - 2480, - 2536, - 2537, - 2522, - 2503, - 2477, - 2508, - 2494, + 2566, + 2584, + 2583, + 2605, + 2607, + 2606, + 2598, + 2596, + 2609, + 2546, + 2582, + 2547, 2548, - 2541, - 2489, - 2516, - 2532, + 2549, + 2575, 2531, - 2553, - 2555, - 2554, - 2546, - 2544, - 2557, - 2496, - 2530, - 2497, - 2498, - 2499, - 2525, - 2481, - 2487, - 2552, - 2510, - 2479, - 2524, - 2518, - 2484, - 2526, - 2533, + 2537, + 2604, + 2560, + 2529, + 2574, + 2568, 2534, - 2528, - 2543, - 2549, - 2542, - 2547, - 2556, - 2490, - 2500, - 2501, - 2509, - 2495, - 2485, - 2483 + 2576, + 2585, + 2586, + 2580, + 2578, + 2595, + 2601, + 2594, + 2599, + 2608, + 2540, + 2550, + 2551, + 2581, + 2559, + 2545, + 2535, + 2533 ] } ], "sources": [ { "fileName": "embed/liveboard.ts", - "line": 38, + "line": 39, "character": 17 } ], @@ -37470,7 +38891,7 @@ ] }, { - "id": 1979, + "id": 2019, "name": "RuntimeFilter", "kind": 256, "kindString": "Interface", @@ -37480,7 +38901,7 @@ }, "children": [ { - "id": 1980, + "id": 2020, "name": "columnName", "kind": 1024, "kindString": "Property", @@ -37491,7 +38912,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1834, + "line": 1862, "character": 4 } ], @@ -37501,7 +38922,7 @@ } }, { - "id": 1981, + "id": 2021, "name": "operator", "kind": 1024, "kindString": "Property", @@ -37512,18 +38933,18 @@ "sources": [ { "fileName": "types.ts", - "line": 1838, + "line": 1866, "character": 4 } ], "type": { "type": "reference", - "id": 1983, + "id": 2023, "name": "RuntimeFilterOp" } }, { - "id": 1982, + "id": 2022, "name": "values", "kind": 1024, "kindString": "Property", @@ -37534,7 +38955,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1844, + "line": 1872, "character": 4 } ], @@ -37569,22 +38990,22 @@ "title": "Properties", "kind": 1024, "children": [ - 1980, - 1981, - 1982 + 2020, + 2021, + 2022 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1830, + "line": 1858, "character": 17 } ] }, { - "id": 2928, + "id": 2984, "name": "RuntimeParameter", "kind": 256, "kindString": "Interface", @@ -37594,7 +39015,7 @@ }, "children": [ { - "id": 2929, + "id": 2985, "name": "name", "kind": 1024, "kindString": "Property", @@ -37605,7 +39026,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1854, + "line": 1882, "character": 4 } ], @@ -37615,7 +39036,7 @@ } }, { - "id": 2930, + "id": 2986, "name": "value", "kind": 1024, "kindString": "Property", @@ -37626,7 +39047,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1858, + "line": 1886, "character": 4 } ], @@ -37654,21 +39075,21 @@ "title": "Properties", "kind": 1024, "children": [ - 2929, - 2930 + 2985, + 2986 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1850, + "line": 1878, "character": 17 } ] }, { - "id": 2558, + "id": 2610, "name": "SageViewConfig", "kind": 256, "kindString": "Interface", @@ -37688,7 +39109,7 @@ }, "children": [ { - "id": 2587, + "id": 2639, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -37719,20 +39140,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2588, + "id": 2640, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2589, + "id": 2641, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2590, + "id": 2642, "name": "key", "kind": 32768, "flags": {}, @@ -37768,7 +39189,7 @@ } }, { - "id": 2575, + "id": 2627, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -37796,7 +39217,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1312, + "line": 1340, "character": 4 } ], @@ -37810,7 +39231,7 @@ } }, { - "id": 2572, + "id": 2624, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -37834,13 +39255,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1276, + "line": 1304, "character": 4 } ], "type": { "type": "reference", - "id": 2319, + "id": 2365, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -37849,7 +39270,7 @@ } }, { - "id": 2604, + "id": 2656, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -37890,7 +39311,7 @@ } }, { - "id": 2591, + "id": 2643, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -37919,7 +39340,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -37928,7 +39349,7 @@ } }, { - "id": 2576, + "id": 2628, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -37956,7 +39377,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1328, + "line": 1356, "character": 4 } ], @@ -37970,7 +39391,7 @@ } }, { - "id": 2568, + "id": 2620, "name": "dataSource", "kind": 1024, "kindString": "Property", @@ -37983,7 +39404,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 112, + "line": 113, "character": 4 } ], @@ -37993,7 +39414,7 @@ } }, { - "id": 2599, + "id": 2651, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -38031,7 +39452,7 @@ } }, { - "id": 2563, + "id": 2615, "name": "disableWorksheetChange", "kind": 1024, "kindString": "Property", @@ -38050,7 +39471,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 75, + "line": 76, "character": 4 } ], @@ -38060,7 +39481,7 @@ } }, { - "id": 2583, + "id": 2635, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -38098,7 +39519,7 @@ } }, { - "id": 2582, + "id": 2634, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -38130,7 +39551,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -38140,7 +39561,7 @@ } }, { - "id": 2595, + "id": 2647, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -38181,7 +39602,7 @@ } }, { - "id": 2577, + "id": 2629, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -38209,7 +39630,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1344, + "line": 1372, "character": 4 } ], @@ -38223,7 +39644,7 @@ } }, { - "id": 2596, + "id": 2648, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -38261,7 +39682,7 @@ } }, { - "id": 2573, + "id": 2625, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -38285,7 +39706,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1287, + "line": 1315, "character": 4 } ], @@ -38299,7 +39720,7 @@ } }, { - "id": 2574, + "id": 2626, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -38323,7 +39744,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1297, + "line": 1325, "character": 4 } ], @@ -38337,7 +39758,7 @@ } }, { - "id": 2598, + "id": 2650, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -38374,7 +39795,7 @@ } }, { - "id": 2579, + "id": 2631, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -38404,7 +39825,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -38413,7 +39834,7 @@ } }, { - "id": 2584, + "id": 2636, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -38449,7 +39870,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -38459,7 +39880,7 @@ } }, { - "id": 2565, + "id": 2617, "name": "hideAutocompleteSuggestions", "kind": 1024, "kindString": "Property", @@ -38478,7 +39899,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 85, + "line": 86, "character": 4 } ], @@ -38488,7 +39909,7 @@ } }, { - "id": 2562, + "id": 2614, "name": "hideSageAnswerHeader", "kind": 1024, "kindString": "Property", @@ -38507,7 +39928,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 70, + "line": 71, "character": 4 } ], @@ -38517,7 +39938,7 @@ } }, { - "id": 2567, + "id": 2619, "name": "hideSampleQuestions", "kind": 1024, "kindString": "Property", @@ -38541,7 +39962,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 108, + "line": 109, "character": 4 } ], @@ -38551,7 +39972,7 @@ } }, { - "id": 2561, + "id": 2613, "name": "hideSearchBarTitle", "kind": 1024, "kindString": "Property", @@ -38574,7 +39995,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 64, + "line": 65, "character": 4 } ], @@ -38584,7 +40005,7 @@ } }, { - "id": 2564, + "id": 2616, "name": "hideWorksheetSelector", "kind": 1024, "kindString": "Property", @@ -38603,7 +40024,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 80, + "line": 81, "character": 4 } ], @@ -38613,7 +40034,7 @@ } }, { - "id": 2592, + "id": 2644, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -38651,7 +40072,7 @@ } }, { - "id": 2607, + "id": 2661, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -38674,7 +40095,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -38688,7 +40109,7 @@ } }, { - "id": 2606, + "id": 2660, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -38711,7 +40132,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -38728,7 +40149,7 @@ } }, { - "id": 2605, + "id": 2659, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -38748,7 +40169,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -38762,7 +40183,7 @@ } }, { - "id": 2601, + "id": 2653, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -38800,7 +40221,7 @@ } }, { - "id": 2586, + "id": 2638, "name": "locale", "kind": 1024, "kindString": "Property", @@ -38838,7 +40259,7 @@ } }, { - "id": 2600, + "id": 2652, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -38876,7 +40297,7 @@ } }, { - "id": 2594, + "id": 2646, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -38914,7 +40335,7 @@ } }, { - "id": 2570, + "id": 2622, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -38938,7 +40359,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1240, + "line": 1268, "character": 4 } ], @@ -38946,7 +40367,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } }, @@ -38956,7 +40377,7 @@ } }, { - "id": 2571, + "id": 2623, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -38980,7 +40401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1261, + "line": 1289, "character": 4 } ], @@ -38988,7 +40409,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } }, @@ -38998,7 +40419,7 @@ } }, { - "id": 2569, + "id": 2621, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -39022,7 +40443,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 134, + "line": 135, "character": 4 } ], @@ -39032,7 +40453,48 @@ } }, { - "id": 2603, + "id": 2657, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.shouldBypassPayloadValidation" + } + }, + { + "id": 2655, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -39069,7 +40531,7 @@ } }, { - "id": 2559, + "id": 2611, "name": "showObjectResults", "kind": 1024, "kindString": "Property", @@ -39088,7 +40550,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 48, + "line": 49, "character": 4 } ], @@ -39098,7 +40560,7 @@ } }, { - "id": 2566, + "id": 2618, "name": "showObjectSuggestions", "kind": 1024, "kindString": "Property", @@ -39117,7 +40579,7 @@ "sources": [ { "fileName": "embed/sage.ts", - "line": 92, + "line": 93, "character": 4 } ], @@ -39127,7 +40589,48 @@ } }, { - "id": 2585, + "id": 2658, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.useHostEventsV2" + } + }, + { + "id": 2637, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -39163,7 +40666,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -39178,52 +40681,54 @@ "title": "Properties", "kind": 1024, "children": [ - 2587, - 2575, - 2572, - 2604, - 2591, - 2576, - 2568, - 2599, - 2563, - 2583, - 2582, - 2595, - 2577, - 2596, - 2573, - 2574, - 2598, - 2579, - 2584, - 2565, - 2562, - 2567, - 2561, - 2564, - 2592, - 2607, - 2606, - 2605, - 2601, - 2586, - 2600, - 2594, - 2570, - 2571, - 2569, - 2603, - 2559, - 2566, - 2585 + 2639, + 2627, + 2624, + 2656, + 2643, + 2628, + 2620, + 2651, + 2615, + 2635, + 2634, + 2647, + 2629, + 2648, + 2625, + 2626, + 2650, + 2631, + 2636, + 2617, + 2614, + 2619, + 2613, + 2616, + 2644, + 2661, + 2660, + 2659, + 2653, + 2638, + 2652, + 2646, + 2622, + 2623, + 2621, + 2657, + 2655, + 2611, + 2618, + 2658, + 2637 ] } ], "sources": [ { "fileName": "embed/sage.ts", - "line": 38, + "line": 39, "character": 17 } ], @@ -39270,7 +40775,7 @@ ] }, { - "id": 2431, + "id": 2479, "name": "SearchBarViewConfig", "kind": 256, "kindString": "Interface", @@ -39285,7 +40790,7 @@ }, "children": [ { - "id": 2446, + "id": 2494, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -39316,20 +40821,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2447, + "id": 2495, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2448, + "id": 2496, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2449, + "id": 2497, "name": "key", "kind": 32768, "flags": {}, @@ -39365,7 +40870,7 @@ } }, { - "id": 2473, + "id": 2523, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -39393,7 +40898,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1312, + "line": 1340, "character": 4 } ], @@ -39407,7 +40912,7 @@ } }, { - "id": 2470, + "id": 2520, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -39431,13 +40936,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1276, + "line": 1304, "character": 4 } ], "type": { "type": "reference", - "id": 2319, + "id": 2365, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -39446,7 +40951,7 @@ } }, { - "id": 2464, + "id": 2512, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -39487,7 +40992,7 @@ } }, { - "id": 2450, + "id": 2498, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -39516,7 +41021,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -39525,7 +41030,7 @@ } }, { - "id": 2474, + "id": 2524, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -39553,7 +41058,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1328, + "line": 1356, "character": 4 } ], @@ -39567,7 +41072,7 @@ } }, { - "id": 2433, + "id": 2481, "name": "dataSource", "kind": 1024, "kindString": "Property", @@ -39591,7 +41096,7 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 39, + "line": 40, "character": 4 } ], @@ -39601,7 +41106,7 @@ } }, { - "id": 2432, + "id": 2480, "name": "dataSources", "kind": 1024, "kindString": "Property", @@ -39629,7 +41134,7 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 25, + "line": 26, "character": 4 } ], @@ -39642,7 +41147,7 @@ } }, { - "id": 2458, + "id": 2506, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -39680,7 +41185,7 @@ } }, { - "id": 2442, + "id": 2490, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -39718,7 +41223,7 @@ } }, { - "id": 2441, + "id": 2489, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -39750,7 +41255,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -39760,7 +41265,7 @@ } }, { - "id": 2454, + "id": 2502, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -39801,7 +41306,7 @@ } }, { - "id": 2475, + "id": 2525, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -39829,7 +41334,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1344, + "line": 1372, "character": 4 } ], @@ -39843,7 +41348,7 @@ } }, { - "id": 2455, + "id": 2503, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -39881,7 +41386,7 @@ } }, { - "id": 2471, + "id": 2521, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -39905,7 +41410,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1287, + "line": 1315, "character": 4 } ], @@ -39919,7 +41424,7 @@ } }, { - "id": 2472, + "id": 2522, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -39943,7 +41448,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1297, + "line": 1325, "character": 4 } ], @@ -39957,7 +41462,7 @@ } }, { - "id": 2436, + "id": 2484, "name": "excludeSearchTokenStringFromURL", "kind": 1024, "kindString": "Property", @@ -39981,7 +41486,7 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 96, + "line": 97, "character": 4 } ], @@ -39991,7 +41496,7 @@ } }, { - "id": 2457, + "id": 2505, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -40028,7 +41533,7 @@ } }, { - "id": 2438, + "id": 2486, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -40058,7 +41563,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -40067,7 +41572,7 @@ } }, { - "id": 2443, + "id": 2491, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -40103,7 +41608,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -40113,7 +41618,7 @@ } }, { - "id": 2451, + "id": 2499, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -40151,7 +41656,7 @@ } }, { - "id": 2467, + "id": 2517, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -40174,7 +41679,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -40188,7 +41693,7 @@ } }, { - "id": 2466, + "id": 2516, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -40211,7 +41716,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -40228,7 +41733,7 @@ } }, { - "id": 2465, + "id": 2515, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -40248,7 +41753,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -40262,7 +41767,7 @@ } }, { - "id": 2460, + "id": 2508, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -40300,7 +41805,7 @@ } }, { - "id": 2445, + "id": 2493, "name": "locale", "kind": 1024, "kindString": "Property", @@ -40338,7 +41843,7 @@ } }, { - "id": 2459, + "id": 2507, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -40376,7 +41881,7 @@ } }, { - "id": 2453, + "id": 2501, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -40414,7 +41919,7 @@ } }, { - "id": 2461, + "id": 2509, "name": "primaryAction", "kind": 1024, "kindString": "Property", @@ -40452,7 +41957,7 @@ } }, { - "id": 2468, + "id": 2518, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -40476,7 +41981,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1240, + "line": 1268, "character": 4 } ], @@ -40484,7 +41989,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } }, @@ -40494,7 +41999,7 @@ } }, { - "id": 2469, + "id": 2519, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -40518,7 +42023,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1261, + "line": 1289, "character": 4 } ], @@ -40526,7 +42031,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } }, @@ -40536,7 +42041,7 @@ } }, { - "id": 2435, + "id": 2483, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -40560,7 +42065,7 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 78, + "line": 79, "character": 4 } ], @@ -40570,7 +42075,48 @@ } }, { - "id": 2463, + "id": 2513, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "BaseViewConfig.shouldBypassPayloadValidation" + } + }, + { + "id": 2511, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -40607,7 +42153,48 @@ } }, { - "id": 2434, + "id": 2514, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "BaseViewConfig.useHostEventsV2" + } + }, + { + "id": 2482, "name": "useLastSelectedSources", "kind": 1024, "kindString": "Property", @@ -40631,7 +42218,7 @@ "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 53, + "line": 54, "character": 4 } ], @@ -40641,7 +42228,7 @@ } }, { - "id": 2444, + "id": 2492, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -40677,7 +42264,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -40692,48 +42279,50 @@ "title": "Properties", "kind": 1024, "children": [ - 2446, - 2473, - 2470, - 2464, - 2450, - 2474, - 2433, - 2432, - 2458, - 2442, - 2441, - 2454, - 2475, - 2455, - 2471, - 2472, - 2436, - 2457, - 2438, - 2443, - 2451, - 2467, - 2466, - 2465, - 2460, - 2445, - 2459, - 2453, - 2461, - 2468, - 2469, - 2435, - 2463, - 2434, - 2444 + 2494, + 2523, + 2520, + 2512, + 2498, + 2524, + 2481, + 2480, + 2506, + 2490, + 2489, + 2502, + 2525, + 2503, + 2521, + 2522, + 2484, + 2505, + 2486, + 2491, + 2499, + 2517, + 2516, + 2515, + 2508, + 2493, + 2507, + 2501, + 2509, + 2518, + 2519, + 2483, + 2513, + 2511, + 2514, + 2482, + 2492 ] } ], "sources": [ { "fileName": "embed/search-bar.tsx", - "line": 9, + "line": 10, "character": 17 } ], @@ -40749,7 +42338,7 @@ ] }, { - "id": 2375, + "id": 2421, "name": "SearchViewConfig", "kind": 256, "kindString": "Interface", @@ -40765,7 +42354,7 @@ }, "children": [ { - "id": 2410, + "id": 2456, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -40796,20 +42385,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2411, + "id": 2457, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2412, + "id": 2458, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2413, + "id": 2459, "name": "key", "kind": 32768, "flags": {}, @@ -40845,7 +42434,7 @@ } }, { - "id": 2387, + "id": 2433, "name": "answerId", "kind": 1024, "kindString": "Property", @@ -40869,7 +42458,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 250, + "line": 251, "character": 4 } ], @@ -40879,7 +42468,7 @@ } }, { - "id": 2377, + "id": 2423, "name": "collapseDataPanel", "kind": 1024, "kindString": "Property", @@ -40903,7 +42492,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 103, + "line": 104, "character": 4 } ], @@ -40913,7 +42502,7 @@ } }, { - "id": 2376, + "id": 2422, "name": "collapseDataSources", "kind": 1024, "kindString": "Property", @@ -40937,7 +42526,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 88, + "line": 89, "character": 4 } ], @@ -40947,7 +42536,7 @@ } }, { - "id": 2398, + "id": 2444, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -40975,7 +42564,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1312, + "line": 1340, "character": 4 } ], @@ -40989,7 +42578,7 @@ } }, { - "id": 2390, + "id": 2436, "name": "collapseSearchBarInitially", "kind": 1024, "kindString": "Property", @@ -41016,7 +42605,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 279, + "line": 280, "character": 4 } ], @@ -41026,7 +42615,7 @@ } }, { - "id": 2395, + "id": 2441, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -41050,13 +42639,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1276, + "line": 1304, "character": 4 } ], "type": { "type": "reference", - "id": 2319, + "id": 2365, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -41065,7 +42654,7 @@ } }, { - "id": 2427, + "id": 2473, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -41106,7 +42695,7 @@ } }, { - "id": 2414, + "id": 2460, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -41135,7 +42724,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -41144,7 +42733,7 @@ } }, { - "id": 2391, + "id": 2437, "name": "dataPanelCustomGroupsAccordionInitialState", "kind": 1024, "kindString": "Property", @@ -41172,7 +42761,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 300, + "line": 301, "character": 4 } ], @@ -41182,7 +42771,7 @@ } }, { - "id": 2399, + "id": 2445, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -41210,7 +42799,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1328, + "line": 1356, "character": 4 } ], @@ -41224,7 +42813,7 @@ } }, { - "id": 2383, + "id": 2429, "name": "dataSource", "kind": 1024, "kindString": "Property", @@ -41248,7 +42837,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 190, + "line": 191, "character": 4 } ], @@ -41258,7 +42847,7 @@ } }, { - "id": 2382, + "id": 2428, "name": "dataSources", "kind": 1024, "kindString": "Property", @@ -41281,7 +42870,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 176, + "line": 177, "character": 4 } ], @@ -41294,7 +42883,7 @@ } }, { - "id": 2422, + "id": 2468, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -41332,7 +42921,7 @@ } }, { - "id": 2406, + "id": 2452, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -41370,7 +42959,7 @@ } }, { - "id": 2405, + "id": 2451, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -41402,7 +42991,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -41412,7 +43001,7 @@ } }, { - "id": 2418, + "id": 2464, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -41453,7 +43042,7 @@ } }, { - "id": 2400, + "id": 2446, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -41481,7 +43070,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1344, + "line": 1372, "character": 4 } ], @@ -41495,7 +43084,7 @@ } }, { - "id": 2380, + "id": 2426, "name": "enableSearchAssist", "kind": 1024, "kindString": "Property", @@ -41519,7 +43108,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 147, + "line": 148, "character": 4 } ], @@ -41529,7 +43118,7 @@ } }, { - "id": 2419, + "id": 2465, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -41567,7 +43156,7 @@ } }, { - "id": 2396, + "id": 2442, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -41591,7 +43180,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1287, + "line": 1315, "character": 4 } ], @@ -41605,7 +43194,7 @@ } }, { - "id": 2397, + "id": 2443, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -41629,7 +43218,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1297, + "line": 1325, "character": 4 } ], @@ -41643,7 +43232,7 @@ } }, { - "id": 2386, + "id": 2432, "name": "excludeSearchTokenStringFromURL", "kind": 1024, "kindString": "Property", @@ -41667,7 +43256,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 236, + "line": 237, "character": 4 } ], @@ -41677,7 +43266,7 @@ } }, { - "id": 2421, + "id": 2467, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -41714,7 +43303,7 @@ } }, { - "id": 2392, + "id": 2438, "name": "focusSearchBarOnRender", "kind": 1024, "kindString": "Property", @@ -41742,7 +43331,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 316, + "line": 317, "character": 4 } ], @@ -41752,7 +43341,7 @@ } }, { - "id": 2381, + "id": 2427, "name": "forceTable", "kind": 1024, "kindString": "Property", @@ -41776,7 +43365,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 161, + "line": 162, "character": 4 } ], @@ -41786,7 +43375,7 @@ } }, { - "id": 2402, + "id": 2448, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -41816,7 +43405,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -41825,7 +43414,7 @@ } }, { - "id": 2407, + "id": 2453, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -41861,7 +43450,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -41871,7 +43460,7 @@ } }, { - "id": 2378, + "id": 2424, "name": "hideDataSources", "kind": 1024, "kindString": "Property", @@ -41895,7 +43484,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 117, + "line": 118, "character": 4 } ], @@ -41905,7 +43494,7 @@ } }, { - "id": 2379, + "id": 2425, "name": "hideResults", "kind": 1024, "kindString": "Property", @@ -41929,7 +43518,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 133, + "line": 134, "character": 4 } ], @@ -41939,7 +43528,7 @@ } }, { - "id": 2388, + "id": 2434, "name": "hideSearchBar", "kind": 1024, "kindString": "Property", @@ -41963,7 +43552,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 265, + "line": 266, "character": 4 } ], @@ -41973,7 +43562,7 @@ } }, { - "id": 2415, + "id": 2461, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -42011,7 +43600,7 @@ } }, { - "id": 2430, + "id": 2478, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -42034,7 +43623,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -42048,7 +43637,7 @@ } }, { - "id": 2429, + "id": 2477, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -42071,7 +43660,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -42088,7 +43677,7 @@ } }, { - "id": 2428, + "id": 2476, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -42108,7 +43697,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -42122,7 +43711,7 @@ } }, { - "id": 2424, + "id": 2470, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -42160,7 +43749,7 @@ } }, { - "id": 2409, + "id": 2455, "name": "locale", "kind": 1024, "kindString": "Property", @@ -42198,7 +43787,7 @@ } }, { - "id": 2423, + "id": 2469, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -42236,7 +43825,7 @@ } }, { - "id": 2417, + "id": 2463, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -42274,7 +43863,7 @@ } }, { - "id": 2393, + "id": 2439, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -42298,7 +43887,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1240, + "line": 1268, "character": 4 } ], @@ -42306,7 +43895,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } }, @@ -42316,7 +43905,7 @@ } }, { - "id": 2394, + "id": 2440, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -42340,7 +43929,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1261, + "line": 1289, "character": 4 } ], @@ -42348,7 +43937,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } }, @@ -42358,7 +43947,7 @@ } }, { - "id": 2385, + "id": 2431, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -42378,7 +43967,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 218, + "line": 219, "character": 4 } ], @@ -42388,7 +43977,7 @@ } }, { - "id": 2384, + "id": 2430, "name": "searchQuery", "kind": 1024, "kindString": "Property", @@ -42407,7 +43996,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 197, + "line": 198, "character": 4 } ], @@ -42417,7 +44006,48 @@ } }, { - "id": 2426, + "id": 2474, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.shouldBypassPayloadValidation" + } + }, + { + "id": 2472, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -42454,7 +44084,48 @@ } }, { - "id": 2389, + "id": 2475, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.useHostEventsV2" + } + }, + { + "id": 2435, "name": "useLastSelectedSources", "kind": 1024, "kindString": "Property", @@ -42474,7 +44145,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 272, + "line": 273, "character": 4 } ], @@ -42484,7 +44155,7 @@ } }, { - "id": 2408, + "id": 2454, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -42520,7 +44191,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -42535,59 +44206,61 @@ "title": "Properties", "kind": 1024, "children": [ - 2410, - 2387, - 2377, - 2376, - 2398, - 2390, - 2395, - 2427, - 2414, - 2391, - 2399, - 2383, - 2382, + 2456, + 2433, + 2423, 2422, - 2406, - 2405, - 2418, - 2400, - 2380, - 2419, - 2396, - 2397, - 2386, - 2421, - 2392, - 2381, - 2402, - 2407, - 2378, - 2379, - 2388, - 2415, - 2430, + 2444, + 2436, + 2441, + 2473, + 2460, + 2437, + 2445, 2429, 2428, - 2424, - 2409, - 2423, - 2417, - 2393, - 2394, - 2385, - 2384, + 2468, + 2452, + 2451, + 2464, + 2446, 2426, - 2389, - 2408 + 2465, + 2442, + 2443, + 2432, + 2467, + 2438, + 2427, + 2448, + 2453, + 2424, + 2425, + 2434, + 2461, + 2478, + 2477, + 2476, + 2470, + 2455, + 2469, + 2463, + 2439, + 2440, + 2431, + 2430, + 2474, + 2472, + 2475, + 2435, + 2454 ] } ], "sources": [ { "fileName": "embed/search.ts", - "line": 72, + "line": 73, "character": 17 } ], @@ -42613,14 +44286,14 @@ ] }, { - "id": 1948, + "id": 1988, "name": "SessionInterface", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1951, + "id": 1991, "name": "acSession", "kind": 1024, "kindString": "Property", @@ -42635,14 +44308,14 @@ "type": { "type": "reflection", "declaration": { - "id": 1952, + "id": 1992, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 1954, + "id": 1994, "name": "genNo", "kind": 1024, "kindString": "Property", @@ -42660,7 +44333,7 @@ } }, { - "id": 1953, + "id": 1993, "name": "sessionId", "kind": 1024, "kindString": "Property", @@ -42683,8 +44356,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1954, - 1953 + 1994, + 1993 ] } ] @@ -42692,7 +44365,7 @@ } }, { - "id": 1950, + "id": 1990, "name": "genNo", "kind": 1024, "kindString": "Property", @@ -42710,7 +44383,7 @@ } }, { - "id": 1949, + "id": 1989, "name": "sessionId", "kind": 1024, "kindString": "Property", @@ -42733,9 +44406,9 @@ "title": "Properties", "kind": 1024, "children": [ - 1951, - 1950, - 1949 + 1991, + 1990, + 1989 ] } ], @@ -42748,7 +44421,7 @@ ] }, { - "id": 1276, + "id": 1300, "name": "SpotterAgentEmbedViewConfig", "kind": 256, "kindString": "Interface", @@ -42764,7 +44437,7 @@ }, "children": [ { - "id": 1287, + "id": 1311, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -42795,20 +44468,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1288, + "id": 1312, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1289, + "id": 1313, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1290, + "id": 1314, "name": "key", "kind": 32768, "flags": {}, @@ -42844,7 +44517,7 @@ } }, { - "id": 1304, + "id": 1328, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -42885,7 +44558,7 @@ } }, { - "id": 1291, + "id": 1315, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -42914,7 +44587,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -42923,7 +44596,7 @@ } }, { - "id": 1299, + "id": 1323, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -42961,7 +44634,7 @@ } }, { - "id": 1283, + "id": 1307, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -42999,7 +44672,7 @@ } }, { - "id": 1282, + "id": 1306, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -43031,7 +44704,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -43041,7 +44714,7 @@ } }, { - "id": 1295, + "id": 1319, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -43082,7 +44755,7 @@ } }, { - "id": 1296, + "id": 1320, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -43120,7 +44793,7 @@ } }, { - "id": 1298, + "id": 1322, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -43157,7 +44830,7 @@ } }, { - "id": 1279, + "id": 1303, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -43187,7 +44860,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -43196,7 +44869,7 @@ } }, { - "id": 1284, + "id": 1308, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -43232,7 +44905,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -43242,7 +44915,7 @@ } }, { - "id": 1292, + "id": 1316, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -43280,7 +44953,7 @@ } }, { - "id": 1307, + "id": 1333, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -43303,7 +44976,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -43317,7 +44990,7 @@ } }, { - "id": 1306, + "id": 1332, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -43340,7 +45013,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -43357,7 +45030,7 @@ } }, { - "id": 1305, + "id": 1331, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -43377,7 +45050,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -43391,7 +45064,7 @@ } }, { - "id": 1301, + "id": 1325, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -43429,7 +45102,7 @@ } }, { - "id": 1286, + "id": 1310, "name": "locale", "kind": 1024, "kindString": "Property", @@ -43467,7 +45140,7 @@ } }, { - "id": 1300, + "id": 1324, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -43505,7 +45178,7 @@ } }, { - "id": 1294, + "id": 1318, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -43543,7 +45216,48 @@ } }, { - "id": 1303, + "id": 1329, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.shouldBypassPayloadValidation" + } + }, + { + "id": 1327, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -43580,7 +45294,48 @@ } }, { - "id": 1285, + "id": 1330, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.useHostEventsV2" + } + }, + { + "id": 1309, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -43616,7 +45371,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -43626,7 +45381,7 @@ } }, { - "id": 1277, + "id": 1301, "name": "worksheetId", "kind": 1024, "kindString": "Property", @@ -43652,28 +45407,30 @@ "title": "Properties", "kind": 1024, "children": [ - 1287, - 1304, - 1291, - 1299, - 1283, - 1282, - 1295, - 1296, - 1298, - 1279, - 1284, - 1292, + 1311, + 1328, + 1315, + 1323, 1307, 1306, - 1305, - 1301, - 1286, - 1300, - 1294, + 1319, + 1320, + 1322, 1303, - 1285, - 1277 + 1308, + 1316, + 1333, + 1332, + 1331, + 1325, + 1310, + 1324, + 1318, + 1329, + 1327, + 1330, + 1309, + 1301 ] } ], @@ -43703,13 +45460,13 @@ "extendedBy": [ { "type": "reference", - "id": 1308, + "id": 1334, "name": "BodylessConversationViewConfig" } ] }, { - "id": 1544, + "id": 1576, "name": "SpotterEmbedViewConfig", "kind": 256, "kindString": "Interface", @@ -43725,7 +45482,7 @@ }, "children": [ { - "id": 1567, + "id": 1599, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -43756,20 +45513,20 @@ "type": { "type": "reflection", "declaration": { - "id": 1568, + "id": 1600, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 1569, + "id": 1601, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 1570, + "id": 1602, "name": "key", "kind": 32768, "flags": {}, @@ -43805,7 +45562,7 @@ } }, { - "id": 1584, + "id": 1616, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -43846,7 +45603,7 @@ } }, { - "id": 1571, + "id": 1603, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -43875,7 +45632,7 @@ ], "type": { "type": "reference", - "id": 2744, + "id": 2800, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -43884,7 +45641,7 @@ } }, { - "id": 1549, + "id": 1581, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -43912,7 +45669,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 75, + "line": 76, "character": 4 } ], @@ -43922,7 +45679,7 @@ } }, { - "id": 1579, + "id": 1611, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -43960,7 +45717,7 @@ } }, { - "id": 1547, + "id": 1579, "name": "disableSourceSelection", "kind": 1024, "kindString": "Property", @@ -43984,7 +45741,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 45, + "line": 46, "character": 4 } ], @@ -43994,7 +45751,7 @@ } }, { - "id": 1563, + "id": 1595, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -44032,7 +45789,7 @@ } }, { - "id": 1562, + "id": 1594, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -44064,7 +45821,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -44074,7 +45831,7 @@ } }, { - "id": 1575, + "id": 1607, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -44115,7 +45872,7 @@ } }, { - "id": 1556, + "id": 1588, "name": "enablePastConversationsSidebar", "kind": 1024, "kindString": "Property", @@ -44143,7 +45900,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 182, + "line": 183, "character": 4 } ], @@ -44153,7 +45910,7 @@ } }, { - "id": 1576, + "id": 1608, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -44191,7 +45948,7 @@ } }, { - "id": 1553, + "id": 1585, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -44215,7 +45972,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 137, + "line": 138, "character": 4 } ], @@ -44225,7 +45982,7 @@ } }, { - "id": 1555, + "id": 1587, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -44249,7 +46006,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 166, + "line": 167, "character": 4 } ], @@ -44259,7 +46016,7 @@ } }, { - "id": 1578, + "id": 1610, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -44296,7 +46053,7 @@ } }, { - "id": 1559, + "id": 1591, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -44326,7 +46083,7 @@ ], "type": { "type": "reference", - "id": 2703, + "id": 2759, "name": "FrameParams" }, "inheritedFrom": { @@ -44335,7 +46092,7 @@ } }, { - "id": 1564, + "id": 1596, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -44371,7 +46128,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -44381,7 +46138,7 @@ } }, { - "id": 1551, + "id": 1583, "name": "hideSampleQuestions", "kind": 1024, "kindString": "Property", @@ -44405,7 +46162,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 106, + "line": 107, "character": 4 } ], @@ -44415,7 +46172,7 @@ } }, { - "id": 1548, + "id": 1580, "name": "hideSourceSelection", "kind": 1024, "kindString": "Property", @@ -44439,7 +46196,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 59, + "line": 60, "character": 4 } ], @@ -44449,7 +46206,7 @@ } }, { - "id": 1572, + "id": 1604, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -44487,7 +46244,7 @@ } }, { - "id": 1587, + "id": 1621, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -44510,7 +46267,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6503, + "line": 6552, "character": 4 } ], @@ -44524,7 +46281,7 @@ } }, { - "id": 1586, + "id": 1620, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -44547,7 +46304,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6486, + "line": 6535, "character": 4 } ], @@ -44564,7 +46321,7 @@ } }, { - "id": 1585, + "id": 1619, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -44584,7 +46341,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6519, "character": 4 } ], @@ -44598,7 +46355,7 @@ } }, { - "id": 1581, + "id": 1613, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -44636,7 +46393,7 @@ } }, { - "id": 1566, + "id": 1598, "name": "locale", "kind": 1024, "kindString": "Property", @@ -44674,7 +46431,7 @@ } }, { - "id": 1580, + "id": 1612, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -44712,7 +46469,7 @@ } }, { - "id": 1574, + "id": 1606, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -44750,7 +46507,7 @@ } }, { - "id": 1552, + "id": 1584, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -44774,7 +46531,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 127, + "line": 128, "character": 4 } ], @@ -44782,13 +46539,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 1979, + "id": 2019, "name": "RuntimeFilter" } } }, { - "id": 1554, + "id": 1586, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -44812,7 +46569,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 156, + "line": 157, "character": 4 } ], @@ -44820,13 +46577,13 @@ "type": "array", "elementType": { "type": "reference", - "id": 2928, + "id": 2984, "name": "RuntimeParameter" } } }, { - "id": 1546, + "id": 1578, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -44839,7 +46596,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 30, + "line": 31, "character": 4 } ], @@ -44849,7 +46606,48 @@ } }, { - "id": 1583, + "id": 1617, + "name": "shouldBypassPayloadValidation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to bypass host events payload validation", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n shouldBypassPayloadValidation:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1136, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.shouldBypassPayloadValidation" + } + }, + { + "id": 1615, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -44886,7 +46684,7 @@ } }, { - "id": 1550, + "id": 1582, "name": "showSpotterLimitations", "kind": 1024, "kindString": "Property", @@ -44910,7 +46708,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 91, + "line": 92, "character": 4 } ], @@ -44920,7 +46718,7 @@ } }, { - "id": 1557, + "id": 1589, "name": "updatedSpotterChatPrompt", "kind": 1024, "kindString": "Property", @@ -44948,17 +46746,58 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 198, + "line": 199, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1618, + "name": "useHostEventsV2", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Flag to use host events v2. This is used to enable the new host events v2 API.", + "tags": [ + { + "tag": "default", + "text": "false" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl" + }, + { + "tag": "example", + "text": "\n```js\nconst embed = new AppEmbed('#tsEmbed', {\n ... // other embed view config\n useHostEventsV2:true,\n})\n```\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1150, "character": 4 } ], "type": { "type": "intrinsic", "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "name": "Omit.useHostEventsV2" } }, { - "id": 1565, + "id": 1597, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -44994,7 +46833,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2177, + "id": 2223, "name": "Action" } }, @@ -45004,7 +46843,7 @@ } }, { - "id": 1545, + "id": 1577, "name": "worksheetId", "kind": 1024, "kindString": "Property", @@ -45015,7 +46854,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 26, + "line": 27, "character": 4 } ], @@ -45030,47 +46869,49 @@ "title": "Properties", "kind": 1024, "children": [ - 1567, - 1584, - 1571, - 1549, + 1599, + 1616, + 1603, + 1581, + 1611, 1579, - 1547, - 1563, - 1562, - 1575, - 1556, - 1576, - 1553, - 1555, - 1578, - 1559, - 1564, - 1551, - 1548, - 1572, - 1587, - 1586, + 1595, + 1594, + 1607, + 1588, + 1608, 1585, - 1581, - 1566, - 1580, - 1574, - 1552, - 1554, - 1546, + 1587, + 1610, + 1591, + 1596, 1583, - 1550, - 1557, - 1565, - 1545 + 1580, + 1604, + 1621, + 1620, + 1619, + 1613, + 1598, + 1612, + 1606, + 1584, + 1586, + 1578, + 1617, + 1615, + 1582, + 1589, + 1618, + 1597, + 1577 ] } ], "sources": [ { "fileName": "embed/conversation.ts", - "line": 21, + "line": 22, "character": 17 } ], @@ -45093,20 +46934,20 @@ "extendedBy": [ { "type": "reference", - "id": 1588, + "id": 1622, "name": "ConversationViewConfig" } ] }, { - "id": 1955, + "id": 1995, "name": "UnderlyingDataPoint", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 1956, + "id": 1996, "name": "columnId", "kind": 1024, "kindString": "Property", @@ -45124,7 +46965,7 @@ } }, { - "id": 1957, + "id": 1997, "name": "dataValue", "kind": 1024, "kindString": "Property", @@ -45147,8 +46988,8 @@ "title": "Properties", "kind": 1024, "children": [ - 1956, - 1957 + 1996, + 1997 ] } ], @@ -45161,14 +47002,14 @@ ] }, { - "id": 2966, + "id": 3022, "name": "VizPoint", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 2967, + "id": 3023, "name": "selectedAttributes", "kind": 1024, "kindString": "Property", @@ -45176,7 +47017,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6116, + "line": 6154, "character": 4 } ], @@ -45189,7 +47030,7 @@ } }, { - "id": 2968, + "id": 3024, "name": "selectedMeasures", "kind": 1024, "kindString": "Property", @@ -45197,7 +47038,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6117, + "line": 6155, "character": 4 } ], @@ -45215,21 +47056,21 @@ "title": "Properties", "kind": 1024, "children": [ - 2967, - 2968 + 3023, + 3024 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6115, + "line": 6153, "character": 17 } ] }, { - "id": 2757, + "id": 2813, "name": "customCssInterface", "kind": 256, "kindString": "Interface", @@ -45239,7 +47080,7 @@ }, "children": [ { - "id": 2759, + "id": 2815, "name": "rules_UNSTABLE", "kind": 1024, "kindString": "Property", @@ -45269,20 +47110,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2760, + "id": 2816, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2761, + "id": 2817, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2762, + "id": 2818, "name": "selector", "kind": 32768, "flags": {}, @@ -45295,7 +47136,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2763, + "id": 2819, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -45308,14 +47149,14 @@ } ], "indexSignature": { - "id": 2764, + "id": 2820, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2765, + "id": 2821, "name": "declaration", "kind": 32768, "flags": {}, @@ -45337,7 +47178,7 @@ } }, { - "id": 2758, + "id": 2814, "name": "variables", "kind": 1024, "kindString": "Property", @@ -45356,7 +47197,7 @@ ], "type": { "type": "reference", - "id": 2766, + "id": 2822, "name": "CustomCssVariables" } } @@ -45366,8 +47207,8 @@ "title": "Properties", "kind": 1024, "children": [ - 2759, - 2758 + 2815, + 2814 ] } ], @@ -45672,7 +47513,7 @@ ] }, { - "id": 2727, + "id": 2783, "name": "DOMSelector", "kind": 4194304, "kindString": "Type alias", @@ -45699,7 +47540,7 @@ } }, { - "id": 2731, + "id": 2787, "name": "MessageCallback", "kind": 4194304, "kindString": "Type alias", @@ -45707,14 +47548,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1666, + "line": 1694, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2732, + "id": 2788, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -45731,13 +47572,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1666, + "line": 1694, "character": 30 } ], "signatures": [ { - "id": 2733, + "id": 2789, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -45747,19 +47588,19 @@ }, "parameters": [ { - "id": 2734, + "id": 2790, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2739, + "id": 2795, "name": "MessagePayload" } }, { - "id": 2735, + "id": 2791, "name": "responder", "kind": 32768, "kindString": "Parameter", @@ -45769,7 +47610,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2736, + "id": 2792, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -45777,13 +47618,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1673, + "line": 1701, "character": 16 } ], "signatures": [ { - "id": 2737, + "id": 2793, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -45793,7 +47634,7 @@ }, "parameters": [ { - "id": 2738, + "id": 2794, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -45824,7 +47665,7 @@ } }, { - "id": 2728, + "id": 2784, "name": "MessageOptions", "kind": 4194304, "kindString": "Type alias", @@ -45841,21 +47682,21 @@ "sources": [ { "fileName": "types.ts", - "line": 1655, + "line": 1683, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2729, + "id": 2785, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2730, + "id": 2786, "name": "start", "kind": 1024, "kindString": "Property", @@ -45868,7 +47709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1660, + "line": 1688, "character": 4 } ], @@ -45883,14 +47724,14 @@ "title": "Properties", "kind": 1024, "children": [ - 2730 + 2786 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1655, + "line": 1683, "character": 29 } ] @@ -45898,7 +47739,7 @@ } }, { - "id": 2739, + "id": 2795, "name": "MessagePayload", "kind": 4194304, "kindString": "Type alias", @@ -45915,21 +47756,21 @@ "sources": [ { "fileName": "types.ts", - "line": 1642, + "line": 1670, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2740, + "id": 2796, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2742, + "id": 2798, "name": "data", "kind": 1024, "kindString": "Property", @@ -45937,7 +47778,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1646, + "line": 1674, "character": 4 } ], @@ -45947,7 +47788,7 @@ } }, { - "id": 2743, + "id": 2799, "name": "status", "kind": 1024, "kindString": "Property", @@ -45957,7 +47798,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1648, + "line": 1676, "character": 4 } ], @@ -45967,7 +47808,7 @@ } }, { - "id": 2741, + "id": 2797, "name": "type", "kind": 1024, "kindString": "Property", @@ -45975,7 +47816,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1644, + "line": 1672, "character": 4 } ], @@ -45990,16 +47831,16 @@ "title": "Properties", "kind": 1024, "children": [ - 2742, - 2743, - 2741 + 2798, + 2799, + 2797 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1642, + "line": 1670, "character": 29 } ] @@ -46057,7 +47898,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } } @@ -46319,7 +48160,7 @@ ], "type": { "type": "reference", - "id": 1875, + "id": 1915, "name": "AnswerService" } }, @@ -46406,7 +48247,7 @@ }, "type": { "type": "reference", - "id": 2323, + "id": 2369, "name": "EmbedConfig" } } @@ -46506,14 +48347,14 @@ }, "type": { "type": "reference", - "id": 2323, + "id": 2369, "name": "EmbedConfig" } } ], "type": { "type": "reference", - "id": 1822, + "id": 1862, "name": "AuthEventEmitter" } } @@ -46653,7 +48494,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2698, + "id": 2754, "name": "PrefetchFeatures" } } @@ -46781,7 +48622,7 @@ ] }, { - "id": 3020, + "id": 3093, "name": "resetCachedAuthToken", "kind": 64, "kindString": "Function", @@ -46797,7 +48638,7 @@ ], "signatures": [ { - "id": 3021, + "id": 3094, "name": "resetCachedAuthToken", "kind": 4096, "kindString": "Call signature", @@ -46991,7 +48832,7 @@ ] }, { - "id": 2938, + "id": 2994, "name": "uploadMixpanelEvent", "kind": 64, "kindString": "Function", @@ -47005,7 +48846,7 @@ ], "signatures": [ { - "id": 2939, + "id": 2995, "name": "uploadMixpanelEvent", "kind": 4096, "kindString": "Call signature", @@ -47015,7 +48856,7 @@ }, "parameters": [ { - "id": 2940, + "id": 2996, "name": "eventId", "kind": 32768, "kindString": "Parameter", @@ -47027,7 +48868,7 @@ } }, { - "id": 2941, + "id": 2997, "name": "eventProps", "kind": 32768, "kindString": "Parameter", @@ -47038,7 +48879,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2942, + "id": 2998, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -47061,75 +48902,78 @@ "title": "Enumerations", "kind": 4, "children": [ - 2177, - 1820, - 1805, - 1812, - 1967, - 2319, - 3011, - 3007, - 3003, - 2173, - 1999, - 2709, - 2960, - 2954, - 2720, - 2097, + 2223, + 1860, + 1845, + 1852, + 2007, + 2365, + 2214, + 3067, + 3063, + 3059, + 2219, + 3076, + 2039, + 3089, + 2765, 3016, - 2963, - 2997, - 2931, - 1958, - 2698, - 2958, - 1983, - 2989 + 3010, + 2776, + 2137, + 3072, + 3019, + 3053, + 2987, + 1998, + 2754, + 3014, + 2023, + 3045 ] }, { "title": "Classes", "kind": 128, "children": [ - 1875, - 1027, - 1340, - 1632, - 614, - 844, - 241, + 1915, + 1047, + 1368, + 1668, + 626, + 860, + 245, 58, - 1244, - 1371 + 1268, + 1399 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 2608, - 1822, - 1308, - 1588, - 2969, - 2766, - 2754, - 2744, - 2323, - 2703, - 2476, - 1979, - 2928, - 2558, - 2431, - 2375, - 1948, - 1276, - 1544, - 1955, - 2966, - 2757, + 2662, + 1862, + 1334, + 1622, + 3025, + 2822, + 2810, + 2800, + 2369, + 2759, + 2526, + 2019, + 2984, + 2610, + 2479, + 2421, + 1988, + 1300, + 1576, + 1995, + 3022, + 2813, 21, 28 ] @@ -47138,10 +48982,10 @@ "title": "Type aliases", "kind": 4194304, "children": [ - 2727, - 2731, - 2728, - 2739 + 2783, + 2787, + 2784, + 2795 ] }, { @@ -47158,9 +49002,9 @@ 4, 7, 25, - 3020, + 3093, 40, - 2938 + 2994 ] } ], From 7e8243d8674e2f064c2dd1fcfca4c80b3fdda6d6 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Mon, 12 Jan 2026 14:51:24 +0530 Subject: [PATCH 18/23] docgen fix --- static/typedoc/typedoc.json | 3816 +++++++++++++++++------------------ 1 file changed, 1903 insertions(+), 1913 deletions(-) diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index 23e33991..962032a5 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -21,7 +21,7 @@ }, { "tag": "example", - "text": "\n```js\nconst embed = new LiveboardEmbed('#tsEmbed', {\n ... //other embed view config\n //visibleActions: [],\n disabledActions: [Action.Download],\n hiddenActions: [Action.Edit, ActionAction.Explore],\n})\n```\nSee also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]\n" + "text": "\n```js\nconst embed = new LiveboardEmbed('#tsEmbed', {\n ... //other embed view config\n //visibleActions: [],\n disabledActions: [Action.Download],\n hiddenActions: [Action.Edit, ActionAction.Explore],\n})\n```\nSee also link:https://developers.thoughtspot.com/docs/actions[Developer Documentation].\n" } ] }, @@ -48,7 +48,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5805, + "line": 5810, "character": 4 } ], @@ -76,7 +76,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4951, + "line": 4956, "character": 4 } ], @@ -104,7 +104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4880, + "line": 4885, "character": 4 } ], @@ -128,7 +128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4869, + "line": 4874, "character": 4 } ], @@ -152,7 +152,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4932, + "line": 4937, "character": 4 } ], @@ -176,7 +176,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4941, + "line": 4946, "character": 4 } ], @@ -204,7 +204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4961, + "line": 4966, "character": 4 } ], @@ -232,7 +232,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5599, + "line": 5604, "character": 4 } ], @@ -260,7 +260,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5321, + "line": 5326, "character": 4 } ], @@ -288,7 +288,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5772, + "line": 5777, "character": 4 } ], @@ -316,7 +316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5309, + "line": 5314, "character": 4 } ], @@ -344,7 +344,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5297, + "line": 5302, "character": 4 } ], @@ -373,7 +373,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5761, + "line": 5766, "character": 4 } ], @@ -401,7 +401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5434, + "line": 5439, "character": 4 } ], @@ -429,7 +429,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5468, + "line": 5473, "character": 4 } ], @@ -457,7 +457,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5523, + "line": 5528, "character": 4 } ], @@ -485,7 +485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5457, + "line": 5462, "character": 4 } ], @@ -513,7 +513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5491, + "line": 5496, "character": 4 } ], @@ -541,7 +541,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5533, + "line": 5538, "character": 4 } ], @@ -569,7 +569,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5502, + "line": 5507, "character": 4 } ], @@ -597,7 +597,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5555, + "line": 5560, "character": 4 } ], @@ -625,7 +625,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5512, + "line": 5517, "character": 4 } ], @@ -653,7 +653,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5479, + "line": 5484, "character": 4 } ], @@ -681,7 +681,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5543, + "line": 5548, "character": 4 } ], @@ -709,7 +709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5445, + "line": 5450, "character": 4 } ], @@ -737,7 +737,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5903, + "line": 5908, "character": 4 } ], @@ -761,7 +761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4923, + "line": 4928, "character": 4 } ], @@ -789,7 +789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4914, + "line": 4919, "character": 4 } ], @@ -817,14 +817,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4902, + "line": 4907, "character": 4 } ], "defaultValue": "\"collapseDataSources\"" }, { - "id": 2352, + "id": 2353, "name": "ColumnRename", "kind": 16, "kindString": "Enumeration member", @@ -845,7 +845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5979, + "line": 5996, "character": 4 } ], @@ -869,7 +869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4891, + "line": 4896, "character": 4 } ], @@ -884,7 +884,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5248, + "line": 5253, "character": 4 } ], @@ -908,7 +908,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4828, + "line": 4833, "character": 4 } ], @@ -932,14 +932,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5247, + "line": 5252, "character": 4 } ], "defaultValue": "\"context-menu-item-copy-to-clipboard\"" }, { - "id": 2353, + "id": 2354, "name": "CoverAndFilterOptionInPDF", "kind": 16, "kindString": "Enumeration member", @@ -960,14 +960,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5989, + "line": 6006, "character": 4 } ], "defaultValue": "\"coverAndFilterOptionInPDF\"" }, { - "id": 2363, + "id": 2364, "name": "CreateGroup", "kind": 16, "kindString": "Enumeration member", @@ -988,7 +988,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6101, + "line": 6118, "character": 4 } ], @@ -1016,7 +1016,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5736, + "line": 5741, "character": 4 } ], @@ -1044,7 +1044,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5341, + "line": 5346, "character": 4 } ], @@ -1072,14 +1072,42 @@ "sources": [ { "fileName": "types.ts", - "line": 5392, + "line": 5397, "character": 4 } ], "defaultValue": "\"context-menu-item-cross-filter\"" }, { - "id": 2350, + "id": 2346, + "name": "DataModelInstructions", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "The **Data model instructions** button on the Spotter interface.\nAllows opening the data model instructions modal.", + "tags": [ + { + "tag": "example", + "text": "\n```js\nhiddenAction: [Action.DataModelInstructions]\n```" + }, + { + "tag": "version", + "text": "SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl\n" + } + ] + }, + "sources": [ + { + "fileName": "types.ts", + "line": 5920, + "character": 4 + } + ], + "defaultValue": "\"DataModelInstructions\"" + }, + { + "id": 2351, "name": "DeletePreviousPrompt", "kind": 16, "kindString": "Enumeration member", @@ -1100,7 +1128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5960, + "line": 5977, "character": 4 } ], @@ -1128,7 +1156,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5872, + "line": 5877, "character": 4 } ], @@ -1156,7 +1184,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5891, + "line": 5896, "character": 4 } ], @@ -1180,7 +1208,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5011, + "line": 5016, "character": 4 } ], @@ -1204,7 +1232,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5044, + "line": 5049, "character": 4 } ], @@ -1229,7 +1257,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5034, + "line": 5039, "character": 4 } ], @@ -1253,7 +1281,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5021, + "line": 5026, "character": 4 } ], @@ -1277,7 +1305,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5054, + "line": 5059, "character": 4 } ], @@ -1301,7 +1329,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5264, + "line": 5269, "character": 4 } ], @@ -1325,7 +1353,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5237, + "line": 5242, "character": 4 } ], @@ -1349,7 +1377,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5228, + "line": 5233, "character": 4 } ], @@ -1373,7 +1401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5130, + "line": 5135, "character": 4 } ], @@ -1397,7 +1425,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4819, + "line": 4824, "character": 4 } ], @@ -1425,7 +1453,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5330, + "line": 5335, "character": 4 } ], @@ -1440,14 +1468,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5253, + "line": 5258, "character": 4 } ], "defaultValue": "\"context-menu-item-edit-measure\"" }, { - "id": 2349, + "id": 2350, "name": "EditPreviousPrompt", "kind": 16, "kindString": "Enumeration member", @@ -1468,7 +1496,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5949, + "line": 5966, "character": 4 } ], @@ -1496,7 +1524,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5643, + "line": 5648, "character": 4 } ], @@ -1524,7 +1552,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5818, + "line": 5823, "character": 4 } ], @@ -1548,7 +1576,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5098, + "line": 5103, "character": 4 } ], @@ -1572,14 +1600,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5138, + "line": 5143, "character": 4 } ], "defaultValue": "\"editTitle\"" }, { - "id": 2351, + "id": 2352, "name": "EditTokens", "kind": 16, "kindString": "Enumeration member", @@ -1600,7 +1628,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5970, + "line": 5987, "character": 4 } ], @@ -1628,7 +1656,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5609, + "line": 5614, "character": 4 } ], @@ -1641,7 +1669,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Action ID to hide or disable Iterative Change Analysis option\non contextual change analysis Inisght charts context menu", + "shortText": "Action ID to hide or disable Iterative Change Analysis option\nin the contextual change analysis Insight charts context menu.", "tags": [ { "tag": "example", @@ -1656,7 +1684,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5620, + "line": 5625, "character": 4 } ], @@ -1680,7 +1708,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5217, + "line": 5222, "character": 4 } ], @@ -1705,7 +1733,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5070, + "line": 5075, "character": 4 } ], @@ -1729,20 +1757,20 @@ "sources": [ { "fileName": "types.ts", - "line": 5080, + "line": 5085, "character": 4 } ], "defaultValue": "\"importTSL\"" }, { - "id": 2354, + "id": 2355, "name": "InConversationTraining", "kind": 16, "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Action ID for hide or disable the\nSpotter in conversation training widget.\nThe Add to Coaching feature is currently in beta\nand is disabled by default on embed deployments.\nTo enable this feature on your instance,\ncontact ThoughtSpot Support.", + "shortText": "Action ID to hide or disable the Spotter in the conversation training widget.\nWhen disabled, users cannot access **Add to Coaching**, which allows adding reference\nquestions and business terms to improve Spotter’s responses.\nThe **Add to Coaching** feature is generally available from version 26.2.0.cl and\nenabled by default on embed deployments.", "tags": [ { "tag": "example", @@ -1757,7 +1785,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6005, + "line": 6022, "character": 4 } ], @@ -1785,7 +1813,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5882, + "line": 5887, "character": 4 } ], @@ -1809,14 +1837,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5179, + "line": 5184, "character": 4 } ], "defaultValue": "\"pinboardInfo\"" }, { - "id": 2360, + "id": 2361, "name": "LiveboardStylePanel", "kind": 16, "kindString": "Enumeration member", @@ -1837,7 +1865,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6071, + "line": 6088, "character": 4 } ], @@ -1865,7 +1893,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5704, + "line": 5709, "character": 4 } ], @@ -1889,7 +1917,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4810, + "line": 4815, "character": 4 } ], @@ -1913,7 +1941,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5684, + "line": 5689, "character": 4 } ], @@ -1941,7 +1969,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5382, + "line": 5387, "character": 4 } ], @@ -1969,7 +1997,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5861, + "line": 5866, "character": 4 } ], @@ -1997,7 +2025,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5589, + "line": 5594, "character": 4 } ], @@ -2024,14 +2052,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5664, + "line": 5669, "character": 4 } ], "defaultValue": "\"modifySageAnswer\"" }, { - "id": 2362, + "id": 2363, "name": "MoveOutOfGroup", "kind": 16, "kindString": "Enumeration member", @@ -2052,14 +2080,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6091, + "line": 6108, "character": 4 } ], "defaultValue": "\"moveOutOfGroup\"" }, { - "id": 2361, + "id": 2362, "name": "MoveToGroup", "kind": 16, "kindString": "Enumeration member", @@ -2080,7 +2108,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6081, + "line": 6098, "character": 4 } ], @@ -2104,7 +2132,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5673, + "line": 5678, "character": 4 } ], @@ -2132,7 +2160,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5794, + "line": 5799, "character": 4 } ], @@ -2160,7 +2188,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5829, + "line": 5834, "character": 4 } ], @@ -2188,7 +2216,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5694, + "line": 5699, "character": 4 } ], @@ -2212,14 +2240,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5196, + "line": 5201, "character": 4 } ], "defaultValue": "\"pin\"" }, { - "id": 2358, + "id": 2359, "name": "PngScreenshotInEmail", "kind": 16, "kindString": "Enumeration member", @@ -2236,7 +2264,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6049, + "line": 6066, "character": 4 } ], @@ -2260,14 +2288,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5108, + "line": 5113, "character": 4 } ], "defaultValue": "\"present\"" }, { - "id": 2346, + "id": 2347, "name": "PreviewDataSpotter", "kind": 16, "kindString": "Enumeration member", @@ -2288,7 +2316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5915, + "line": 5932, "character": 4 } ], @@ -2313,7 +2341,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5287, + "line": 5292, "character": 4 } ], @@ -2337,14 +2365,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5148, + "line": 5153, "character": 4 } ], "defaultValue": "\"delete\"" }, { - "id": 2359, + "id": 2360, "name": "RemoveAttachment", "kind": 16, "kindString": "Enumeration member", @@ -2365,7 +2393,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6061, + "line": 6078, "character": 4 } ], @@ -2378,7 +2406,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Remove** action that appears when cross filters are applied\non a Liveboard.\nRemoves filters applied o a visualization.", + "shortText": "The **Remove** action that appears when cross filters are applied\non a Liveboard.\nRemoves filters applied to a visualization.", "tags": [ { "tag": "example", @@ -2393,7 +2421,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5423, + "line": 5428, "character": 4 } ], @@ -2421,7 +2449,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5783, + "line": 5788, "character": 4 } ], @@ -2449,7 +2477,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5569, + "line": 5574, "character": 4 } ], @@ -2480,7 +2508,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5351, + "line": 5356, "character": 4 } ], @@ -2504,7 +2532,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5273, + "line": 5278, "character": 4 } ], @@ -2532,14 +2560,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5579, + "line": 5584, "character": 4 } ], "defaultValue": "\"requestVerification\"" }, { - "id": 2347, + "id": 2348, "name": "ResetSpotterChat", "kind": 16, "kindString": "Enumeration member", @@ -2560,7 +2588,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5927, + "line": 5944, "character": 4 } ], @@ -2588,7 +2616,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5655, + "line": 5660, "character": 4 } ], @@ -2612,7 +2640,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4779, + "line": 4784, "character": 4 } ], @@ -2636,7 +2664,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4797, + "line": 4802, "character": 4 } ], @@ -2660,7 +2688,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4842, + "line": 4847, "character": 4 } ], @@ -2684,7 +2712,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4851, + "line": 4856, "character": 4 } ], @@ -2699,7 +2727,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5254, + "line": 5259, "character": 4 } ], @@ -2723,7 +2751,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4860, + "line": 4865, "character": 4 } ], @@ -2741,7 +2769,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4986, + "line": 4991, "character": 4 } ], @@ -2769,7 +2797,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5630, + "line": 5635, "character": 4 } ], @@ -2793,7 +2821,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5001, + "line": 5006, "character": 4 } ], @@ -2817,14 +2845,14 @@ "sources": [ { "fileName": "types.ts", - "line": 4974, + "line": 4979, "character": 4 } ], "defaultValue": "\"spotIQAnalyze\"" }, { - "id": 2348, + "id": 2349, "name": "SpotterFeedback", "kind": 16, "kindString": "Enumeration member", @@ -2845,14 +2873,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5938, + "line": 5955, "character": 4 } ], "defaultValue": "\"spotterFeedback\"" }, { - "id": 2357, + "id": 2358, "name": "SpotterTokenQuickEdit", "kind": 16, "kindString": "Enumeration member", @@ -2873,14 +2901,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6038, + "line": 6055, "character": 4 } ], "defaultValue": "\"SpotterTokenQuickEdit\"" }, { - "id": 2355, + "id": 2356, "name": "SpotterWarningsBanner", "kind": 16, "kindString": "Enumeration member", @@ -2901,14 +2929,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6016, + "line": 6033, "character": 4 } ], "defaultValue": "\"SpotterWarningsBanner\"" }, { - "id": 2356, + "id": 2357, "name": "SpotterWarningsOnTokens", "kind": 16, "kindString": "Enumeration member", @@ -2929,7 +2957,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6027, + "line": 6044, "character": 4 } ], @@ -2953,7 +2981,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5209, + "line": 5214, "character": 4 } ], @@ -2981,7 +3009,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5372, + "line": 5377, "character": 4 } ], @@ -3009,7 +3037,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5361, + "line": 5366, "character": 4 } ], @@ -3022,7 +3050,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Sync to Slack** action on Liveboard visualizations.\nAllows sending data to third-party apps Slack", + "shortText": "The **Sync to Slack** action on Liveboard visualizations.\nAllows sending data to third-party apps like Slack.", "tags": [ { "tag": "example", @@ -3030,14 +3058,14 @@ }, { "tag": "version", - "text": "@version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl\n" + "text": "SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 5402, + "line": 5407, "character": 4 } ], @@ -3050,7 +3078,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Sync to Teams** action on Liveboard visualizations.\nAllows sending data to third-party apps Team", + "shortText": "The **Sync to Teams** action on Liveboard visualizations.\nAllows sending data to third-party apps like Microsoft Teams.", "tags": [ { "tag": "example", @@ -3058,14 +3086,14 @@ }, { "tag": "version", - "text": "@version SDK : 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl\n" + "text": "SDK: 1.32.0 | ThoughtSpot Cloud: 10.1.0.cl\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 5412, + "line": 5417, "character": 4 } ], @@ -3097,7 +3125,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5723, + "line": 5728, "character": 4 } ], @@ -3121,14 +3149,14 @@ "sources": [ { "fileName": "types.ts", - "line": 5120, + "line": 5125, "character": 4 } ], "defaultValue": "\"toggleSize\"" }, { - "id": 2364, + "id": 2365, "name": "UngroupLiveboardGroup", "kind": 16, "kindString": "Enumeration member", @@ -3149,7 +3177,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6111, + "line": 6128, "character": 4 } ], @@ -3177,7 +3205,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5851, + "line": 5856, "character": 4 } ], @@ -3201,7 +3229,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5089, + "line": 5094, "character": 4 } ], @@ -3229,7 +3257,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5747, + "line": 5752, "character": 4 } ], @@ -3257,7 +3285,7 @@ "sources": [ { "fileName": "types.ts", - "line": 5840, + "line": 5845, "character": 4 } ], @@ -3298,17 +3326,18 @@ 2240, 2239, 2238, - 2352, + 2353, 2237, 2282, 2230, 2281, - 2353, - 2363, + 2354, + 2364, 2330, 2293, 2298, - 2350, + 2346, + 2351, 2342, 2344, 2252, @@ -3323,21 +3352,21 @@ 2229, 2292, 2284, - 2349, + 2350, 2322, 2337, 2261, 2265, - 2351, + 2352, 2319, 2320, 2278, 2258, 2259, - 2354, + 2355, 2343, 2272, - 2360, + 2361, 2328, 2228, 2326, @@ -3345,26 +3374,26 @@ 2341, 2317, 2324, + 2363, 2362, - 2361, 2325, 2335, 2338, 2327, 2275, - 2358, + 2359, 2262, - 2346, + 2347, 2288, 2266, - 2359, + 2360, 2301, 2334, 2315, 2294, 2287, 2316, - 2347, + 2348, 2323, 2224, 2227, @@ -3376,10 +3405,10 @@ 2321, 2251, 2246, - 2348, - 2357, - 2355, + 2349, + 2358, 2356, + 2357, 2277, 2296, 2295, @@ -3387,7 +3416,7 @@ 2300, 2329, 2263, - 2364, + 2365, 2340, 2260, 2331, @@ -3398,7 +3427,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4770, + "line": 4775, "character": 12 } ] @@ -3953,7 +3982,7 @@ ] }, { - "id": 2365, + "id": 2366, "name": "ContextMenuTriggerOptions", "kind": 4, "kindString": "Enumeration", @@ -3963,7 +3992,7 @@ }, "children": [ { - "id": 2368, + "id": 2369, "name": "BOTH_CLICKS", "kind": 16, "kindString": "Enumeration member", @@ -3971,14 +4000,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6131, + "line": 6148, "character": 4 } ], "defaultValue": "\"both-clicks\"" }, { - "id": 2366, + "id": 2367, "name": "LEFT_CLICK", "kind": 16, "kindString": "Enumeration member", @@ -3986,14 +4015,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6129, + "line": 6146, "character": 4 } ], "defaultValue": "\"left-click\"" }, { - "id": 2367, + "id": 2368, "name": "RIGHT_CLICK", "kind": 16, "kindString": "Enumeration member", @@ -4001,7 +4030,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6130, + "line": 6147, "character": 4 } ], @@ -4013,16 +4042,16 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2368, - 2366, - 2367 + 2369, + 2367, + 2368 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6128, + "line": 6145, "character": 12 } ] @@ -4043,7 +4072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6473, + "line": 6478, "character": 4 } ], @@ -4058,7 +4087,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6472, + "line": 6477, "character": 4 } ], @@ -4073,7 +4102,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6471, + "line": 6476, "character": 4 } ], @@ -4088,7 +4117,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6474, + "line": 6479, "character": 4 } ], @@ -4110,13 +4139,13 @@ "sources": [ { "fileName": "types.ts", - "line": 6470, + "line": 6475, "character": 12 } ] }, { - "id": 3067, + "id": 3070, "name": "CustomActionTarget", "kind": 4, "kindString": "Enumeration", @@ -4126,7 +4155,7 @@ }, "children": [ { - "id": 3070, + "id": 3073, "name": "ANSWER", "kind": 16, "kindString": "Enumeration member", @@ -4134,14 +4163,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6216, + "line": 6233, "character": 4 } ], "defaultValue": "\"ANSWER\"" }, { - "id": 3068, + "id": 3071, "name": "LIVEBOARD", "kind": 16, "kindString": "Enumeration member", @@ -4149,14 +4178,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6214, + "line": 6231, "character": 4 } ], "defaultValue": "\"LIVEBOARD\"" }, { - "id": 3071, + "id": 3074, "name": "SPOTTER", "kind": 16, "kindString": "Enumeration member", @@ -4164,14 +4193,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6217, + "line": 6234, "character": 4 } ], "defaultValue": "\"SPOTTER\"" }, { - "id": 3069, + "id": 3072, "name": "VIZ", "kind": 16, "kindString": "Enumeration member", @@ -4179,7 +4208,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6215, + "line": 6232, "character": 4 } ], @@ -4191,23 +4220,23 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3070, - 3068, + 3073, 3071, - 3069 + 3074, + 3072 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6213, + "line": 6230, "character": 12 } ] }, { - "id": 3063, + "id": 3066, "name": "CustomActionsPosition", "kind": 4, "kindString": "Enumeration", @@ -4217,7 +4246,7 @@ }, "children": [ { - "id": 3066, + "id": 3069, "name": "CONTEXTMENU", "kind": 16, "kindString": "Enumeration member", @@ -4225,14 +4254,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6207, + "line": 6224, "character": 4 } ], "defaultValue": "\"CONTEXTMENU\"" }, { - "id": 3065, + "id": 3068, "name": "MENU", "kind": 16, "kindString": "Enumeration member", @@ -4240,14 +4269,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6206, + "line": 6223, "character": 4 } ], "defaultValue": "\"MENU\"" }, { - "id": 3064, + "id": 3067, "name": "PRIMARY", "kind": 16, "kindString": "Enumeration member", @@ -4255,7 +4284,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6205, + "line": 6222, "character": 4 } ], @@ -4267,22 +4296,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3066, - 3065, - 3064 + 3069, + 3068, + 3067 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6204, + "line": 6221, "character": 12 } ] }, { - "id": 3059, + "id": 3062, "name": "DataPanelCustomColumnGroupsAccordionState", "kind": 4, "kindString": "Enumeration", @@ -4292,7 +4321,7 @@ }, "children": [ { - "id": 3061, + "id": 3064, "name": "COLLAPSE_ALL", "kind": 16, "kindString": "Enumeration member", @@ -4310,7 +4339,7 @@ "defaultValue": "\"COLLAPSE_ALL\"" }, { - "id": 3060, + "id": 3063, "name": "EXPAND_ALL", "kind": 16, "kindString": "Enumeration member", @@ -4328,7 +4357,7 @@ "defaultValue": "\"EXPAND_ALL\"" }, { - "id": 3062, + "id": 3065, "name": "EXPAND_FIRST", "kind": 16, "kindString": "Enumeration member", @@ -4351,9 +4380,9 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3061, - 3060, - 3062 + 3064, + 3063, + 3065 ] } ], @@ -4387,7 +4416,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4598, + "line": 4603, "character": 4 } ], @@ -4405,7 +4434,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4602, + "line": 4607, "character": 4 } ], @@ -4423,7 +4452,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4594, + "line": 4599, "character": 4 } ], @@ -4444,20 +4473,20 @@ "sources": [ { "fileName": "types.ts", - "line": 4590, + "line": 4595, "character": 12 } ] }, { - "id": 3076, + "id": 3079, "name": "EmbedErrorCodes", "kind": 4, "kindString": "Enumeration", "flags": {}, "comment": { - "shortText": "Specific error codes for embedded component errors.", - "text": "These codes provide granular identification of errors that occur in embedded components.\nThey are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for\nprecise error handling and debugging.\n\nThe codes are organized into categories:\n- **Worksheet ID not found or does not exist**: Errors related to applying or updating filters\n- **Liveboard ID missing**: Errors related to missing liveboard ID\n- **Conflicting actions configuration**: Errors related to conflicting actions configuration\n- **Conflicting tabs configuration**: Errors related to conflicting tabs configuration\n- **Initialization error**: Errors related to initialization error\n- **Network error**: Errors related to network error\n- **Custom action validation**: Errors related to custom action validation\n- **Login failed**: Errors related to login failed\n- **Render not called**: Errors related to render not called\n- **Host event type undefined or invalid**: Errors related to host event type undefined or invalid\n", + "shortText": "Error codes for identifying specific issues in embedded ThoughtSpot components.", + "text": "Use these codes for precise error handling and debugging. Each code maps to a\ndistinct failure scenario, enabling targeted recovery strategies.\n", "tags": [ { "tag": "version", @@ -4465,7 +4494,7 @@ }, { "tag": "group", - "text": "Error Handling" + "text": "Error Handling\n" }, { "tag": "see", @@ -4477,13 +4506,13 @@ }, { "tag": "example", - "text": "\nHandle specific error codes\n\nembed.on(EmbedEvent.Error, (error) => {\n if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {\n console.error('Worksheet ID not found:', error.message);\n }\n});\n" + "text": "\nHandle specific error codes in the error event handler\n\nembed.on(EmbedEvent.Error, (error) => {\n if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {\n console.error('Worksheet ID not found:', error.message);\n }\n});\n" } ] }, "children": [ { - "id": 3079, + "id": 3082, "name": "CONFLICTING_ACTIONS_CONFIG", "kind": 16, "kindString": "Enumeration member", @@ -4494,14 +4523,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6368, + "line": 6373, "character": 4 } ], "defaultValue": "\"CONFLICTING_ACTIONS_CONFIG\"" }, { - "id": 3080, + "id": 3083, "name": "CONFLICTING_TABS_CONFIG", "kind": 16, "kindString": "Enumeration member", @@ -4512,14 +4541,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6371, + "line": 6376, "character": 4 } ], "defaultValue": "\"CONFLICTING_TABS_CONFIG\"" }, { - "id": 3083, + "id": 3086, "name": "CUSTOM_ACTION_VALIDATION", "kind": 16, "kindString": "Enumeration member", @@ -4530,14 +4559,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6380, + "line": 6385, "character": 4 } ], "defaultValue": "\"CUSTOM_ACTION_VALIDATION\"" }, { - "id": 3086, + "id": 3089, "name": "HOST_EVENT_TYPE_UNDEFINED", "kind": 16, "kindString": "Enumeration member", @@ -4548,14 +4577,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6389, + "line": 6394, "character": 4 } ], "defaultValue": "\"HOST_EVENT_TYPE_UNDEFINED\"" }, { - "id": 3081, + "id": 3084, "name": "INIT_ERROR", "kind": 16, "kindString": "Enumeration member", @@ -4566,14 +4595,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6374, + "line": 6379, "character": 4 } ], "defaultValue": "\"INIT_ERROR\"" }, { - "id": 3078, + "id": 3081, "name": "LIVEBOARD_ID_MISSING", "kind": 16, "kindString": "Enumeration member", @@ -4584,14 +4613,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6365, + "line": 6370, "character": 4 } ], "defaultValue": "\"LIVEBOARD_ID_MISSING\"" }, { - "id": 3084, + "id": 3087, "name": "LOGIN_FAILED", "kind": 16, "kindString": "Enumeration member", @@ -4602,14 +4631,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6383, + "line": 6388, "character": 4 } ], "defaultValue": "\"LOGIN_FAILED\"" }, { - "id": 3082, + "id": 3085, "name": "NETWORK_ERROR", "kind": 16, "kindString": "Enumeration member", @@ -4620,14 +4649,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6377, + "line": 6382, "character": 4 } ], "defaultValue": "\"NETWORK_ERROR\"" }, { - "id": 3087, + "id": 3090, "name": "PARSING_API_INTERCEPT_BODY_ERROR", "kind": 16, "kindString": "Enumeration member", @@ -4638,14 +4667,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6392, + "line": 6397, "character": 4 } ], "defaultValue": "\"PARSING_API_INTERCEPT_BODY_ERROR\"" }, { - "id": 3085, + "id": 3088, "name": "RENDER_NOT_CALLED", "kind": 16, "kindString": "Enumeration member", @@ -4656,14 +4685,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6386, + "line": 6391, "character": 4 } ], "defaultValue": "\"RENDER_NOT_CALLED\"" }, { - "id": 3088, + "id": 3091, "name": "UPDATE_PARAMS_FAILED", "kind": 16, "kindString": "Enumeration member", @@ -4674,14 +4703,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6395, + "line": 6400, "character": 4 } ], "defaultValue": "\"UPDATE_PARAMS_FAILED\"" }, { - "id": 3077, + "id": 3080, "name": "WORKSHEET_ID_NOT_FOUND", "kind": 16, "kindString": "Enumeration member", @@ -4692,7 +4721,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6362, + "line": 6367, "character": 4 } ], @@ -4704,25 +4733,25 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3079, - 3080, + 3082, 3083, 3086, - 3081, - 3078, + 3089, 3084, - 3082, + 3081, 3087, 3085, + 3090, 3088, - 3077 + 3091, + 3080 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6360, + "line": 6365, "character": 12 } ] @@ -4774,7 +4803,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2409, + "line": 2422, "character": 4 } ], @@ -4802,7 +4831,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2288, + "line": 2301, "character": 4 } ], @@ -4834,7 +4863,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2052, + "line": 2065, "character": 4 } ], @@ -4862,7 +4891,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3013, + "line": 3026, "character": 4 } ], @@ -4890,7 +4919,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2619, + "line": 2632, "character": 4 } ], @@ -4922,7 +4951,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2146, + "line": 2159, "character": 4 } ], @@ -4950,7 +4979,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2587, + "line": 2600, "character": 4 } ], @@ -4978,7 +5007,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2398, + "line": 2411, "character": 4 } ], @@ -5007,7 +5036,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3179, + "line": 3192, "character": 4 } ], @@ -5047,7 +5076,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2828, + "line": 2841, "character": 4 } ], @@ -5075,7 +5104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2159, + "line": 2172, "character": 4 } ], @@ -5107,7 +5136,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1954, + "line": 1967, "character": 4 } ], @@ -5135,7 +5164,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2695, + "line": 2708, "character": 4 } ], @@ -5163,7 +5192,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2565, + "line": 2578, "character": 4 } ], @@ -5191,7 +5220,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2715, + "line": 2728, "character": 4 } ], @@ -5219,7 +5248,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2500, + "line": 2513, "character": 4 } ], @@ -5243,7 +5272,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2779, + "line": 2792, "character": 4 } ], @@ -5268,7 +5297,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2963, + "line": 2976, "character": 4 } ], @@ -5292,7 +5321,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2968, + "line": 2981, "character": 4 } ], @@ -5316,7 +5345,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2819, + "line": 2832, "character": 4 } ], @@ -5344,7 +5373,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2726, + "line": 2739, "character": 4 } ], @@ -5380,7 +5409,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2069, + "line": 2082, "character": 4 } ], @@ -5416,7 +5445,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1982, + "line": 1995, "character": 4 } ], @@ -5444,7 +5473,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3024, + "line": 3037, "character": 4 } ], @@ -5476,7 +5505,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2040, + "line": 2053, "character": 4 } ], @@ -5504,7 +5533,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2677, + "line": 2690, "character": 4 } ], @@ -5536,7 +5565,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2814, + "line": 2827, "character": 4 } ], @@ -5564,7 +5593,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2255, + "line": 2268, "character": 4 } ], @@ -5592,7 +5621,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2244, + "line": 2257, "character": 4 } ], @@ -5621,7 +5650,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2323, + "line": 2336, "character": 4 } ], @@ -5649,7 +5678,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2368, + "line": 2381, "character": 4 } ], @@ -5677,7 +5706,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2353, + "line": 2366, "character": 4 } ], @@ -5705,7 +5734,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2338, + "line": 2351, "character": 4 } ], @@ -5733,7 +5762,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2383, + "line": 2396, "character": 4 } ], @@ -5761,7 +5790,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2489, + "line": 2502, "character": 4 } ], @@ -5789,7 +5818,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2477, + "line": 2490, "character": 4 } ], @@ -5833,7 +5862,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2028, + "line": 2041, "character": 4 } ], @@ -5861,7 +5890,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2641, + "line": 2654, "character": 4 } ], @@ -5889,7 +5918,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2523, + "line": 2536, "character": 4 } ], @@ -5903,7 +5932,7 @@ "flags": {}, "comment": { "shortText": "An error has occurred. This event is fired for the following error types:", - "text": "`API` - API call failure error.\n`FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen\nmode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value\nfilter. `NON_EXIST_FILTER` - Error due to a non-existent filter.\n`INVALID_DATE_VALUE` - Invalid date value error.\n`INVALID_OPERATOR` - Use of invalid operator during filter application.\n\nFor more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType", + "text": "`API` - API call failure.\n`FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen\nmode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value\nfilter. `NON_EXIST_FILTER` - Error due to a non-existent filter.\n`INVALID_DATE_VALUE` - Invalid date value error.\n`INVALID_OPERATOR` - Use of invalid operator during filter application.\n\nFor more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType", "tags": [ { "tag": "returns", @@ -5926,7 +5955,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2136, + "line": 2149, "character": 4 } ], @@ -5954,7 +5983,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2705, + "line": 2718, "character": 4 } ], @@ -5982,7 +6011,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2539, + "line": 2552, "character": 4 } ], @@ -6006,7 +6035,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2756, + "line": 2769, "character": 4 } ], @@ -6034,7 +6063,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2201, + "line": 2214, "character": 4 } ], @@ -6062,7 +6091,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1942, + "line": 1955, "character": 4 } ], @@ -6090,7 +6119,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3057, + "line": 3070, "character": 4 } ], @@ -6118,7 +6147,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3046, + "line": 3059, "character": 4 } ], @@ -6146,7 +6175,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2608, + "line": 2621, "character": 4 } ], @@ -6178,7 +6207,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2277, + "line": 2290, "character": 4 } ], @@ -6210,7 +6239,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1968, + "line": 1981, "character": 4 } ], @@ -6238,7 +6267,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2652, + "line": 2665, "character": 4 } ], @@ -6266,7 +6295,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2227, + "line": 2240, "character": 4 } ], @@ -6279,16 +6308,13 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "This event can be emitted to intercept search execution initiated by\nthe users and implement the logic to allow or restrict search execution.\nYou can can also show custom error text if the search query must be\nrestricted due to your application or business requirements.", + "shortText": "This event can be emitted to intercept search execution initiated by\nusers and implement logic to allow or restrict search execution.\nYou can also show custom error text if the search query must be\nrestricted due to your application or business requirements.", "text": "Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`\nfor this embed event to get emitted.", "tags": [ { - "tag": "param:payload", - "text": "The payload received from the embed related to the Data API call." - }, - { - "tag": "param:responder", - "text": "\nContains elements that lets developers define whether ThoughtSpot\nshould run the search, and if not, what error message\nshould be shown to the user.\n\n`execute` - When execute returns `true`, the search will be run.\nWhen execute returns `false`, the search will not be executed.\n\n`error` - Developers can customize the error message text when `execute`\nis `false` using the `errorText` and `errorDescription` parameters in responder.\n\n`errorText` - The error message text to be shown to the user.\n`errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user." + "tag": "param", + "text": "Includes the following event listener parameters:\n- `payload`: The payload received from the embed related to the Data API call.\n- `responder`: Contains elements that let developers define whether ThoughtSpot\n should run the search, and if not, what error message\n should be shown to the user.\n\n`execute` - When `execute` returns `true`, the search will be run.\nWhen `execute` returns `false`, the search will not be executed.\n\n`error` - Developers can customize the error message text when `execute`\nis `false` using the `errorText` and `errorDescription` parameters in responder.\n\n`errorText` - The error message text to be shown to the user.\n`errorDescription (ThoughtSpot: 10.15.0.cl and above)` - The error description to be shown to the user.", + "param": "-" }, { "tag": "version", @@ -6303,7 +6329,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2896, + "line": 2909, "character": 4 } ], @@ -6331,7 +6357,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3113, + "line": 3126, "character": 4 } ], @@ -6355,7 +6381,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2907, + "line": 2920, "character": 4 } ], @@ -6383,7 +6409,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2429, + "line": 2442, "character": 4 } ], @@ -6415,7 +6441,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2667, + "line": 2680, "character": 4 } ], @@ -6443,7 +6469,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3002, + "line": 3015, "character": 4 } ], @@ -6471,7 +6497,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1991, + "line": 2004, "character": 4 } ], @@ -6495,7 +6521,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2833, + "line": 2846, "character": 4 } ], @@ -6535,7 +6561,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2807, + "line": 2820, "character": 4 } ], @@ -6563,7 +6589,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3068, + "line": 3081, "character": 4 } ], @@ -6591,7 +6617,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2211, + "line": 2224, "character": 4 } ], @@ -6615,7 +6641,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2762, + "line": 2775, "character": 4 } ], @@ -6639,7 +6665,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2769, + "line": 2782, "character": 4 } ], @@ -6667,7 +6693,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2307, + "line": 2320, "character": 4 } ], @@ -6695,7 +6721,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2550, + "line": 2563, "character": 4 } ], @@ -6735,7 +6761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2798, + "line": 2811, "character": 4 } ], @@ -6763,7 +6789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2630, + "line": 2643, "character": 4 } ], @@ -6791,7 +6817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2686, + "line": 2699, "character": 4 } ], @@ -6819,7 +6845,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2465, + "line": 2478, "character": 4 } ], @@ -6847,7 +6873,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2576, + "line": 2589, "character": 4 } ], @@ -6875,7 +6901,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2447, + "line": 2460, "character": 4 } ], @@ -6903,7 +6929,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2991, + "line": 3004, "character": 4 } ], @@ -6931,7 +6957,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3079, + "line": 3092, "character": 4 } ], @@ -6959,7 +6985,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3090, + "line": 3103, "character": 4 } ], @@ -6987,7 +7013,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3035, + "line": 3048, "character": 4 } ], @@ -7016,7 +7042,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2950, + "line": 2963, "character": 4 } ], @@ -7040,7 +7066,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2774, + "line": 2787, "character": 4 } ], @@ -7080,7 +7106,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2789, + "line": 2802, "character": 4 } ], @@ -7108,7 +7134,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2511, + "line": 2524, "character": 4 } ], @@ -7144,7 +7170,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2100, + "line": 2113, "character": 4 } ], @@ -7176,7 +7202,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2081, + "line": 2094, "character": 4 } ], @@ -7204,7 +7230,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2737, + "line": 2750, "character": 4 } ], @@ -7306,13 +7332,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1929, + "line": 1942, "character": 12 } ] }, { - "id": 3089, + "id": 3092, "name": "ErrorDetailsTypes", "kind": 4, "kindString": "Enumeration", @@ -7341,7 +7367,7 @@ }, "children": [ { - "id": 3090, + "id": 3093, "name": "API", "kind": 16, "kindString": "Enumeration member", @@ -7352,14 +7378,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6320, + "line": 6337, "character": 4 } ], "defaultValue": "\"API\"" }, { - "id": 3092, + "id": 3095, "name": "NETWORK", "kind": 16, "kindString": "Enumeration member", @@ -7370,14 +7396,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6324, + "line": 6341, "character": 4 } ], "defaultValue": "\"NETWORK\"" }, { - "id": 3091, + "id": 3094, "name": "VALIDATION_ERROR", "kind": 16, "kindString": "Enumeration member", @@ -7388,7 +7414,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6322, + "line": 6339, "character": 4 } ], @@ -7400,22 +7426,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3090, - 3092, - 3091 + 3093, + 3095, + 3094 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6318, + "line": 6335, "character": 12 } ] }, { - "id": 2765, + "id": 2766, "name": "HomeLeftNavItem", "kind": 4, "kindString": "Enumeration", @@ -7425,7 +7451,7 @@ }, "children": [ { - "id": 2769, + "id": 2770, "name": "Answers", "kind": 16, "kindString": "Enumeration member", @@ -7449,7 +7475,7 @@ "defaultValue": "\"answers\"" }, { - "id": 2773, + "id": 2774, "name": "Create", "kind": 16, "kindString": "Enumeration member", @@ -7473,7 +7499,7 @@ "defaultValue": "\"create\"" }, { - "id": 2775, + "id": 2776, "name": "Favorites", "kind": 16, "kindString": "Enumeration member", @@ -7497,7 +7523,7 @@ "defaultValue": "\"favorites\"" }, { - "id": 2767, + "id": 2768, "name": "Home", "kind": 16, "kindString": "Enumeration member", @@ -7521,7 +7547,7 @@ "defaultValue": "\"insights-home\"" }, { - "id": 2772, + "id": 2773, "name": "LiveboardSchedules", "kind": 16, "kindString": "Enumeration member", @@ -7545,7 +7571,7 @@ "defaultValue": "\"liveboard-schedules\"" }, { - "id": 2768, + "id": 2769, "name": "Liveboards", "kind": 16, "kindString": "Enumeration member", @@ -7569,7 +7595,7 @@ "defaultValue": "\"liveboards\"" }, { - "id": 2770, + "id": 2771, "name": "MonitorSubscription", "kind": 16, "kindString": "Enumeration member", @@ -7593,7 +7619,7 @@ "defaultValue": "\"monitor-alerts\"" }, { - "id": 2766, + "id": 2767, "name": "SearchData", "kind": 16, "kindString": "Enumeration member", @@ -7617,7 +7643,7 @@ "defaultValue": "\"search-data\"" }, { - "id": 2771, + "id": 2772, "name": "SpotIQAnalysis", "kind": 16, "kindString": "Enumeration member", @@ -7641,7 +7667,7 @@ "defaultValue": "\"spotiq-analysis\"" }, { - "id": 2774, + "id": 2775, "name": "Spotter", "kind": 16, "kindString": "Enumeration member", @@ -7670,16 +7696,16 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2769, + 2770, + 2774, + 2776, + 2768, 2773, - 2775, + 2769, + 2771, 2767, 2772, - 2768, - 2770, - 2766, - 2771, - 2774 + 2775 ] } ], @@ -7692,7 +7718,7 @@ ] }, { - "id": 3016, + "id": 3017, "name": "HomePage", "kind": 4, "kindString": "Enumeration", @@ -7708,7 +7734,7 @@ }, "children": [ { - "id": 3017, + "id": 3018, "name": "Modular", "kind": 16, "kindString": "Enumeration member", @@ -7726,7 +7752,7 @@ "defaultValue": "\"v2\"" }, { - "id": 3018, + "id": 3019, "name": "ModularWithStylingChanges", "kind": 16, "kindString": "Enumeration member", @@ -7749,8 +7775,8 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3017, - 3018 + 3018, + 3019 ] } ], @@ -7763,14 +7789,14 @@ ] }, { - "id": 3010, + "id": 3011, "name": "HomePageSearchBarMode", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 3012, + "id": 3013, "name": "AI_ANSWER", "kind": 16, "kindString": "Enumeration member", @@ -7785,7 +7811,7 @@ "defaultValue": "\"aiAnswer\"" }, { - "id": 3013, + "id": 3014, "name": "NONE", "kind": 16, "kindString": "Enumeration member", @@ -7800,7 +7826,7 @@ "defaultValue": "\"none\"" }, { - "id": 3011, + "id": 3012, "name": "OBJECT_SEARCH", "kind": 16, "kindString": "Enumeration member", @@ -7820,9 +7846,9 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3012, 3013, - 3011 + 3014, + 3012 ] } ], @@ -7835,7 +7861,7 @@ ] }, { - "id": 2776, + "id": 2777, "name": "HomepageModule", "kind": 4, "kindString": "Enumeration", @@ -7852,7 +7878,7 @@ }, "children": [ { - "id": 2779, + "id": 2780, "name": "Favorite", "kind": 16, "kindString": "Enumeration member", @@ -7863,14 +7889,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1810, + "line": 1815, "character": 4 } ], "defaultValue": "\"FAVORITE\"" }, { - "id": 2782, + "id": 2783, "name": "Learning", "kind": 16, "kindString": "Enumeration member", @@ -7881,14 +7907,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1822, + "line": 1827, "character": 4 } ], "defaultValue": "\"LEARNING\"" }, { - "id": 2780, + "id": 2781, "name": "MyLibrary", "kind": 16, "kindString": "Enumeration member", @@ -7899,14 +7925,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1814, + "line": 1819, "character": 4 } ], "defaultValue": "\"MY_LIBRARY\"" }, { - "id": 2777, + "id": 2778, "name": "Search", "kind": 16, "kindString": "Enumeration member", @@ -7917,14 +7943,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1802, + "line": 1807, "character": 4 } ], "defaultValue": "\"SEARCH\"" }, { - "id": 2781, + "id": 2782, "name": "Trending", "kind": 16, "kindString": "Enumeration member", @@ -7935,14 +7961,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1818, + "line": 1823, "character": 4 } ], "defaultValue": "\"TRENDING\"" }, { - "id": 2778, + "id": 2779, "name": "Watchlist", "kind": 16, "kindString": "Enumeration member", @@ -7953,7 +7979,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1806, + "line": 1811, "character": 4 } ], @@ -7965,19 +7991,19 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2779, - 2782, 2780, - 2777, + 2783, 2781, - 2778 + 2778, + 2782, + 2779 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1798, + "line": 1803, "character": 12 } ] @@ -8033,7 +8059,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3625, + "line": 3630, "character": 4 } ], @@ -8066,7 +8092,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3430, + "line": 3440, "character": 4 } ], @@ -8099,7 +8125,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4460, + "line": 4464, "character": 4 } ], @@ -8132,7 +8158,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4502, + "line": 4506, "character": 4 } ], @@ -8160,7 +8186,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4275, + "line": 4280, "character": 4 } ], @@ -8193,7 +8219,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4540, + "line": 4544, "character": 4 } ], @@ -8226,7 +8252,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3761, + "line": 3766, "character": 4 } ], @@ -8263,7 +8289,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3699, + "line": 3704, "character": 4 } ], @@ -8291,7 +8317,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4469, + "line": 4473, "character": 4 } ], @@ -8324,7 +8350,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3845, + "line": 3850, "character": 4 } ], @@ -8352,7 +8378,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4487, + "line": 4491, "character": 4 } ], @@ -8365,7 +8391,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Triggered when the embed is needed to be destroyed. This is used to clean up any embed related resources internally.", + "shortText": "Triggered when the embed needs to be destroyed. This is used to clean up any embed-related resources internally.", "tags": [ { "tag": "example", @@ -8380,7 +8406,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4560, + "line": 4564, "character": 4 } ], @@ -8417,7 +8443,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3891, + "line": 3896, "character": 4 } ], @@ -8450,7 +8476,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3942, + "line": 3947, "character": 4 } ], @@ -8487,7 +8513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3615, + "line": 3620, "character": 4 } ], @@ -8515,7 +8541,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3915, + "line": 3920, "character": 4 } ], @@ -8548,7 +8574,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3969, + "line": 3974, "character": 4 } ], @@ -8565,27 +8591,7 @@ "tags": [ { "tag": "param", - "text": "points - an object containing selectedPoints/clickedPoints\nto drill to. For example, { selectedPoints: []}", - "param": "-" - }, - { - "tag": "param", - "text": "columnGuid - Optional. GUID of the column to drill\nby. If not provided it will auto drill by the configured\n column.", - "param": "-" - }, - { - "tag": "param", - "text": "autoDrillDown - Optional. If true, the drill down will be\ndone automatically on the most popular column.", - "param": "-" - }, - { - "tag": "param", - "text": "vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill\nin case of a Liveboard.", - "param": "-" - }, - { - "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.", + "text": "Includes the following keys:\n- `points`: An object containing `selectedPoints` and/or `clickedPoint`\n to drill to. For example, `{ selectedPoints: [] }`.\n- `columnGuid`: Optional. GUID of the column to drill by. If not provided,\n it will auto drill by the configured column.\n- `autoDrillDown`: Optional. If `true`, the drill down will be done automatically\n on the most popular column.\n- `vizId` (TS >= 9.8.0): Optional. The GUID of the visualization to drill in case\n of a Liveboard. In Spotter embed, `vizId` refers to the Answer ID and is **required**.", "param": "-" }, { @@ -8605,7 +8611,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3307, + "line": 3319, "character": 4 } ], @@ -8623,12 +8629,7 @@ "tags": [ { "tag": "param", - "text": "object - To trigger the action for a specific visualization\nin Liveboard embed, pass in `vizId` as a key.", - "param": "-" - }, - { - "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.\n", + "text": "Object parameter. Includes the following keys:\n- `vizId`: To trigger the action for a specific visualization in Liveboard embed,\n pass in `vizId` as a key. In Spotter embed, `vizId` refers to the Answer ID and is **required**.\n", "param": "-" }, { @@ -8648,7 +8649,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3744, + "line": 3749, "character": 4 } ], @@ -8681,7 +8682,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4440, + "line": 4444, "character": 4 } ], @@ -8709,7 +8710,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3579, + "line": 3584, "character": 4 } ], @@ -8742,7 +8743,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3682, + "line": 3687, "character": 4 } ], @@ -8770,7 +8771,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3569, + "line": 3574, "character": 4 } ], @@ -8803,7 +8804,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4265, + "line": 4270, "character": 4 } ], @@ -8831,7 +8832,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4092, + "line": 4097, "character": 4 } ], @@ -8859,7 +8860,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3327, + "line": 3339, "character": 4 } ], @@ -8887,7 +8888,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4582, + "line": 4587, "character": 4 } ], @@ -8916,7 +8917,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4340, + "line": 4344, "character": 4 } ], @@ -8948,7 +8949,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3809, + "line": 3814, "character": 4 } ], @@ -8976,7 +8977,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4195, + "line": 4199, "character": 4 } ], @@ -9004,7 +9005,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3541, + "line": 3546, "character": 4 } ], @@ -9048,7 +9049,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3658, + "line": 3663, "character": 4 } ], @@ -9089,7 +9090,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3720, + "line": 3725, "character": 4 } ], @@ -9122,7 +9123,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4069, + "line": 4074, "character": 4 } ], @@ -9139,7 +9140,7 @@ "tags": [ { "tag": "param", - "text": "`path` - the path to navigate to to go forward or back. The path value can\nbe a number; for example, `1`, `-1`.", + "text": "`path` - the path to navigate to go forward or back. The path value can\nbe a number; for example, `1`, `-1`.", "param": "-" }, { @@ -9155,7 +9156,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3400, + "line": 3410, "character": 4 } ], @@ -9192,7 +9193,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3420, + "line": 3430, "character": 4 } ], @@ -9205,31 +9206,12 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Trigger **Pin** action on an embedded object.\nIf no parameters are defined, the pin action is triggered\nfor the Answer that the user is currently on\nand a modal opens for Liveboard selection.\nTo add an Answer or visualization to a Liveboard programmatically without\nshowing requiring additional user input via *Pin to Liveboard* modal, define\nthe following parameters:", + "shortText": "Trigger **Pin** action on an embedded object.\nIf no parameters are defined, the pin action is triggered\nfor the Answer that the user is currently on\nand a modal opens for Liveboard selection.\nTo add an Answer or visualization to a Liveboard programmatically without\nrequiring additional user input via the *Pin to Liveboard* modal, define\nthe following parameters:", "tags": [ { "tag": "param", - "text": "\n`vizId`- GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.\n Optional when pinning a new chart or table generated from a Search query.\n **Required** in Spotter Embed." - }, - { - "tag": "param", - "text": "\n`liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,\n specify the `newLiveboardName` parameter to create a new Liveboard." - }, - { - "tag": "param", - "text": "\n`tabId` - GUID of the Liveboard tab. Adds the Answer to the Liveboard tab\n specified in the code." - }, - { - "tag": "param", - "text": "\n`newVizName` - Name string for the Answer or visualization. If defined,\n this parameter adds a new visualization object or creates a copy of the\n Answer or visualization specified in `vizId`.\n Required attribute." - }, - { - "tag": "param", - "text": "\n`newLiveboardName` - Name string for the Liveboard.\n Creates a new Liveboard object with the specified name." - }, - { - "tag": "param", - "text": "\n`newTabName` - Name of the tab. Adds a new tab Liveboard specified\n in the code.\n" + "text": "Includes the following keys:\n- `vizId`: GUID of the saved Answer or Spotter visualization ID to pin to a Liveboard.\n Optional when pinning a new chart or table generated from a Search query.\n **Required** in Spotter Embed.\n- `liveboardId`: GUID of the Liveboard to pin an Answer. If there is no Liveboard,\n specify the `newLiveboardName` parameter to create a new Liveboard.\n- `tabId`: GUID of the Liveboard tab. Adds the Answer to the Liveboard tab\n specified in the code.\n- `newVizName`: Name string for the Answer or visualization. If defined,\n this parameter adds a new visualization object or creates a copy of the\n Answer or visualization specified in `vizId`.\n Required.\n- `newLiveboardName`: Name string for the Liveboard.\n Creates a new Liveboard object with the specified name.\n- `newTabName`: Name of the tab. Adds a new tab Liveboard specified\n in the code.\n", + "param": "-" }, { "tag": "example", @@ -9260,7 +9242,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3531, + "line": 3536, "character": 4 } ], @@ -9293,7 +9275,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3778, + "line": 3783, "character": 4 } ], @@ -9321,7 +9303,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4449, + "line": 4453, "character": 4 } ], @@ -9353,7 +9335,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3672, + "line": 3677, "character": 4 } ], @@ -9386,7 +9368,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3440, + "line": 3450, "character": 4 } ], @@ -9414,7 +9396,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4300, + "line": 4305, "character": 4 } ], @@ -9442,7 +9424,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4081, + "line": 4086, "character": 4 } ], @@ -9470,7 +9452,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4478, + "line": 4482, "character": 4 } ], @@ -9503,7 +9485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4022, + "line": 4027, "character": 4 } ], @@ -9520,17 +9502,7 @@ "tags": [ { "tag": "param", - "text": "`vizId` refers to the Answer ID in Spotter embed\nand is required in Spotter embed.\nOptional attributes to set Answer properties include:", - "param": "-" - }, - { - "tag": "param", - "text": "`name` - Name string for the Answer.", - "param": "-" - }, - { - "tag": "param", - "text": "`description` - Description text for the Answer.", + "text": "Includes the following keys:\n- `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter embed.\n- `name`: Optional. Name string for the Answer.\n- `description`: Optional. Description text for the Answer.", "param": "-" }, { @@ -9550,7 +9522,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4390, + "line": 4393, "character": 4 } ], @@ -9578,7 +9550,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3550, + "line": 3555, "character": 4 } ], @@ -9606,7 +9578,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3559, + "line": 3564, "character": 4 } ], @@ -9623,29 +9595,19 @@ "tags": [ { "tag": "param", - "text": "`searchQuery` - query string with search tokens", - "param": "-" - }, - { - "tag": "param", - "text": "`dataSources` - Data source GUID to Search on\n - Although an array, only a single source\n is supported.", - "param": "-" - }, - { - "tag": "param", - "text": "`execute` - executes search and updates the existing query", + "text": "Includes the following keys:\n- `searchQuery`: Query string with search tokens.\n- `dataSources`: Data source GUID to search on.\n Although an array, only a single source is supported.\n- `execute`: Executes search and updates the existing query.", "param": "-" }, { "tag": "example", - "text": "\n```js\nsearchembed.trigger(HostEvent.Search, {\nsearchQuery: \"[sales] by [item type]\",\ndataSources: [\"cd252e5c-b552-49a8-821d-3eadaa049cca\"],\nexecute: true\n});\n```\n" + "text": "\n```js\nsearchEmbed.trigger(HostEvent.Search, {\nsearchQuery: \"[sales] by [item type]\",\ndataSources: [\"cd252e5c-b552-49a8-821d-3eadaa049cca\"],\nexecute: true\n});\n```\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 3256, + "line": 3269, "character": 4 } ], @@ -9678,7 +9640,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3352, + "line": 3364, "character": 4 } ], @@ -9711,7 +9673,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4221, + "line": 4225, "character": 4 } ], @@ -9744,7 +9706,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4208, + "line": 4212, "character": 4 } ], @@ -9777,7 +9739,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3340, + "line": 3352, "character": 4 } ], @@ -9805,7 +9767,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3982, + "line": 3987, "character": 4 } ], @@ -9838,7 +9800,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3828, + "line": 3833, "character": 4 } ], @@ -9871,7 +9833,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3865, + "line": 3870, "character": 4 } ], @@ -9888,12 +9850,7 @@ "tags": [ { "tag": "param", - "text": "`query`: Text string in Natural Language format", - "param": "-" - }, - { - "tag": "param", - "text": "`executeSearch`: Boolean to execute search and update search query", + "text": "Includes the following keys:\n- `query`: Text string in Natural Language format.\n- `executeSearch`: Boolean to execute search and update search query.", "param": "-" }, { @@ -9909,7 +9866,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4430, + "line": 4434, "character": 4 } ], @@ -9922,18 +9879,23 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Triggers a create new conversation operation in spotter embed.", + "shortText": "Triggers a new conversation in Spotter embed.", + "text": "This feature is available only when chat history is enabled on your ThoughtSpot instance.\nContact your admin or ThoughtSpot Support to enable chat history on your instance.\n", "tags": [ { "tag": "example", - "text": "\n```js\nThis feature is available only when chat history is enabled on your ThoughtSpot instance.\nContact your admin or ThoughtSpot Support to enable chat history on your instance.\n@example\n```js\nspotterEmbed.trigger(HostEvent.StartNewSpotterConversation);\n```\n@version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl\n" + "text": "\n```js\nspotterEmbed.trigger(HostEvent.StartNewSpotterConversation);\n```" + }, + { + "tag": "version", + "text": "SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 4572, + "line": 4577, "character": 4 } ], @@ -9966,7 +9928,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4053, + "line": 4058, "character": 4 } ], @@ -9999,7 +9961,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4037, + "line": 4042, "character": 4 } ], @@ -10032,7 +9994,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4415, + "line": 4418, "character": 4 } ], @@ -10060,7 +10022,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4291, + "line": 4296, "character": 4 } ], @@ -10077,12 +10039,7 @@ "tags": [ { "tag": "param", - "text": "`filter`: a single filter object containing column name,\nfilter operator, and values.", - "param": "-" - }, - { - "tag": "param", - "text": "`filters`: multiple filter objects with column name, filter operator,\nand values for each.\n\nEach filter object must include the following attributes:\n\n`column` - Name of the column to filter on.\n\n`oper` - Filter operator, for example, EQ, IN, CONTAINS.\n For information about the supported filter operators,\n see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].\n\n`values` - An array of one or several values. The value definition on the\n data type you choose to filter on. For a complete list of supported data types,\n see\n link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported\n data types].\n\n`type` - To update filters for date time, specify the date format type.\nFor more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].", + "text": "Includes the following keys:\n- `filter`: A single filter object containing column name, filter operator, and values.\n- `filters`: Multiple filter objects with column name, filter operator, and values for each.\n\nEach filter object must include the following attributes:\n\n`column` - Name of the column to filter on.\n\n`oper` - Filter operator, for example, EQ, IN, CONTAINS.\n For information about the supported filter operators,\n see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].\n\n`values` - An array of one or several values. The value definition on the\n data type you choose to filter on. For a complete list of supported data types,\n see\n link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported\n data types].\n\n`type` - To update filters for date time, specify the date format type.\nFor more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].", "param": "-" }, { @@ -10110,7 +10067,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4182, + "line": 4186, "character": 4 } ], @@ -10127,12 +10084,7 @@ "tags": [ { "tag": "param", - "text": "`name` - Name of the Parameter", - "param": "-" - }, - { - "tag": "param", - "text": "`value` - The value to set for the Parameter.\n\nOptionally, to control the visibility of the Parameter chip,\nuse the `isVisibleToUser` attribute when applying an override.\n", + "text": "Includes the following keys for each item:\n- `name`: Name of the parameter.\n- `value`: The value to set for the parameter.\n- `isVisibleToUser`: Optional. To control the visibility of the parameter chip.\n", "param": "-" }, { @@ -10148,7 +10100,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4320, + "line": 4324, "character": 4 } ], @@ -10172,7 +10124,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4348, + "line": 4352, "character": 4 } ], @@ -10190,7 +10142,7 @@ "tags": [ { "tag": "param", - "text": "Pass an array of {@link RuntimeFilter} with the following attributes:\n`columnName` - _String_. The name of the column to filter on.\n\n`operator` - {@link RuntimeFilterOp} to apply. For more information,\nsee link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].\n\n`values` - List of operands. Some operators such as EQ and LE allow a\nsingle value, whereas BW and IN accept multiple values.\n\n**Note**: Updating runtime filters resets the ThoughtSpot\nobject to its original state and applies new filter conditions.\nAny user changes (like drilling into a visualization)\nwill be cleared, restoring the original visualization\nwith the updated filters.\n\n", + "text": "Array of {@link RuntimeFilter} objects. Each item includes:\n- `columnName`: Name of the column to filter on.\n- `operator`: {@link RuntimeFilterOp} to apply. For more information, see\n link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].\n- `values`: List of operands. Some operators such as EQ and LE allow a single\n value, whereas BW and IN accept multiple values.\n\n**Note**: Updating runtime filters resets the ThoughtSpot\nobject to its original state and applies new filter conditions.\nAny user changes (like drilling into a visualization)\nwill be cleared, restoring the original visualization\nwith the updated filters.\n\n", "param": "-" }, { @@ -10210,7 +10162,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3388, + "line": 3398, "character": 4 } ], @@ -10227,12 +10179,7 @@ "tags": [ { "tag": "param", - "text": "`queryString`: Text string in Natural Language format", - "param": "-" - }, - { - "tag": "param", - "text": "`executeSearch`: Boolean to execute search and update search query", + "text": "Includes the following keys:\n- `queryString`: Text string in Natural Language format.\n- `executeSearch`: Boolean to execute search and update search query.", "param": "-" }, { @@ -10248,7 +10195,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4235, + "line": 4240, "character": 4 } ], @@ -10276,7 +10223,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3588, + "line": 3593, "character": 4 } ], @@ -10304,7 +10251,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3456, + "line": 3466, "character": 4 } ], @@ -10391,13 +10338,13 @@ "sources": [ { "fileName": "types.ts", - "line": 3236, + "line": 3249, "character": 12 } ] }, { - "id": 3072, + "id": 3075, "name": "InterceptedApiType", "kind": 4, "kindString": "Enumeration", @@ -10407,7 +10354,7 @@ }, "children": [ { - "id": 3074, + "id": 3077, "name": "ALL", "kind": 16, "kindString": "Enumeration member", @@ -10418,14 +10365,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6504, + "line": 6509, "character": 4 } ], "defaultValue": "\"ALL\"" }, { - "id": 3073, + "id": 3076, "name": "AnswerData", "kind": 16, "kindString": "Enumeration member", @@ -10436,14 +10383,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6500, + "line": 6505, "character": 4 } ], "defaultValue": "\"AnswerData\"" }, { - "id": 3075, + "id": 3078, "name": "LiveboardData", "kind": 16, "kindString": "Enumeration member", @@ -10454,7 +10401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6508, + "line": 6513, "character": 4 } ], @@ -10466,22 +10413,22 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3074, - 3073, - 3075 + 3077, + 3076, + 3078 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6496, + "line": 6501, "character": 12 } ] }, { - "id": 3019, + "id": 3020, "name": "ListPage", "kind": 4, "kindString": "Enumeration", @@ -10497,7 +10444,7 @@ }, "children": [ { - "id": 3020, + "id": 3021, "name": "List", "kind": 16, "kindString": "Enumeration member", @@ -10515,7 +10462,7 @@ "defaultValue": "\"v2\"" }, { - "id": 3021, + "id": 3022, "name": "ListWithUXChanges", "kind": 16, "kindString": "Enumeration member", @@ -10538,8 +10485,8 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3020, - 3021 + 3021, + 3022 ] } ], @@ -10552,7 +10499,7 @@ ] }, { - "id": 3053, + "id": 3054, "name": "ListPageColumns", "kind": 4, "kindString": "Enumeration", @@ -10568,7 +10515,7 @@ }, "children": [ { - "id": 3056, + "id": 3058, "name": "Author", "kind": 16, "kindString": "Enumeration member", @@ -10579,14 +10526,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1843, + "line": 1852, "character": 4 } ], "defaultValue": "\"AUTHOR\"" }, { - "id": 3057, + "id": 3059, "name": "DateSort", "kind": 16, "kindString": "Enumeration member", @@ -10597,32 +10544,55 @@ "sources": [ { "fileName": "types.ts", - "line": 1847, + "line": 1856, "character": 4 } ], "defaultValue": "\"DATE_SORT\"" }, { - "id": 3054, + "id": 3055, + "name": "Favorites", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Favorites" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1840, + "character": 4 + } + ], + "defaultValue": "\"FAVOURITE\"" + }, + { + "id": 3056, "name": "Favourite", "kind": 16, "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Favourite" + "tags": [ + { + "tag": "deprecated", + "text": "Use {@link ListPageColumns.Favorites} instead.\n" + } + ] }, "sources": [ { "fileName": "types.ts", - "line": 1835, + "line": 1844, "character": 4 } ], "defaultValue": "\"FAVOURITE\"" }, { - "id": 3058, + "id": 3060, "name": "Share", "kind": 16, "kindString": "Enumeration member", @@ -10633,14 +10603,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1851, + "line": 1860, "character": 4 } ], "defaultValue": "\"SHARE\"" }, { - "id": 3055, + "id": 3057, "name": "Tags", "kind": 16, "kindString": "Enumeration member", @@ -10651,11 +10621,29 @@ "sources": [ { "fileName": "types.ts", - "line": 1839, + "line": 1848, "character": 4 } ], "defaultValue": "\"TAGS\"" + }, + { + "id": 3061, + "name": "Verified", + "kind": 16, + "kindString": "Enumeration member", + "flags": {}, + "comment": { + "shortText": "Verified badge/column" + }, + "sources": [ + { + "fileName": "types.ts", + "line": 1864, + "character": 4 + } + ], + "defaultValue": "\"VERIFIED\"" } ], "groups": [ @@ -10663,24 +10651,26 @@ "title": "Enumeration members", "kind": 16, "children": [ + 3058, + 3059, + 3055, 3056, + 3060, 3057, - 3054, - 3058, - 3055 + 3061 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1831, + "line": 1836, "character": 12 } ] }, { - "id": 2987, + "id": 2988, "name": "LogLevel", "kind": 4, "kindString": "Enumeration", @@ -10690,7 +10680,7 @@ }, "children": [ { - "id": 2992, + "id": 2993, "name": "DEBUG", "kind": 16, "kindString": "Enumeration member", @@ -10711,14 +10701,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6291, + "line": 6308, "character": 4 } ], "defaultValue": "\"DEBUG\"" }, { - "id": 2989, + "id": 2990, "name": "ERROR", "kind": 16, "kindString": "Enumeration member", @@ -10739,14 +10729,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6252, + "line": 6269, "character": 4 } ], "defaultValue": "\"ERROR\"" }, { - "id": 2991, + "id": 2992, "name": "INFO", "kind": 16, "kindString": "Enumeration member", @@ -10767,14 +10757,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6277, + "line": 6294, "character": 4 } ], "defaultValue": "\"INFO\"" }, { - "id": 2988, + "id": 2989, "name": "SILENT", "kind": 16, "kindString": "Enumeration member", @@ -10795,14 +10785,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6240, + "line": 6257, "character": 4 } ], "defaultValue": "\"SILENT\"" }, { - "id": 2993, + "id": 2994, "name": "TRACE", "kind": 16, "kindString": "Enumeration member", @@ -10823,14 +10813,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6303, + "line": 6320, "character": 4 } ], "defaultValue": "\"TRACE\"" }, { - "id": 2990, + "id": 2991, "name": "WARN", "kind": 16, "kindString": "Enumeration member", @@ -10851,7 +10841,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6264, + "line": 6281, "character": 4 } ], @@ -10863,19 +10853,19 @@ "title": "Enumeration members", "kind": 16, "children": [ + 2993, + 2990, 2992, 2989, - 2991, - 2988, - 2993, - 2990 + 2994, + 2991 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6227, + "line": 6244, "character": 12 } ] @@ -11041,14 +11031,14 @@ ] }, { - "id": 2754, + "id": 2755, "name": "PrefetchFeatures", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 2755, + "id": 2756, "name": "FullApp", "kind": 16, "kindString": "Enumeration member", @@ -11056,14 +11046,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6118, + "line": 6135, "character": 4 } ], "defaultValue": "\"FullApp\"" }, { - "id": 2757, + "id": 2758, "name": "LiveboardEmbed", "kind": 16, "kindString": "Enumeration member", @@ -11071,14 +11061,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6120, + "line": 6137, "character": 4 } ], "defaultValue": "\"LiveboardEmbed\"" }, { - "id": 2756, + "id": 2757, "name": "SearchEmbed", "kind": 16, "kindString": "Enumeration member", @@ -11086,14 +11076,14 @@ "sources": [ { "fileName": "types.ts", - "line": 6119, + "line": 6136, "character": 4 } ], "defaultValue": "\"SearchEmbed\"" }, { - "id": 2758, + "id": 2759, "name": "VizEmbed", "kind": 16, "kindString": "Enumeration member", @@ -11101,7 +11091,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6121, + "line": 6138, "character": 4 } ], @@ -11113,23 +11103,23 @@ "title": "Enumeration members", "kind": 16, "children": [ - 2755, - 2757, 2756, - 2758 + 2758, + 2757, + 2759 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6117, + "line": 6134, "character": 12 } ] }, { - "id": 3014, + "id": 3015, "name": "PrimaryNavbarVersion", "kind": 4, "kindString": "Enumeration", @@ -11145,7 +11135,7 @@ }, "children": [ { - "id": 3015, + "id": 3016, "name": "Sliding", "kind": 16, "kindString": "Enumeration member", @@ -11168,7 +11158,7 @@ "title": "Enumeration members", "kind": 16, "children": [ - 3015 + 3016 ] } ], @@ -11202,7 +11192,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1758, + "line": 1763, "character": 4 } ], @@ -11220,7 +11210,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1778, + "line": 1783, "character": 4 } ], @@ -11238,7 +11228,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1774, + "line": 1779, "character": 4 } ], @@ -11256,7 +11246,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1766, + "line": 1771, "character": 4 } ], @@ -11274,7 +11264,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1770, + "line": 1775, "character": 4 } ], @@ -11292,7 +11282,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1754, + "line": 1759, "character": 4 } ], @@ -11310,7 +11300,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1762, + "line": 1767, "character": 4 } ], @@ -11328,7 +11318,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1730, + "line": 1735, "character": 4 } ], @@ -11346,7 +11336,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1750, + "line": 1755, "character": 4 } ], @@ -11364,7 +11354,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1746, + "line": 1751, "character": 4 } ], @@ -11382,7 +11372,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1782, + "line": 1787, "character": 4 } ], @@ -11400,7 +11390,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1742, + "line": 1747, "character": 4 } ], @@ -11418,7 +11408,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1738, + "line": 1743, "character": 4 } ], @@ -11436,7 +11426,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1734, + "line": 1739, "character": 4 } ], @@ -11454,7 +11444,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1786, + "line": 1791, "character": 4 } ], @@ -11487,20 +11477,20 @@ "sources": [ { "fileName": "types.ts", - "line": 1726, + "line": 1731, "character": 12 } ] }, { - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent", "kind": 4, "kindString": "Enumeration", "flags": {}, "children": [ { - "id": 3050, + "id": 3051, "name": "GetAnswerConfig", "kind": 16, "kindString": "Enumeration member", @@ -11515,7 +11505,7 @@ "defaultValue": "\"getAnswerPageConfig\"" }, { - "id": 3049, + "id": 3050, "name": "GetAvailableUIPassthroughs", "kind": 16, "kindString": "Enumeration member", @@ -11530,7 +11520,7 @@ "defaultValue": "\"getAvailableUiPassthroughs\"" }, { - "id": 3048, + "id": 3049, "name": "GetDiscoverabilityStatus", "kind": 16, "kindString": "Enumeration member", @@ -11545,7 +11535,7 @@ "defaultValue": "\"getDiscoverabilityStatus\"" }, { - "id": 3051, + "id": 3052, "name": "GetLiveboardConfig", "kind": 16, "kindString": "Enumeration member", @@ -11560,7 +11550,7 @@ "defaultValue": "\"getPinboardPageConfig\"" }, { - "id": 3052, + "id": 3053, "name": "GetUnsavedAnswerTML", "kind": 16, "kindString": "Enumeration member", @@ -11575,7 +11565,7 @@ "defaultValue": "\"getUnsavedAnswerTML\"" }, { - "id": 3046, + "id": 3047, "name": "PinAnswerToLiveboard", "kind": 16, "kindString": "Enumeration member", @@ -11590,7 +11580,7 @@ "defaultValue": "\"addVizToPinboard\"" }, { - "id": 3047, + "id": 3048, "name": "SaveAnswer", "kind": 16, "kindString": "Enumeration member", @@ -11610,13 +11600,13 @@ "title": "Enumeration members", "kind": 16, "children": [ + 3051, 3050, 3049, - 3048, - 3051, 3052, - 3046, - 3047 + 3053, + 3047, + 3048 ] } ], @@ -11736,7 +11726,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 3022, + "id": 3023, "name": "VizPoint" } } @@ -12924,7 +12914,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2783, + "id": 2784, "name": "DOMSelector" } }, @@ -12936,7 +12926,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2662, + "id": 2663, "name": "AppViewConfig" } } @@ -13600,7 +13590,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -13631,7 +13621,7 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1826, + "line": 1830, "character": 11 } ], @@ -13679,7 +13669,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -13691,7 +13681,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -14162,7 +14152,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -14848,7 +14838,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 362, + "line": 371, "character": 4 } ], @@ -15034,7 +15024,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 338, + "line": 347, "character": 17 } ], @@ -15089,7 +15079,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 285, + "line": 294, "character": 11 } ], @@ -15451,7 +15441,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -15535,7 +15525,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -15550,7 +15540,7 @@ }, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -15729,7 +15719,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 325, + "line": 334, "character": 17 } ], @@ -16045,7 +16035,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -16151,7 +16141,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 361, + "line": 370, "character": 13 } ], @@ -16212,7 +16202,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2783, + "id": 2784, "name": "DOMSelector" } }, @@ -16224,7 +16214,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2526, + "id": 2527, "name": "LiveboardViewConfig" } } @@ -16879,7 +16869,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -16910,7 +16900,7 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1826, + "line": 1830, "character": 11 } ], @@ -16958,7 +16948,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -16970,7 +16960,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -17441,7 +17431,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -17607,7 +17597,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2783, + "id": 2784, "name": "DOMSelector" } }, @@ -17619,7 +17609,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2610, + "id": 2611, "name": "SageViewConfig" } } @@ -18206,7 +18196,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -18237,7 +18227,7 @@ "sources": [ { "fileName": "embed/ts-embed.ts", - "line": 1826, + "line": 1830, "character": 11 } ], @@ -18285,7 +18275,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -18297,7 +18287,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -18769,7 +18759,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -18945,7 +18935,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2479, + "id": 2480, "name": "SearchBarViewConfig" } } @@ -19499,7 +19489,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -19581,7 +19571,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -19596,7 +19586,7 @@ }, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -20080,7 +20070,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -20240,7 +20230,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2783, + "id": 2784, "name": "DOMSelector" } }, @@ -20252,7 +20242,7 @@ "flags": {}, "type": { "type": "reference", - "id": 2421, + "id": 2422, "name": "SearchViewConfig" } } @@ -20401,7 +20391,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 533, + "line": 538, "character": 17 } ], @@ -20454,7 +20444,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 498, + "line": 503, "character": 11 } ], @@ -20838,7 +20828,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -20920,7 +20910,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -20935,7 +20925,7 @@ }, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -21108,7 +21098,7 @@ "sources": [ { "fileName": "embed/search.ts", - "line": 509, + "line": 514, "character": 17 } ], @@ -21419,7 +21409,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -22070,7 +22060,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 227, + "line": 231, "character": 4 } ], @@ -22250,7 +22240,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 338, + "line": 347, "character": 17 } ], @@ -22303,7 +22293,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 285, + "line": 294, "character": 11 } ], @@ -22655,7 +22645,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } } @@ -22737,7 +22727,7 @@ }, "type": { "type": "reference", - "id": 2787, + "id": 2788, "name": "MessageCallback" } }, @@ -22752,7 +22742,7 @@ }, "type": { "type": "reference", - "id": 2784, + "id": 2785, "name": "MessageOptions" }, "defaultValue": "..." @@ -22925,7 +22915,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 325, + "line": 334, "character": 17 } ], @@ -23233,7 +23223,7 @@ "flags": {}, "type": { "type": "reference", - "id": 3045, + "id": 3046, "name": "UIPassthroughEvent" } } @@ -23337,7 +23327,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 226, + "line": 230, "character": 13 } ], @@ -23356,7 +23346,7 @@ ] }, { - "id": 2662, + "id": 2663, "name": "AppViewConfig", "kind": 256, "kindString": "Interface", @@ -23372,7 +23362,7 @@ }, "children": [ { - "id": 2701, + "id": 2702, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -23403,20 +23393,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2702, + "id": 2703, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2703, + "id": 2704, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2704, + "id": 2705, "name": "key", "kind": 32768, "flags": {}, @@ -23452,7 +23442,7 @@ } }, { - "id": 2730, + "id": 2731, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -23480,7 +23470,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1340, + "line": 1345, "character": 4 } ], @@ -23494,7 +23484,7 @@ } }, { - "id": 2682, + "id": 2683, "name": "collapseSearchBarInitially", "kind": 1024, "kindString": "Property", @@ -23531,7 +23521,7 @@ } }, { - "id": 2727, + "id": 2728, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -23561,7 +23551,7 @@ ], "type": { "type": "reference", - "id": 2365, + "id": 2366, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -23570,7 +23560,7 @@ } }, { - "id": 2747, + "id": 2748, "name": "coverAndFilterOptionInPDF", "kind": 1024, "kindString": "Property", @@ -23594,7 +23584,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1560, + "line": 1565, "character": 4 } ], @@ -23608,7 +23598,7 @@ } }, { - "id": 2719, + "id": 2720, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -23649,7 +23639,7 @@ } }, { - "id": 2705, + "id": 2706, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -23678,7 +23668,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -23687,7 +23677,7 @@ } }, { - "id": 2683, + "id": 2684, "name": "dataPanelCustomGroupsAccordionInitialState", "kind": 1024, "kindString": "Property", @@ -23721,12 +23711,12 @@ ], "type": { "type": "reference", - "id": 3059, + "id": 3062, "name": "DataPanelCustomColumnGroupsAccordionState" } }, { - "id": 2731, + "id": 2732, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -23754,7 +23744,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1356, + "line": 1361, "character": 4 } ], @@ -23768,7 +23758,7 @@ } }, { - "id": 2665, + "id": 2666, "name": "disableProfileAndHelp", "kind": 1024, "kindString": "Property", @@ -23806,7 +23796,7 @@ } }, { - "id": 2713, + "id": 2714, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -23844,7 +23834,7 @@ } }, { - "id": 2697, + "id": 2698, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -23882,7 +23872,7 @@ } }, { - "id": 2696, + "id": 2697, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -23924,7 +23914,7 @@ } }, { - "id": 2681, + "id": 2682, "name": "discoveryExperience", "kind": 1024, "kindString": "Property", @@ -23961,7 +23951,7 @@ } }, { - "id": 2709, + "id": 2710, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -24002,7 +23992,7 @@ } }, { - "id": 2741, + "id": 2742, "name": "enable2ColumnLayout", "kind": 1024, "kindString": "Property", @@ -24030,7 +24020,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1458, + "line": 1463, "character": 4 } ], @@ -24044,7 +24034,7 @@ } }, { - "id": 2746, + "id": 2747, "name": "enableAskSage", "kind": 1024, "kindString": "Property", @@ -24072,7 +24062,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1544, + "line": 1549, "character": 4 } ], @@ -24086,7 +24076,7 @@ } }, { - "id": 2732, + "id": 2733, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -24114,7 +24104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1372, + "line": 1377, "character": 4 } ], @@ -24128,7 +24118,7 @@ } }, { - "id": 2666, + "id": 2667, "name": "enablePendoHelp", "kind": 1024, "kindString": "Property", @@ -24164,7 +24154,7 @@ } }, { - "id": 2678, + "id": 2679, "name": "enableSearchAssist", "kind": 1024, "kindString": "Property", @@ -24202,7 +24192,7 @@ } }, { - "id": 2710, + "id": 2711, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -24240,7 +24230,7 @@ } }, { - "id": 2728, + "id": 2729, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -24248,12 +24238,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\nwhen set to false, runtime filters will be included in the URL.", + "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime filters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -24264,7 +24254,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1315, + "line": 1317, "character": 4 } ], @@ -24278,7 +24268,7 @@ } }, { - "id": 2729, + "id": 2730, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -24286,12 +24276,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL.", + "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime parameters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -24302,7 +24292,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1325, + "line": 1330, "character": 4 } ], @@ -24316,7 +24306,7 @@ } }, { - "id": 2712, + "id": 2713, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -24353,7 +24343,7 @@ } }, { - "id": 2693, + "id": 2694, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -24383,7 +24373,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -24392,7 +24382,7 @@ } }, { - "id": 2679, + "id": 2680, "name": "fullHeight", "kind": 1024, "kindString": "Property", @@ -24426,7 +24416,7 @@ } }, { - "id": 2698, + "id": 2699, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -24472,7 +24462,7 @@ } }, { - "id": 2736, + "id": 2737, "name": "hiddenHomeLeftNavItems", "kind": 1024, "kindString": "Property", @@ -24504,7 +24494,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2765, + "id": 2766, "name": "HomeLeftNavItem" } }, @@ -24514,7 +24504,7 @@ } }, { - "id": 2734, + "id": 2735, "name": "hiddenHomepageModules", "kind": 1024, "kindString": "Property", @@ -24546,7 +24536,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2776, + "id": 2777, "name": "HomepageModule" } }, @@ -24556,7 +24546,7 @@ } }, { - "id": 2733, + "id": 2734, "name": "hiddenListColumns", "kind": 1024, "kindString": "Property", @@ -24588,7 +24578,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 3053, + "id": 3054, "name": "ListPageColumns" } }, @@ -24598,7 +24588,7 @@ } }, { - "id": 2670, + "id": 2671, "name": "hideApplicationSwitcher", "kind": 1024, "kindString": "Property", @@ -24636,7 +24626,7 @@ } }, { - "id": 2667, + "id": 2668, "name": "hideHamburger", "kind": 1024, "kindString": "Property", @@ -24674,7 +24664,7 @@ } }, { - "id": 2664, + "id": 2665, "name": "hideHomepageLeftNav", "kind": 1024, "kindString": "Property", @@ -24712,7 +24702,7 @@ } }, { - "id": 2744, + "id": 2745, "name": "hideIrrelevantChipsInLiveboardTabs", "kind": 1024, "kindString": "Property", @@ -24740,7 +24730,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1511, + "line": 1516, "character": 4 } ], @@ -24754,7 +24744,7 @@ } }, { - "id": 2737, + "id": 2738, "name": "hideLiveboardHeader", "kind": 1024, "kindString": "Property", @@ -24782,7 +24772,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1394, + "line": 1399, "character": 4 } ], @@ -24796,7 +24786,7 @@ } }, { - "id": 2669, + "id": 2670, "name": "hideNotification", "kind": 1024, "kindString": "Property", @@ -24834,7 +24824,7 @@ } }, { - "id": 2668, + "id": 2669, "name": "hideObjectSearch", "kind": 1024, "kindString": "Property", @@ -24872,7 +24862,7 @@ } }, { - "id": 2676, + "id": 2677, "name": "hideObjects", "kind": 1024, "kindString": "Property", @@ -24909,7 +24899,7 @@ } }, { - "id": 2671, + "id": 2672, "name": "hideOrgSwitcher", "kind": 1024, "kindString": "Property", @@ -24947,7 +24937,7 @@ } }, { - "id": 2675, + "id": 2676, "name": "hideTagFilterChips", "kind": 1024, "kindString": "Property", @@ -24981,7 +24971,7 @@ } }, { - "id": 2684, + "id": 2685, "name": "homePageSearchBarMode", "kind": 1024, "kindString": "Property", @@ -25007,12 +24997,12 @@ ], "type": { "type": "reference", - "id": 3010, + "id": 3011, "name": "HomePageSearchBarMode" } }, { - "id": 2706, + "id": 2707, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -25050,7 +25040,7 @@ } }, { - "id": 2724, + "id": 2725, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -25073,7 +25063,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -25087,7 +25077,7 @@ } }, { - "id": 2723, + "id": 2724, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -25110,7 +25100,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -25127,7 +25117,7 @@ } }, { - "id": 2749, + "id": 2750, "name": "isCentralizedLiveboardFilterUXEnabled", "kind": 1024, "kindString": "Property", @@ -25151,7 +25141,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1594, + "line": 1599, "character": 4 } ], @@ -25165,7 +25155,7 @@ } }, { - "id": 2751, + "id": 2752, "name": "isEnhancedFilterInteractivityEnabled", "kind": 1024, "kindString": "Property", @@ -25189,7 +25179,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1625, + "line": 1630, "character": 4 } ], @@ -25203,7 +25193,7 @@ } }, { - "id": 2750, + "id": 2751, "name": "isLinkParametersEnabled", "kind": 1024, "kindString": "Property", @@ -25227,7 +25217,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1609, + "line": 1614, "character": 4 } ], @@ -25241,7 +25231,7 @@ } }, { - "id": 2742, + "id": 2743, "name": "isLiveboardCompactHeaderEnabled", "kind": 1024, "kindString": "Property", @@ -25269,7 +25259,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1475, + "line": 1480, "character": 4 } ], @@ -25283,7 +25273,7 @@ } }, { - "id": 2740, + "id": 2741, "name": "isLiveboardHeaderSticky", "kind": 1024, "kindString": "Property", @@ -25307,7 +25297,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1441, + "line": 1446, "character": 4 } ], @@ -25321,7 +25311,7 @@ } }, { - "id": 2753, + "id": 2754, "name": "isLiveboardMasterpiecesEnabled", "kind": 1024, "kindString": "Property", @@ -25349,7 +25339,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1657, + "line": 1662, "character": 4 } ], @@ -25363,7 +25353,7 @@ } }, { - "id": 2686, + "id": 2687, "name": "isLiveboardStylingAndGroupingEnabled", "kind": 1024, "kindString": "Property", @@ -25397,7 +25387,7 @@ } }, { - "id": 2722, + "id": 2723, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -25417,7 +25407,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -25431,7 +25421,7 @@ } }, { - "id": 2687, + "id": 2688, "name": "isPNGInScheduledEmailsEnabled", "kind": 1024, "kindString": "Property", @@ -25465,7 +25455,7 @@ } }, { - "id": 2685, + "id": 2686, "name": "isUnifiedSearchExperienceEnabled", "kind": 1024, "kindString": "Property", @@ -25503,7 +25493,7 @@ } }, { - "id": 2688, + "id": 2689, "name": "lazyLoadingForFullHeight", "kind": 1024, "kindString": "Property", @@ -25540,7 +25530,7 @@ } }, { - "id": 2689, + "id": 2690, "name": "lazyLoadingMargin", "kind": 1024, "kindString": "Property", @@ -25574,7 +25564,7 @@ } }, { - "id": 2715, + "id": 2716, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -25612,7 +25602,7 @@ } }, { - "id": 2748, + "id": 2749, "name": "liveboardXLSXCSVDownload", "kind": 1024, "kindString": "Property", @@ -25636,7 +25626,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1576, + "line": 1581, "character": 4 } ], @@ -25650,7 +25640,7 @@ } }, { - "id": 2700, + "id": 2701, "name": "locale", "kind": 1024, "kindString": "Property", @@ -25688,7 +25678,7 @@ } }, { - "id": 2691, + "id": 2692, "name": "minimumHeight", "kind": 1024, "kindString": "Property", @@ -25725,7 +25715,7 @@ } }, { - "id": 2680, + "id": 2681, "name": "modularHomeExperience", "kind": 1024, "kindString": "Property", @@ -25762,7 +25752,7 @@ } }, { - "id": 2714, + "id": 2715, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -25800,7 +25790,7 @@ } }, { - "id": 2673, + "id": 2674, "name": "pageId", "kind": 1024, "kindString": "Property", @@ -25835,7 +25825,7 @@ } }, { - "id": 2672, + "id": 2673, "name": "path", "kind": 1024, "kindString": "Property", @@ -25869,7 +25859,7 @@ } }, { - "id": 2708, + "id": 2709, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -25907,7 +25897,7 @@ } }, { - "id": 2716, + "id": 2717, "name": "primaryAction", "kind": 1024, "kindString": "Property", @@ -25945,7 +25935,7 @@ } }, { - "id": 2735, + "id": 2736, "name": "reorderedHomepageModules", "kind": 1024, "kindString": "Property", @@ -25977,7 +25967,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2776, + "id": 2777, "name": "HomepageModule" } }, @@ -25987,7 +25977,7 @@ } }, { - "id": 2725, + "id": 2726, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -26029,7 +26019,7 @@ } }, { - "id": 2726, + "id": 2727, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -26061,7 +26051,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } }, @@ -26071,7 +26061,7 @@ } }, { - "id": 2720, + "id": 2721, "name": "shouldBypassPayloadValidation", "kind": 1024, "kindString": "Property", @@ -26112,7 +26102,7 @@ } }, { - "id": 2718, + "id": 2719, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -26149,7 +26139,7 @@ } }, { - "id": 2739, + "id": 2740, "name": "showLiveboardDescription", "kind": 1024, "kindString": "Property", @@ -26177,7 +26167,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1426, + "line": 1431, "character": 4 } ], @@ -26191,7 +26181,7 @@ } }, { - "id": 2745, + "id": 2746, "name": "showLiveboardReverifyBanner", "kind": 1024, "kindString": "Property", @@ -26219,7 +26209,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1528, + "line": 1533, "character": 4 } ], @@ -26233,7 +26223,7 @@ } }, { - "id": 2738, + "id": 2739, "name": "showLiveboardTitle", "kind": 1024, "kindString": "Property", @@ -26261,7 +26251,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1410, + "line": 1415, "character": 4 } ], @@ -26275,7 +26265,7 @@ } }, { - "id": 2743, + "id": 2744, "name": "showLiveboardVerifiedBadge", "kind": 1024, "kindString": "Property", @@ -26303,7 +26293,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1492, + "line": 1497, "character": 4 } ], @@ -26317,7 +26307,7 @@ } }, { - "id": 2752, + "id": 2753, "name": "showMaskedFilterChip", "kind": 1024, "kindString": "Property", @@ -26345,7 +26335,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1641, + "line": 1646, "character": 4 } ], @@ -26359,7 +26349,7 @@ } }, { - "id": 2663, + "id": 2664, "name": "showPrimaryNavbar", "kind": 1024, "kindString": "Property", @@ -26397,7 +26387,7 @@ } }, { - "id": 2674, + "id": 2675, "name": "tag", "kind": 1024, "kindString": "Property", @@ -26431,7 +26421,7 @@ } }, { - "id": 2690, + "id": 2691, "name": "updatedSpotterChatPrompt", "kind": 1024, "kindString": "Property", @@ -26469,7 +26459,7 @@ } }, { - "id": 2721, + "id": 2722, "name": "useHostEventsV2", "kind": 1024, "kindString": "Property", @@ -26510,7 +26500,7 @@ } }, { - "id": 2699, + "id": 2700, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -26561,87 +26551,87 @@ "title": "Properties", "kind": 1024, "children": [ - 2701, - 2730, - 2682, - 2727, - 2747, - 2719, - 2705, - 2683, + 2702, 2731, - 2665, - 2713, - 2697, - 2696, - 2681, - 2709, - 2741, - 2746, + 2683, + 2728, + 2748, + 2720, + 2706, + 2684, 2732, 2666, - 2678, - 2710, - 2728, - 2729, - 2712, - 2693, - 2679, + 2714, 2698, - 2736, - 2734, + 2697, + 2682, + 2710, + 2742, + 2747, 2733, - 2670, 2667, - 2664, - 2744, + 2679, + 2711, + 2729, + 2730, + 2713, + 2694, + 2680, + 2699, 2737, - 2669, + 2735, + 2734, + 2671, 2668, + 2665, + 2745, + 2738, + 2670, + 2669, + 2677, + 2672, 2676, - 2671, - 2675, - 2684, - 2706, + 2685, + 2707, + 2725, 2724, - 2723, - 2749, - 2751, 2750, - 2742, - 2740, - 2753, - 2686, - 2722, + 2752, + 2751, + 2743, + 2741, + 2754, 2687, - 2685, + 2723, 2688, + 2686, 2689, + 2690, + 2716, + 2749, + 2701, + 2692, + 2681, 2715, - 2748, - 2700, - 2691, - 2680, - 2714, + 2674, 2673, - 2672, - 2708, - 2716, - 2735, - 2725, + 2709, + 2717, + 2736, 2726, - 2720, - 2718, - 2739, - 2745, - 2738, - 2743, - 2752, - 2663, - 2674, - 2690, + 2727, 2721, - 2699 + 2719, + 2740, + 2746, + 2739, + 2744, + 2753, + 2664, + 2675, + 2691, + 2722, + 2700 ] } ], @@ -27540,7 +27530,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -27820,7 +27810,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -27939,7 +27929,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -27977,7 +27967,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -28015,7 +28005,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -28601,7 +28591,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -28884,7 +28874,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 183, + "line": 187, "character": 4 } ], @@ -28946,12 +28936,12 @@ "isOptional": true }, "comment": { - "shortText": "Flag to control whether runtime filters should be included in the URL.\nIf true, filters will be passed via app initialization payload instead.\nIf false/undefined, filters will be added to URL (default behavior).", + "shortText": "Flag to control whether runtime filters should be included in the URL.\nIf true, filters will be passed via app initialization payload\n(default behavior from SDK 1.45.0).\nIf false/undefined, filters are appended to the iframe URL instead.\n(default behavior before SDK 1.45.0).", "text": "Supported embed types: `SpotterEmbed`", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -28962,7 +28952,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 138, + "line": 140, "character": 4 } ], @@ -28985,12 +28975,12 @@ "isOptional": true }, "comment": { - "shortText": "Flag to control whether runtime parameters should be included in the URL.\nIf true, parameters will be passed via app initialization payload instead.\nIf false/undefined, parameters will be added to URL (default behavior).", + "shortText": "Flag to control whether runtime parameters should be included in the URL.\nIf true, parameters will be passed via app\ninitialization payload (default behavior from SDK 1.45.0).\nIf false/undefined, parameters are appended to\nthe iframe URL instead (default behavior before SDK 1.45.0).", "text": "Supported embed types: `SpotterEmbed`", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -29001,7 +28991,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 167, + "line": 171, "character": 4 } ], @@ -29084,7 +29074,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -29281,7 +29271,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -29319,7 +29309,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -29357,7 +29347,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -29595,7 +29585,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 157, + "line": 159, "character": 4 } ], @@ -29603,7 +29593,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } }, @@ -29789,7 +29779,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 199, + "line": 203, "character": 4 } ], @@ -29966,7 +29956,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 209, + "line": 213, "character": 17 } ], @@ -29979,7 +29969,7 @@ ] }, { - "id": 3025, + "id": 3026, "name": "CustomActionPayload", "kind": 256, "kindString": "Interface", @@ -29994,7 +29984,7 @@ }, "children": [ { - "id": 3026, + "id": 3027, "name": "contextMenuPoints", "kind": 1024, "kindString": "Property", @@ -30004,21 +29994,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6162, + "line": 6179, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 3027, + "id": 3028, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 3028, + "id": 3029, "name": "clickedPoint", "kind": 1024, "kindString": "Property", @@ -30026,18 +30016,18 @@ "sources": [ { "fileName": "types.ts", - "line": 6163, + "line": 6180, "character": 8 } ], "type": { "type": "reference", - "id": 3022, + "id": 3023, "name": "VizPoint" } }, { - "id": 3029, + "id": 3030, "name": "selectedPoints", "kind": 1024, "kindString": "Property", @@ -30045,7 +30035,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6164, + "line": 6181, "character": 8 } ], @@ -30053,7 +30043,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 3022, + "id": 3023, "name": "VizPoint" } } @@ -30064,8 +30054,8 @@ "title": "Properties", "kind": 1024, "children": [ - 3028, - 3029 + 3029, + 3030 ] } ] @@ -30073,7 +30063,7 @@ } }, { - "id": 3030, + "id": 3031, "name": "embedAnswerData", "kind": 1024, "kindString": "Property", @@ -30081,21 +30071,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6166, + "line": 6183, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 3031, + "id": 3032, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 3039, + "id": 3040, "name": "columns", "kind": 1024, "kindString": "Property", @@ -30103,7 +30093,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6174, + "line": 6191, "character": 8 } ], @@ -30116,7 +30106,7 @@ } }, { - "id": 3040, + "id": 3041, "name": "data", "kind": 1024, "kindString": "Property", @@ -30124,7 +30114,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6175, + "line": 6192, "character": 8 } ], @@ -30137,7 +30127,7 @@ } }, { - "id": 3033, + "id": 3034, "name": "id", "kind": 1024, "kindString": "Property", @@ -30145,7 +30135,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6168, + "line": 6185, "character": 8 } ], @@ -30155,7 +30145,7 @@ } }, { - "id": 3032, + "id": 3033, "name": "name", "kind": 1024, "kindString": "Property", @@ -30163,7 +30153,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6167, + "line": 6184, "character": 8 } ], @@ -30173,7 +30163,7 @@ } }, { - "id": 3034, + "id": 3035, "name": "sources", "kind": 1024, "kindString": "Property", @@ -30181,21 +30171,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6169, + "line": 6186, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 3035, + "id": 3036, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 3036, + "id": 3037, "name": "header", "kind": 1024, "kindString": "Property", @@ -30203,21 +30193,21 @@ "sources": [ { "fileName": "types.ts", - "line": 6170, + "line": 6187, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 3037, + "id": 3038, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 3038, + "id": 3039, "name": "guid", "kind": 1024, "kindString": "Property", @@ -30225,7 +30215,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6171, + "line": 6188, "character": 16 } ], @@ -30240,7 +30230,7 @@ "title": "Properties", "kind": 1024, "children": [ - 3038 + 3039 ] } ] @@ -30253,7 +30243,7 @@ "title": "Properties", "kind": 1024, "children": [ - 3036 + 3037 ] } ] @@ -30266,23 +30256,23 @@ "title": "Properties", "kind": 1024, "children": [ - 3039, 3040, + 3041, + 3034, 3033, - 3032, - 3034 + 3035 ] } ], "indexSignature": { - "id": 3041, + "id": 3042, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 3042, + "id": 3043, "name": "key", "kind": 32768, "flags": {}, @@ -30301,7 +30291,7 @@ } }, { - "id": 3043, + "id": 3044, "name": "session", "kind": 1024, "kindString": "Property", @@ -30309,7 +30299,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6178, + "line": 6195, "character": 4 } ], @@ -30320,7 +30310,7 @@ } }, { - "id": 3044, + "id": 3045, "name": "vizId", "kind": 1024, "kindString": "Property", @@ -30330,7 +30320,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6179, + "line": 6196, "character": 4 } ], @@ -30345,23 +30335,23 @@ "title": "Properties", "kind": 1024, "children": [ - 3026, - 3030, - 3043, - 3044 + 3027, + 3031, + 3044, + 3045 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6161, + "line": 6178, "character": 17 } ] }, { - "id": 2822, + "id": 2823, "name": "CustomCssVariables", "kind": 256, "kindString": "Interface", @@ -30371,7 +30361,7 @@ }, "children": [ { - "id": 2876, + "id": 2877, "name": "--ts-var-answer-chart-hover-background", "kind": 1024, "kindString": "Property", @@ -30394,7 +30384,7 @@ } }, { - "id": 2875, + "id": 2876, "name": "--ts-var-answer-chart-select-background", "kind": 1024, "kindString": "Property", @@ -30417,7 +30407,7 @@ } }, { - "id": 2845, + "id": 2846, "name": "--ts-var-answer-data-panel-background-color", "kind": 1024, "kindString": "Property", @@ -30440,7 +30430,7 @@ } }, { - "id": 2846, + "id": 2847, "name": "--ts-var-answer-edit-panel-background-color", "kind": 1024, "kindString": "Property", @@ -30463,7 +30453,7 @@ } }, { - "id": 2848, + "id": 2849, "name": "--ts-var-answer-view-table-chart-switcher-active-background", "kind": 1024, "kindString": "Property", @@ -30486,7 +30476,7 @@ } }, { - "id": 2847, + "id": 2848, "name": "--ts-var-answer-view-table-chart-switcher-background", "kind": 1024, "kindString": "Property", @@ -30509,7 +30499,7 @@ } }, { - "id": 2827, + "id": 2828, "name": "--ts-var-application-color", "kind": 1024, "kindString": "Property", @@ -30532,7 +30522,7 @@ } }, { - "id": 2888, + "id": 2889, "name": "--ts-var-axis-data-label-color", "kind": 1024, "kindString": "Property", @@ -30555,7 +30545,7 @@ } }, { - "id": 2889, + "id": 2890, "name": "--ts-var-axis-data-label-font-family", "kind": 1024, "kindString": "Property", @@ -30578,7 +30568,7 @@ } }, { - "id": 2886, + "id": 2887, "name": "--ts-var-axis-title-color", "kind": 1024, "kindString": "Property", @@ -30601,7 +30591,7 @@ } }, { - "id": 2887, + "id": 2888, "name": "--ts-var-axis-title-font-family", "kind": 1024, "kindString": "Property", @@ -30624,7 +30614,7 @@ } }, { - "id": 2850, + "id": 2851, "name": "--ts-var-button--icon-border-radius", "kind": 1024, "kindString": "Property", @@ -30647,7 +30637,7 @@ } }, { - "id": 2855, + "id": 2856, "name": "--ts-var-button--primary--active-background", "kind": 1024, "kindString": "Property", @@ -30670,7 +30660,7 @@ } }, { - "id": 2852, + "id": 2853, "name": "--ts-var-button--primary--font-family", "kind": 1024, "kindString": "Property", @@ -30693,7 +30683,7 @@ } }, { - "id": 2854, + "id": 2855, "name": "--ts-var-button--primary--hover-background", "kind": 1024, "kindString": "Property", @@ -30716,7 +30706,7 @@ } }, { - "id": 2853, + "id": 2854, "name": "--ts-var-button--primary-background", "kind": 1024, "kindString": "Property", @@ -30739,7 +30729,7 @@ } }, { - "id": 2851, + "id": 2852, "name": "--ts-var-button--primary-color", "kind": 1024, "kindString": "Property", @@ -30762,7 +30752,7 @@ } }, { - "id": 2860, + "id": 2861, "name": "--ts-var-button--secondary--active-background", "kind": 1024, "kindString": "Property", @@ -30785,7 +30775,7 @@ } }, { - "id": 2857, + "id": 2858, "name": "--ts-var-button--secondary--font-family", "kind": 1024, "kindString": "Property", @@ -30808,7 +30798,7 @@ } }, { - "id": 2859, + "id": 2860, "name": "--ts-var-button--secondary--hover-background", "kind": 1024, "kindString": "Property", @@ -30831,7 +30821,7 @@ } }, { - "id": 2858, + "id": 2859, "name": "--ts-var-button--secondary-background", "kind": 1024, "kindString": "Property", @@ -30854,7 +30844,7 @@ } }, { - "id": 2856, + "id": 2857, "name": "--ts-var-button--secondary-color", "kind": 1024, "kindString": "Property", @@ -30877,7 +30867,7 @@ } }, { - "id": 2864, + "id": 2865, "name": "--ts-var-button--tertiary--active-background", "kind": 1024, "kindString": "Property", @@ -30900,7 +30890,7 @@ } }, { - "id": 2863, + "id": 2864, "name": "--ts-var-button--tertiary--hover-background", "kind": 1024, "kindString": "Property", @@ -30923,7 +30913,7 @@ } }, { - "id": 2862, + "id": 2863, "name": "--ts-var-button--tertiary-background", "kind": 1024, "kindString": "Property", @@ -30946,7 +30936,7 @@ } }, { - "id": 2861, + "id": 2862, "name": "--ts-var-button--tertiary-color", "kind": 1024, "kindString": "Property", @@ -30969,7 +30959,7 @@ } }, { - "id": 2849, + "id": 2850, "name": "--ts-var-button-border-radius", "kind": 1024, "kindString": "Property", @@ -30992,7 +30982,7 @@ } }, { - "id": 2982, + "id": 2983, "name": "--ts-var-cca-modal-summary-header-background", "kind": 1024, "kindString": "Property", @@ -31015,7 +31005,7 @@ } }, { - "id": 2977, + "id": 2978, "name": "--ts-var-change-analysis-insights-background", "kind": 1024, "kindString": "Property", @@ -31038,7 +31028,7 @@ } }, { - "id": 2972, + "id": 2973, "name": "--ts-var-chart-heatmap-legend-label-color", "kind": 1024, "kindString": "Property", @@ -31061,7 +31051,7 @@ } }, { - "id": 2971, + "id": 2972, "name": "--ts-var-chart-heatmap-legend-title-color", "kind": 1024, "kindString": "Property", @@ -31084,7 +31074,7 @@ } }, { - "id": 2974, + "id": 2975, "name": "--ts-var-chart-treemap-legend-label-color", "kind": 1024, "kindString": "Property", @@ -31107,7 +31097,7 @@ } }, { - "id": 2973, + "id": 2974, "name": "--ts-var-chart-treemap-legend-title-color", "kind": 1024, "kindString": "Property", @@ -31130,7 +31120,7 @@ } }, { - "id": 2911, + "id": 2912, "name": "--ts-var-checkbox-active-color", "kind": 1024, "kindString": "Property", @@ -31153,7 +31143,7 @@ } }, { - "id": 2914, + "id": 2915, "name": "--ts-var-checkbox-background-color", "kind": 1024, "kindString": "Property", @@ -31176,7 +31166,7 @@ } }, { - "id": 2909, + "id": 2910, "name": "--ts-var-checkbox-border-color", "kind": 1024, "kindString": "Property", @@ -31199,7 +31189,7 @@ } }, { - "id": 2912, + "id": 2913, "name": "--ts-var-checkbox-checked-color", "kind": 1024, "kindString": "Property", @@ -31222,7 +31212,7 @@ } }, { - "id": 2913, + "id": 2914, "name": "--ts-var-checkbox-checked-disabled", "kind": 1024, "kindString": "Property", @@ -31245,7 +31235,7 @@ } }, { - "id": 2908, + "id": 2909, "name": "--ts-var-checkbox-error-border", "kind": 1024, "kindString": "Property", @@ -31268,7 +31258,7 @@ } }, { - "id": 2910, + "id": 2911, "name": "--ts-var-checkbox-hover-border", "kind": 1024, "kindString": "Property", @@ -31291,7 +31281,7 @@ } }, { - "id": 2881, + "id": 2882, "name": "--ts-var-chip--active-background", "kind": 1024, "kindString": "Property", @@ -31314,7 +31304,7 @@ } }, { - "id": 2880, + "id": 2881, "name": "--ts-var-chip--active-color", "kind": 1024, "kindString": "Property", @@ -31337,7 +31327,7 @@ } }, { - "id": 2883, + "id": 2884, "name": "--ts-var-chip--hover-background", "kind": 1024, "kindString": "Property", @@ -31360,7 +31350,7 @@ } }, { - "id": 2882, + "id": 2883, "name": "--ts-var-chip--hover-color", "kind": 1024, "kindString": "Property", @@ -31383,7 +31373,7 @@ } }, { - "id": 2879, + "id": 2880, "name": "--ts-var-chip-background", "kind": 1024, "kindString": "Property", @@ -31406,7 +31396,7 @@ } }, { - "id": 2877, + "id": 2878, "name": "--ts-var-chip-border-radius", "kind": 1024, "kindString": "Property", @@ -31429,7 +31419,7 @@ } }, { - "id": 2878, + "id": 2879, "name": "--ts-var-chip-box-shadow", "kind": 1024, "kindString": "Property", @@ -31452,7 +31442,7 @@ } }, { - "id": 2884, + "id": 2885, "name": "--ts-var-chip-color", "kind": 1024, "kindString": "Property", @@ -31475,7 +31465,7 @@ } }, { - "id": 2885, + "id": 2886, "name": "--ts-var-chip-title-font-family", "kind": 1024, "kindString": "Property", @@ -31498,7 +31488,7 @@ } }, { - "id": 2896, + "id": 2897, "name": "--ts-var-dialog-body-background", "kind": 1024, "kindString": "Property", @@ -31521,7 +31511,7 @@ } }, { - "id": 2897, + "id": 2898, "name": "--ts-var-dialog-body-color", "kind": 1024, "kindString": "Property", @@ -31544,7 +31534,7 @@ } }, { - "id": 2900, + "id": 2901, "name": "--ts-var-dialog-footer-background", "kind": 1024, "kindString": "Property", @@ -31567,7 +31557,7 @@ } }, { - "id": 2898, + "id": 2899, "name": "--ts-var-dialog-header-background", "kind": 1024, "kindString": "Property", @@ -31590,7 +31580,7 @@ } }, { - "id": 2899, + "id": 2900, "name": "--ts-var-dialog-header-color", "kind": 1024, "kindString": "Property", @@ -31613,7 +31603,7 @@ } }, { - "id": 2907, + "id": 2908, "name": "--ts-var-home-favorite-suggestion-card-background", "kind": 1024, "kindString": "Property", @@ -31636,7 +31626,7 @@ } }, { - "id": 2906, + "id": 2907, "name": "--ts-var-home-favorite-suggestion-card-icon-color", "kind": 1024, "kindString": "Property", @@ -31659,7 +31649,7 @@ } }, { - "id": 2905, + "id": 2906, "name": "--ts-var-home-favorite-suggestion-card-text-color", "kind": 1024, "kindString": "Property", @@ -31682,7 +31672,7 @@ } }, { - "id": 2904, + "id": 2905, "name": "--ts-var-home-watchlist-selected-text-color", "kind": 1024, "kindString": "Property", @@ -31705,7 +31695,7 @@ } }, { - "id": 2970, + "id": 2971, "name": "--ts-var-kpi-analyze-text-color", "kind": 1024, "kindString": "Property", @@ -31728,7 +31718,7 @@ } }, { - "id": 2969, + "id": 2970, "name": "--ts-var-kpi-comparison-color", "kind": 1024, "kindString": "Property", @@ -31751,7 +31741,7 @@ } }, { - "id": 2968, + "id": 2969, "name": "--ts-var-kpi-hero-color", "kind": 1024, "kindString": "Property", @@ -31774,7 +31764,7 @@ } }, { - "id": 2976, + "id": 2977, "name": "--ts-var-kpi-negative-change-color", "kind": 1024, "kindString": "Property", @@ -31797,7 +31787,7 @@ } }, { - "id": 2975, + "id": 2976, "name": "--ts-var-kpi-positive-change-color", "kind": 1024, "kindString": "Property", @@ -31820,7 +31810,7 @@ } }, { - "id": 2902, + "id": 2903, "name": "--ts-var-list-hover-background", "kind": 1024, "kindString": "Property", @@ -31843,7 +31833,7 @@ } }, { - "id": 2901, + "id": 2902, "name": "--ts-var-list-selected-background", "kind": 1024, "kindString": "Property", @@ -31866,7 +31856,7 @@ } }, { - "id": 2929, + "id": 2930, "name": "--ts-var-liveboard-answer-viz-padding", "kind": 1024, "kindString": "Property", @@ -31889,7 +31879,7 @@ } }, { - "id": 2942, + "id": 2943, "name": "--ts-var-liveboard-chip--active-background", "kind": 1024, "kindString": "Property", @@ -31913,7 +31903,7 @@ } }, { - "id": 2941, + "id": 2942, "name": "--ts-var-liveboard-chip--hover-background", "kind": 1024, "kindString": "Property", @@ -31937,7 +31927,7 @@ } }, { - "id": 2939, + "id": 2940, "name": "--ts-var-liveboard-chip-background", "kind": 1024, "kindString": "Property", @@ -31961,7 +31951,7 @@ } }, { - "id": 2940, + "id": 2941, "name": "--ts-var-liveboard-chip-color", "kind": 1024, "kindString": "Property", @@ -31985,7 +31975,7 @@ } }, { - "id": 2947, + "id": 2948, "name": "--ts-var-liveboard-cross-filter-layout-background", "kind": 1024, "kindString": "Property", @@ -32008,7 +31998,7 @@ } }, { - "id": 2945, + "id": 2946, "name": "--ts-var-liveboard-dual-column-breakpoint", "kind": 1024, "kindString": "Property", @@ -32031,7 +32021,7 @@ } }, { - "id": 2944, + "id": 2945, "name": "--ts-var-liveboard-edit-bar-background", "kind": 1024, "kindString": "Property", @@ -32054,7 +32044,7 @@ } }, { - "id": 2930, + "id": 2931, "name": "--ts-var-liveboard-group-background", "kind": 1024, "kindString": "Property", @@ -32078,7 +32068,7 @@ } }, { - "id": 2931, + "id": 2932, "name": "--ts-var-liveboard-group-border-color", "kind": 1024, "kindString": "Property", @@ -32102,7 +32092,7 @@ } }, { - "id": 2935, + "id": 2936, "name": "--ts-var-liveboard-group-description-font-color", "kind": 1024, "kindString": "Property", @@ -32126,7 +32116,7 @@ } }, { - "id": 2923, + "id": 2924, "name": "--ts-var-liveboard-group-padding", "kind": 1024, "kindString": "Property", @@ -32150,7 +32140,7 @@ } }, { - "id": 2938, + "id": 2939, "name": "--ts-var-liveboard-group-tile-background", "kind": 1024, "kindString": "Property", @@ -32174,7 +32164,7 @@ } }, { - "id": 2937, + "id": 2938, "name": "--ts-var-liveboard-group-tile-description-font-color", "kind": 1024, "kindString": "Property", @@ -32198,7 +32188,7 @@ } }, { - "id": 2928, + "id": 2929, "name": "--ts-var-liveboard-group-tile-padding", "kind": 1024, "kindString": "Property", @@ -32222,7 +32212,7 @@ } }, { - "id": 2936, + "id": 2937, "name": "--ts-var-liveboard-group-tile-title-font-color", "kind": 1024, "kindString": "Property", @@ -32246,7 +32236,7 @@ } }, { - "id": 2926, + "id": 2927, "name": "--ts-var-liveboard-group-tile-title-font-size", "kind": 1024, "kindString": "Property", @@ -32270,7 +32260,7 @@ } }, { - "id": 2927, + "id": 2928, "name": "--ts-var-liveboard-group-tile-title-font-weight", "kind": 1024, "kindString": "Property", @@ -32294,7 +32284,7 @@ } }, { - "id": 2934, + "id": 2935, "name": "--ts-var-liveboard-group-title-font-color", "kind": 1024, "kindString": "Property", @@ -32318,7 +32308,7 @@ } }, { - "id": 2924, + "id": 2925, "name": "--ts-var-liveboard-group-title-font-size", "kind": 1024, "kindString": "Property", @@ -32342,7 +32332,7 @@ } }, { - "id": 2925, + "id": 2926, "name": "--ts-var-liveboard-group-title-font-weight", "kind": 1024, "kindString": "Property", @@ -32366,7 +32356,7 @@ } }, { - "id": 2961, + "id": 2962, "name": "--ts-var-liveboard-header-action-button-active-color", "kind": 1024, "kindString": "Property", @@ -32389,7 +32379,7 @@ } }, { - "id": 2958, + "id": 2959, "name": "--ts-var-liveboard-header-action-button-background", "kind": 1024, "kindString": "Property", @@ -32412,7 +32402,7 @@ } }, { - "id": 2959, + "id": 2960, "name": "--ts-var-liveboard-header-action-button-font-color", "kind": 1024, "kindString": "Property", @@ -32435,7 +32425,7 @@ } }, { - "id": 2960, + "id": 2961, "name": "--ts-var-liveboard-header-action-button-hover-color", "kind": 1024, "kindString": "Property", @@ -32458,7 +32448,7 @@ } }, { - "id": 2916, + "id": 2917, "name": "--ts-var-liveboard-header-background", "kind": 1024, "kindString": "Property", @@ -32481,7 +32471,7 @@ } }, { - "id": 2967, + "id": 2968, "name": "--ts-var-liveboard-header-badge-active-color", "kind": 1024, "kindString": "Property", @@ -32504,7 +32494,7 @@ } }, { - "id": 2962, + "id": 2963, "name": "--ts-var-liveboard-header-badge-background", "kind": 1024, "kindString": "Property", @@ -32527,7 +32517,7 @@ } }, { - "id": 2963, + "id": 2964, "name": "--ts-var-liveboard-header-badge-font-color", "kind": 1024, "kindString": "Property", @@ -32550,7 +32540,7 @@ } }, { - "id": 2966, + "id": 2967, "name": "--ts-var-liveboard-header-badge-hover-color", "kind": 1024, "kindString": "Property", @@ -32573,7 +32563,7 @@ } }, { - "id": 2964, + "id": 2965, "name": "--ts-var-liveboard-header-badge-modified-background", "kind": 1024, "kindString": "Property", @@ -32596,7 +32586,7 @@ } }, { - "id": 2965, + "id": 2966, "name": "--ts-var-liveboard-header-badge-modified-font-color", "kind": 1024, "kindString": "Property", @@ -32619,7 +32609,7 @@ } }, { - "id": 2917, + "id": 2918, "name": "--ts-var-liveboard-header-font-color", "kind": 1024, "kindString": "Property", @@ -32642,7 +32632,7 @@ } }, { - "id": 2915, + "id": 2916, "name": "--ts-var-liveboard-layout-background", "kind": 1024, "kindString": "Property", @@ -32665,7 +32655,7 @@ } }, { - "id": 2933, + "id": 2934, "name": "--ts-var-liveboard-notetitle-body-font-color", "kind": 1024, "kindString": "Property", @@ -32688,7 +32678,7 @@ } }, { - "id": 2932, + "id": 2933, "name": "--ts-var-liveboard-notetitle-heading-font-color", "kind": 1024, "kindString": "Property", @@ -32711,7 +32701,7 @@ } }, { - "id": 2946, + "id": 2947, "name": "--ts-var-liveboard-single-column-breakpoint", "kind": 1024, "kindString": "Property", @@ -32734,7 +32724,7 @@ } }, { - "id": 2948, + "id": 2949, "name": "--ts-var-liveboard-tab-active-border-color", "kind": 1024, "kindString": "Property", @@ -32757,7 +32747,7 @@ } }, { - "id": 2949, + "id": 2950, "name": "--ts-var-liveboard-tab-hover-color", "kind": 1024, "kindString": "Property", @@ -32780,7 +32770,7 @@ } }, { - "id": 2919, + "id": 2920, "name": "--ts-var-liveboard-tile-background", "kind": 1024, "kindString": "Property", @@ -32803,7 +32793,7 @@ } }, { - "id": 2918, + "id": 2919, "name": "--ts-var-liveboard-tile-border-color", "kind": 1024, "kindString": "Property", @@ -32826,7 +32816,7 @@ } }, { - "id": 2920, + "id": 2921, "name": "--ts-var-liveboard-tile-border-radius", "kind": 1024, "kindString": "Property", @@ -32849,7 +32839,7 @@ } }, { - "id": 2921, + "id": 2922, "name": "--ts-var-liveboard-tile-padding", "kind": 1024, "kindString": "Property", @@ -32872,7 +32862,7 @@ } }, { - "id": 2922, + "id": 2923, "name": "--ts-var-liveboard-tile-table-header-background", "kind": 1024, "kindString": "Property", @@ -32895,7 +32885,7 @@ } }, { - "id": 2950, + "id": 2951, "name": "--ts-var-liveboard-tile-title-fontsize", "kind": 1024, "kindString": "Property", @@ -32918,7 +32908,7 @@ } }, { - "id": 2951, + "id": 2952, "name": "--ts-var-liveboard-tile-title-fontweight", "kind": 1024, "kindString": "Property", @@ -32941,7 +32931,7 @@ } }, { - "id": 2894, + "id": 2895, "name": "--ts-var-menu--hover-background", "kind": 1024, "kindString": "Property", @@ -32964,7 +32954,7 @@ } }, { - "id": 2891, + "id": 2892, "name": "--ts-var-menu-background", "kind": 1024, "kindString": "Property", @@ -32987,7 +32977,7 @@ } }, { - "id": 2890, + "id": 2891, "name": "--ts-var-menu-color", "kind": 1024, "kindString": "Property", @@ -33010,7 +33000,7 @@ } }, { - "id": 2892, + "id": 2893, "name": "--ts-var-menu-font-family", "kind": 1024, "kindString": "Property", @@ -33033,7 +33023,7 @@ } }, { - "id": 2895, + "id": 2896, "name": "--ts-var-menu-selected-text-color", "kind": 1024, "kindString": "Property", @@ -33056,7 +33046,7 @@ } }, { - "id": 2893, + "id": 2894, "name": "--ts-var-menu-text-transform", "kind": 1024, "kindString": "Property", @@ -33079,7 +33069,7 @@ } }, { - "id": 2828, + "id": 2829, "name": "--ts-var-nav-background", "kind": 1024, "kindString": "Property", @@ -33102,7 +33092,7 @@ } }, { - "id": 2829, + "id": 2830, "name": "--ts-var-nav-color", "kind": 1024, "kindString": "Property", @@ -33125,7 +33115,7 @@ } }, { - "id": 2956, + "id": 2957, "name": "--ts-var-parameter-chip-active-background", "kind": 1024, "kindString": "Property", @@ -33148,7 +33138,7 @@ } }, { - "id": 2957, + "id": 2958, "name": "--ts-var-parameter-chip-active-text-color", "kind": 1024, "kindString": "Property", @@ -33171,7 +33161,7 @@ } }, { - "id": 2952, + "id": 2953, "name": "--ts-var-parameter-chip-background", "kind": 1024, "kindString": "Property", @@ -33194,7 +33184,7 @@ } }, { - "id": 2954, + "id": 2955, "name": "--ts-var-parameter-chip-hover-background", "kind": 1024, "kindString": "Property", @@ -33217,7 +33207,7 @@ } }, { - "id": 2955, + "id": 2956, "name": "--ts-var-parameter-chip-hover-text-color", "kind": 1024, "kindString": "Property", @@ -33240,7 +33230,7 @@ } }, { - "id": 2953, + "id": 2954, "name": "--ts-var-parameter-chip-text-color", "kind": 1024, "kindString": "Property", @@ -33263,7 +33253,7 @@ } }, { - "id": 2823, + "id": 2824, "name": "--ts-var-root-background", "kind": 1024, "kindString": "Property", @@ -33286,7 +33276,7 @@ } }, { - "id": 2824, + "id": 2825, "name": "--ts-var-root-color", "kind": 1024, "kindString": "Property", @@ -33309,7 +33299,7 @@ } }, { - "id": 2825, + "id": 2826, "name": "--ts-var-root-font-family", "kind": 1024, "kindString": "Property", @@ -33332,7 +33322,7 @@ } }, { - "id": 2826, + "id": 2827, "name": "--ts-var-root-text-transform", "kind": 1024, "kindString": "Property", @@ -33355,7 +33345,7 @@ } }, { - "id": 2837, + "id": 2838, "name": "--ts-var-search-auto-complete-background", "kind": 1024, "kindString": "Property", @@ -33378,7 +33368,7 @@ } }, { - "id": 2841, + "id": 2842, "name": "--ts-var-search-auto-complete-font-color", "kind": 1024, "kindString": "Property", @@ -33401,7 +33391,7 @@ } }, { - "id": 2842, + "id": 2843, "name": "--ts-var-search-auto-complete-subtext-font-color", "kind": 1024, "kindString": "Property", @@ -33424,7 +33414,7 @@ } }, { - "id": 2840, + "id": 2841, "name": "--ts-var-search-bar-auto-complete-hover-background", "kind": 1024, "kindString": "Property", @@ -33447,7 +33437,7 @@ } }, { - "id": 2836, + "id": 2837, "name": "--ts-var-search-bar-background", "kind": 1024, "kindString": "Property", @@ -33470,7 +33460,7 @@ } }, { - "id": 2839, + "id": 2840, "name": "--ts-var-search-bar-navigation-help-text-background", "kind": 1024, "kindString": "Property", @@ -33493,7 +33483,7 @@ } }, { - "id": 2833, + "id": 2834, "name": "--ts-var-search-bar-text-font-color", "kind": 1024, "kindString": "Property", @@ -33516,7 +33506,7 @@ } }, { - "id": 2834, + "id": 2835, "name": "--ts-var-search-bar-text-font-family", "kind": 1024, "kindString": "Property", @@ -33539,7 +33529,7 @@ } }, { - "id": 2835, + "id": 2836, "name": "--ts-var-search-bar-text-font-style", "kind": 1024, "kindString": "Property", @@ -33562,7 +33552,7 @@ } }, { - "id": 2830, + "id": 2831, "name": "--ts-var-search-data-button-background", "kind": 1024, "kindString": "Property", @@ -33585,7 +33575,7 @@ } }, { - "id": 2831, + "id": 2832, "name": "--ts-var-search-data-button-font-color", "kind": 1024, "kindString": "Property", @@ -33608,7 +33598,7 @@ } }, { - "id": 2832, + "id": 2833, "name": "--ts-var-search-data-button-font-family", "kind": 1024, "kindString": "Property", @@ -33631,7 +33621,7 @@ } }, { - "id": 2838, + "id": 2839, "name": "--ts-var-search-navigation-button-background", "kind": 1024, "kindString": "Property", @@ -33654,7 +33644,7 @@ } }, { - "id": 2903, + "id": 2904, "name": "--ts-var-segment-control-hover-background", "kind": 1024, "kindString": "Property", @@ -33677,7 +33667,7 @@ } }, { - "id": 2943, + "id": 2944, "name": "--ts-var-side-panel-width", "kind": 1024, "kindString": "Property", @@ -33700,7 +33690,7 @@ } }, { - "id": 2981, + "id": 2982, "name": "--ts-var-spotiq-analyze-crosscorrelation-card-background", "kind": 1024, "kindString": "Property", @@ -33723,7 +33713,7 @@ } }, { - "id": 2978, + "id": 2979, "name": "--ts-var-spotiq-analyze-forecasting-card-background", "kind": 1024, "kindString": "Property", @@ -33746,7 +33736,7 @@ } }, { - "id": 2979, + "id": 2980, "name": "--ts-var-spotiq-analyze-outlier-card-background", "kind": 1024, "kindString": "Property", @@ -33769,7 +33759,7 @@ } }, { - "id": 2980, + "id": 2981, "name": "--ts-var-spotiq-analyze-trend-card-background", "kind": 1024, "kindString": "Property", @@ -33792,7 +33782,7 @@ } }, { - "id": 2983, + "id": 2984, "name": "--ts-var-spotter-chat-width", "kind": 1024, "kindString": "Property", @@ -33815,7 +33805,7 @@ } }, { - "id": 2843, + "id": 2844, "name": "--ts-var-spotter-input-background", "kind": 1024, "kindString": "Property", @@ -33838,7 +33828,7 @@ } }, { - "id": 2844, + "id": 2845, "name": "--ts-var-spotter-prompt-background", "kind": 1024, "kindString": "Property", @@ -33861,7 +33851,7 @@ } }, { - "id": 2873, + "id": 2874, "name": "--ts-var-viz-background", "kind": 1024, "kindString": "Property", @@ -33884,7 +33874,7 @@ } }, { - "id": 2871, + "id": 2872, "name": "--ts-var-viz-border-radius", "kind": 1024, "kindString": "Property", @@ -33907,7 +33897,7 @@ } }, { - "id": 2872, + "id": 2873, "name": "--ts-var-viz-box-shadow", "kind": 1024, "kindString": "Property", @@ -33930,7 +33920,7 @@ } }, { - "id": 2868, + "id": 2869, "name": "--ts-var-viz-description-color", "kind": 1024, "kindString": "Property", @@ -33953,7 +33943,7 @@ } }, { - "id": 2869, + "id": 2870, "name": "--ts-var-viz-description-font-family", "kind": 1024, "kindString": "Property", @@ -33976,7 +33966,7 @@ } }, { - "id": 2870, + "id": 2871, "name": "--ts-var-viz-description-text-transform", "kind": 1024, "kindString": "Property", @@ -33999,7 +33989,7 @@ } }, { - "id": 2874, + "id": 2875, "name": "--ts-var-viz-legend-hover-background", "kind": 1024, "kindString": "Property", @@ -34022,7 +34012,7 @@ } }, { - "id": 2865, + "id": 2866, "name": "--ts-var-viz-title-color", "kind": 1024, "kindString": "Property", @@ -34045,7 +34035,7 @@ } }, { - "id": 2866, + "id": 2867, "name": "--ts-var-viz-title-font-family", "kind": 1024, "kindString": "Property", @@ -34068,7 +34058,7 @@ } }, { - "id": 2867, + "id": 2868, "name": "--ts-var-viz-title-text-transform", "kind": 1024, "kindString": "Property", @@ -34096,167 +34086,167 @@ "title": "Properties", "kind": 1024, "children": [ + 2877, 2876, - 2875, - 2845, 2846, - 2848, 2847, - 2827, - 2888, + 2849, + 2848, + 2828, 2889, - 2886, + 2890, 2887, - 2850, + 2888, + 2851, + 2856, + 2853, 2855, - 2852, 2854, - 2853, - 2851, + 2852, + 2861, + 2858, 2860, - 2857, 2859, - 2858, - 2856, + 2857, + 2865, 2864, 2863, 2862, - 2861, - 2849, - 2982, - 2977, + 2850, + 2983, + 2978, + 2973, 2972, - 2971, + 2975, 2974, - 2973, - 2911, - 2914, - 2909, 2912, - 2913, - 2908, + 2915, 2910, + 2913, + 2914, + 2909, + 2911, + 2882, 2881, - 2880, + 2884, 2883, - 2882, - 2879, - 2877, + 2880, 2878, - 2884, + 2879, 2885, - 2896, + 2886, 2897, - 2900, 2898, + 2901, 2899, + 2900, + 2908, 2907, 2906, 2905, - 2904, + 2971, 2970, 2969, - 2968, + 2977, 2976, - 2975, + 2903, 2902, - 2901, - 2929, + 2930, + 2943, 2942, - 2941, - 2939, 2940, - 2947, + 2941, + 2948, + 2946, 2945, - 2944, - 2930, 2931, - 2935, - 2923, + 2932, + 2936, + 2924, + 2939, 2938, + 2929, 2937, - 2928, - 2936, - 2926, 2927, - 2934, - 2924, + 2928, + 2935, 2925, - 2961, - 2958, + 2926, + 2962, 2959, 2960, - 2916, - 2967, - 2962, + 2961, + 2917, + 2968, 2963, - 2966, 2964, + 2967, 2965, - 2917, - 2915, + 2966, + 2918, + 2916, + 2934, 2933, - 2932, - 2946, - 2948, + 2947, 2949, - 2919, - 2918, + 2950, 2920, + 2919, 2921, 2922, - 2950, + 2923, 2951, - 2894, - 2891, - 2890, - 2892, + 2952, 2895, + 2892, + 2891, 2893, - 2828, + 2896, + 2894, 2829, - 2956, + 2830, 2957, - 2952, - 2954, - 2955, + 2958, 2953, - 2823, + 2955, + 2956, + 2954, 2824, 2825, 2826, - 2837, - 2841, + 2827, + 2838, 2842, + 2843, + 2841, + 2837, 2840, - 2836, - 2839, - 2833, 2834, 2835, - 2830, + 2836, 2831, 2832, - 2838, - 2903, - 2943, - 2981, - 2978, + 2833, + 2839, + 2904, + 2944, + 2982, 2979, 2980, - 2983, - 2843, + 2981, + 2984, 2844, - 2873, - 2871, + 2845, + 2874, 2872, - 2868, + 2873, 2869, 2870, - 2874, - 2865, + 2871, + 2875, 2866, - 2867 + 2867, + 2868 ] } ], @@ -34269,7 +34259,7 @@ ] }, { - "id": 2810, + "id": 2811, "name": "CustomStyles", "kind": 256, "kindString": "Interface", @@ -34279,7 +34269,7 @@ }, "children": [ { - "id": 2812, + "id": 2813, "name": "customCSS", "kind": 1024, "kindString": "Property", @@ -34295,12 +34285,12 @@ ], "type": { "type": "reference", - "id": 2813, + "id": 2814, "name": "customCssInterface" } }, { - "id": 2811, + "id": 2812, "name": "customCSSUrl", "kind": 1024, "kindString": "Property", @@ -34325,8 +34315,8 @@ "title": "Properties", "kind": 1024, "children": [ - 2812, - 2811 + 2813, + 2812 ] } ], @@ -34339,7 +34329,7 @@ ] }, { - "id": 2800, + "id": 2801, "name": "CustomisationsInterface", "kind": 256, "kindString": "Interface", @@ -34355,7 +34345,7 @@ }, "children": [ { - "id": 2802, + "id": 2803, "name": "content", "kind": 1024, "kindString": "Property", @@ -34372,14 +34362,14 @@ "type": { "type": "reflection", "declaration": { - "id": 2803, + "id": 2804, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2805, + "id": 2806, "name": "stringIDs", "kind": 1024, "kindString": "Property", @@ -34409,7 +34399,7 @@ } }, { - "id": 2806, + "id": 2807, "name": "stringIDsUrl", "kind": 1024, "kindString": "Property", @@ -34429,7 +34419,7 @@ } }, { - "id": 2804, + "id": 2805, "name": "strings", "kind": 1024, "kindString": "Property", @@ -34472,21 +34462,21 @@ "title": "Properties", "kind": 1024, "children": [ - 2805, 2806, - 2804 + 2807, + 2805 ] } ], "indexSignature": { - "id": 2807, + "id": 2808, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2808, + "id": 2809, "name": "key", "kind": 32768, "flags": {}, @@ -34505,7 +34495,7 @@ } }, { - "id": 2809, + "id": 2810, "name": "iconSpriteUrl", "kind": 1024, "kindString": "Property", @@ -34525,7 +34515,7 @@ } }, { - "id": 2801, + "id": 2802, "name": "style", "kind": 1024, "kindString": "Property", @@ -34541,7 +34531,7 @@ ], "type": { "type": "reference", - "id": 2810, + "id": 2811, "name": "CustomStyles" } } @@ -34551,9 +34541,9 @@ "title": "Properties", "kind": 1024, "children": [ - 2802, - 2809, - 2801 + 2803, + 2810, + 2802 ] } ], @@ -34566,7 +34556,7 @@ ] }, { - "id": 2369, + "id": 2370, "name": "EmbedConfig", "kind": 256, "kindString": "Interface", @@ -34582,7 +34572,7 @@ }, "children": [ { - "id": 2411, + "id": 2412, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -34612,20 +34602,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2412, + "id": 2413, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2413, + "id": 2414, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2414, + "id": 2415, "name": "key", "kind": 32768, "flags": {}, @@ -34657,7 +34647,7 @@ } }, { - "id": 2372, + "id": 2373, "name": "authEndpoint", "kind": 1024, "kindString": "Property", @@ -34665,7 +34655,7 @@ "isOptional": true }, "comment": { - "shortText": "[AuthServer] The trusted authentication endpoint to use to get the\nauthentication token. A `GET` request is made to the\nauthentication API endpoint, which returns the token\nas a plaintext response. For trusted authentication,\nthe `authEndpoint` or `getAuthToken` attribute is required." + "shortText": "[AuthServer] The trusted authentication endpoint to use to get the\nauthentication token. A `GET` request is made to the\nauthentication API endpoint, which returns the token\nas a plaintext response. For trusted authentication,\nthe `authEndpoint` or `getAuthToken` attribute is required." }, "sources": [ { @@ -34680,7 +34670,7 @@ } }, { - "id": 2393, + "id": 2394, "name": "authTriggerContainer", "kind": 1024, "kindString": "Property", @@ -34722,7 +34712,7 @@ } }, { - "id": 2395, + "id": 2396, "name": "authTriggerText", "kind": 1024, "kindString": "Property", @@ -34751,7 +34741,7 @@ } }, { - "id": 2371, + "id": 2372, "name": "authType", "kind": 1024, "kindString": "Property", @@ -34773,7 +34763,7 @@ } }, { - "id": 2384, + "id": 2385, "name": "autoLogin", "kind": 1024, "kindString": "Property", @@ -34802,7 +34792,7 @@ } }, { - "id": 2396, + "id": 2397, "name": "blockNonEmbedFullAppAccess", "kind": 1024, "kindString": "Property", @@ -34835,7 +34825,7 @@ } }, { - "id": 2387, + "id": 2388, "name": "callPrefetch", "kind": 1024, "kindString": "Property", @@ -34864,7 +34854,7 @@ } }, { - "id": 2420, + "id": 2421, "name": "cleanupTimeout", "kind": 1024, "kindString": "Property", @@ -34897,7 +34887,7 @@ } }, { - "id": 2408, + "id": 2409, "name": "currencyFormat", "kind": 1024, "kindString": "Property", @@ -34926,7 +34916,7 @@ } }, { - "id": 2418, + "id": 2419, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -34962,7 +34952,7 @@ } }, { - "id": 2415, + "id": 2416, "name": "customVariablesForThirdPartyTools", "kind": 1024, "kindString": "Property", @@ -35005,7 +34995,7 @@ } }, { - "id": 2392, + "id": 2393, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -35030,12 +35020,12 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" } }, { - "id": 2406, + "id": 2407, "name": "dateFormatLocale", "kind": 1024, "kindString": "Property", @@ -35064,7 +35054,7 @@ } }, { - "id": 2389, + "id": 2390, "name": "detectCookieAccessSlow", "kind": 1024, "kindString": "Property", @@ -35072,7 +35062,7 @@ "isOptional": true }, "comment": { - "shortText": "[AuthServer|Basic] Detect if third-party party cookies are enabled by doing an\nadditional call. This is slower and should be avoided. Listen to the\n`NO_COOKIE_ACCESS` event to handle the situation.", + "shortText": "[AuthServer|Basic] Detect if third-party cookies are enabled by doing an\nadditional call. This is slower and should be avoided. Listen to the\n`NO_COOKIE_ACCESS` event to handle the situation.", "text": "This is slightly slower than letting the browser handle the cookie check, as it\ninvolves an extra network call.", "tags": [ { @@ -35094,7 +35084,7 @@ } }, { - "id": 2417, + "id": 2418, "name": "disableFullscreenPresentation", "kind": 1024, "kindString": "Property", @@ -35131,7 +35121,7 @@ } }, { - "id": 2410, + "id": 2411, "name": "disableLoginFailurePage", "kind": 1024, "kindString": "Property", @@ -35160,7 +35150,7 @@ } }, { - "id": 2385, + "id": 2386, "name": "disableLoginRedirect", "kind": 1024, "kindString": "Property", @@ -35193,7 +35183,7 @@ } }, { - "id": 2416, + "id": 2417, "name": "disablePreauthCache", "kind": 1024, "kindString": "Property", @@ -35213,7 +35203,7 @@ } }, { - "id": 2405, + "id": 2406, "name": "disableSDKTracking", "kind": 1024, "kindString": "Property", @@ -35242,7 +35232,7 @@ } }, { - "id": 2383, + "id": 2384, "name": "ignoreNoCookieAccess", "kind": 1024, "kindString": "Property", @@ -35271,7 +35261,7 @@ } }, { - "id": 2378, + "id": 2379, "name": "inPopup", "kind": 1024, "kindString": "Property", @@ -35305,7 +35295,7 @@ } }, { - "id": 2404, + "id": 2405, "name": "logLevel", "kind": 1024, "kindString": "Property", @@ -35338,12 +35328,12 @@ ], "type": { "type": "reference", - "id": 2987, + "id": 2988, "name": "LogLevel" } }, { - "id": 2386, + "id": 2387, "name": "loginFailedMessage", "kind": 1024, "kindString": "Property", @@ -35372,7 +35362,7 @@ } }, { - "id": 2377, + "id": 2378, "name": "noRedirect", "kind": 1024, "kindString": "Property", @@ -35405,7 +35395,7 @@ } }, { - "id": 2407, + "id": 2408, "name": "numberFormatLocale", "kind": 1024, "kindString": "Property", @@ -35434,7 +35424,7 @@ } }, { - "id": 2376, + "id": 2377, "name": "password", "kind": 1024, "kindString": "Property", @@ -35458,7 +35448,7 @@ } }, { - "id": 2402, + "id": 2403, "name": "pendoTrackingKey", "kind": 1024, "kindString": "Property", @@ -35487,7 +35477,7 @@ } }, { - "id": 2388, + "id": 2389, "name": "queueMultiRenders", "kind": 1024, "kindString": "Property", @@ -35520,7 +35510,7 @@ } }, { - "id": 2379, + "id": 2380, "name": "redirectPath", "kind": 1024, "kindString": "Property", @@ -35550,7 +35540,7 @@ } }, { - "id": 2381, + "id": 2382, "name": "shouldEncodeUrlQueryParams", "kind": 1024, "kindString": "Property", @@ -35579,7 +35569,7 @@ } }, { - "id": 2403, + "id": 2404, "name": "suppressErrorAlerts", "kind": 1024, "kindString": "Property", @@ -35608,7 +35598,7 @@ } }, { - "id": 2382, + "id": 2383, "name": "suppressNoCookieAccessAlert", "kind": 1024, "kindString": "Property", @@ -35637,7 +35627,7 @@ } }, { - "id": 2391, + "id": 2392, "name": "suppressSageEmbedBetaWarning", "kind": 1024, "kindString": "Property", @@ -35660,7 +35650,7 @@ } }, { - "id": 2390, + "id": 2391, "name": "suppressSearchEmbedBetaWarning", "kind": 1024, "kindString": "Property", @@ -35689,7 +35679,7 @@ } }, { - "id": 2370, + "id": 2371, "name": "thoughtSpotHost", "kind": 1024, "kindString": "Property", @@ -35710,7 +35700,7 @@ } }, { - "id": 2394, + "id": 2395, "name": "useEventForSAMLPopup", "kind": 1024, "kindString": "Property", @@ -35733,7 +35723,7 @@ } }, { - "id": 2375, + "id": 2376, "name": "username", "kind": 1024, "kindString": "Property", @@ -35756,7 +35746,7 @@ } }, { - "id": 2419, + "id": 2420, "name": "waitForCleanupOnDestroy", "kind": 1024, "kindString": "Property", @@ -35789,7 +35779,7 @@ } }, { - "id": 2373, + "id": 2374, "name": "getAuthToken", "kind": 2048, "kindString": "Method", @@ -35805,7 +35795,7 @@ ], "signatures": [ { - "id": 2374, + "id": 2375, "name": "getAuthToken", "kind": 4096, "kindString": "Call signature", @@ -35833,52 +35823,52 @@ "title": "Properties", "kind": 1024, "children": [ - 2411, + 2412, + 2373, + 2394, + 2396, 2372, + 2385, + 2397, + 2388, + 2421, + 2409, + 2419, + 2416, 2393, - 2395, - 2371, - 2384, - 2396, - 2387, - 2420, - 2408, + 2407, + 2390, 2418, - 2415, - 2392, - 2406, - 2389, + 2411, + 2386, 2417, - 2410, - 2385, - 2416, + 2406, + 2384, + 2379, 2405, - 2383, + 2387, 2378, - 2404, - 2386, + 2408, 2377, - 2407, - 2376, - 2402, - 2388, - 2379, - 2381, 2403, + 2389, + 2380, 2382, + 2404, + 2383, + 2392, 2391, - 2390, - 2370, - 2394, - 2375, - 2419 + 2371, + 2395, + 2376, + 2420 ] }, { "title": "Methods", "kind": 2048, "children": [ - 2373 + 2374 ] } ], @@ -35891,7 +35881,7 @@ ] }, { - "id": 2759, + "id": 2760, "name": "FrameParams", "kind": 256, "kindString": "Interface", @@ -35907,7 +35897,7 @@ }, "children": [ { - "id": 2761, + "id": 2762, "name": "height", "kind": 1024, "kindString": "Property", @@ -35939,7 +35929,7 @@ } }, { - "id": 2762, + "id": 2763, "name": "loading", "kind": 1024, "kindString": "Property", @@ -35975,7 +35965,7 @@ } }, { - "id": 2760, + "id": 2761, "name": "width", "kind": 1024, "kindString": "Property", @@ -36012,9 +36002,9 @@ "title": "Properties", "kind": 1024, "children": [ - 2761, 2762, - 2760 + 2763, + 2761 ] } ], @@ -36026,7 +36016,7 @@ } ], "indexSignature": { - "id": 2763, + "id": 2764, "name": "__index", "kind": 8192, "kindString": "Index signature", @@ -36036,7 +36026,7 @@ }, "parameters": [ { - "id": 2764, + "id": 2765, "name": "key", "kind": 32768, "flags": {}, @@ -36070,7 +36060,7 @@ } }, { - "id": 2526, + "id": 2527, "name": "LiveboardViewConfig", "kind": 256, "kindString": "Interface", @@ -36086,7 +36076,7 @@ }, "children": [ { - "id": 2538, + "id": 2539, "name": "activeTabId", "kind": 1024, "kindString": "Property", @@ -36120,7 +36110,7 @@ } }, { - "id": 2561, + "id": 2562, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -36151,20 +36141,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2562, + "id": 2563, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2563, + "id": 2564, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2564, + "id": 2565, "name": "key", "kind": 32768, "flags": {}, @@ -36200,7 +36190,7 @@ } }, { - "id": 2590, + "id": 2591, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -36228,7 +36218,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1340, + "line": 1345, "character": 4 } ], @@ -36242,7 +36232,7 @@ } }, { - "id": 2587, + "id": 2588, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -36272,7 +36262,7 @@ ], "type": { "type": "reference", - "id": 2365, + "id": 2366, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -36281,7 +36271,7 @@ } }, { - "id": 2603, + "id": 2604, "name": "coverAndFilterOptionInPDF", "kind": 1024, "kindString": "Property", @@ -36305,7 +36295,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1560, + "line": 1565, "character": 4 } ], @@ -36319,7 +36309,7 @@ } }, { - "id": 2579, + "id": 2580, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -36360,7 +36350,7 @@ } }, { - "id": 2565, + "id": 2566, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -36389,7 +36379,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -36398,7 +36388,7 @@ } }, { - "id": 2591, + "id": 2592, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -36426,7 +36416,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1356, + "line": 1361, "character": 4 } ], @@ -36440,7 +36430,7 @@ } }, { - "id": 2528, + "id": 2529, "name": "defaultHeight", "kind": 1024, "kindString": "Property", @@ -36482,7 +36472,7 @@ } }, { - "id": 2573, + "id": 2574, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -36520,7 +36510,7 @@ } }, { - "id": 2557, + "id": 2558, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -36558,7 +36548,7 @@ } }, { - "id": 2556, + "id": 2557, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -36600,7 +36590,7 @@ } }, { - "id": 2569, + "id": 2570, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -36641,7 +36631,7 @@ } }, { - "id": 2597, + "id": 2598, "name": "enable2ColumnLayout", "kind": 1024, "kindString": "Property", @@ -36669,7 +36659,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1458, + "line": 1463, "character": 4 } ], @@ -36683,7 +36673,7 @@ } }, { - "id": 2602, + "id": 2603, "name": "enableAskSage", "kind": 1024, "kindString": "Property", @@ -36711,7 +36701,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1544, + "line": 1549, "character": 4 } ], @@ -36725,7 +36715,7 @@ } }, { - "id": 2592, + "id": 2593, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -36753,7 +36743,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1372, + "line": 1377, "character": 4 } ], @@ -36767,7 +36757,7 @@ } }, { - "id": 2570, + "id": 2571, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -36805,7 +36795,7 @@ } }, { - "id": 2530, + "id": 2531, "name": "enableVizTransformations", "kind": 1024, "kindString": "Property", @@ -36841,7 +36831,7 @@ } }, { - "id": 2588, + "id": 2589, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -36849,12 +36839,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\nwhen set to false, runtime filters will be included in the URL.", + "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime filters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -36865,7 +36855,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1315, + "line": 1317, "character": 4 } ], @@ -36879,7 +36869,7 @@ } }, { - "id": 2589, + "id": 2590, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -36887,12 +36877,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL.", + "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime parameters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -36903,7 +36893,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1325, + "line": 1330, "character": 4 } ], @@ -36917,7 +36907,7 @@ } }, { - "id": 2572, + "id": 2573, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -36954,7 +36944,7 @@ } }, { - "id": 2553, + "id": 2554, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -36984,7 +36974,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -36993,7 +36983,7 @@ } }, { - "id": 2527, + "id": 2528, "name": "fullHeight", "kind": 1024, "kindString": "Property", @@ -37027,7 +37017,7 @@ } }, { - "id": 2558, + "id": 2559, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -37073,7 +37063,7 @@ } }, { - "id": 2544, + "id": 2545, "name": "hiddenTabs", "kind": 1024, "kindString": "Property", @@ -37110,7 +37100,7 @@ } }, { - "id": 2600, + "id": 2601, "name": "hideIrrelevantChipsInLiveboardTabs", "kind": 1024, "kindString": "Property", @@ -37138,7 +37128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1511, + "line": 1516, "character": 4 } ], @@ -37152,7 +37142,7 @@ } }, { - "id": 2593, + "id": 2594, "name": "hideLiveboardHeader", "kind": 1024, "kindString": "Property", @@ -37180,7 +37170,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1394, + "line": 1399, "character": 4 } ], @@ -37194,7 +37184,7 @@ } }, { - "id": 2539, + "id": 2540, "name": "hideTabPanel", "kind": 1024, "kindString": "Property", @@ -37228,7 +37218,7 @@ } }, { - "id": 2566, + "id": 2567, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -37266,7 +37256,7 @@ } }, { - "id": 2584, + "id": 2585, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -37289,7 +37279,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -37303,7 +37293,7 @@ } }, { - "id": 2583, + "id": 2584, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -37326,7 +37316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -37343,7 +37333,7 @@ } }, { - "id": 2605, + "id": 2606, "name": "isCentralizedLiveboardFilterUXEnabled", "kind": 1024, "kindString": "Property", @@ -37367,7 +37357,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1594, + "line": 1599, "character": 4 } ], @@ -37381,7 +37371,7 @@ } }, { - "id": 2607, + "id": 2608, "name": "isEnhancedFilterInteractivityEnabled", "kind": 1024, "kindString": "Property", @@ -37405,7 +37395,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1625, + "line": 1630, "character": 4 } ], @@ -37419,7 +37409,7 @@ } }, { - "id": 2606, + "id": 2607, "name": "isLinkParametersEnabled", "kind": 1024, "kindString": "Property", @@ -37443,7 +37433,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1609, + "line": 1614, "character": 4 } ], @@ -37457,7 +37447,7 @@ } }, { - "id": 2598, + "id": 2599, "name": "isLiveboardCompactHeaderEnabled", "kind": 1024, "kindString": "Property", @@ -37485,7 +37475,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1475, + "line": 1480, "character": 4 } ], @@ -37499,7 +37489,7 @@ } }, { - "id": 2596, + "id": 2597, "name": "isLiveboardHeaderSticky", "kind": 1024, "kindString": "Property", @@ -37523,7 +37513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1441, + "line": 1446, "character": 4 } ], @@ -37537,7 +37527,7 @@ } }, { - "id": 2609, + "id": 2610, "name": "isLiveboardMasterpiecesEnabled", "kind": 1024, "kindString": "Property", @@ -37565,7 +37555,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1657, + "line": 1662, "character": 4 } ], @@ -37579,7 +37569,7 @@ } }, { - "id": 2546, + "id": 2547, "name": "isLiveboardStylingAndGroupingEnabled", "kind": 1024, "kindString": "Property", @@ -37613,7 +37603,7 @@ } }, { - "id": 2582, + "id": 2583, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -37633,7 +37623,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -37647,7 +37637,7 @@ } }, { - "id": 2547, + "id": 2548, "name": "isPNGInScheduledEmailsEnabled", "kind": 1024, "kindString": "Property", @@ -37681,7 +37671,7 @@ } }, { - "id": 2548, + "id": 2549, "name": "lazyLoadingForFullHeight", "kind": 1024, "kindString": "Property", @@ -37718,7 +37708,7 @@ } }, { - "id": 2549, + "id": 2550, "name": "lazyLoadingMargin", "kind": 1024, "kindString": "Property", @@ -37752,7 +37742,7 @@ } }, { - "id": 2575, + "id": 2576, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -37790,7 +37780,7 @@ } }, { - "id": 2531, + "id": 2532, "name": "liveboardId", "kind": 1024, "kindString": "Property", @@ -37824,7 +37814,7 @@ } }, { - "id": 2537, + "id": 2538, "name": "liveboardV2", "kind": 1024, "kindString": "Property", @@ -37858,7 +37848,7 @@ } }, { - "id": 2604, + "id": 2605, "name": "liveboardXLSXCSVDownload", "kind": 1024, "kindString": "Property", @@ -37882,7 +37872,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1576, + "line": 1581, "character": 4 } ], @@ -37896,7 +37886,7 @@ } }, { - "id": 2560, + "id": 2561, "name": "locale", "kind": 1024, "kindString": "Property", @@ -37934,7 +37924,7 @@ } }, { - "id": 2529, + "id": 2530, "name": "minimumHeight", "kind": 1024, "kindString": "Property", @@ -37971,7 +37961,7 @@ } }, { - "id": 2574, + "id": 2575, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -38009,7 +37999,7 @@ } }, { - "id": 2568, + "id": 2569, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -38047,7 +38037,7 @@ } }, { - "id": 2534, + "id": 2535, "name": "preventLiveboardFilterRemoval", "kind": 1024, "kindString": "Property", @@ -38081,7 +38071,7 @@ } }, { - "id": 2576, + "id": 2577, "name": "primaryAction", "kind": 1024, "kindString": "Property", @@ -38119,7 +38109,7 @@ } }, { - "id": 2585, + "id": 2586, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -38161,7 +38151,7 @@ } }, { - "id": 2586, + "id": 2587, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -38193,7 +38183,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } }, @@ -38203,7 +38193,7 @@ } }, { - "id": 2580, + "id": 2581, "name": "shouldBypassPayloadValidation", "kind": 1024, "kindString": "Property", @@ -38244,7 +38234,7 @@ } }, { - "id": 2578, + "id": 2579, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -38281,7 +38271,7 @@ } }, { - "id": 2595, + "id": 2596, "name": "showLiveboardDescription", "kind": 1024, "kindString": "Property", @@ -38309,7 +38299,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1426, + "line": 1431, "character": 4 } ], @@ -38323,7 +38313,7 @@ } }, { - "id": 2601, + "id": 2602, "name": "showLiveboardReverifyBanner", "kind": 1024, "kindString": "Property", @@ -38351,7 +38341,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1528, + "line": 1533, "character": 4 } ], @@ -38365,7 +38355,7 @@ } }, { - "id": 2594, + "id": 2595, "name": "showLiveboardTitle", "kind": 1024, "kindString": "Property", @@ -38393,7 +38383,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1410, + "line": 1415, "character": 4 } ], @@ -38407,7 +38397,7 @@ } }, { - "id": 2599, + "id": 2600, "name": "showLiveboardVerifiedBadge", "kind": 1024, "kindString": "Property", @@ -38435,7 +38425,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1492, + "line": 1497, "character": 4 } ], @@ -38449,7 +38439,7 @@ } }, { - "id": 2608, + "id": 2609, "name": "showMaskedFilterChip", "kind": 1024, "kindString": "Property", @@ -38477,7 +38467,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1641, + "line": 1646, "character": 4 } ], @@ -38491,7 +38481,7 @@ } }, { - "id": 2540, + "id": 2541, "name": "showPreviewLoader", "kind": 1024, "kindString": "Property", @@ -38525,7 +38515,7 @@ } }, { - "id": 2550, + "id": 2551, "name": "showSpotterLimitations", "kind": 1024, "kindString": "Property", @@ -38558,7 +38548,7 @@ } }, { - "id": 2551, + "id": 2552, "name": "updatedSpotterChatPrompt", "kind": 1024, "kindString": "Property", @@ -38596,7 +38586,7 @@ } }, { - "id": 2581, + "id": 2582, "name": "useHostEventsV2", "kind": 1024, "kindString": "Property", @@ -38637,7 +38627,7 @@ } }, { - "id": 2559, + "id": 2560, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -38683,7 +38673,7 @@ } }, { - "id": 2545, + "id": 2546, "name": "visibleTabs", "kind": 1024, "kindString": "Property", @@ -38720,7 +38710,7 @@ } }, { - "id": 2535, + "id": 2536, "name": "visibleVizs", "kind": 1024, "kindString": "Property", @@ -38757,7 +38747,7 @@ } }, { - "id": 2533, + "id": 2534, "name": "vizId", "kind": 1024, "kindString": "Property", @@ -38796,75 +38786,75 @@ "title": "Properties", "kind": 1024, "children": [ - 2538, - 2561, - 2590, - 2587, - 2603, - 2579, - 2565, + 2539, + 2562, 2591, - 2528, - 2573, - 2557, - 2556, - 2569, - 2597, - 2602, - 2592, - 2570, - 2530, 2588, - 2589, - 2572, - 2553, - 2527, + 2604, + 2580, + 2566, + 2592, + 2529, + 2574, 2558, - 2544, - 2600, + 2557, + 2570, + 2598, + 2603, 2593, - 2539, - 2566, + 2571, + 2531, + 2589, + 2590, + 2573, + 2554, + 2528, + 2559, + 2545, + 2601, + 2594, + 2540, + 2567, + 2585, 2584, - 2583, - 2605, - 2607, 2606, - 2598, - 2596, - 2609, - 2546, - 2582, + 2608, + 2607, + 2599, + 2597, + 2610, 2547, + 2583, 2548, 2549, - 2575, - 2531, - 2537, - 2604, - 2560, - 2529, - 2574, - 2568, - 2534, + 2550, 2576, - 2585, + 2532, + 2538, + 2605, + 2561, + 2530, + 2575, + 2569, + 2535, + 2577, 2586, - 2580, - 2578, + 2587, + 2581, + 2579, + 2596, + 2602, 2595, - 2601, - 2594, - 2599, - 2608, - 2540, - 2550, + 2600, + 2609, + 2541, 2551, - 2581, - 2559, - 2545, - 2535, - 2533 + 2552, + 2582, + 2560, + 2546, + 2536, + 2534 ] } ], @@ -38912,7 +38902,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1862, + "line": 1875, "character": 4 } ], @@ -38933,7 +38923,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1866, + "line": 1879, "character": 4 } ], @@ -38955,7 +38945,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1872, + "line": 1885, "character": 4 } ], @@ -38999,13 +38989,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1858, + "line": 1871, "character": 17 } ] }, { - "id": 2984, + "id": 2985, "name": "RuntimeParameter", "kind": 256, "kindString": "Interface", @@ -39015,7 +39005,7 @@ }, "children": [ { - "id": 2985, + "id": 2986, "name": "name", "kind": 1024, "kindString": "Property", @@ -39026,7 +39016,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1882, + "line": 1895, "character": 4 } ], @@ -39036,7 +39026,7 @@ } }, { - "id": 2986, + "id": 2987, "name": "value", "kind": 1024, "kindString": "Property", @@ -39047,7 +39037,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1886, + "line": 1899, "character": 4 } ], @@ -39075,21 +39065,21 @@ "title": "Properties", "kind": 1024, "children": [ - 2985, - 2986 + 2986, + 2987 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1878, + "line": 1891, "character": 17 } ] }, { - "id": 2610, + "id": 2611, "name": "SageViewConfig", "kind": 256, "kindString": "Interface", @@ -39109,7 +39099,7 @@ }, "children": [ { - "id": 2639, + "id": 2640, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -39140,20 +39130,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2640, + "id": 2641, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2641, + "id": 2642, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2642, + "id": 2643, "name": "key", "kind": 32768, "flags": {}, @@ -39189,7 +39179,7 @@ } }, { - "id": 2627, + "id": 2628, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -39217,7 +39207,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1340, + "line": 1345, "character": 4 } ], @@ -39231,7 +39221,7 @@ } }, { - "id": 2624, + "id": 2625, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -39261,7 +39251,7 @@ ], "type": { "type": "reference", - "id": 2365, + "id": 2366, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -39270,7 +39260,7 @@ } }, { - "id": 2656, + "id": 2657, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -39311,7 +39301,7 @@ } }, { - "id": 2643, + "id": 2644, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -39340,7 +39330,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -39349,7 +39339,7 @@ } }, { - "id": 2628, + "id": 2629, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -39377,7 +39367,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1356, + "line": 1361, "character": 4 } ], @@ -39391,7 +39381,7 @@ } }, { - "id": 2620, + "id": 2621, "name": "dataSource", "kind": 1024, "kindString": "Property", @@ -39414,7 +39404,7 @@ } }, { - "id": 2651, + "id": 2652, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -39452,7 +39442,7 @@ } }, { - "id": 2615, + "id": 2616, "name": "disableWorksheetChange", "kind": 1024, "kindString": "Property", @@ -39481,7 +39471,7 @@ } }, { - "id": 2635, + "id": 2636, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -39519,7 +39509,7 @@ } }, { - "id": 2634, + "id": 2635, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -39561,7 +39551,7 @@ } }, { - "id": 2647, + "id": 2648, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -39602,7 +39592,7 @@ } }, { - "id": 2629, + "id": 2630, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -39630,7 +39620,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1372, + "line": 1377, "character": 4 } ], @@ -39644,7 +39634,7 @@ } }, { - "id": 2648, + "id": 2649, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -39682,7 +39672,7 @@ } }, { - "id": 2625, + "id": 2626, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -39690,12 +39680,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\nwhen set to false, runtime filters will be included in the URL.", + "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime filters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -39706,7 +39696,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1315, + "line": 1317, "character": 4 } ], @@ -39720,7 +39710,7 @@ } }, { - "id": 2626, + "id": 2627, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -39728,12 +39718,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL.", + "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime parameters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -39744,7 +39734,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1325, + "line": 1330, "character": 4 } ], @@ -39758,7 +39748,7 @@ } }, { - "id": 2650, + "id": 2651, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -39795,7 +39785,7 @@ } }, { - "id": 2631, + "id": 2632, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -39825,7 +39815,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -39834,7 +39824,7 @@ } }, { - "id": 2636, + "id": 2637, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -39880,7 +39870,7 @@ } }, { - "id": 2617, + "id": 2618, "name": "hideAutocompleteSuggestions", "kind": 1024, "kindString": "Property", @@ -39909,7 +39899,7 @@ } }, { - "id": 2614, + "id": 2615, "name": "hideSageAnswerHeader", "kind": 1024, "kindString": "Property", @@ -39938,7 +39928,7 @@ } }, { - "id": 2619, + "id": 2620, "name": "hideSampleQuestions", "kind": 1024, "kindString": "Property", @@ -39972,7 +39962,7 @@ } }, { - "id": 2613, + "id": 2614, "name": "hideSearchBarTitle", "kind": 1024, "kindString": "Property", @@ -40005,7 +39995,7 @@ } }, { - "id": 2616, + "id": 2617, "name": "hideWorksheetSelector", "kind": 1024, "kindString": "Property", @@ -40034,7 +40024,7 @@ } }, { - "id": 2644, + "id": 2645, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -40072,7 +40062,7 @@ } }, { - "id": 2661, + "id": 2662, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -40095,7 +40085,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -40109,7 +40099,7 @@ } }, { - "id": 2660, + "id": 2661, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -40132,7 +40122,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -40149,7 +40139,7 @@ } }, { - "id": 2659, + "id": 2660, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -40169,7 +40159,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -40183,7 +40173,7 @@ } }, { - "id": 2653, + "id": 2654, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -40221,7 +40211,7 @@ } }, { - "id": 2638, + "id": 2639, "name": "locale", "kind": 1024, "kindString": "Property", @@ -40259,7 +40249,7 @@ } }, { - "id": 2652, + "id": 2653, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -40297,7 +40287,7 @@ } }, { - "id": 2646, + "id": 2647, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -40335,7 +40325,7 @@ } }, { - "id": 2622, + "id": 2623, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -40377,7 +40367,7 @@ } }, { - "id": 2623, + "id": 2624, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -40409,7 +40399,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } }, @@ -40419,7 +40409,7 @@ } }, { - "id": 2621, + "id": 2622, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -40453,7 +40443,7 @@ } }, { - "id": 2657, + "id": 2658, "name": "shouldBypassPayloadValidation", "kind": 1024, "kindString": "Property", @@ -40494,7 +40484,7 @@ } }, { - "id": 2655, + "id": 2656, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -40531,7 +40521,7 @@ } }, { - "id": 2611, + "id": 2612, "name": "showObjectResults", "kind": 1024, "kindString": "Property", @@ -40560,7 +40550,7 @@ } }, { - "id": 2618, + "id": 2619, "name": "showObjectSuggestions", "kind": 1024, "kindString": "Property", @@ -40589,7 +40579,7 @@ } }, { - "id": 2658, + "id": 2659, "name": "useHostEventsV2", "kind": 1024, "kindString": "Property", @@ -40630,7 +40620,7 @@ } }, { - "id": 2637, + "id": 2638, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -40681,47 +40671,47 @@ "title": "Properties", "kind": 1024, "children": [ - 2639, - 2627, - 2624, - 2656, - 2643, + 2640, 2628, - 2620, - 2651, - 2615, - 2635, - 2634, - 2647, + 2625, + 2657, + 2644, 2629, + 2621, + 2652, + 2616, + 2636, + 2635, 2648, - 2625, + 2630, + 2649, 2626, - 2650, - 2631, - 2636, - 2617, + 2627, + 2651, + 2632, + 2637, + 2618, + 2615, + 2620, 2614, - 2619, - 2613, - 2616, - 2644, + 2617, + 2645, + 2662, 2661, 2660, - 2659, + 2654, + 2639, 2653, - 2638, - 2652, - 2646, - 2622, + 2647, 2623, - 2621, - 2657, - 2655, - 2611, - 2618, + 2624, + 2622, 2658, - 2637 + 2656, + 2612, + 2619, + 2659, + 2638 ] } ], @@ -40775,7 +40765,7 @@ ] }, { - "id": 2479, + "id": 2480, "name": "SearchBarViewConfig", "kind": 256, "kindString": "Interface", @@ -40790,7 +40780,7 @@ }, "children": [ { - "id": 2494, + "id": 2495, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -40821,20 +40811,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2495, + "id": 2496, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2496, + "id": 2497, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2497, + "id": 2498, "name": "key", "kind": 32768, "flags": {}, @@ -40870,7 +40860,7 @@ } }, { - "id": 2523, + "id": 2524, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -40898,7 +40888,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1340, + "line": 1345, "character": 4 } ], @@ -40912,7 +40902,7 @@ } }, { - "id": 2520, + "id": 2521, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -40942,7 +40932,7 @@ ], "type": { "type": "reference", - "id": 2365, + "id": 2366, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -40951,7 +40941,7 @@ } }, { - "id": 2512, + "id": 2513, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -40992,7 +40982,7 @@ } }, { - "id": 2498, + "id": 2499, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -41021,7 +41011,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -41030,7 +41020,7 @@ } }, { - "id": 2524, + "id": 2525, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -41058,7 +41048,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1356, + "line": 1361, "character": 4 } ], @@ -41072,7 +41062,7 @@ } }, { - "id": 2481, + "id": 2482, "name": "dataSource", "kind": 1024, "kindString": "Property", @@ -41106,7 +41096,7 @@ } }, { - "id": 2480, + "id": 2481, "name": "dataSources", "kind": 1024, "kindString": "Property", @@ -41147,7 +41137,7 @@ } }, { - "id": 2506, + "id": 2507, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -41185,7 +41175,7 @@ } }, { - "id": 2490, + "id": 2491, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -41223,7 +41213,7 @@ } }, { - "id": 2489, + "id": 2490, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -41265,7 +41255,7 @@ } }, { - "id": 2502, + "id": 2503, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -41306,7 +41296,7 @@ } }, { - "id": 2525, + "id": 2526, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -41334,7 +41324,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1372, + "line": 1377, "character": 4 } ], @@ -41348,7 +41338,7 @@ } }, { - "id": 2503, + "id": 2504, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -41386,7 +41376,7 @@ } }, { - "id": 2521, + "id": 2522, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -41394,12 +41384,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\nwhen set to false, runtime filters will be included in the URL.", + "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime filters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -41410,7 +41400,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1315, + "line": 1317, "character": 4 } ], @@ -41424,7 +41414,7 @@ } }, { - "id": 2522, + "id": 2523, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -41432,12 +41422,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL.", + "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime parameters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -41448,7 +41438,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1325, + "line": 1330, "character": 4 } ], @@ -41462,7 +41452,7 @@ } }, { - "id": 2484, + "id": 2485, "name": "excludeSearchTokenStringFromURL", "kind": 1024, "kindString": "Property", @@ -41496,7 +41486,7 @@ } }, { - "id": 2505, + "id": 2506, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -41533,7 +41523,7 @@ } }, { - "id": 2486, + "id": 2487, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -41563,7 +41553,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -41572,7 +41562,7 @@ } }, { - "id": 2491, + "id": 2492, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -41618,7 +41608,7 @@ } }, { - "id": 2499, + "id": 2500, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -41656,7 +41646,7 @@ } }, { - "id": 2517, + "id": 2518, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -41679,7 +41669,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -41693,7 +41683,7 @@ } }, { - "id": 2516, + "id": 2517, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -41716,7 +41706,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -41733,7 +41723,7 @@ } }, { - "id": 2515, + "id": 2516, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -41753,7 +41743,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -41767,7 +41757,7 @@ } }, { - "id": 2508, + "id": 2509, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -41805,7 +41795,7 @@ } }, { - "id": 2493, + "id": 2494, "name": "locale", "kind": 1024, "kindString": "Property", @@ -41843,7 +41833,7 @@ } }, { - "id": 2507, + "id": 2508, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -41881,7 +41871,7 @@ } }, { - "id": 2501, + "id": 2502, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -41919,7 +41909,7 @@ } }, { - "id": 2509, + "id": 2510, "name": "primaryAction", "kind": 1024, "kindString": "Property", @@ -41957,7 +41947,7 @@ } }, { - "id": 2518, + "id": 2519, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -41999,7 +41989,7 @@ } }, { - "id": 2519, + "id": 2520, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -42031,7 +42021,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } }, @@ -42041,7 +42031,7 @@ } }, { - "id": 2483, + "id": 2484, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -42075,7 +42065,7 @@ } }, { - "id": 2513, + "id": 2514, "name": "shouldBypassPayloadValidation", "kind": 1024, "kindString": "Property", @@ -42116,7 +42106,7 @@ } }, { - "id": 2511, + "id": 2512, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -42153,7 +42143,7 @@ } }, { - "id": 2514, + "id": 2515, "name": "useHostEventsV2", "kind": 1024, "kindString": "Property", @@ -42194,7 +42184,7 @@ } }, { - "id": 2482, + "id": 2483, "name": "useLastSelectedSources", "kind": 1024, "kindString": "Property", @@ -42228,7 +42218,7 @@ } }, { - "id": 2492, + "id": 2493, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -42279,43 +42269,43 @@ "title": "Properties", "kind": 1024, "children": [ - 2494, - 2523, - 2520, - 2512, - 2498, + 2495, 2524, + 2521, + 2513, + 2499, + 2525, + 2482, 2481, - 2480, - 2506, + 2507, + 2491, 2490, - 2489, - 2502, - 2525, 2503, - 2521, + 2526, + 2504, 2522, - 2484, - 2505, - 2486, - 2491, - 2499, + 2523, + 2485, + 2506, + 2487, + 2492, + 2500, + 2518, 2517, 2516, - 2515, - 2508, - 2493, - 2507, - 2501, 2509, - 2518, + 2494, + 2508, + 2502, + 2510, 2519, - 2483, - 2513, - 2511, + 2520, + 2484, 2514, - 2482, - 2492 + 2512, + 2515, + 2483, + 2493 ] } ], @@ -42338,7 +42328,7 @@ ] }, { - "id": 2421, + "id": 2422, "name": "SearchViewConfig", "kind": 256, "kindString": "Interface", @@ -42354,7 +42344,7 @@ }, "children": [ { - "id": 2456, + "id": 2457, "name": "additionalFlags", "kind": 1024, "kindString": "Property", @@ -42385,20 +42375,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2457, + "id": 2458, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2458, + "id": 2459, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2459, + "id": 2460, "name": "key", "kind": 32768, "flags": {}, @@ -42434,7 +42424,7 @@ } }, { - "id": 2433, + "id": 2434, "name": "answerId", "kind": 1024, "kindString": "Property", @@ -42468,7 +42458,7 @@ } }, { - "id": 2423, + "id": 2424, "name": "collapseDataPanel", "kind": 1024, "kindString": "Property", @@ -42502,7 +42492,7 @@ } }, { - "id": 2422, + "id": 2423, "name": "collapseDataSources", "kind": 1024, "kindString": "Property", @@ -42536,7 +42526,7 @@ } }, { - "id": 2444, + "id": 2445, "name": "collapseSearchBar", "kind": 1024, "kindString": "Property", @@ -42564,7 +42554,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1340, + "line": 1345, "character": 4 } ], @@ -42578,7 +42568,7 @@ } }, { - "id": 2436, + "id": 2437, "name": "collapseSearchBarInitially", "kind": 1024, "kindString": "Property", @@ -42615,7 +42605,7 @@ } }, { - "id": 2441, + "id": 2442, "name": "contextMenuTrigger", "kind": 1024, "kindString": "Property", @@ -42645,7 +42635,7 @@ ], "type": { "type": "reference", - "id": 2365, + "id": 2366, "name": "ContextMenuTriggerOptions" }, "inheritedFrom": { @@ -42654,7 +42644,7 @@ } }, { - "id": 2473, + "id": 2474, "name": "customActions", "kind": 1024, "kindString": "Property", @@ -42695,7 +42685,7 @@ } }, { - "id": 2460, + "id": 2461, "name": "customizations", "kind": 1024, "kindString": "Property", @@ -42724,7 +42714,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -42733,7 +42723,7 @@ } }, { - "id": 2437, + "id": 2438, "name": "dataPanelCustomGroupsAccordionInitialState", "kind": 1024, "kindString": "Property", @@ -42771,7 +42761,7 @@ } }, { - "id": 2445, + "id": 2446, "name": "dataPanelV2", "kind": 1024, "kindString": "Property", @@ -42799,7 +42789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1356, + "line": 1361, "character": 4 } ], @@ -42813,7 +42803,7 @@ } }, { - "id": 2429, + "id": 2430, "name": "dataSource", "kind": 1024, "kindString": "Property", @@ -42847,7 +42837,7 @@ } }, { - "id": 2428, + "id": 2429, "name": "dataSources", "kind": 1024, "kindString": "Property", @@ -42883,7 +42873,7 @@ } }, { - "id": 2468, + "id": 2469, "name": "disableRedirectionLinksInNewTab", "kind": 1024, "kindString": "Property", @@ -42921,7 +42911,7 @@ } }, { - "id": 2452, + "id": 2453, "name": "disabledActionReason", "kind": 1024, "kindString": "Property", @@ -42959,7 +42949,7 @@ } }, { - "id": 2451, + "id": 2452, "name": "disabledActions", "kind": 1024, "kindString": "Property", @@ -43001,7 +42991,7 @@ } }, { - "id": 2464, + "id": 2465, "name": "doNotTrackPreRenderSize", "kind": 1024, "kindString": "Property", @@ -43042,7 +43032,7 @@ } }, { - "id": 2446, + "id": 2447, "name": "enableCustomColumnGroups", "kind": 1024, "kindString": "Property", @@ -43070,7 +43060,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1372, + "line": 1377, "character": 4 } ], @@ -43084,7 +43074,7 @@ } }, { - "id": 2426, + "id": 2427, "name": "enableSearchAssist", "kind": 1024, "kindString": "Property", @@ -43118,7 +43108,7 @@ } }, { - "id": 2465, + "id": 2466, "name": "enableV2Shell_experimental", "kind": 1024, "kindString": "Property", @@ -43156,7 +43146,7 @@ } }, { - "id": 2442, + "id": 2443, "name": "excludeRuntimeFiltersfromURL", "kind": 1024, "kindString": "Property", @@ -43164,12 +43154,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\nwhen set to false, runtime filters will be included in the URL.", + "shortText": "Boolean to exclude runtimeFilters in the URL\nBy default it is true, this flag removes runtime filters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime filters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -43180,7 +43170,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1315, + "line": 1317, "character": 4 } ], @@ -43194,7 +43184,7 @@ } }, { - "id": 2443, + "id": 2444, "name": "excludeRuntimeParametersfromURL", "kind": 1024, "kindString": "Property", @@ -43202,12 +43192,12 @@ "isOptional": true }, "comment": { - "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL.", + "shortText": "Boolean to exclude runtimeParameters from the URL\nwhen set to true, this flag removes runtime parameters from the URL\n(default behavior from SDK 1.45.0).\nwhen set to false, runtime parameters will be included in the URL\n(default behavior before SDK 1.45.0).", "text": "Irrespective of this flag, runtime filters ( if passed ) will be applied to the\nembedded view.", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -43218,7 +43208,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1325, + "line": 1330, "character": 4 } ], @@ -43232,7 +43222,7 @@ } }, { - "id": 2432, + "id": 2433, "name": "excludeSearchTokenStringFromURL", "kind": 1024, "kindString": "Property", @@ -43266,7 +43256,7 @@ } }, { - "id": 2467, + "id": 2468, "name": "exposeTranslationIDs", "kind": 1024, "kindString": "Property", @@ -43303,7 +43293,7 @@ } }, { - "id": 2438, + "id": 2439, "name": "focusSearchBarOnRender", "kind": 1024, "kindString": "Property", @@ -43341,7 +43331,7 @@ } }, { - "id": 2427, + "id": 2428, "name": "forceTable", "kind": 1024, "kindString": "Property", @@ -43375,7 +43365,7 @@ } }, { - "id": 2448, + "id": 2449, "name": "frameParams", "kind": 1024, "kindString": "Property", @@ -43405,7 +43395,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -43414,7 +43404,7 @@ } }, { - "id": 2453, + "id": 2454, "name": "hiddenActions", "kind": 1024, "kindString": "Property", @@ -43460,7 +43450,7 @@ } }, { - "id": 2424, + "id": 2425, "name": "hideDataSources", "kind": 1024, "kindString": "Property", @@ -43494,7 +43484,7 @@ } }, { - "id": 2425, + "id": 2426, "name": "hideResults", "kind": 1024, "kindString": "Property", @@ -43528,7 +43518,7 @@ } }, { - "id": 2434, + "id": 2435, "name": "hideSearchBar", "kind": 1024, "kindString": "Property", @@ -43562,7 +43552,7 @@ } }, { - "id": 2461, + "id": 2462, "name": "insertAsSibling", "kind": 1024, "kindString": "Property", @@ -43600,7 +43590,7 @@ } }, { - "id": 2478, + "id": 2479, "name": "interceptTimeout", "kind": 1024, "kindString": "Property", @@ -43623,7 +43613,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -43637,7 +43627,7 @@ } }, { - "id": 2477, + "id": 2478, "name": "interceptUrls", "kind": 1024, "kindString": "Property", @@ -43660,7 +43650,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -43677,7 +43667,7 @@ } }, { - "id": 2476, + "id": 2477, "name": "isOnBeforeGetVizDataInterceptEnabled", "kind": 1024, "kindString": "Property", @@ -43697,7 +43687,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -43711,7 +43701,7 @@ } }, { - "id": 2470, + "id": 2471, "name": "linkOverride", "kind": 1024, "kindString": "Property", @@ -43749,7 +43739,7 @@ } }, { - "id": 2455, + "id": 2456, "name": "locale", "kind": 1024, "kindString": "Property", @@ -43787,7 +43777,7 @@ } }, { - "id": 2469, + "id": 2470, "name": "overrideOrgId", "kind": 1024, "kindString": "Property", @@ -43825,7 +43815,7 @@ } }, { - "id": 2463, + "id": 2464, "name": "preRenderId", "kind": 1024, "kindString": "Property", @@ -43863,7 +43853,7 @@ } }, { - "id": 2439, + "id": 2440, "name": "runtimeFilters", "kind": 1024, "kindString": "Property", @@ -43905,7 +43895,7 @@ } }, { - "id": 2440, + "id": 2441, "name": "runtimeParameters", "kind": 1024, "kindString": "Property", @@ -43937,7 +43927,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } }, @@ -43947,7 +43937,7 @@ } }, { - "id": 2431, + "id": 2432, "name": "searchOptions", "kind": 1024, "kindString": "Property", @@ -43977,7 +43967,7 @@ } }, { - "id": 2430, + "id": 2431, "name": "searchQuery", "kind": 1024, "kindString": "Property", @@ -44006,7 +43996,7 @@ } }, { - "id": 2474, + "id": 2475, "name": "shouldBypassPayloadValidation", "kind": 1024, "kindString": "Property", @@ -44047,7 +44037,7 @@ } }, { - "id": 2472, + "id": 2473, "name": "showAlerts", "kind": 1024, "kindString": "Property", @@ -44084,7 +44074,7 @@ } }, { - "id": 2475, + "id": 2476, "name": "useHostEventsV2", "kind": 1024, "kindString": "Property", @@ -44125,7 +44115,7 @@ } }, { - "id": 2435, + "id": 2436, "name": "useLastSelectedSources", "kind": 1024, "kindString": "Property", @@ -44155,7 +44145,7 @@ } }, { - "id": 2454, + "id": 2455, "name": "visibleActions", "kind": 1024, "kindString": "Property", @@ -44206,54 +44196,54 @@ "title": "Properties", "kind": 1024, "children": [ - 2456, - 2433, + 2457, + 2434, + 2424, 2423, - 2422, - 2444, - 2436, - 2441, - 2473, - 2460, - 2437, 2445, + 2437, + 2442, + 2474, + 2461, + 2438, + 2446, + 2430, 2429, - 2428, - 2468, + 2469, + 2453, 2452, - 2451, - 2464, - 2446, - 2426, 2465, - 2442, - 2443, - 2432, - 2467, - 2438, + 2447, 2427, - 2448, - 2453, - 2424, + 2466, + 2443, + 2444, + 2433, + 2468, + 2439, + 2428, + 2449, + 2454, 2425, - 2434, - 2461, + 2426, + 2435, + 2462, + 2479, 2478, 2477, - 2476, + 2471, + 2456, 2470, - 2455, - 2469, - 2463, - 2439, + 2464, 2440, + 2441, + 2432, 2431, - 2430, - 2474, - 2472, 2475, - 2435, - 2454 + 2473, + 2476, + 2436, + 2455 ] } ], @@ -44587,7 +44577,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -44860,7 +44850,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -44976,7 +44966,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -45013,7 +45003,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -45050,7 +45040,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -45632,7 +45622,7 @@ ], "type": { "type": "reference", - "id": 2800, + "id": 2801, "name": "CustomisationsInterface" }, "inheritedFrom": { @@ -45900,7 +45890,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 183, + "line": 187, "character": 4 } ], @@ -45956,12 +45946,12 @@ "isOptional": true }, "comment": { - "shortText": "Flag to control whether runtime filters should be included in the URL.\nIf true, filters will be passed via app initialization payload instead.\nIf false/undefined, filters will be added to URL (default behavior).", + "shortText": "Flag to control whether runtime filters should be included in the URL.\nIf true, filters will be passed via app initialization payload\n(default behavior from SDK 1.45.0).\nIf false/undefined, filters are appended to the iframe URL instead.\n(default behavior before SDK 1.45.0).", "text": "Supported embed types: `SpotterEmbed`", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -45972,7 +45962,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 138, + "line": 140, "character": 4 } ], @@ -45990,12 +45980,12 @@ "isOptional": true }, "comment": { - "shortText": "Flag to control whether runtime parameters should be included in the URL.\nIf true, parameters will be passed via app initialization payload instead.\nIf false/undefined, parameters will be added to URL (default behavior).", + "shortText": "Flag to control whether runtime parameters should be included in the URL.\nIf true, parameters will be passed via app\ninitialization payload (default behavior from SDK 1.45.0).\nIf false/undefined, parameters are appended to\nthe iframe URL instead (default behavior before SDK 1.45.0).", "text": "Supported embed types: `SpotterEmbed`", "tags": [ { "tag": "default", - "text": "false" + "text": "true" }, { "tag": "version", @@ -46006,7 +45996,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 167, + "line": 171, "character": 4 } ], @@ -46083,7 +46073,7 @@ ], "type": { "type": "reference", - "id": 2759, + "id": 2760, "name": "FrameParams" }, "inheritedFrom": { @@ -46267,7 +46257,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6552, + "line": 6557, "character": 4 } ], @@ -46304,7 +46294,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6535, + "line": 6540, "character": 4 } ], @@ -46341,7 +46331,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6519, + "line": 6524, "character": 4 } ], @@ -46569,7 +46559,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 157, + "line": 159, "character": 4 } ], @@ -46577,7 +46567,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2984, + "id": 2985, "name": "RuntimeParameter" } } @@ -46746,7 +46736,7 @@ "sources": [ { "fileName": "embed/conversation.ts", - "line": 199, + "line": 203, "character": 4 } ], @@ -47002,14 +46992,14 @@ ] }, { - "id": 3022, + "id": 3023, "name": "VizPoint", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 3023, + "id": 3024, "name": "selectedAttributes", "kind": 1024, "kindString": "Property", @@ -47017,7 +47007,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6154, + "line": 6171, "character": 4 } ], @@ -47030,7 +47020,7 @@ } }, { - "id": 3024, + "id": 3025, "name": "selectedMeasures", "kind": 1024, "kindString": "Property", @@ -47038,7 +47028,7 @@ "sources": [ { "fileName": "types.ts", - "line": 6155, + "line": 6172, "character": 4 } ], @@ -47056,21 +47046,21 @@ "title": "Properties", "kind": 1024, "children": [ - 3023, - 3024 + 3024, + 3025 ] } ], "sources": [ { "fileName": "types.ts", - "line": 6153, + "line": 6170, "character": 17 } ] }, { - "id": 2813, + "id": 2814, "name": "customCssInterface", "kind": 256, "kindString": "Interface", @@ -47080,7 +47070,7 @@ }, "children": [ { - "id": 2815, + "id": 2816, "name": "rules_UNSTABLE", "kind": 1024, "kindString": "Property", @@ -47110,20 +47100,20 @@ "type": { "type": "reflection", "declaration": { - "id": 2816, + "id": 2817, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 2817, + "id": 2818, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2818, + "id": 2819, "name": "selector", "kind": 32768, "flags": {}, @@ -47136,7 +47126,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2819, + "id": 2820, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -47149,14 +47139,14 @@ } ], "indexSignature": { - "id": 2820, + "id": 2821, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 2821, + "id": 2822, "name": "declaration", "kind": 32768, "flags": {}, @@ -47178,7 +47168,7 @@ } }, { - "id": 2814, + "id": 2815, "name": "variables", "kind": 1024, "kindString": "Property", @@ -47197,7 +47187,7 @@ ], "type": { "type": "reference", - "id": 2822, + "id": 2823, "name": "CustomCssVariables" } } @@ -47207,8 +47197,8 @@ "title": "Properties", "kind": 1024, "children": [ - 2815, - 2814 + 2816, + 2815 ] } ], @@ -47513,7 +47503,7 @@ ] }, { - "id": 2783, + "id": 2784, "name": "DOMSelector", "kind": 4194304, "kindString": "Type alias", @@ -47540,7 +47530,7 @@ } }, { - "id": 2787, + "id": 2788, "name": "MessageCallback", "kind": 4194304, "kindString": "Type alias", @@ -47548,14 +47538,14 @@ "sources": [ { "fileName": "types.ts", - "line": 1694, + "line": 1699, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2788, + "id": 2789, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -47572,13 +47562,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1694, + "line": 1699, "character": 30 } ], "signatures": [ { - "id": 2789, + "id": 2790, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -47588,19 +47578,19 @@ }, "parameters": [ { - "id": 2790, + "id": 2791, "name": "payload", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 2795, + "id": 2796, "name": "MessagePayload" } }, { - "id": 2791, + "id": 2792, "name": "responder", "kind": 32768, "kindString": "Parameter", @@ -47610,7 +47600,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2792, + "id": 2793, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -47618,13 +47608,13 @@ "sources": [ { "fileName": "types.ts", - "line": 1701, + "line": 1706, "character": 16 } ], "signatures": [ { - "id": 2793, + "id": 2794, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -47634,7 +47624,7 @@ }, "parameters": [ { - "id": 2794, + "id": 2795, "name": "data", "kind": 32768, "kindString": "Parameter", @@ -47665,7 +47655,7 @@ } }, { - "id": 2784, + "id": 2785, "name": "MessageOptions", "kind": 4194304, "kindString": "Type alias", @@ -47682,21 +47672,21 @@ "sources": [ { "fileName": "types.ts", - "line": 1683, + "line": 1688, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2785, + "id": 2786, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2786, + "id": 2787, "name": "start", "kind": 1024, "kindString": "Property", @@ -47709,7 +47699,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1688, + "line": 1693, "character": 4 } ], @@ -47724,14 +47714,14 @@ "title": "Properties", "kind": 1024, "children": [ - 2786 + 2787 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1683, + "line": 1688, "character": 29 } ] @@ -47739,7 +47729,7 @@ } }, { - "id": 2795, + "id": 2796, "name": "MessagePayload", "kind": 4194304, "kindString": "Type alias", @@ -47756,21 +47746,21 @@ "sources": [ { "fileName": "types.ts", - "line": 1670, + "line": 1675, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 2796, + "id": 2797, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 2798, + "id": 2799, "name": "data", "kind": 1024, "kindString": "Property", @@ -47778,7 +47768,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1674, + "line": 1679, "character": 4 } ], @@ -47788,7 +47778,7 @@ } }, { - "id": 2799, + "id": 2800, "name": "status", "kind": 1024, "kindString": "Property", @@ -47798,7 +47788,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1676, + "line": 1681, "character": 4 } ], @@ -47808,7 +47798,7 @@ } }, { - "id": 2797, + "id": 2798, "name": "type", "kind": 1024, "kindString": "Property", @@ -47816,7 +47806,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1672, + "line": 1677, "character": 4 } ], @@ -47831,16 +47821,16 @@ "title": "Properties", "kind": 1024, "children": [ - 2798, 2799, - 2797 + 2800, + 2798 ] } ], "sources": [ { "fileName": "types.ts", - "line": 1670, + "line": 1675, "character": 29 } ] @@ -48247,7 +48237,7 @@ }, "type": { "type": "reference", - "id": 2369, + "id": 2370, "name": "EmbedConfig" } } @@ -48347,7 +48337,7 @@ }, "type": { "type": "reference", - "id": 2369, + "id": 2370, "name": "EmbedConfig" } } @@ -48494,7 +48484,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 2754, + "id": 2755, "name": "PrefetchFeatures" } } @@ -48622,7 +48612,7 @@ ] }, { - "id": 3093, + "id": 3096, "name": "resetCachedAuthToken", "kind": 64, "kindString": "Function", @@ -48638,7 +48628,7 @@ ], "signatures": [ { - "id": 3094, + "id": 3097, "name": "resetCachedAuthToken", "kind": 4096, "kindString": "Call signature", @@ -48832,7 +48822,7 @@ ] }, { - "id": 2994, + "id": 2995, "name": "uploadMixpanelEvent", "kind": 64, "kindString": "Function", @@ -48846,7 +48836,7 @@ ], "signatures": [ { - "id": 2995, + "id": 2996, "name": "uploadMixpanelEvent", "kind": 4096, "kindString": "Call signature", @@ -48856,7 +48846,7 @@ }, "parameters": [ { - "id": 2996, + "id": 2997, "name": "eventId", "kind": 32768, "kindString": "Parameter", @@ -48868,7 +48858,7 @@ } }, { - "id": 2997, + "id": 2998, "name": "eventProps", "kind": 32768, "kindString": "Parameter", @@ -48879,7 +48869,7 @@ "type": { "type": "reflection", "declaration": { - "id": 2998, + "id": 2999, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -48907,29 +48897,29 @@ 1845, 1852, 2007, - 2365, + 2366, 2214, - 3067, - 3063, - 3059, + 3070, + 3066, + 3062, 2219, - 3076, + 3079, 2039, - 3089, - 2765, - 3016, - 3010, - 2776, + 3092, + 2766, + 3017, + 3011, + 2777, 2137, - 3072, - 3019, - 3053, - 2987, + 3075, + 3020, + 3054, + 2988, 1998, - 2754, - 3014, + 2755, + 3015, 2023, - 3045 + 3046 ] }, { @@ -48952,28 +48942,28 @@ "title": "Interfaces", "kind": 256, "children": [ - 2662, + 2663, 1862, 1334, 1622, - 3025, - 2822, - 2810, - 2800, - 2369, - 2759, - 2526, + 3026, + 2823, + 2811, + 2801, + 2370, + 2760, + 2527, 2019, - 2984, - 2610, - 2479, - 2421, + 2985, + 2611, + 2480, + 2422, 1988, 1300, 1576, 1995, - 3022, - 2813, + 3023, + 2814, 21, 28 ] @@ -48982,10 +48972,10 @@ "title": "Type aliases", "kind": 4194304, "children": [ - 2783, - 2787, 2784, - 2795 + 2788, + 2785, + 2796 ] }, { @@ -49002,9 +48992,9 @@ 4, 7, 25, - 3093, + 3096, 40, - 2994 + 2995 ] } ], From f5f4d3ae98f310bb1ad6662b90d570caf7369b03 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 29 Jan 2026 09:49:50 +0530 Subject: [PATCH 19/23] resolved comments --- src/embed/app.ts | 1 - src/embed/conversation.ts | 11 ----- src/embed/hostEventClient/contracts.ts | 11 ++++- .../hostEventClient/host-event-client.ts | 2 +- src/embed/liveboard.ts | 11 ----- src/embed/sage.ts | 11 ----- src/embed/search-bar.tsx | 11 ----- src/embed/search.ts | 11 ----- src/types.ts | 46 ++++++++++++++++++- 9 files changed, 56 insertions(+), 59 deletions(-) diff --git a/src/embed/app.ts b/src/embed/app.ts index 6b21887c..9093ab7b 100644 --- a/src/embed/app.ts +++ b/src/embed/app.ts @@ -19,7 +19,6 @@ import { AllEmbedViewConfig, } from '../types'; import { V1Embed } from './ts-embed'; -import { PageContextOptions } from './hostEventClient/contracts'; /** * Pages within the ThoughtSpot app that can be embedded. diff --git a/src/embed/conversation.ts b/src/embed/conversation.ts index 72d18169..fc5211ef 100644 --- a/src/embed/conversation.ts +++ b/src/embed/conversation.ts @@ -3,7 +3,6 @@ import { ERROR_MESSAGE } from '../errors'; import { Param, BaseViewConfig, RuntimeFilter, RuntimeParameter, ErrorDetailsTypes, EmbedErrorCodes } from '../types'; import { TsEmbed } from './ts-embed'; import { getQueryParamString, getFilterQuery, getRuntimeParameters } from '../utils'; -import { PageContextOptions } from './hostEventClient/contracts'; /** * Configuration for search options @@ -338,16 +337,6 @@ export class SpotterEmbed extends TsEmbed { await this.renderIFrame(src); return this; } - - /** - * Get the current context of the embedded SpotterEmbed. - * @returns The current context object containing the page type and object ids. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl - */ - public async getCurrentContext(): Promise { - const context = await super.getCurrentContext(); - return context; - } } /** diff --git a/src/embed/hostEventClient/contracts.ts b/src/embed/hostEventClient/contracts.ts index 8f68b31f..c5708c8c 100644 --- a/src/embed/hostEventClient/contracts.ts +++ b/src/embed/hostEventClient/contracts.ts @@ -119,6 +119,15 @@ export enum PageType { DIALOG = 'dialog', } +/** + * Objects is a map of object ids to their names. + * @example + * { + * answerId: '123', + * liveboardId: '456', + * vizIds: ['789', '101'], + * } + */ interface Objects { answerId?: string; liveboardId?: string; @@ -130,5 +139,5 @@ interface Objects { export interface PageContextOptions { page: ContextType; pageType: PageType; - objects: Objects; + objectIds: Objects; } diff --git a/src/embed/hostEventClient/host-event-client.ts b/src/embed/hostEventClient/host-event-client.ts index 0bf45687..85d66406 100644 --- a/src/embed/hostEventClient/host-event-client.ts +++ b/src/embed/hostEventClient/host-event-client.ts @@ -43,7 +43,7 @@ export class HostEventClient { parameters: UIPassthroughRequest, context?: ContextType, ): Promise> { - const response = (await this.triggerUIPassthroughApi(apiName, parameters, context as ContextType)) + const response = (await this.triggerUIPassthroughApi(apiName, parameters, context)) ?.filter?.((r) => r.error || r.value)[0]; if (!response) { diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index b4f4fcc5..519f16d3 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -643,7 +643,6 @@ export class LiveboardEmbed extends V1Embed { } private sendFullHeightLazyLoadData = () => { - console.log('sendFullHeightLazyLoadData', this.iFrame); const data = calculateVisibleElementData(this.iFrame); this.trigger(HostEvent.VisibleEmbedCoordinates, data); } @@ -892,16 +891,6 @@ export class LiveboardEmbed extends V1Embed { return url; } - - /** - * Get the current context of the embedded liveboard. - * @returns The current context object containing the page type and object ids. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl - */ - public async getCurrentContext(): Promise { - const context = await super.getCurrentContext(); - return context; - } } /** diff --git a/src/embed/sage.ts b/src/embed/sage.ts index 24a4678b..a8818ae7 100644 --- a/src/embed/sage.ts +++ b/src/embed/sage.ts @@ -6,7 +6,6 @@ * @author Mourya Balabhadra */ -import { PageContextOptions } from './hostEventClient/contracts'; import { DOMSelector, Param, BaseViewConfig, SearchLiveboardCommonViewConfig } from '../types'; import { getQueryParamString } from '../utils'; import { V1Embed } from './ts-embed'; @@ -230,14 +229,4 @@ export class SageEmbed extends V1Embed { return this; } - - /** - * Get the current context of the embedded SageEmbed. - * @returns The current context object containing the page type and object ids. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl - */ - public async getCurrentContext(): Promise { - const context = await super.getCurrentContext(); - return context; - } } diff --git a/src/embed/search-bar.tsx b/src/embed/search-bar.tsx index e3855164..bc5f0262 100644 --- a/src/embed/search-bar.tsx +++ b/src/embed/search-bar.tsx @@ -2,7 +2,6 @@ import { SearchLiveboardCommonViewConfig, BaseViewConfig, DefaultAppInitData, Pa import { getQueryParamString } from '../utils'; import { TsEmbed } from './ts-embed'; import { SearchOptions } from './search'; -import { PageContextOptions } from './hostEventClient/contracts'; /** * @group Embed components @@ -199,14 +198,4 @@ export class SearchBarEmbed extends TsEmbed { const defaultAppInitData = await super.getAppInitData(); return { ...defaultAppInitData, ...this.getSearchInitData() }; } - - /** - * Get the current context of the embedded search bar. - * @returns The current context object containing the page type and object ids. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl - */ - public async getCurrentContext(): Promise { - const context = await super.getCurrentContext(); - return context; - } } diff --git a/src/embed/search.ts b/src/embed/search.ts index f36f620d..a36172fc 100644 --- a/src/embed/search.ts +++ b/src/embed/search.ts @@ -27,7 +27,6 @@ import { getAuthPromise } from './base'; import { getReleaseVersion } from '../auth'; import { getEmbedConfig } from './embedConfig'; import { getInterceptInitData } from '../api-intercept'; -import { PageContextOptions } from './hostEventClient/contracts'; /** * Configuration for search options. @@ -529,14 +528,4 @@ export class SearchEmbed extends TsEmbed { }); return this; } - - /** - * Get the current context of the embedded search. - * @returns The current context object containing the page type and object ids. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl - */ - public async getCurrentContext(): Promise { - const context = await super.getCurrentContext(); - return context; - } } diff --git a/src/types.ts b/src/types.ts index 44dcfcc7..f5565345 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1122,7 +1122,7 @@ export interface BaseViewConfig extends ApiInterceptFlags { customActions?: CustomAction[]; /** - * Flag to bypass host events payload validation + * This flag skips payload validation so events can be processed even if the payload is old, incomplete, or from a trusted system. * @default false * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl * @example @@ -6556,3 +6556,47 @@ export type ApiInterceptFlags = { */ interceptTimeout?: number; }; + +/** + * Context object for the embedded component. + * @example + * ```js + * const context = await embed.getCurrentContext(); + * console.log(context); + * ``` + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + */ +export interface ContextObject { + /** + * Stack of context objects. + */ + stack: Array<{ + /** + * Name of the context object. + */ + name: string; + /** + * Type of the context object. + */ + type: ContextType; + /** + * Object IDs of the context object. + */ + objectIds: { + [key: string]: string[]; + }; + }> + /** + * Current context object. + */ + currentContext: { + /** + * Name of the current context object. + */ + name: string; + type: ContextType; + objectIds: { + [key: string]: string[]; + }; + } +} \ No newline at end of file From 89a5a25c6c97a29a63babeff89233aedc7f9597d Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Thu, 29 Jan 2026 09:59:37 +0530 Subject: [PATCH 20/23] fixed jsdoc --- src/embed/hostEventClient/contracts.ts | 30 +----------- src/embed/liveboard.ts | 2 +- src/embed/ts-embed.ts | 3 +- src/types.ts | 65 +++++++++++++++++++++++--- 4 files changed, 63 insertions(+), 37 deletions(-) diff --git a/src/embed/hostEventClient/contracts.ts b/src/embed/hostEventClient/contracts.ts index c5708c8c..731c9edb 100644 --- a/src/embed/hostEventClient/contracts.ts +++ b/src/embed/hostEventClient/contracts.ts @@ -112,32 +112,4 @@ export type HostEventResponse = PayloadT | HostEventRequest; export type TriggerResponse = - PayloadT extends HostEventRequest ? HostEventResponse : any; - -export enum PageType { - PAGE = 'page', - DIALOG = 'dialog', -} - -/** - * Objects is a map of object ids to their names. - * @example - * { - * answerId: '123', - * liveboardId: '456', - * vizIds: ['789', '101'], - * } - */ -interface Objects { - answerId?: string; - liveboardId?: string; - vizIds?: string[]; - dataModelIds?: string[]; - modalTitle?: string; -} - -export interface PageContextOptions { - page: ContextType; - pageType: PageType; - objectIds: Objects; -} + PayloadT extends HostEventRequest ? HostEventResponse : any; \ No newline at end of file diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index 519f16d3..b670abb5 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -28,7 +28,7 @@ import { calculateVisibleElementData, getQueryParamString, isUndefined, isValidC import { getAuthPromise } from './base'; import { TsEmbed, V1Embed } from './ts-embed'; import { addPreviewStylesIfNotPresent } from '../utils/global-styles'; -import { TriggerPayload, TriggerResponse, PageContextOptions } from './hostEventClient/contracts'; +import { TriggerPayload, TriggerResponse } from './hostEventClient/contracts'; import { logger } from '../utils/logger'; diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index 6b460d82..faca5c60 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -61,6 +61,7 @@ import { ErrorDetailsTypes, EmbedErrorCodes, ContextType, + ContextObject, } from '../types'; import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service'; import { processEventData, processAuthFailure } from '../utils/processData'; @@ -1434,7 +1435,7 @@ export class TsEmbed { * @returns The current context object containing the page type and object ids. * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl */ - public async getCurrentContext(): Promise { + public async getCurrentContext(): Promise { return new Promise((resolve) => { this.executeAfterEmbedContainerLoaded(async () => { const context = await this.trigger(HostEvent.GetPageContext, {}); diff --git a/src/types.ts b/src/types.ts index f5565345..329d5ad8 100644 --- a/src/types.ts +++ b/src/types.ts @@ -6473,9 +6473,21 @@ export interface EmbedErrorDetailsEvent { } export enum ContextType { + /** + * Search answer context for search page or edit viz dialog on liveboard page. + */ Search = 'search-answer', + /** + * Liveboard context for liveboard page. + */ Liveboard = 'liveboard', + /** + * Answer context for explore modal/page on liveboard page. + */ Answer = 'answer', + /** + * Spotter context for spotter modal/page. + */ Spotter = 'spotter', } @@ -6557,12 +6569,57 @@ export type ApiInterceptFlags = { interceptTimeout?: number; }; +/** + * Object IDs for the embedded component. + * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + */ +export interface ObjectIds { + /** + * Liveboard ID. + */ + liveboardId?: string; + /** + * Answer ID. + */ + answerId?: string; + /** + * Viz IDs. + */ + vizIds?: string[]; + /** + * Data model IDs. + */ + dataModelIds?: string[]; + /** + * Modal title. + */ + modalTitle?: string; +} + /** * Context object for the embedded component. * @example * ```js * const context = await embed.getCurrentContext(); * console.log(context); + * { + * stack: [ + * { + * name: 'Liveboard', + * type: ContextType.Liveboard, + * objectIds: { + * liveboardId: '123', + * }, + * }, + * ], + * currentContext: { + * name: 'Liveboard', + * type: ContextType.Liveboard, + * objectIds: { + * liveboardId: '123', + * }, + * }, + * } * ``` * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl */ @@ -6582,9 +6639,7 @@ export interface ContextObject { /** * Object IDs of the context object. */ - objectIds: { - [key: string]: string[]; - }; + objectIds: ObjectIds; }> /** * Current context object. @@ -6595,8 +6650,6 @@ export interface ContextObject { */ name: string; type: ContextType; - objectIds: { - [key: string]: string[]; - }; + objectIds: ObjectIds; } } \ No newline at end of file From 272efa4ba5efb7f4f1819eba663b5a719940dadf Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 30 Jan 2026 16:21:57 +0530 Subject: [PATCH 21/23] fixed version --- src/embed/ts-embed.ts | 2 +- src/types.ts | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/embed/ts-embed.ts b/src/embed/ts-embed.ts index faca5c60..b0efe554 100644 --- a/src/embed/ts-embed.ts +++ b/src/embed/ts-embed.ts @@ -1433,7 +1433,7 @@ export class TsEmbed { /** * Get the current context of the embedded TS component. * @returns The current context object containing the page type and object ids. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl */ public async getCurrentContext(): Promise { return new Promise((resolve) => { diff --git a/src/types.ts b/src/types.ts index bb9e0a3f..ce13e9d1 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1124,7 +1124,7 @@ export interface BaseViewConfig extends ApiInterceptFlags { /** * This flag skips payload validation so events can be processed even if the payload is old, incomplete, or from a trusted system. * @default false - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl * @example * ```js * const embed = new AppEmbed('#tsEmbed', { @@ -1138,7 +1138,7 @@ export interface BaseViewConfig extends ApiInterceptFlags { /** * Flag to use host events v2. This is used to enable the new host events v2 API. * @default false - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl * @example * ```js * const embed = new AppEmbed('#tsEmbed', { @@ -6645,7 +6645,7 @@ export type ApiInterceptFlags = { /** * Object IDs for the embedded component. - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl */ export interface ObjectIds { /** @@ -6695,7 +6695,7 @@ export interface ObjectIds { * }, * } * ``` - * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl + * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl */ export interface ContextObject { /** From 2c66d9f6cd810529e1e654c55e92d64c7456b4e4 Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 30 Jan 2026 16:23:00 +0530 Subject: [PATCH 22/23] hidden --- src/types.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/types.ts b/src/types.ts index ce13e9d1..4eb4d721 100644 --- a/src/types.ts +++ b/src/types.ts @@ -4577,7 +4577,9 @@ export enum HostEvent { StartNewSpotterConversation = 'StartNewSpotterConversation', /** + * @hidden * Get the current context of the embedded page. + * * @example * ```js * const context = await liveboardEmbed.trigger(HostEvent.GetPageContext); From df343fa2fcdbdbde2132c6ac55b4cb12fe57893a Mon Sep 17 00:00:00 2001 From: Ruchi Anand Date: Fri, 30 Jan 2026 16:53:12 +0530 Subject: [PATCH 23/23] added UTs --- src/embed/ts-embed.spec.ts | 54 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/src/embed/ts-embed.spec.ts b/src/embed/ts-embed.spec.ts index 4e4f3cbe..97dd320d 100644 --- a/src/embed/ts-embed.spec.ts +++ b/src/embed/ts-embed.spec.ts @@ -31,6 +31,7 @@ import { DefaultAppInitData, ErrorDetailsTypes, EmbedErrorCodes, + ContextObject, } from '../types'; import { executeAfterWait, @@ -3167,6 +3168,59 @@ describe('Unit test case for ts embed', () => { expect(callback3).toHaveBeenCalledTimes(1); }); + describe('getCurrentContext', () => { + const mockContext: ContextObject = { + stack: [ + { + name: 'Liveboard', + type: 'Liveboard' as any, + objectIds: { liveboardId: 'lb-123' }, + }, + ], + currentContext: { + name: 'Liveboard', + type: 'Liveboard' as any, + objectIds: { liveboardId: 'lb-123' }, + }, + }; + + test('should return context when embed container is already loaded', async () => { + const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig); + searchEmbed.isEmbedContainerLoaded = true; + + const triggerSpy = jest.spyOn(searchEmbed, 'trigger') + .mockResolvedValue(mockContext); + + const context = await searchEmbed.getCurrentContext(); + + expect(context).toEqual(mockContext); + expect(triggerSpy).toHaveBeenCalledWith(HostEvent.GetPageContext, {}); + }); + + test('should wait for embed container to load before returning context', async () => { + const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig); + searchEmbed.isEmbedContainerLoaded = false; + + const triggerSpy = jest.spyOn(searchEmbed, 'trigger') + .mockResolvedValue(mockContext); + + const contextPromise = searchEmbed.getCurrentContext(); + + // Context should not be resolved yet + await executeAfterWait(() => { + expect(triggerSpy).not.toHaveBeenCalled(); + }, 10); + + // Simulate embed container becoming ready + searchEmbed['executeEmbedContainerReadyCallbacks'](); + + const context = await contextPromise; + + expect(context).toEqual(mockContext); + expect(triggerSpy).toHaveBeenCalledWith(HostEvent.GetPageContext, {}); + }); + }); + test('should register embed container event handlers during construction', () => { const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);