From 5c767c84da91ca80e7b15e8ad288f2dd1d85e8cc Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Tue, 18 Feb 2025 23:13:47 +0530 Subject: [PATCH 1/4] doc fixes --- src/embed/liveboard.ts | 5 +- src/types.ts | 140 ++++++++++++++++++++++------------------- 2 files changed, 79 insertions(+), 66 deletions(-) diff --git a/src/embed/liveboard.ts b/src/embed/liveboard.ts index fbbbee20..92abcdc8 100644 --- a/src/embed/liveboard.ts +++ b/src/embed/liveboard.ts @@ -293,7 +293,10 @@ export interface LiveboardViewConfig */ showPreviewLoader?: boolean; /** - * This flag is used to enable the compact header on a Liveboard + * Enables or disables the compact header feature on a Liveboard. + * Compact Liveboard header is turned off by default on Liveboards in + * ThoughtSpot Embedded apps. + * * @type {boolean} * @default false * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl diff --git a/src/types.ts b/src/types.ts index 045e8a5f..ba3d2a59 100644 --- a/src/types.ts +++ b/src/types.ts @@ -213,12 +213,12 @@ export type DOMSelector = string | HTMLElement; * Use {@link CustomCssVariables} or css rules. */ export interface customCssInterface { - /** - * The custom css variables, which can be set. - * The allowed list is in the CustomCssVariables - * interface. For more information, see - * link:https://developers.thoughtspot.com/docs/css-variables-reference - */ + /** + * 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 @@ -770,7 +770,7 @@ export interface ViewConfig { */ showAlerts?: boolean; /** - * The list of runtime filters to apply to a search answer, + * The list of runtime filters to apply to a search Answer, * visualization, or Liveboard. * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw * @example @@ -789,7 +789,7 @@ export interface ViewConfig { */ runtimeFilters?: RuntimeFilter[]; /** - * The list of parameter override to apply to a search answer, + * The list of parameter override to apply to a search Answer, * visualization, or Liveboard. * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw * @example @@ -807,7 +807,7 @@ export interface ViewConfig { */ runtimeParameters?: RuntimeParameter[]; /** - * The locale/language to use for the embedded view. + * The locale settings to apply to the embedded view. * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw * @example * ```js @@ -872,7 +872,7 @@ export interface ViewConfig { */ contextMenuTrigger?: ContextMenuTriggerOptions; /** - * Flag to override openNew tab context menu link + * Flag to override the *Open Link in New Tab* context menu option. * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl * @example * ```js @@ -1012,7 +1012,7 @@ export interface ViewConfig { preRenderId?: string; /** - * Determines whether the PreRender component should not dynamically track the size + * 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. @@ -1402,8 +1402,8 @@ export enum EmbedEvent { */ Load = 'load', /** - * Data pertaining to answer or Liveboard is received - * @return data - The answer or Liveboard data + * Data pertaining to an Answer or Liveboard is received + * @return data - The Answer or Liveboard data * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw * @example *```js @@ -1577,7 +1577,7 @@ export enum EmbedEvent { */ Alert = 'alert', /** - * The ThoughtSpot auth session has expired. + * The ThoughtSpot authentication session has expired. * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw * @example *```js @@ -1649,7 +1649,7 @@ export enum EmbedEvent { /** * 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 + * are blocked by default. `NoCookieAccess` can trigger. * @example *```js * appEmbed.on(EmbedEvent.NoCookieAccess) @@ -1737,7 +1737,7 @@ export enum EmbedEvent { */ Save = 'save', /** - * Emitted when the download action is triggered on an answer + * 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, @@ -1753,7 +1753,7 @@ export enum EmbedEvent { */ Download = 'download', /** - * Emitted when the download action is triggered on an answer + * 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 @@ -1767,7 +1767,7 @@ export enum EmbedEvent { */ DownloadAsPng = 'downloadAsPng', /** - * Emitted when the Download as PDF action is triggered on an answer + * 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 @@ -1781,7 +1781,7 @@ export enum EmbedEvent { */ DownloadAsPdf = 'downloadAsPdf', /** - * Emitted when the Download as CSV action is triggered on an answer + * 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 @@ -1795,7 +1795,7 @@ export enum EmbedEvent { */ DownloadAsCsv = 'downloadAsCsv', /** - * Emitted when the Download as XLSX action is triggered on an answer + * 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 @@ -1823,7 +1823,8 @@ export enum EmbedEvent { */ AnswerDelete = 'answerDelete', /** - * Emitted when an answer is pinned to a Liveboard + * 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 @@ -1961,7 +1962,7 @@ export enum EmbedEvent { */ SaveAsView = 'saveAsView', /** - * Emitted when the user creates a copy of an Answer + * 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 @@ -1975,7 +1976,7 @@ export enum EmbedEvent { */ CopyAEdit = 'copyAEdit', /** - * Emitted when a user clicks Show underlying data on an Answer + * 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 @@ -1986,7 +1987,7 @@ export enum EmbedEvent { */ ShowUnderlyingData = 'showUnderlyingData', /** - * Emitted when an answer is switched to a chart or table view. + * 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 @@ -2120,11 +2121,12 @@ export enum EmbedEvent { */ CopyLink = 'embedDocument', /** - * Emitted when a user interacts with cross filters on a visualization or Liveboard + * 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.trigger(HostEvent.CrossFilterChanged, { + * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, { * vizId: '730496d6-6903-4601-937e-2c691821af3c'}) *``` */ @@ -2218,8 +2220,8 @@ export enum EmbedEvent { */ DeletePersonalisedView = 'deletePersonalisedView', /** - * Emitted when a user creates a new worksheet - * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl + * Emitted when a user creates a Worksheet. + * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw */ CreateWorksheet = 'createWorksheet', /** @@ -2232,8 +2234,8 @@ export enum EmbedEvent { */ AskSageInit = 'AskSageInit', /** - * Emitted when a LB/viz is renamed - * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl + * Emitted when a Liveboard or visualization is renamed. + * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw */ Rename = 'rename', /** @@ -2297,8 +2299,7 @@ export enum EmbedEvent { OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept', /** * Emitted when parameter changes in an Answer - * or Liveboard - * + * or Liveboard. * ```js * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => { * console.log('payload', payload); @@ -2325,7 +2326,7 @@ export enum EmbedEvent { */ TableVizRendered = 'TableVizRendered', /** - * Emitted when the liveboard is created from pin modal or liveboard list page. + * 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. * @@ -2470,7 +2471,7 @@ export enum HostEvent { */ Filter = 'filter', /** - * Reload the answer or visualization + * Reload the Answer or visualization * @hidden */ Reload = 'reload', @@ -2520,12 +2521,10 @@ export enum HostEvent { * and `AppEmbed` only. In full application embedding, this event updates * the runtime filters applied on the Liveboard and saved Answer objects. * - * - * Pass an array of runtime filters with the following attributes: - * + * @param - Pass an array of {@link RuntimeFilter} with the following attributes: * `columnName` - _String_. The name of the column to filter on. * - * `operator` - Runtime filter operator to apply. For more information, + * `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 @@ -2537,7 +2536,7 @@ export enum HostEvent { * will be cleared, restoring the original visualization * with the updated filters. * - * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types. + * @example * ```js * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [ @@ -3186,7 +3185,7 @@ export enum HostEvent { * ```js * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => { * console.log( - * tabDetails // TabDetails of current LB + * tabDetails // TabDetails of current Liveboard * ); * }) * ``` @@ -3234,7 +3233,7 @@ export enum HostEvent { */ UpdateSageQuery = 'updateSageQuery', /** - * Get the answer session for a Search or + * Get the Answer session for a Search or * Liveboard visualization. * @example * ```js @@ -3645,9 +3644,10 @@ export enum Action { */ AddDataPanelObjects = 'addDataPanelObjects', /** - * Filter configuration options on a Liveboard page. - * Allows configuring filters on a - * Liveboard. + * The filter configuration options for a Liveboard. + * The configuration options are available when adding + * filters on a Liveboard. + * * @example * ```js * disabledActions: [Action.ConfigureFilter] @@ -3784,11 +3784,10 @@ export enum Action { /** * *The **Download PDF** action that downloads a Liveboard, - *visualization, or Answer as a PDF file. - * + * visualization, or Answer as a PDF file. * - ***NOTE**: The **Download** > **PDF** action is available on - *visualizations and Answers if the data is in tabular format. + * **NOTE**: The **Download** > **PDF** option is available for + * tables in visualizations and Answers. * @example * ```js * disabledActions: [Action.DownloadAsPdf] @@ -3820,9 +3819,11 @@ export enum Action { */ DownloadTrace = 'downloadTrace', /** - * The **Export TML** menu action on Liveboard, Answers - * Worksheets and Data Connections page. - * Exports an object as a TML file. + * 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] @@ -3830,7 +3831,8 @@ export enum Action { */ ExportTML = 'exportTSL', /** - * The **Import TML** menu action for Liveboards and Answers. + * The **Import TML** menu action on the + * *Data Workspace* > *Utilities* page. * Imports TML representation of ThoughtSpot objects. * @example * ```js @@ -3840,7 +3842,7 @@ export enum Action { ImportTML = 'importTSL', /** * The **Update TML** menu action for Liveboards and Answers. - * Update TML representation of ThoughtSpot objects. + * Updates TML representation of ThoughtSpot objects. * @example * ```js * disabledActions: [Action.UpdateTML] @@ -3867,8 +3869,11 @@ export enum Action { */ Present = 'present', /** - * The tile resize options in the visualization menu. - * Allows switching between different preset layouts. + * 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] @@ -3894,8 +3899,9 @@ export enum Action { */ EditTitle = 'editTitle', /** - * The **Delete** menu action on Liveboards and visualizations. - * Deletes a Liveboard or a visualization from a Liveboard. + * The **Delete** action on a Liveboard, *Liveboards* and + * *Answers* list pages in full application embedding. + * * @example * ```js * disabledActions: [Action.Remove] @@ -3972,8 +3978,9 @@ export enum Action { */ Explore = 'explore', /** - * The action to include data points on a drilled-down Answer - * or visualization + * 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] @@ -3982,8 +3989,8 @@ export enum Action { DrillInclude = 'context-menu-item-include', /** - * The action to exclude data points on a drilled-down Answer - * or visualization + * 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] @@ -4450,7 +4457,7 @@ export enum Action { /** * Action ID for the Parent TML action * The parent action **TML** must be included to access TML-related options - * within the cascading menu (specific to the answer page) + * within the cascading menu (specific to the Answer page) * @example * ```js * // to include specific TML actions @@ -4491,8 +4498,10 @@ export enum Action { VerifiedLiveboard = 'verifiedLiveboard', /** - * The *Ask Sage* action for Answers and visualizations. - * Allows initiating a Natural Language Search query. + * 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 @@ -4701,7 +4710,8 @@ export enum Action { */ DeletePreviousPrompt = 'deletePreviousPrompt', /** - * Action ID for hide/disable edit of tokens on spotter results. + * Action ID for hide or disable editing tokens generated from + * Spotter results. * @example * ```js * hiddenAction: [Action.EditTokens] From adb675615aa4249ba6bb36680331bd67f8a15e0b Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Tue, 25 Feb 2025 18:36:32 +0530 Subject: [PATCH 2/4] typo fixes and shareViz update --- src/types.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/types.ts b/src/types.ts index ba3d2a59..591fa598 100644 --- a/src/types.ts +++ b/src/types.ts @@ -3745,6 +3745,9 @@ export enum Action { * @hidden */ SpotIQFollow = 'spotIQFollow', + /** + * The Share action for a Liveboard visualization. + */ ShareViz = 'shareViz', /** * @hidden @@ -4137,7 +4140,7 @@ export enum Action { * Allows users to manage data sync pipelines to third-party apps. * @example * ```js - * disabledActions: [Action.SyncToOtherApps] + * disabledActions: [Action.ManagePipelines] * ``` * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw */ From 315d72f5f8c6125b25a33b565549504a3e1d7083 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Tue, 25 Feb 2025 20:11:52 +0530 Subject: [PATCH 3/4] ci-check fix --- src/types.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/types.ts b/src/types.ts index 591fa598..efbea736 100644 --- a/src/types.ts +++ b/src/types.ts @@ -3746,7 +3746,7 @@ export enum Action { */ SpotIQFollow = 'spotIQFollow', /** - * The Share action for a Liveboard visualization. + * The Share action for a Liveboard visualization. */ ShareViz = 'shareViz', /** @@ -3754,8 +3754,8 @@ export enum Action { */ ReplaySearch = 'replaySearch', /** - * The **Show underlying data** menu action on a visualization or - * Answer page. + * The **Show underlying data** menu action on a + * visualization or Answer page. * Displays detailed information and raw data * for a given visualization. * @example @@ -3765,8 +3765,8 @@ export enum Action { */ ShowUnderlyingData = 'showUnderlyingData', /** - * The **Download** menu action on Liveboard visualizations - * and Answers. + * The **Download** menu action on Liveboard + * visualizations and Answers. * Allows downloading a visualization or Answer. * @example * ```js From 60904fb2f769f009be9ce2cf9a5c61703c633be0 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Tue, 4 Mar 2025 13:35:08 +0530 Subject: [PATCH 4/4] docgen --- static/typedoc/typedoc.json | 686 ++++++++++++++++++------------------ 1 file changed, 345 insertions(+), 341 deletions(-) diff --git a/static/typedoc/typedoc.json b/static/typedoc/typedoc.json index d95e52d5..08c0924c 100644 --- a/static/typedoc/typedoc.json +++ b/static/typedoc/typedoc.json @@ -48,7 +48,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4547, + "line": 4559, "character": 4 } ], @@ -104,7 +104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3646, + "line": 3645, "character": 4 } ], @@ -128,7 +128,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3635, + "line": 3634, "character": 4 } ], @@ -232,7 +232,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4354, + "line": 4364, "character": 4 } ], @@ -260,7 +260,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4076, + "line": 4086, "character": 4 } ], @@ -288,7 +288,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4514, + "line": 4526, "character": 4 } ], @@ -316,7 +316,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4064, + "line": 4074, "character": 4 } ], @@ -344,7 +344,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4052, + "line": 4062, "character": 4 } ], @@ -357,7 +357,8 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The *Ask Sage* action for Answers and visualizations.\nAllows initiating a Natural Language Search query.", + "shortText": "Action ID for the *Ask Sage* In Natural Language Search embed,\n*Spotter* in Liveboard, full app, and Spotter embed.", + "text": "Allows initiating a conversation with ThoughtSpot AI analyst.\n", "tags": [ { "tag": "example", @@ -372,7 +373,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4503, + "line": 4515, "character": 4 } ], @@ -400,7 +401,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4189, + "line": 4199, "character": 4 } ], @@ -428,7 +429,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4223, + "line": 4233, "character": 4 } ], @@ -456,7 +457,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4278, + "line": 4288, "character": 4 } ], @@ -484,7 +485,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4212, + "line": 4222, "character": 4 } ], @@ -512,7 +513,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4246, + "line": 4256, "character": 4 } ], @@ -540,7 +541,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4288, + "line": 4298, "character": 4 } ], @@ -568,7 +569,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4257, + "line": 4267, "character": 4 } ], @@ -596,7 +597,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4310, + "line": 4320, "character": 4 } ], @@ -624,7 +625,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4267, + "line": 4277, "character": 4 } ], @@ -652,7 +653,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4234, + "line": 4244, "character": 4 } ], @@ -680,7 +681,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4298, + "line": 4308, "character": 4 } ], @@ -708,7 +709,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4200, + "line": 4210, "character": 4 } ], @@ -736,7 +737,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4645, + "line": 4657, "character": 4 } ], @@ -829,7 +830,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Filter configuration options on a Liveboard page.\nAllows configuring filters on a\nLiveboard.", + "shortText": "The filter configuration options for a Liveboard.\nThe configuration options are available when adding\nfilters on a Liveboard.", "tags": [ { "tag": "example", @@ -855,7 +856,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4003, + "line": 4013, "character": 4 } ], @@ -879,7 +880,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3594, + "line": 3593, "character": 4 } ], @@ -903,7 +904,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4002, + "line": 4012, "character": 4 } ], @@ -931,7 +932,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4480, + "line": 4490, "character": 4 } ], @@ -959,7 +960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4096, + "line": 4106, "character": 4 } ], @@ -987,7 +988,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4147, + "line": 4157, "character": 4 } ], @@ -1015,7 +1016,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4702, + "line": 4714, "character": 4 } ], @@ -1043,7 +1044,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4614, + "line": 4626, "character": 4 } ], @@ -1071,7 +1072,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4633, + "line": 4645, "character": 4 } ], @@ -1084,7 +1085,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Download** menu action on Liveboard visualizations\nand Answers.\nAllows downloading a visualization or Answer.", + "shortText": "The **Download** menu action on Liveboard\nvisualizations and Answers.\nAllows downloading a visualization or Answer.", "tags": [ { "tag": "example", @@ -1095,7 +1096,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3773, + "line": 3776, "character": 4 } ], @@ -1119,7 +1120,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3807, + "line": 3809, "character": 4 } ], @@ -1133,7 +1134,7 @@ "flags": {}, "comment": { "shortText": "The **Download PDF** action that downloads a Liveboard,\nvisualization, or Answer as a PDF file.", - "text": "**NOTE**: The **Download** > **PDF** action is available on\nvisualizations and Answers if the data is in tabular format.", + "text": "**NOTE**: The **Download** > **PDF** option is available for\ntables in visualizations and Answers.", "tags": [ { "tag": "example", @@ -1144,7 +1145,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3797, + "line": 3799, "character": 4 } ], @@ -1168,7 +1169,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3783, + "line": 3786, "character": 4 } ], @@ -1192,7 +1193,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3817, + "line": 3819, "character": 4 } ], @@ -1216,7 +1217,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4019, + "line": 4029, "character": 4 } ], @@ -1229,7 +1230,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The action to exclude data points on a drilled-down Answer\nor visualization", + "shortText": "The contextual menu action to exclude a specific data point\nwhen drilling down a table or chart on an Answer.", "tags": [ { "tag": "example", @@ -1240,7 +1241,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3992, + "line": 4002, "character": 4 } ], @@ -1253,7 +1254,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The action to include data points on a drilled-down Answer\nor visualization", + "shortText": "The contextual menu action to include a specific data point\nwhen drilling down a table or chart on an Answer.", "tags": [ { "tag": "example", @@ -1264,7 +1265,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3983, + "line": 3993, "character": 4 } ], @@ -1288,7 +1289,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3887, + "line": 3895, "character": 4 } ], @@ -1312,7 +1313,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3585, + "line": 3584, "character": 4 } ], @@ -1340,7 +1341,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4085, + "line": 4095, "character": 4 } ], @@ -1355,7 +1356,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4008, + "line": 4018, "character": 4 } ], @@ -1383,7 +1384,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4691, + "line": 4703, "character": 4 } ], @@ -1411,7 +1412,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4387, + "line": 4397, "character": 4 } ], @@ -1439,7 +1440,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4560, + "line": 4572, "character": 4 } ], @@ -1463,7 +1464,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3858, + "line": 3863, "character": 4 } ], @@ -1487,7 +1488,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3895, + "line": 3903, "character": 4 } ], @@ -1500,7 +1501,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Action ID for hide/disable edit of tokens on spotter results.", + "shortText": "Action ID for hide or disable editing tokens generated from\nSpotter results.", "tags": [ { "tag": "example", @@ -1515,7 +1516,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4711, + "line": 4724, "character": 4 } ], @@ -1543,7 +1544,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4364, + "line": 4374, "character": 4 } ], @@ -1567,7 +1568,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3973, + "line": 3982, "character": 4 } ], @@ -1580,7 +1581,8 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Export TML** menu action on Liveboard, Answers\nWorksheets and Data Connections page.\nExports an object as a TML file.", + "shortText": "The **Export TML** menu action on a Liveboard, Answer, and\nthe Data Workspace pages for data objects and connections.", + "text": "Allows exporting an object as a TML file.\n", "tags": [ { "tag": "example", @@ -1591,7 +1593,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3831, + "line": 3835, "character": 4 } ], @@ -1604,7 +1606,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Import TML** menu action for Liveboards and Answers.\nImports TML representation of ThoughtSpot objects.", + "shortText": "The **Import TML** menu action on the\n*Data Workspace* > *Utilities* page.\nImports TML representation of ThoughtSpot objects.", "tags": [ { "tag": "example", @@ -1615,7 +1617,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3840, + "line": 3845, "character": 4 } ], @@ -1643,7 +1645,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4624, + "line": 4636, "character": 4 } ], @@ -1667,7 +1669,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3935, + "line": 3944, "character": 4 } ], @@ -1695,7 +1697,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4448, + "line": 4458, "character": 4 } ], @@ -1719,7 +1721,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3576, + "line": 3575, "character": 4 } ], @@ -1743,7 +1745,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4428, + "line": 4438, "character": 4 } ], @@ -1760,7 +1762,7 @@ "tags": [ { "tag": "example", - "text": "\n```js\ndisabledActions: [Action.SyncToOtherApps]\n```" + "text": "\n```js\ndisabledActions: [Action.ManagePipelines]\n```" }, { "tag": "version", @@ -1771,7 +1773,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4137, + "line": 4147, "character": 4 } ], @@ -1799,7 +1801,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4603, + "line": 4615, "character": 4 } ], @@ -1827,7 +1829,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4344, + "line": 4354, "character": 4 } ], @@ -1854,7 +1856,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4408, + "line": 4418, "character": 4 } ], @@ -1878,7 +1880,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4417, + "line": 4427, "character": 4 } ], @@ -1906,7 +1908,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4536, + "line": 4548, "character": 4 } ], @@ -1934,7 +1936,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4571, + "line": 4583, "character": 4 } ], @@ -1962,7 +1964,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4438, + "line": 4448, "character": 4 } ], @@ -1986,7 +1988,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3952, + "line": 3961, "character": 4 } ], @@ -2010,7 +2012,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3868, + "line": 3873, "character": 4 } ], @@ -2038,7 +2040,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4657, + "line": 4669, "character": 4 } ], @@ -2063,7 +2065,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4042, + "line": 4052, "character": 4 } ], @@ -2076,7 +2078,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Delete** menu action on Liveboards and visualizations.\nDeletes a Liveboard or a visualization from a Liveboard.", + "shortText": "The **Delete** action on a Liveboard, *Liveboards* and\n*Answers* list pages in full application embedding.", "tags": [ { "tag": "example", @@ -2087,7 +2089,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3904, + "line": 3913, "character": 4 } ], @@ -2115,7 +2117,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4178, + "line": 4188, "character": 4 } ], @@ -2143,7 +2145,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4525, + "line": 4537, "character": 4 } ], @@ -2171,7 +2173,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4324, + "line": 4334, "character": 4 } ], @@ -2202,7 +2204,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4106, + "line": 4116, "character": 4 } ], @@ -2226,7 +2228,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4028, + "line": 4038, "character": 4 } ], @@ -2254,7 +2256,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4334, + "line": 4344, "character": 4 } ], @@ -2282,7 +2284,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4669, + "line": 4681, "character": 4 } ], @@ -2310,7 +2312,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4399, + "line": 4409, "character": 4 } ], @@ -2334,7 +2336,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3545, + "line": 3544, "character": 4 } ], @@ -2358,7 +2360,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3563, + "line": 3562, "character": 4 } ], @@ -2382,7 +2384,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3608, + "line": 3607, "character": 4 } ], @@ -2406,7 +2408,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3617, + "line": 3616, "character": 4 } ], @@ -2421,7 +2423,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4009, + "line": 4019, "character": 4 } ], @@ -2445,7 +2447,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3626, + "line": 3625, "character": 4 } ], @@ -2457,10 +2459,13 @@ "kind": 16, "kindString": "Enumeration member", "flags": {}, + "comment": { + "shortText": "The Share action for a Liveboard visualization." + }, "sources": [ { "fileName": "types.ts", - "line": 3748, + "line": 3751, "character": 4 } ], @@ -2488,7 +2493,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4374, + "line": 4384, "character": 4 } ], @@ -2501,7 +2506,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Show underlying data** menu action on a visualization or\nAnswer page.\nDisplays detailed information and raw data\nfor a given visualization.", + "shortText": "The **Show underlying data** menu action on a\nvisualization or Answer page.\nDisplays detailed information and raw data\nfor a given visualization.", "tags": [ { "tag": "example", @@ -2512,7 +2517,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3763, + "line": 3766, "character": 4 } ], @@ -2564,7 +2569,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4680, + "line": 4692, "character": 4 } ], @@ -2588,7 +2593,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3965, + "line": 3974, "character": 4 } ], @@ -2616,7 +2621,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4127, + "line": 4137, "character": 4 } ], @@ -2644,7 +2649,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4116, + "line": 4126, "character": 4 } ], @@ -2672,7 +2677,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4157, + "line": 4167, "character": 4 } ], @@ -2700,7 +2705,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4167, + "line": 4177, "character": 4 } ], @@ -2713,7 +2718,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Action ID for the Parent TML action\nThe parent action **TML** must be included to access TML-related options\nwithin the cascading menu (specific to the answer page)", + "shortText": "Action ID for the Parent TML action\nThe parent action **TML** must be included to access TML-related options\nwithin the cascading menu (specific to the Answer page)", "tags": [ { "tag": "example", @@ -2732,7 +2737,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4467, + "line": 4477, "character": 4 } ], @@ -2745,7 +2750,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The tile resize options in the visualization menu.\nAllows switching between different preset layouts.", + "shortText": "The visualization tile resize option.\nAlso available via More `...` options menu on a visualization.\nAllows resizing visualization tiles and switching\nbetween different preset layout option.", "tags": [ { "tag": "example", @@ -2756,7 +2761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3877, + "line": 3885, "character": 4 } ], @@ -2784,7 +2789,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4593, + "line": 4605, "character": 4 } ], @@ -2797,7 +2802,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The **Update TML** menu action for Liveboards and Answers.\nUpdate TML representation of ThoughtSpot objects.", + "shortText": "The **Update TML** menu action for Liveboards and Answers.\nUpdates TML representation of ThoughtSpot objects.", "tags": [ { "tag": "example", @@ -2808,7 +2813,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3849, + "line": 3854, "character": 4 } ], @@ -2836,7 +2841,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4491, + "line": 4501, "character": 4 } ], @@ -2864,7 +2869,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4582, + "line": 4594, "character": 4 } ], @@ -2991,7 +2996,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3536, + "line": 3535, "character": 12 } ] @@ -3024,7 +3029,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 136, + "line": 137, "character": 4 } ], @@ -3043,7 +3048,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 131, + "line": 132, "character": 12 } ] @@ -3073,7 +3078,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 40, + "line": 41, "character": 4 } ], @@ -3088,7 +3093,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 42, + "line": 43, "character": 4 } ], @@ -3103,7 +3108,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 39, + "line": 40, "character": 4 } ], @@ -3118,7 +3123,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 41, + "line": 42, "character": 4 } ], @@ -3133,7 +3138,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 38, + "line": 39, "character": 4 } ], @@ -3156,7 +3161,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 37, + "line": 38, "character": 12 } ] @@ -3189,7 +3194,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 53, + "line": 54, "character": 4 } ], @@ -3207,7 +3212,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 70, + "line": 71, "character": 4 } ], @@ -3225,7 +3230,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 57, + "line": 58, "character": 4 } ], @@ -3243,7 +3248,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 66, + "line": 67, "character": 4 } ], @@ -3267,7 +3272,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 77, + "line": 78, "character": 4 } ], @@ -3290,7 +3295,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 49, + "line": 50, "character": 12 } ] @@ -3529,7 +3534,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4732, + "line": 4745, "character": 4 } ], @@ -3544,7 +3549,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4730, + "line": 4743, "character": 4 } ], @@ -3559,7 +3564,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4731, + "line": 4744, "character": 4 } ], @@ -3580,7 +3585,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4729, + "line": 4742, "character": 12 } ] @@ -3607,7 +3612,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3390, + "line": 3389, "character": 4 } ], @@ -3625,7 +3630,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3394, + "line": 3393, "character": 4 } ], @@ -3643,7 +3648,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3386, + "line": 3385, "character": 4 } ], @@ -3664,7 +3669,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3382, + "line": 3381, "character": 12 } ] @@ -3776,7 +3781,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2025, + "line": 2026, "character": 4 } ], @@ -3821,7 +3826,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when an answer is switched to a chart or table view.", + "shortText": "Emitted when an Answer is switched to a chart or table view.", "tags": [ { "tag": "version", @@ -3836,7 +3841,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1998, + "line": 1999, "character": 4 } ], @@ -3904,7 +3909,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2233, + "line": 2235, "character": 4 } ], @@ -3917,7 +3922,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "The ThoughtSpot auth session has expired.", + "shortText": "The ThoughtSpot authentication session has expired.", "tags": [ { "tag": "version", @@ -3992,7 +3997,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2101, + "line": 2102, "character": 4 } ], @@ -4005,7 +4010,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the user creates a copy of an Answer", + "shortText": "Emitted when the user creates a copy of an Answer.", "tags": [ { "tag": "version", @@ -4020,7 +4025,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1976, + "line": 1977, "character": 4 } ], @@ -4048,7 +4053,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2121, + "line": 2122, "character": 4 } ], @@ -4076,7 +4081,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1913, + "line": 1914, "character": 4 } ], @@ -4100,7 +4105,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2184, + "line": 2186, "character": 4 } ], @@ -4113,7 +4118,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the liveboard is created from pin modal or liveboard list page.\nYou can use this event as a hook to trigger\nother events on liveboard creation.", + "shortText": "Emitted when the liveboard is created from pin modal or Liveboard list page.\nYou can use this event as a hook to trigger\nother events on liveboard creation.", "text": "```js\nliveboardEmbed.on(EmbedEvent.CreateLiveboard, (payload) => {\n console.log('payload', payload);\n})\n```", "tags": [ { @@ -4125,7 +4130,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2339, + "line": 2340, "character": 4 } ], @@ -4138,18 +4143,18 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when a user creates a new worksheet", + "shortText": "Emitted when a user creates a Worksheet.", "tags": [ { "tag": "version", - "text": "SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl\n" + "text": "SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 2224, + "line": 2226, "character": 4 } ], @@ -4162,7 +4167,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when a user interacts with cross filters on a visualization or Liveboard", + "shortText": "Emitted when a user interacts with cross filters on a\nvisualization or Liveboard.", "tags": [ { "tag": "version", @@ -4170,14 +4175,14 @@ }, { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.CrossFilterChanged, {\n vizId: '730496d6-6903-4601-937e-2c691821af3c'})\n```\n" + "text": "\n```js\nliveboardEmbed.on(EmbedEvent.CrossFilterChanged, {\n vizId: '730496d6-6903-4601-937e-2c691821af3c'})\n```\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 2131, + "line": 2133, "character": 4 } ], @@ -4226,11 +4231,11 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Data pertaining to answer or Liveboard is received", + "shortText": "Data pertaining to an Answer or Liveboard is received", "tags": [ { "tag": "returns", - "text": "data - The answer or Liveboard data" + "text": "data - The Answer or Liveboard data" }, { "tag": "version", @@ -4309,7 +4314,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2083, + "line": 2084, "character": 4 } ], @@ -4341,7 +4346,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2219, + "line": 2221, "character": 4 } ], @@ -4410,7 +4415,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the download action is triggered on an answer", + "shortText": "Emitted when the download action is triggered on an Answer.", "text": "**Note**: This event is deprecated in v1.21.0.\nTo fire an event when a download action is initiated on a chart or table,\nuse `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,\n`EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`", "tags": [ { @@ -4439,7 +4444,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the Download as CSV action is triggered on an answer", + "shortText": "Emitted when the Download as CSV action is triggered on an Answer.", "tags": [ { "tag": "version", @@ -4467,7 +4472,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the Download as PDF action is triggered on an answer", + "shortText": "Emitted when the Download as PDF action is triggered on an Answer", "tags": [ { "tag": "version", @@ -4495,7 +4500,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the download action is triggered on an answer", + "shortText": "Emitted when the download action is triggered on an Answer.", "tags": [ { "tag": "version", @@ -4523,7 +4528,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the Download as XLSX action is triggered on an answer", + "shortText": "Emitted when the Download as XLSX action is triggered on an Answer.", "tags": [ { "tag": "version", @@ -4566,7 +4571,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1902, + "line": 1903, "character": 4 } ], @@ -4594,7 +4599,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1890, + "line": 1891, "character": 4 } ], @@ -4666,7 +4671,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2047, + "line": 2048, "character": 4 } ], @@ -4694,7 +4699,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1936, + "line": 1937, "character": 4 } ], @@ -4759,7 +4764,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2111, + "line": 2112, "character": 4 } ], @@ -4787,7 +4792,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1951, + "line": 1952, "character": 4 } ], @@ -4811,7 +4816,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2161, + "line": 2163, "character": 4 } ], @@ -4895,7 +4900,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2014, + "line": 2015, "character": 4 } ], @@ -4987,7 +4992,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2058, + "line": 2059, "character": 4 } ], @@ -5000,7 +5005,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when the embed does not have cookie access. This happens\nwhen Safari and other Web browsers block third-party cookies\nare blocked by default. `NoCookieAccess` can trigger", + "shortText": "Emitted when the embed does not have cookie access. This happens\nwhen Safari and other Web browsers block third-party cookies\nare blocked by default. `NoCookieAccess` can trigger.", "tags": [ { "tag": "example", @@ -5052,7 +5057,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2297, + "line": 2299, "character": 4 } ], @@ -5065,8 +5070,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when parameter changes in an Answer\nor Liveboard", - "text": "```js\nliveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {\n console.log('payload', payload);\n})\n```", + "shortText": "Emitted when parameter changes in an Answer\nor Liveboard.\n```js\nliveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {\n console.log('payload', payload);\n})\n```", "tags": [ { "tag": "version", @@ -5077,7 +5081,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2309, + "line": 2310, "character": 4 } ], @@ -5090,7 +5094,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when an answer is pinned to a Liveboard", + "shortText": "Emitted when a user initiates the Pin action to\n add an Answer to a Liveboard.", "tags": [ { "tag": "version", @@ -5105,7 +5109,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1842, + "line": 1843, "character": 4 } ], @@ -5137,7 +5141,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2073, + "line": 2074, "character": 4 } ], @@ -5178,18 +5182,18 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when a LB/viz is renamed", + "shortText": "Emitted when a Liveboard or visualization is renamed.", "tags": [ { "tag": "version", - "text": "SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl\n" + "text": "SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw\n" } ] }, "sources": [ { "fileName": "types.ts", - "line": 2238, + "line": 2240, "character": 4 } ], @@ -5229,7 +5233,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2212, + "line": 2214, "character": 4 } ], @@ -5281,7 +5285,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2167, + "line": 2169, "character": 4 } ], @@ -5305,7 +5309,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2174, + "line": 2176, "character": 4 } ], @@ -5361,7 +5365,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1962, + "line": 1963, "character": 4 } ], @@ -5401,7 +5405,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2203, + "line": 2205, "character": 4 } ], @@ -5429,7 +5433,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2036, + "line": 2037, "character": 4 } ], @@ -5457,7 +5461,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2092, + "line": 2093, "character": 4 } ], @@ -5485,7 +5489,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1878, + "line": 1879, "character": 4 } ], @@ -5498,7 +5502,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Emitted when a user clicks Show underlying data on an Answer", + "shortText": "Emitted when a user clicks *Show underlying data* on an Answer.", "tags": [ { "tag": "version", @@ -5513,7 +5517,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1987, + "line": 1988, "character": 4 } ], @@ -5541,7 +5545,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1860, + "line": 1861, "character": 4 } ], @@ -5569,7 +5573,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2326, + "line": 2327, "character": 5 } ], @@ -5593,7 +5597,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2179, + "line": 2181, "character": 4 } ], @@ -5633,7 +5637,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2194, + "line": 2196, "character": 4 } ], @@ -5661,7 +5665,7 @@ "sources": [ { "fileName": "types.ts", - "line": 1924, + "line": 1925, "character": 4 } ], @@ -5757,7 +5761,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2142, + "line": 2144, "character": 4 } ], @@ -6320,7 +6324,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2590, + "line": 2589, "character": 4 } ], @@ -6348,7 +6352,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3262, + "line": 3261, "character": 4 } ], @@ -6381,7 +6385,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2863, + "line": 2862, "character": 4 } ], @@ -6418,7 +6422,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2807, + "line": 2806, "character": 4 } ], @@ -6451,7 +6455,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2930, + "line": 2929, "character": 4 } ], @@ -6483,7 +6487,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2966, + "line": 2965, "character": 4 } ], @@ -6511,7 +6515,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2998, + "line": 2997, "character": 4 } ], @@ -6540,7 +6544,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2748, + "line": 2747, "character": 4 } ], @@ -6568,7 +6572,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2981, + "line": 2980, "character": 4 } ], @@ -6596,7 +6600,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3015, + "line": 3014, "character": 4 } ], @@ -6648,7 +6652,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2466, + "line": 2467, "character": 4 } ], @@ -6682,7 +6686,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2846, + "line": 2845, "character": 4 } ], @@ -6710,7 +6714,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2726, + "line": 2725, "character": 4 } ], @@ -6743,7 +6747,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2790, + "line": 2789, "character": 4 } ], @@ -6771,7 +6775,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2716, + "line": 2715, "character": 4 } ], @@ -6784,7 +6788,7 @@ "kindString": "Enumeration member", "flags": {}, "comment": { - "shortText": "Get the answer session for a Search or\nLiveboard visualization.", + "shortText": "Get the Answer session for a Search or\nLiveboard visualization.", "tags": [ { "tag": "example", @@ -6803,7 +6807,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3252, + "line": 3251, "character": 4 } ], @@ -6831,7 +6835,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3111, + "line": 3110, "character": 4 } ], @@ -6859,7 +6863,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2488, + "line": 2489, "character": 4 } ], @@ -6883,7 +6887,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3311, + "line": 3310, "character": 4 } ], @@ -6915,7 +6919,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2894, + "line": 2893, "character": 4 } ], @@ -6932,7 +6936,7 @@ "tags": [ { "tag": "example", - "text": "\n```js\nliveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {\n console.log(\n tabDetails // TabDetails of current LB\n );\n})\n```" + "text": "\n```js\nliveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {\n console.log(\n tabDetails // TabDetails of current Liveboard\n );\n})\n```" }, { "tag": "version", @@ -6943,7 +6947,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3195, + "line": 3194, "character": 4 } ], @@ -6971,7 +6975,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2688, + "line": 2687, "character": 4 } ], @@ -7011,7 +7015,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2771, + "line": 2770, "character": 4 } ], @@ -7052,7 +7056,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2828, + "line": 2827, "character": 4 } ], @@ -7085,7 +7089,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3088, + "line": 3087, "character": 4 } ], @@ -7118,7 +7122,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2563, + "line": 2562, "character": 4 } ], @@ -7151,7 +7155,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2580, + "line": 2579, "character": 4 } ], @@ -7215,7 +7219,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2678, + "line": 2677, "character": 4 } ], @@ -7248,7 +7252,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2880, + "line": 2879, "character": 4 } ], @@ -7276,7 +7280,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2780, + "line": 2779, "character": 4 } ], @@ -7309,7 +7313,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2600, + "line": 2599, "character": 4 } ], @@ -7337,7 +7341,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3287, + "line": 3286, "character": 4 } ], @@ -7365,7 +7369,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3100, + "line": 3099, "character": 4 } ], @@ -7393,7 +7397,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3041, + "line": 3040, "character": 4 } ], @@ -7426,7 +7430,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3350, + "line": 3349, "character": 4 } ], @@ -7454,7 +7458,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2697, + "line": 2696, "character": 4 } ], @@ -7482,7 +7486,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2706, + "line": 2705, "character": 4 } ], @@ -7521,7 +7525,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2416, + "line": 2417, "character": 4 } ], @@ -7554,7 +7558,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2513, + "line": 2514, "character": 4 } ], @@ -7587,7 +7591,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3221, + "line": 3220, "character": 4 } ], @@ -7620,7 +7624,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3208, + "line": 3207, "character": 4 } ], @@ -7653,7 +7657,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2501, + "line": 2502, "character": 4 } ], @@ -7681,7 +7685,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3028, + "line": 3027, "character": 4 } ], @@ -7714,7 +7718,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2913, + "line": 2912, "character": 4 } ], @@ -7747,7 +7751,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2950, + "line": 2949, "character": 4 } ], @@ -7780,7 +7784,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3072, + "line": 3071, "character": 4 } ], @@ -7813,7 +7817,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3056, + "line": 3055, "character": 4 } ], @@ -7846,7 +7850,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3374, + "line": 3373, "character": 4 } ], @@ -7874,7 +7878,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3278, + "line": 3277, "character": 4 } ], @@ -7920,7 +7924,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3182, + "line": 3181, "character": 4 } ], @@ -7944,7 +7948,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3301, + "line": 3300, "character": 4 } ], @@ -7968,7 +7972,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3319, + "line": 3318, "character": 4 } ], @@ -7982,11 +7986,11 @@ "flags": {}, "comment": { "shortText": "Updates the runtime filters applied on a Liveboard. The filter\nattributes passed with this event are appended to the existing runtime\nfilters applied on a Liveboard.", - "text": "**Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`\nand `AppEmbed` only. In full application embedding, this event updates\nthe runtime filters applied on the Liveboard and saved Answer objects.\n\n\nPass an array of runtime filters with the following attributes:\n\n`columnName` - _String_. The name of the column to filter on.\n\n`operator` - Runtime filter operator 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", + "text": "**Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`\nand `AppEmbed` only. In full application embedding, this event updates\nthe runtime filters applied on the Liveboard and saved Answer objects.\n", "tags": [ { "tag": "param", - "text": "{@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.", + "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", "param": "-" }, { @@ -8006,7 +8010,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2551, + "line": 2550, "character": 4 } ], @@ -8044,7 +8048,7 @@ "sources": [ { "fileName": "types.ts", - "line": 3235, + "line": 3234, "character": 4 } ], @@ -8072,7 +8076,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2735, + "line": 2734, "character": 4 } ], @@ -8100,7 +8104,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2616, + "line": 2615, "character": 4 } ], @@ -8174,7 +8178,7 @@ "sources": [ { "fileName": "types.ts", - "line": 2396, + "line": 2397, "character": 12 } ] @@ -8211,7 +8215,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4854, + "line": 4867, "character": 4 } ], @@ -8239,7 +8243,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4815, + "line": 4828, "character": 4 } ], @@ -8267,7 +8271,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4840, + "line": 4853, "character": 4 } ], @@ -8295,7 +8299,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4803, + "line": 4816, "character": 4 } ], @@ -8323,7 +8327,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4866, + "line": 4879, "character": 4 } ], @@ -8351,7 +8355,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4827, + "line": 4840, "character": 4 } ], @@ -8375,7 +8379,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4790, + "line": 4803, "character": 12 } ] @@ -8556,7 +8560,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4719, + "line": 4732, "character": 4 } ], @@ -8571,7 +8575,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4721, + "line": 4734, "character": 4 } ], @@ -8586,7 +8590,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4720, + "line": 4733, "character": 4 } ], @@ -8601,7 +8605,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4722, + "line": 4735, "character": 4 } ], @@ -8623,7 +8627,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4718, + "line": 4731, "character": 12 } ] @@ -13064,7 +13068,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 414, + "line": 417, "character": 4 } ], @@ -13282,7 +13286,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 698, + "line": 701, "character": 11 } ], @@ -13583,7 +13587,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 679, + "line": 682, "character": 11 } ], @@ -13931,7 +13935,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 669, + "line": 672, "character": 17 } ], @@ -14064,7 +14068,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 649, + "line": 652, "character": 11 } ], @@ -14312,7 +14316,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 408, + "line": 411, "character": 13 } ], @@ -18467,7 +18471,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -19436,7 +19440,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -19473,7 +19477,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -19732,7 +19736,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of runtime filters to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of runtime filters to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -19773,7 +19777,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -20887,7 +20891,7 @@ "sources": [ { "fileName": "auth.ts", - "line": 84, + "line": 85, "character": 17 } ] @@ -21269,7 +21273,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -21707,7 +21711,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -21744,7 +21748,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -21897,7 +21901,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of runtime filters to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of runtime filters to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -21938,7 +21942,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -22578,7 +22582,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -23082,7 +23086,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -23119,7 +23123,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -23272,7 +23276,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of runtime filters to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of runtime filters to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -23313,7 +23317,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -23630,7 +23634,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4763, + "line": 4776, "character": 4 } ], @@ -23652,7 +23656,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4764, + "line": 4777, "character": 8 } ], @@ -23671,7 +23675,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4765, + "line": 4778, "character": 8 } ], @@ -23707,7 +23711,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4767, + "line": 4780, "character": 4 } ], @@ -23729,7 +23733,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4775, + "line": 4788, "character": 8 } ], @@ -23750,7 +23754,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4776, + "line": 4789, "character": 8 } ], @@ -23771,7 +23775,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4769, + "line": 4782, "character": 8 } ], @@ -23789,7 +23793,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4768, + "line": 4781, "character": 8 } ], @@ -23807,7 +23811,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4770, + "line": 4783, "character": 8 } ], @@ -23829,7 +23833,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4771, + "line": 4784, "character": 12 } ], @@ -23851,7 +23855,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4772, + "line": 4785, "character": 16 } ], @@ -23935,7 +23939,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4779, + "line": 4792, "character": 4 } ], @@ -23956,7 +23960,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4780, + "line": 4793, "character": 4 } ], @@ -23981,7 +23985,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4762, + "line": 4775, "character": 17 } ] @@ -28272,7 +28276,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -28753,7 +28757,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 351, + "line": 354, "character": 4 } ], @@ -28878,7 +28882,7 @@ "isOptional": true }, "comment": { - "shortText": "This flag is used to enable the compact header on a Liveboard", + "shortText": "Enables or disables the compact header feature on a Liveboard.\nCompact Liveboard header is turned off by default on Liveboards in\nThoughtSpot Embedded apps.", "tags": [ { "tag": "default", @@ -28897,7 +28901,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 308, + "line": 311, "character": 4 } ], @@ -28948,7 +28952,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -29051,7 +29055,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -29195,7 +29199,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of runtime filters to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of runtime filters to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -29236,7 +29240,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -29370,7 +29374,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 337, + "line": 340, "character": 4 } ], @@ -29444,7 +29448,7 @@ "sources": [ { "fileName": "embed/liveboard.ts", - "line": 322, + "line": 325, "character": 4 } ], @@ -30367,7 +30371,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -30831,7 +30835,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -30868,7 +30872,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -30979,7 +30983,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of runtime filters to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of runtime filters to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -31020,7 +31024,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -31723,7 +31727,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -32071,7 +32075,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -32108,7 +32112,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -32219,7 +32223,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -33075,7 +33079,7 @@ "isOptional": true }, "comment": { - "shortText": "Determines whether the PreRender component should not dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", + "shortText": "Determines if the PreRender component should dynamically track the size\nof its embedding element and adjust its own size accordingly.\nEnabling this option allows the PreRender component to automatically adapt\nits dimensions based on changes to the size of the embedding element.", "tags": [ { "tag": "default", @@ -33654,7 +33658,7 @@ "isOptional": true }, "comment": { - "shortText": "Flag to override openNew tab context menu link", + "shortText": "Flag to override the *Open Link in New Tab* context menu option.", "tags": [ { "tag": "version", @@ -33691,7 +33695,7 @@ "isOptional": true }, "comment": { - "shortText": "The locale/language to use for the embedded view.", + "shortText": "The locale settings to apply to the embedded view.", "tags": [ { "tag": "version", @@ -33802,7 +33806,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of runtime filters to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of runtime filters to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -33843,7 +33847,7 @@ "isOptional": true }, "comment": { - "shortText": "The list of parameter override to apply to a search answer,\nvisualization, or Liveboard.", + "shortText": "The list of parameter override to apply to a search Answer,\nvisualization, or Liveboard.", "tags": [ { "tag": "version", @@ -34355,7 +34359,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4755, + "line": 4768, "character": 4 } ], @@ -34376,7 +34380,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4756, + "line": 4769, "character": 4 } ], @@ -34402,7 +34406,7 @@ "sources": [ { "fileName": "types.ts", - "line": 4754, + "line": 4767, "character": 17 } ] @@ -34524,7 +34528,7 @@ "isOptional": true }, "comment": { - "shortText": "The custom css variables, which can be set.\nThe allowed list is in the CustomCssVariables\ninterface. For more information, see\nlink:https://developers.thoughtspot.com/docs/css-variables-reference" + "shortText": "The custom css variables, which can be set.\nThe variables are available in the {@link CustomCssVariables}\ninterface. For more information, see\nlink:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference]." }, "sources": [ { @@ -35591,7 +35595,7 @@ "sources": [ { "fileName": "utils/sessionInfoService.ts", - "line": 92, + "line": 93, "character": 22 } ], @@ -35603,7 +35607,7 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session info object and caches it for future use.\nOnce fetched the session info object is cached and returned from the cache on\nsubsequent calls.", + "shortText": "Returns the cached session info object and caches it for future use.\nOnce fetched the session info object is cached and returned from the cache on\nsubsequent calls.\nThis cache is cleared when inti is called OR resetCachedSessionInfo is called.", "tags": [ { "tag": "example",